dropbox_api 0.1.16 → 0.1.17

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -102,9 +102,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:01 2018 by
+  Generated on Sat Feb 16 18:39:17 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/dropbox_api.gemspec

@@ -17,14 +17,12 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.has_rdoc = "yard"
-
   spec.add_development_dependency "bundler", ">= 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "oauth2", "~> 1.1"
   spec.add_dependency "faraday", ">= 0.8", "<= 0.15.4"
+  spec.add_dependency "oauth2", "~> 1.1"
 end

data/lib/dropbox_api.rb

@@ -71,9 +71,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 +98,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'
@@ -125,6 +132,8 @@ 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 +149,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 +177,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'

data/lib/dropbox_api/endpoints/base.rb

@@ -33,8 +33,10 @@ module DropboxApi::Endpoints
 
         raise error
       else
-        raise DropboxApi::Errors::HttpError,
+        raise(
+          DropboxApi::Errors::HttpError,
           "HTTP #{raw_response.status}: #{raw_response.body}"
+        )
       end
     end
 

data/lib/dropbox_api/endpoints/file_requests/create_file_request.rb

@@ -13,8 +13,8 @@ module DropboxApi::Endpoints::Files
     #   this will be relative to the app folder.
     add_endpoint :create_file_request do |title, destination|
       perform_request({
-        title: title,
-        destination: destination
+        :title => title,
+        :destination => destination
       })
     end
   end

data/lib/dropbox_api/endpoints/files/copy_batch.rb

@@ -0,0 +1,35 @@
+module DropboxApi::Endpoints::Files
+  class CopyBatch < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/copy_batch_v2".freeze
+    ResultType  = DropboxApi::Results::CopyBatchResult
+
+    include DropboxApi::OptionsValidator
+
+    # Copy multiple files or folders to different locations at once in the
+    # user's Dropbox.
+    #
+    # This will either finish synchronously, or return a job ID and do
+    # the async copy job in background. Please use {Client#copy_batch_check}
+    # to check the job status.
+    #
+    # Note: No errors are returned by this endpoint.
+    #
+    # @param entries [Array<Hash>] List of entries to be moved or copied.
+    #   Each entry must be a hash with two keys: `:from_path` & `:to_path`.
+    # @option options autorename [Boolean] If there's a conflict with any file,
+    #   have the Dropbox server try to autorename that file to avoid the
+    #   conflict. The default for this field is `false`.
+    # @return [String, Array] Either the job id or the list of job statuses.
+    add_endpoint :copy_batch do |entries, options = {}|
+      validate_options([
+        :autorename
+      ], options)
+      options[:autorename] ||= false
+
+      perform_request(options.merge({
+        :entries => entries
+      }))
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/copy_batch_check.rb

@@ -0,0 +1,20 @@
+module DropboxApi::Endpoints::Files
+  class CopyBatchCheck < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/copy_batch/check_v2'.freeze
+    ResultType  = DropboxApi::Results::RelocationBatchResult
+    ErrorType   = DropboxApi::Errors::PollError
+
+    # Returns the status of an asynchronous job for {Client#copy_batch}. It
+    # returns a list of results for each entry.
+    #
+    # @param async_job_id [String] Id of the asynchronous job.
+    #   This is the value of a response returned from the method that
+    #   launched the job.
+    # @return [:in_progress, Array] This could be either the `:in_progress`
+    #   flag or a list of job statuses.
+    add_endpoint :copy_batch_check do |async_job_id|
+      perform_request :async_job_id => async_job_id
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/create_folder_batch.rb

@@ -0,0 +1,40 @@
+module DropboxApi::Endpoints::Files
+  class CreateFolderBatch < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/create_folder_batch".freeze
+    ResultType  = DropboxApi::Results::CreateFolderBatchResult
+
+    include DropboxApi::OptionsValidator
+
+    # Create multiple folders at once.
+    #
+    # This route is asynchronous for large batches, which returns a job ID
+    # immediately and runs the create folder batch asynchronously. Otherwise,
+    # creates the folders and returns the result synchronously for smaller
+    # inputs. You can force asynchronous behaviour by using the `:force_async`
+    # flag. Use {Client#create_folder_batch_check} to check the job status.
+    #
+    # Note: No errors are returned by this endpoint.
+    #
+    # @param paths [Array] List of paths to be created in the user's Dropbox.
+    #   Duplicate path arguments in the batch are considered only once.
+    # @option options autorename [Boolean] If there's a conflict, have the
+    #   Dropbox server try to autorename the folder to avoid the conflict.
+    #   The default for this field is `false`.
+    # @option options force_async [Boolean] Whether to force the create to
+    #   happen asynchronously. The default for this field is `false`.
+    # @return [String, Array] Either the job id or the list of job statuses.
+    add_endpoint :create_folder_batch do |paths, options = {}|
+      validate_options([
+        :autorename,
+        :force_async
+      ], options)
+      options[:autorename] ||= false
+      options[:force_async] ||= false
+
+      perform_request(options.merge({
+        :paths => paths
+      }))
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb

