dropbox_api 0.1.16 → 0.1.19

data/lib/dropbox_api/middleware/decode_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::MiddleWare
   class DecodeResult < Faraday::Middleware
     def call(rq_env)
@@ -14,7 +15,7 @@ module DropboxApi::MiddleWare
       # Dropbox may send a response with the string 'null' in its body, this
       # would be a void result. `add_folder_member` is an example of an
       # endpoint without return values.
-      if json == "null"
+      if json == 'null'
         {}
       else
         JSON.parse json
@@ -22,5 +23,5 @@ module DropboxApi::MiddleWare
     end
   end
 
-  Faraday::Response.register_middleware :decode_result => DecodeResult
+  Faraday::Response.register_middleware decode_result: DecodeResult
 end

data/lib/dropbox_api/middleware/stack.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::MiddleWare
   class Stack
     def initialize

data/lib/dropbox_api/options_validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
   module OptionsValidator
     # Takes in a list of valid option keys and a hash of options. If one of the

data/lib/dropbox_api/result_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
   class ResultBuilder
     def initialize(response_data)
@@ -5,11 +6,11 @@ module DropboxApi
     end
 
     def error_summary
-      @response_data["error_summary"] if @response_data.is_a? Hash
+      @response_data['error_summary'] if @response_data.is_a? Hash
     end
 
     def error
-      @response_data["error"]
+      @response_data['error']
     end
 
     def has_error?

data/lib/dropbox_api/results/add_file_member_result_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   # Example of a result of the `add_file_member` endpoint:
   #   [{

data/lib/dropbox_api/results/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class Base
     def initialize(result_data)

data/lib/dropbox_api/results/basic_account_batch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class BasicAccountBatch < Array
     def initialize(accounts)

data/lib/dropbox_api/results/copy_batch_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class CopyBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'async_job_id'
+        result_data['async_job_id']
+      when 'complete'
+        RelocationBatchResult.new(result_data)
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/create_folder_batch_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  # Result returned by {Client#create_folder_batch} that may either launch an
+  # asynchronous job or complete synchronously.
+  #
+  # The value will be either a job id or a list of job statuses.
+  class CreateFolderBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'async_job_id'
+        result_data
+      when 'complete'
+        result_data['entries'].map do |entry|
+          DropboxApi::Results::CreateFolderBatchResultEntry.new(entry)
+        end
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/create_folder_batch_result_entry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class CreateFolderBatchResultEntry < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'success'
+        DropboxApi::Metadata::Folder.new result_data['metadata']
+      when 'failure'
+        # At the moment, this is a `CreateFolderEntryError` which is an open
+        # union that can only be a `WriteError`. In the future, more errors
+        # could be added to the API which means we'd have to implement the
+        # actual `CreateFolderEntryError` class.
+        DropboxApi::Errors::WriteError
+          .build('Folder operation failed', result_data['failure']['path'])
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/delete_batch_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  # Result returned by {Client#delete_batch} that may either launch an
+  # asynchronous job or complete synchronously.
+  #
+  # The value will be either a job id or a list of job statuses.
+  class DeleteBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'async_job_id'
+        result_data
+      when 'complete'
+        result_data['entries'].map do |entry|
+          DropboxApi::Results::DeleteBatchResultEntry.new(entry)
+        end
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/delete_batch_result_entry.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class DeleteBatchResultEntry < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'success'
+        DropboxApi::Metadata::Resource.new result_data['metadata']
+      when 'failure'
+        DropboxApi::Errors::DeleteError
+          .build('Delete operation failed', result_data['failure'])
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/get_copy_reference_result.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class GetCopyReferenceResult < DropboxApi::Results::Base
     # Metadata of the file or folder.
     def resource
-      @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
+      @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
 
     # A copy reference to the file or folder.
     def copy_reference
-      @copy_reference ||= @data["copy_reference"]
+      @copy_reference ||= @data['copy_reference']
     end
 
     # The expiration date of the copy reference.
     # This value is currently set to be far enough in the future
     # so that expiration is effectively not an issue.
     def expires
-      @expires ||= Time.parse(@data["expires"])
+      @expires ||= Time.parse(@data['expires'])
     end
   end
 end

data/lib/dropbox_api/results/get_temporary_link_result.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class GetTemporaryLinkResult < DropboxApi::Results::Base
     def file
