dropbox_api 0.1.14 → 0.1.19

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DropboxApi::Endpoints::Files
+  class CopyBatchCheck < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/copy_batch/check_v2'
+    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/copy_reference_get.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CopyReferenceGet < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/copy_reference/get".freeze
+    Path        = '/2/files/copy_reference/get'
     ResultType  = DropboxApi::Results::GetCopyReferenceResult
     ErrorType   = DropboxApi::Errors::GetCopyReferenceError
 
@@ -14,7 +15,7 @@ module DropboxApi::Endpoints::Files
     # @return [DropboxApi::Results::GetCopyReferenceResult]
     add_endpoint :copy_reference_get do |path|
       perform_request({
-        :path => path
+        path: path
       })
     end
   end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CopyReferenceSave < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/copy_reference/save".freeze
+    Path        = '/2/files/copy_reference/save'
     ResultType  = DropboxApi::Results::SaveCopyReferenceResult
     ErrorType   = DropboxApi::Errors::SaveCopyReferenceError
 
@@ -14,8 +15,8 @@ module DropboxApi::Endpoints::Files
     # @return [DropboxApi::Results::SaveCopyReferenceResult]
     add_endpoint :copy_reference_save do |copy_reference, path|
       perform_request({
-        :copy_reference => copy_reference,
-        :path => path
+        copy_reference: copy_reference,
+        path: path
       })
     end
   end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class CreateFolder < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/create_folder".freeze
+    Path        = '/2/files/create_folder'
     ResultType  = DropboxApi::Metadata::Folder
     ErrorType   = DropboxApi::Errors::CreateFolderError
 
@@ -11,7 +12,7 @@ module DropboxApi::Endpoints::Files
     # @return [DropboxApi::Metadata::Folder] The new folder.
     add_endpoint :create_folder do |path|
       perform_request({
-        :path => path
+        path: path
       })
     end
   end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module DropboxApi::Endpoints::Files
+  class CreateFolderBatch < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/create_folder_batch'
+    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,22 @@
+# frozen_string_literal: true
+module DropboxApi::Endpoints::Files
+  class CreateFolderBatchCheck < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/create_folder_batch/check'
+    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.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class Delete < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/delete".freeze
+    Path        = '/2/files/delete'
     ResultType  = DropboxApi::Metadata::Resource
     ErrorType   = DropboxApi::Errors::DeleteError
 
@@ -25,7 +26,7 @@ module DropboxApi::Endpoints::Files
       validate_options([:parent_rev], options)
 
       perform_request options.merge({
-        :path => path
+        path: path
       })
     end
   end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module DropboxApi::Endpoints::Files
+  class DeleteBatch < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/delete_batch'
+    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,21 @@
+# frozen_string_literal: true
+module DropboxApi::Endpoints::Files
+  class DeleteBatchCheck < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = '/2/files/delete_batch/check'
+    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/download.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class Download < DropboxApi::Endpoints::ContentDownload
     Method      = :post
-    Path        = "/2/files/download".freeze
+    Path        = '/2/files/download'
     ResultType  = DropboxApi::Metadata::File
     ErrorType   = DropboxApi::Errors::DownloadError
 
@@ -9,7 +10,7 @@ module DropboxApi::Endpoints::Files
     #
     # @param path [String] The path of the file to download.
     add_endpoint :download do |path, &block|
-      perform_request({:path => path}, &block)
+      perform_request({path: path}, &block)
     end
   end
 end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class GetMetadata < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/get_metadata".freeze
+    Path        = '/2/files/get_metadata'
     ResultType  = DropboxApi::Metadata::Resource
     ErrorType   = DropboxApi::Errors::GetMetadataError
 
@@ -34,7 +35,7 @@ module DropboxApi::Endpoints::Files
       ], options)
 
       perform_request(options.merge({
-        :path => path
+        path: path
       }))
     end
   end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class GetPreview < DropboxApi::Endpoints::ContentDownload
     Method      = :post
-    Path        = "/2/files/get_preview".freeze
+    Path        = '/2/files/get_preview'
     ResultType  = DropboxApi::Metadata::File
     ErrorType   = DropboxApi::Errors::PreviewError
 
@@ -11,7 +12,7 @@ module DropboxApi::Endpoints::Files
     #
     # @param path [String] The path of the file to preview.
     add_endpoint :get_preview do |path, &block|
-      perform_request({:path => path}, &block)
+      perform_request({path: path}, &block)
     end
   end
 end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class GetTemporaryLink < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/get_temporary_link".freeze
+    Path        = '/2/files/get_temporary_link'
     ResultType  = DropboxApi::Results::GetTemporaryLinkResult
     ErrorType   = DropboxApi::Errors::GetMetadataError
 
@@ -11,7 +12,7 @@ module DropboxApi::Endpoints::Files
     #
     # @param path [String] The path to the file you want a temporary link to.
     add_endpoint :get_temporary_link do |path|