@@ -0,0 +1,21 @@
+module DropboxApi::Endpoints::Files
+  class CreateFolderBatchCheck < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/create_folder_batch/check".freeze
+    ResultType  = DropboxApi::Results::CreateFolderBatchResult
+    ErrorType   = DropboxApi::Errors::PollError
+
+    # Returns the status of an asynchronous job for create_folder_batch.
+    # If success, it returns list of result for each entry.
+    #
+    # @param async_job_id [String] Id of the asynchronous job.
+    #   This is the value of a response returned from the method that launched
+    #   the job.
+    # @return [Array] A list of one result for each entry.
+    add_endpoint :create_folder_batch_check do |async_job_id|
+      perform_request({
+        :async_job_id => async_job_id
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/delete_batch.rb

@@ -0,0 +1,22 @@
+module DropboxApi::Endpoints::Files
+  class DeleteBatch < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/delete_batch".freeze
+    ResultType  = DropboxApi::Results::DeleteBatchResult
+
+    # Delete multiple files/folders at once.
+    #
+    # This route is asynchronous, which returns a job ID immediately and runs
+    # the delete batch asynchronously. Use {Client#delete_batch_check} to check
+    # the job status.
+    #
+    # @param entries [Array] List of entries, each entry is a Hash with these
+    #   fields: `path` (mandatory) & parent_rev (optional).
+    # @return [String, Array] Either the job id or the list of job statuses.
+    add_endpoint :delete_batch do |entries|
+      perform_request({
+        :entries => entries
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/delete_batch_check.rb

@@ -0,0 +1,20 @@
+module DropboxApi::Endpoints::Files
+  class DeleteBatchCheck < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/delete_batch/check".freeze
+    ResultType  = DropboxApi::Results::DeleteBatchResult
+    ErrorType   = DropboxApi::Errors::PollError
+
+    # Returns the status of an asynchronous job for delete_batch. If success,
+    # it returns list of result for each entry.
+    #
+    # @param async_job_id [String] Id of the asynchronous job.
+    # @return [:in_progress, Array] This could be either the `:in_progress`
+    #   flag or a list of job statuses.
+    add_endpoint :delete_batch_check do |async_job_id|
+      perform_request({
+        :async_job_id => async_job_id
+      })
+    end
+  end
+end

data/lib/dropbox_api/endpoints/files/upload.rb

@@ -11,7 +11,7 @@ module DropboxApi::Endpoints::Files
     #
     # Do not use this to upload a file larger than 150 MB.
     #
-    # For larger files you can use {#upload_by_chunks}.
+    # For larger files you can use {Client#upload_by_chunks}.
     #
     # @example
     #   client = DropboxApi::Client.new

data/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb

@@ -40,7 +40,7 @@ module DropboxApi::Endpoints::Sharing
 
       perform_request({
         :path => path,
-        :settings=> settings
+        :settings => settings
       })
     end
   end

data/lib/dropbox_api/errors/create_folder_batch_error.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Errors
+  class CreateFolderBatchError < BasicError
+    ErrorSubtypes = {
+      :too_many_files => TooManyFilesError
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/delete_error.rb

@@ -2,7 +2,8 @@ module DropboxApi::Errors
   class DeleteError < BasicError
     ErrorSubtypes = {
       :path_lookup => LookupError,
-      :path_write => WriteError
+      :path_write => WriteError,
+      :too_many_write_operations => TooManyWriteOperationsError
     }.freeze
   end
-end
+end

data/lib/dropbox_api/errors/relocation_batch_entry_error.rb

@@ -0,0 +1,9 @@
+module DropboxApi::Errors
+  class RelocationBatchEntryError < BasicError
+    ErrorSubtypes = {
+      :relocation_error => RelocationError,
+      :internal_error => InternalError,
+      :too_many_write_operations => TooManyWriteOperationsError
+    }.freeze
+  end
+end

data/lib/dropbox_api/results/copy_batch_result.rb

@@ -0,0 +1,14 @@
+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,20 @@
+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,19 @@
+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,20 @@
+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,15 @@
+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/relocation_batch_result.rb

@@ -0,0 +1,20 @@
+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