-      @file ||= DropboxApi::Metadata::File.new(@data["metadata"])
+      @file ||= DropboxApi::Metadata::File.new(@data['metadata'])
     end
 
     def link
-      @data["link"]
+      @data['link']
     end
   end
 end

data/lib/dropbox_api/results/get_thumbnail_batch_result.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class GetThumbnailBatchResult < DropboxApi::Results::Base
     def entries
-      @entries ||= @data["entries"].map do |entry|
+      @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::ThumbnailBatchResultEntry.new entry
       end
     end

data/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListFolderGetLatestCursorResult < DropboxApi::Results::Base
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
   end
 end

data/lib/dropbox_api/results/list_folder_longpoll_result.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListFolderLongpollResult < DropboxApi::Results::Base
     # Indicates whether new changes are available. If true, call
     # `list_folder_continue` to retrieve the changes.
     def changes
-      @data["changes"].to_s == "true"
+      @data['changes'].to_s == 'true'
     end
 
     # If present, backoff for at least this many seconds before calling
     # `list_folder_longpoll` again. This field is optional.
     def backoff
-      @data["backoff"]
+      @data['backoff']
     end
   end
 end

data/lib/dropbox_api/results/list_folder_result.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListFolderResult < DropboxApi::Results::Base
     # A collection of files and directories.
     def entries
-      @entries ||= @data["entries"].map do |entry|
+      @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::Resource.new entry
       end
     end
@@ -10,13 +11,13 @@ module DropboxApi::Results
     # Pass the cursor into `list_folder_continue` to see what's changed in the
     # folder since your previous query.
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
 
     # If true, then there are more entries available. Pass the cursor to
     # `list_folder_continue` to retrieve the rest.
     def has_more?
-      @data["has_more"].to_s == "true"
+      @data['has_more'].to_s == 'true'
     end
   end
 end

data/lib/dropbox_api/results/list_revisions_result.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListRevisionsResult < DropboxApi::Results::Base
     # A collection of files and directories.
     def entries
-      @entries ||= @data["entries"].map do |entry|
+      @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::File.new entry
       end
     end
 
     def is_deleted?
-      @data["is_deleted"] == true
+      @data['is_deleted'] == true
     end
   end
 end

data/lib/dropbox_api/results/list_shared_links_result.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ListSharedLinksResult < DropboxApi::Results::Base
     #  Shared links applicable to the path argument.
     def links
-      @entries ||= @data["links"].map do |entry|
+      @entries ||= @data['links'].map do |entry|
         DropboxApi::Metadata::SharedLinkMetadata.new entry
       end
     end
@@ -10,13 +11,13 @@ module DropboxApi::Results
     # Pass the cursor into `list_folder_continue` to see what's changed in the
     # folder since your previous query.
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
 
     # If true, then there are more entries available. Pass the cursor to
     # `list_folder_continue` to retrieve the rest.
     def has_more?
-      @data["has_more"].to_s == "true"
+      @data['has_more'].to_s == 'true'
     end
   end
 end

data/lib/dropbox_api/results/relocation_batch_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  # Result returned by {Client#copy_batch} or {Client#move_batch} that may
+  # either launch an asynchronous job or complete synchronously.
+  #
+  # The value will be either `:in_progress` or a list of job statuses.
+  class RelocationBatchResult < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'in_progress'
+        :in_progress
+      when 'complete'
+        result_data['entries'].map do |entry|
+          DropboxApi::Results::RelocationBatchResultEntry.new(entry)
+        end
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/relocation_batch_result_entry.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class RelocationBatchResultEntry < DropboxApi::Results::Base
+    def self.new(result_data)
+      case result_data['.tag']
+      when 'success'
+        DropboxApi::Metadata::Resource.new result_data['success']
+      when 'failure'
+        DropboxApi::Errors::RelocationBatchEntryError
+          .build('File or folder operation failed', result_data['failure'])
+      else
+        raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+      end
+    end
+  end
+end

data/lib/dropbox_api/results/save_copy_reference_result.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class SaveCopyReferenceResult < DropboxApi::Results::Base
     # The saved file or folder in the user's Dropbox.
     def resource
-      @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
+      @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
   end
 end

data/lib/dropbox_api/results/save_url_job_status.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class SaveUrlJobStatus < DropboxApi::Results::Base
     def self.new(result_data)
-      case result_data[".tag"]
-      when "in_progress"
+      case result_data['.tag']
+      when 'in_progress'
         :in_progress