-      perform_request({:path => path})
+      perform_request({path: path})
     end
   end
 end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class GetThumbnail < DropboxApi::Endpoints::ContentDownload
     Method      = :post
-    Path        = "/2/files/get_thumbnail".freeze
+    Path        = '/2/files/get_thumbnail'
     ResultType  = DropboxApi::Metadata::File
     ErrorType   = DropboxApi::Errors::PreviewError
 
@@ -50,7 +51,7 @@ module DropboxApi::Endpoints::Files
       options[:size] ||= :w64h64
 
       perform_request(options.merge({
-        :path => path
+        path: path
       }), &block)
     end
   end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class GetThumbnailBatch < DropboxApi::Endpoints::RpcContent
     Method      = :post
-    Path        = "/2/files/get_thumbnail_batch".freeze
+    Path        = '/2/files/get_thumbnail_batch'
     ResultType  = DropboxApi::Results::GetThumbnailBatchResult
     ErrorType   = DropboxApi::Errors::ThumbnailBatchError
 
@@ -25,12 +26,12 @@ module DropboxApi::Endpoints::Files
       options[:size] ||= :w64h64
       options[:mode] ||= :strict
 
-      perform_request :entries => build_entries_params(paths, options)
+      perform_request entries: build_entries_params(paths, options)
     end
 
     def build_entries_params(paths, options)
       paths.map do |path|
-        options.merge({ :path => path })
+        options.merge({ path: path })
       end
     end
 

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class ListFolder < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/list_folder".freeze
+    Path        = '/2/files/list_folder'
     ResultType  = DropboxApi::Results::ListFolderResult
     ErrorType   = DropboxApi::Errors::ListFolderError
 
@@ -21,21 +22,27 @@ module DropboxApi::Endpoints::Files
     #   returned for deleted file or folder, otherwise
     #   {DropboxApi::Errors::NotFoundError}
     #   will be raised. The default for this field is `false`.
+    # @option options limit [Numeric] If present, will specify max number of
+    #   results per request (Note:
+    #   {https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder Dropbox docs} indicate
+    #   this is "approximate", and more may be returned)
     add_endpoint :list_folder do |path, options = {}|
       validate_options([
         :recursive,
         :include_media_info,
         :include_deleted,
         :shared_link,
-        :include_has_explicit_shared_members
+        :include_has_explicit_shared_members,
+        :limit
       ], options)
       options[:recursive] ||= false
       options[:include_media_info] ||= false
       options[:include_deleted] ||= false
       options[:shared_link] = build_shared_link_param(options[:shared_link]) if options[:shared_link]
-
+      options[:limit] = options[:limit] if options[:limit]
+      
       perform_request options.merge({
-        :path => path
+        path: path
       })
     end
 

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class ListFolderContinue < DropboxApi::Endpoints::Rpc
     # NOTE: This hasn't been tested with real data, I couldn't make a query
     #       long enough to enable the `has_more` attribute in the
     #       `ListFolderResult`.
     Method      = :post
-    Path        = "/2/files/list_folder/continue".freeze
+    Path        = '/2/files/list_folder/continue'
     ResultType  = DropboxApi::Results::ListFolderResult
     ErrorType   = DropboxApi::Errors::ListFolderContinueError
 
@@ -14,7 +15,7 @@ module DropboxApi::Endpoints::Files
     # @param cursor [String] The cursor returned by your last call to
     #   list_folder or list_folder_continue.
     add_endpoint :list_folder_continue do |cursor|
-      perform_request :cursor => cursor
+      perform_request cursor: cursor
     end
   end
 end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class ListFolderGetLatestCursor < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/list_folder/get_latest_cursor".freeze
+    Path        = '/2/files/list_folder/get_latest_cursor'
     ResultType  = DropboxApi::Results::ListFolderGetLatestCursorResult
     ErrorType   = DropboxApi::Errors::ListFolderError
 

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class ListFolderLongpoll < DropboxApi::Endpoints::RpcNotify
     Method      = :post
-    Path        = "/2/files/list_folder/longpoll".freeze
+    Path        = '/2/files/list_folder/longpoll'
     ResultType  = DropboxApi::Results::ListFolderLongpollResult
     ErrorType   = DropboxApi::Errors::ListFolderLongpollError
 
@@ -28,7 +29,7 @@ module DropboxApi::Endpoints::Files
       options[:timeout] ||= 30
 
       perform_request options.merge({
-        :cursor => cursor
+        cursor: cursor
       })
     end
   end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DropboxApi::Endpoints::Files
   class ListRevisions < DropboxApi::Endpoints::Rpc
     Method      = :post
-    Path        = "/2/files/list_revisions".freeze
+    Path        = '/2/files/list_revisions'
     ResultType  = DropboxApi::Results::ListRevisionsResult
     ErrorType   = DropboxApi::Errors::ListRevisionsError
 
@@ -19,7 +20,7 @@ module DropboxApi::Endpoints::Files
       options[:limit] ||= 10
 
       perform_request options.merge({
-        :path => path
+        path: path
       })
     end
   end