dropbox_api 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47cd12fc36b2c62e257a717af58a4a2fa11f802c
-  data.tar.gz: c1ae321423d2b7f2494bba5fa9e24870322b0b25
+  metadata.gz: 3e7c47a22dce4e23deadb2344e7398865ff747c4
+  data.tar.gz: 29cb9bbbece2ff2fa58fe029b380660e13e79023
 SHA512:
-  metadata.gz: 11c9d49a540be98afedb19678fc4e85ac0de227eec0784916ce9279c9b37bba96922593a56096e56d058eb8b862c70684e827d292d60820f1fd5ee37f6f9c2e7
-  data.tar.gz: b75d171a9a4947d22f41efed6917e7e66b25636bf82fa2250b449978c0a0e6cf48868e1161a8292be7a1adbda4a0890b05cccdbb3f92e2a3f24af753b973caec
+  metadata.gz: 5f532b00a80f97e888b6b4913a0b57a25eb53b183a4a97a8e64255463924b57e79487b655784f7a332cad27bdb93694515f6166939929b197329eef3062b542c
+  data.tar.gz: 96be7b099622bff41b42186885dd9f4e0f89437042331e9f1500bd0a7e49afa827f691612df0280ca11113e722743995c86cfea792869a7dd236c22237c36a92

data/TODO.md

@@ -1,11 +1,8 @@
 # Short term goals
 
-- Remove dependency on faraday.
+- Update faraday version.
+- Fix `@option` params in doc.
 - Complete full [API coverage](api_coverage.md).
 
-# Further on
-
-- Improve the  API reference page, help here:
-  http://gnuu.org/2009/11/18/customizing-yard-templates/
-- Supporting streams would be great.
+# Worth looking at
 - Add a layer to handle pagination, use `Enumerable`.

data/lib/dropbox_api.rb

@@ -134,6 +134,8 @@ require 'dropbox_api/endpoints/rpc_notify'
 require 'dropbox_api/endpoints/content_download'
 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_reference_get'
 require 'dropbox_api/endpoints/files/copy_reference_save'
@@ -151,6 +153,7 @@ require 'dropbox_api/endpoints/files/list_folder_longpoll'
 require 'dropbox_api/endpoints/files/list_folder_get_latest_cursor'
 require 'dropbox_api/endpoints/files/list_revisions'
 require 'dropbox_api/endpoints/files/move'
+require 'dropbox_api/endpoints/files/permanently_delete'
 require 'dropbox_api/endpoints/files/restore'
 require 'dropbox_api/endpoints/files/save_url'
 require 'dropbox_api/endpoints/files/save_url_check_job_status'

data/lib/dropbox_api/endpoints/auth/token_revoke.rb

@@ -0,0 +1,14 @@
+module DropboxApi::Endpoints::Auth
+  class TokenRevoke < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/auth/token/revoke".freeze
+    ResultType  = DropboxApi::Results::VoidResult
+    ErrorType   = nil
+
+    # Revoke the access token for the current account
+    #
+    add_endpoint :token_revoke do
+      perform_request(nil)
+    end
+  end
+end

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

@@ -5,18 +5,26 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::Resource
     ErrorType   = DropboxApi::Errors::DeleteError
 
+    include DropboxApi::OptionsValidator
+
     # Delete the file or folder at a given path.
     #
     # If the path is a folder, all its contents will be deleted too.
     #
     # A successful response indicates that the file or folder was deleted.
-    # The returned metadata will be the corresponding FileMetadata or
-    # FolderMetadata for the item at time of deletion, and not a
-    # DeletedMetadata object.
+    # The returned metadata will be the corresponding
+    # {DropboxApi::Metadata::File} or {DropboxApi::Metadata::Folder} for the
+    # item at time of deletion, and not a {DropboxApi::Metadata::Deleted} object.
     #
     # @param path [String] Path in the user's Dropbox to delete.