-      when "complete"
+      when 'complete'
         DropboxApi::Metadata::File.new result_data
-      when "failed"
-        DropboxApi::Errors::SaveUrlError.build("Async job failed",
-                                               result_data["failed"])
+      when 'failed'
+        DropboxApi::Errors::SaveUrlError.build('Async job failed',
+                                               result_data['failed'])
       else
         raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}"
       end

data/lib/dropbox_api/results/save_url_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class SaveUrlResult < DropboxApi::Results::Base
     # Example with an async job:
@@ -8,7 +9,7 @@ module DropboxApi::Results
     #
     # I couldn't manage to get anything other than an async job.
     def async_job_id
-      @data["async_job_id"]
+      @data['async_job_id']
     end
   end
 end

data/lib/dropbox_api/results/search/match.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results::Search
   class Match
     def initialize(data)
@@ -5,11 +6,11 @@ module DropboxApi::Results::Search
     end
 
     def match_type
-      @data["match_type"]
+      @data['match_type']
     end
 
     def resource
-      @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
+      @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
   end
 end

data/lib/dropbox_api/results/search_v2_result.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module DropboxApi::Results
+  class SearchV2Result < DropboxApi::Results::Base
+    # A list (possibly empty) of matches for the query.
+    def matches
+      @matches ||= @data['matches'].map do |match|
+        DropboxApi::Metadata::SearchMatchV2.new match
+      end
+    end
+
+    # Used for paging. If true, indicates there is another page of results
+    # available that can be fetched by calling search again.
+    def has_more?
+      @data['more'].to_s == 'true'
+    end
+
+    # Pass the cursor into #search_continue to fetch the next page of results
+    # (not yet implemented).
+    # This field is optional.
+    def cursor
+      @data['cursor']
+    end
+  end
+end

data/lib/dropbox_api/results/share_folder_launch.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class ShareFolderLaunch
     def self.new(result_data)
-      case result_data[".tag"]
-      when "complete"
+      case result_data['.tag']
+      when 'complete'
         DropboxApi::Metadata::SharedFolder.new result_data
-      when "async_job_id"
+      when 'async_job_id'
         result_data
       else
         raise ArgumentError, "Unable to infer resource type for `#{tag}`"

data/lib/dropbox_api/results/shared_file_members.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class SharedFileMembers < DropboxApi::Results::Base
     def users
-      @data["users"]
+      @data['users']
     end
 
     def groups
-      @data["groups"]
+      @data['groups']
     end
 
     def invitees
-      @data["invitees"]
+      @data['invitees']
     end
 
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
   end
 end

data/lib/dropbox_api/results/shared_folder_members.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class SharedFolderMembers < DropboxApi::Results::Base
     def users
-      @data["users"]
+      @data['users']
     end
 
     def groups
-      @data["groups"]
+      @data['groups']
     end
 
     def invitees
-      @data["invitees"]
+      @data['invitees']
     end
 
     def cursor
-      @data["cursor"]
+      @data['cursor']
     end
   end
 end

data/lib/dropbox_api/results/upload_session_start.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class UploadSessionStart < DropboxApi::Results::Base
     def session_id
-      @data["session_id"]
+      @data['session_id']
     end
   end
 end

data/lib/dropbox_api/results/void_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi::Results
   class VoidResult < DropboxApi::Results::Base
   end

data/lib/dropbox_api/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DropboxApi
-  VERSION = '0.1.16'.freeze
+  VERSION = '0.1.19'
 end

data/lib/dropbox_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'dropbox_api/version'
 
 require 'time'
@@ -40,6 +41,16 @@ require 'dropbox_api/metadata/folder_sharing_info'
 require 'dropbox_api/metadata/folder'
 require 'dropbox_api/metadata/deleted'
 require 'dropbox_api/metadata/resource'
+require 'dropbox_api/metadata/metadata_v2'
+require 'dropbox_api/metadata/file_category'
+require 'dropbox_api/metadata/file_categories_list'
+require 'dropbox_api/metadata/file_extensions_list'
+require 'dropbox_api/metadata/search_order_by'
+require 'dropbox_api/metadata/file_status'
+require 'dropbox_api/metadata/search_options'
+require 'dropbox_api/metadata/search_match_type_v2'
+require 'dropbox_api/metadata/search_match_v2'
+require 'dropbox_api/metadata/search_match_field_options'
 require 'dropbox_api/metadata/shared_folder_policy'
 require 'dropbox_api/metadata/shared_folder'
 require 'dropbox_api/metadata/file_link_metadata'
@@ -71,9 +82,9 @@ require 'dropbox_api/errors/share_path_error'
 require 'dropbox_api/errors/share_folder_error'
 require 'dropbox_api/errors/get_copy_reference_error'
 require 'dropbox_api/errors/save_copy_reference_error'
+require 'dropbox_api/errors/create_folder_batch_error'
 require 'dropbox_api/errors/create_folder_error'
 require 'dropbox_api/errors/create_shared_link_with_settings_error'
-require 'dropbox_api/errors/delete_error'
 require 'dropbox_api/errors/download_error'
 require 'dropbox_api/errors/sharing_file_access_error'
 require 'dropbox_api/errors/sharing_user_error'
@@ -98,14 +109,21 @@ require 'dropbox_api/errors/poll_error'
 require 'dropbox_api/errors/add_file_member_error'
 require 'dropbox_api/errors/add_folder_member_error'
 require 'dropbox_api/errors/too_many_requests_error'
+require 'dropbox_api/errors/relocation_batch_entry_error'
 require 'dropbox_api/errors/get_account_error'
 require 'dropbox_api/errors/thumbnail_batch_error'
 require 'dropbox_api/errors/thumbnail_error'
 require 'dropbox_api/errors/create_file_request_error'
+require 'dropbox_api/errors/delete_error'
 
 require 'dropbox_api/result_builder'
 require 'dropbox_api/results/base'
 require 'dropbox_api/results/basic_account_batch'
+require 'dropbox_api/results/create_folder_batch_result'
+require 'dropbox_api/results/create_folder_batch_result_entry'
+require 'dropbox_api/results/relocation_batch_result'
+require 'dropbox_api/results/relocation_batch_result_entry'
+require 'dropbox_api/results/copy_batch_result'
 require 'dropbox_api/results/get_copy_reference_result'
 require 'dropbox_api/results/save_copy_reference_result'
 require 'dropbox_api/results/add_file_member_result_list'
@@ -118,13 +136,14 @@ require 'dropbox_api/results/list_folder_get_latest_cursor_result'
 require 'dropbox_api/results/list_shared_links_result'
 require 'dropbox_api/results/save_url_result'
 require 'dropbox_api/results/save_url_job_status'
-require 'dropbox_api/results/search/match'
-require 'dropbox_api/results/search_result'
+require 'dropbox_api/results/search_v2_result'
 require 'dropbox_api/results/share_folder_launch'
 require 'dropbox_api/results/shared_file_members'
 require 'dropbox_api/results/shared_folder_members'
 require 'dropbox_api/results/void_result'
 require 'dropbox_api/results/upload_session_start'
+require 'dropbox_api/results/delete_batch_result_entry'
+require 'dropbox_api/results/delete_batch_result'
 
 require 'dropbox_api/client'
 require 'dropbox_api/connection_builder'
@@ -140,9 +159,12 @@ require 'dropbox_api/endpoints/content_upload'
 require 'dropbox_api/endpoints/auth/token_revoke'
 
 require 'dropbox_api/endpoints/files/copy'
+require 'dropbox_api/endpoints/files/copy_batch_check'
+require 'dropbox_api/endpoints/files/copy_batch'
 require 'dropbox_api/endpoints/files/copy_reference_get'
 require 'dropbox_api/endpoints/files/copy_reference_save'
 require 'dropbox_api/endpoints/files/create_folder'
+require 'dropbox_api/endpoints/files/create_folder_batch'
 require 'dropbox_api/endpoints/files/delete'
 require 'dropbox_api/endpoints/files/download'
 require 'dropbox_api/endpoints/files/get_metadata'
@@ -165,6 +187,9 @@ require 'dropbox_api/endpoints/files/upload'
 require 'dropbox_api/endpoints/files/upload_session_start'
 require 'dropbox_api/endpoints/files/upload_session_append_v2'
 require 'dropbox_api/endpoints/files/upload_session_finish'
+require 'dropbox_api/endpoints/files/delete_batch_check'
+require 'dropbox_api/endpoints/files/delete_batch'
+require 'dropbox_api/endpoints/files/create_folder_batch_check'
 
 require 'dropbox_api/endpoints/sharing/add_file_member'
 require 'dropbox_api/endpoints/sharing/list_file_members'