-    add_endpoint :delete do |path|
-      perform_request({
+    # @option options parent_rev [String] Perform delete if given "rev"
+    #   matches the existing file's latest "rev". This field does not support
+    #   deleting a folder. If the given "rev" doesn't match, a
+    #   {DropboxApi::Errors::FileConflictError} will be raised.
+    add_endpoint :delete do |path, options = {}|
+      validate_options([:parent_rev], options)
+
+      perform_request options.merge({
         :path => path
       })
     end

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

@@ -15,11 +15,13 @@ module DropboxApi::Endpoints::Files
     # `:pending` or `nil`.
     #
     # @param path [String] The path of a file or folder on Dropbox.
-    # @option include_media_info [Boolean] If `true`, FileMetadata.media_info
+    # @option options include_media_info [Boolean] If `true`, `media_info`
     #   is set for photo and video. The default for this field is `false`.
-    # @option include_deleted [Boolean] If `true`, DeletedMetadata will be
-    #   returned for deleted file or folder, otherwise LookupError.not_found
-    #   will be returned. The default for this field is False.
+    # @option options include_deleted [Boolean] If `true`,
+    #   {DropboxApi::Metadata::Deleted} will be
+    #   returned for deleted file or folder, otherwise
+    #   {DropboxApi::Errors::NotFoundError}
+    #   will be raised. The default for this field is `false`.
     add_endpoint :get_metadata do |path, options = {}|
       validate_options([:include_media_info, :include_deleted], options)
 

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

@@ -10,14 +10,17 @@ module DropboxApi::Endpoints::Files
     # Returns the contents of a folder.
     #
     # @param path [String] The path to the folder you want to read.
-    # @option recursive [Boolean] If `true`, the list folder operation will be
-    #   applied recursively to all subfolders and the response will contain
-    #   contents of all subfolders. The default for this field is `false`.
-    # @option include_media_info [Boolean] If `true`, FileMetadata.media_info
+    # @option options recursive [Boolean] If `true`, the list folder operation
+    #   will be applied recursively to all subfolders and the response will
+    #   contain contents of all subfolders. The default for this field is
+    #   `false`.
+    # @option options include_media_info [Boolean] If `true`, media_info
     #   is set for photo and video. The default for this field is `false`.
-    # @option include_deleted [Boolean] If `true`, DeletedMetadata will be
-    #   returned for deleted file or folder, otherwise LookupError.not_found
-    #   will be returned. The default for this field is `false`.
+    # @option options include_deleted [Boolean] If `true`,
+    #   {DropboxApi::Metadata::Deleted} will be
+    #   returned for deleted file or folder, otherwise
+    #   {DropboxApi::Errors::NotFoundError}
+    #   will be raised. The default for this field is `false`.
     add_endpoint :list_folder do |path, options = {}|
       validate_options([
         :recursive,

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

@@ -8,7 +8,7 @@ module DropboxApi::Endpoints::Files
     include DropboxApi::OptionsValidator
 
     # A way to quickly get a cursor for the folder's state. Unlike
-    # {DropboxApi::API#list_folder}, this doesn't return any entries. This
+    # {DropboxApi::Client#list_folder}, this doesn't return any entries. This
     # endpoint is for app which only needs to know about new files and
     # modifications and doesn't need to know about files that already exist in
     # Dropbox.

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

@@ -10,8 +10,8 @@ module DropboxApi::Endpoints::Files
     # Return revisions of a file
     #
     # @param path [String] The path to file you want to see the revisions of.
-    # @option limit [Numeric] The maximum number of revision entries returned.
-    #   The default for this field is 10.
+    # @option options limit [Numeric] The maximum number of revision entries
+    #   returned. The default for this field is 10.
     add_endpoint :list_revisions do |path, options = {}|
       validate_options([
         :limit

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

@@ -0,0 +1,28 @@
+module DropboxApi::Endpoints::Files
+  class PermanentlyDelete < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/permanently_delete".freeze
+    ResultType  = DropboxApi::Results::VoidResult
+    ErrorType   = DropboxApi::Errors::DeleteError
+
+    include DropboxApi::OptionsValidator
+
+    # Permanently delete the file or folder at a given path.
+    #
+    # See https://www.dropbox.com/en/help/40
+    #
+    # Note: This endpoint is only available for Dropbox Business apps.
+    #
+    # @param path [String] Path in the user's Dropbox to delete.
+    # @option options parent_rev [String] Perform delete if given "rev"
+    #   matches the existing file's latest "rev". This field does not support
+    #   deleting a folder.
+    add_endpoint :permanently_delete do |path, options = {}|
+      validate_options([:parent_rev], options)
+
+      perform_request options.merge({
+        :path => path
+      })
+    end
+  end
+end

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

@@ -17,13 +17,13 @@ module DropboxApi::Endpoints::Files
     #   token is used for prefix matching (i.e. "bat c" matches "bat cave" but
     #   not "batman car").
     # @param path [String] The path in the user's Dropbox to search.
-    # @option start [Numeric] The starting index within the search results
-    #   (used for paging). The default for this field is 0.
-    # @option max_results [Numeric] The maximum number of search results to
-    #   return. The default for this field is 100.
-    # @option mode [:filename, :filename_and_content, :deleted_filename] The
-    #   search mode. Note that searching file content is only available for
-    #   Dropbox Business accounts. The default is filename.
+    # @option options start [Numeric] The starting index within the search
+    #   results (used for paging). The default for this field is 0.
+    # @option options max_results [Numeric] The maximum number of search
+    #   results to return. The default for this field is 100.
+    # @option options mode [:filename, :filename_and_content, :deleted_filename]
+    #   The search mode. Note that searching file content is only
+    #   available for Dropbox Business accounts. The default is filename.
     add_endpoint :search do |query, path = "", options = {}|
       validate_options([
         :start,

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

@@ -17,9 +17,9 @@ module DropboxApi::Endpoints::Sharing
     # links to parent folders of the given path. Links to parent folders can
     # be suppressed by setting direct_only to true.
     #
-    # @option path [String]
-    # @option cursor [String] The cursor returned by your last call.
-    # @option direct_only [Boolean]
+    # @option options path [String]
+    # @option options cursor [String] The cursor returned by your last call.
+    # @option options direct_only [Boolean]
     # @return [ListSharedLinksResult]
     add_endpoint :list_shared_links do |options = {}|
       validate_options([:path, :cursor, :direct_only], options)

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

@@ -11,7 +11,7 @@ module DropboxApi::Endpoints::Sharing
     #
     # Most sharing will be completed synchronously. Large folders will be
     # completed asynchronously. To make testing the async case repeatable, set
-    # `ShareFolderArg.force_async`.
+    # `force_async`.
     #
     # If a ShareFolderLaunch.async_job_id is returned, you'll need to call
     # check_share_job_status until the action completes to get the metadata
@@ -21,18 +21,18 @@ module DropboxApi::Endpoints::Sharing
     #
     # @param path [String] The path to the folder to share. If it does not
     #   exist, then a new one is created.
-    # @option member_policy [:anyone, :team] Who can be a member of this shared
-    #   folder. Only applicable if the current user is on a team. The default
-    #   is `:anyone`.
-    # @option acl_update_policy [:owner, :editors] Who can add and remove
-    #   members of this shared folder. The default is `:owner`.
-    # @option shared_link_policy [:anyone, :members] The policy to apply to
-    #   shared links created for content inside this shared folder. The
-    #   current user must be on a team to set this policy to `:members`.
+    # @option options member_policy [:anyone, :team] Who can be a member of
+    #   this shared folder. Only applicable if the current user is on a team.
+    #   The default is `:anyone`.
+    # @option options acl_update_policy [:owner, :editors] Who can add and
+    #   remove members of this shared folder. The default is `:owner`.
+    # @option options shared_link_policy [:anyone, :members] The policy to
+    #   apply to shared links created for content inside this shared folder.
+    #   The current user must be on a team to set this policy to `:members`.
     #   The default is `anyone`.
-    # @option force_async [Boolean] Whether to force the share to happen
-    #   asynchronously. The default for this field is `false`.
-    # @return [ShareFolderLaunch] Shared folder metadata.
+    # @option options force_async [Boolean] Whether to force the share to
+    #   happen asynchronously. The default for this field is `false`.
+    # @return [DropboxApi::Results::ShareFolderLaunch] Shared folder metadata.
     add_endpoint :share_folder do |path, options = {}|
       validate_options([
         :member_policy,

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.11'.freeze
+  VERSION = '0.1.12'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - lib/dropbox_api/chunked_uploader.rb
 - lib/dropbox_api/client.rb
 - lib/dropbox_api/connection_builder.rb
+- lib/dropbox_api/endpoints/auth/token_revoke.rb
 - lib/dropbox_api/endpoints/base.rb
 - lib/dropbox_api/endpoints/content_download.rb
 - lib/dropbox_api/endpoints/content_upload.rb
@@ -162,6 +163,7 @@ files:
 - lib/dropbox_api/endpoints/files/list_folder_longpoll.rb
 - lib/dropbox_api/endpoints/files/list_revisions.rb
 - lib/dropbox_api/endpoints/files/move.rb
+- lib/dropbox_api/endpoints/files/permanently_delete.rb
 - lib/dropbox_api/endpoints/files/restore.rb
 - lib/dropbox_api/endpoints/files/save_url.rb
 - lib/dropbox_api/endpoints/files/save_url_check_job_status.rb