dropbox_api 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b389b70a2387d0fdb49c3fdb6f2eee7f668c8a6
-  data.tar.gz: d3e52de1f131820d0bef5ceef1317d3e27f87bf7
+  metadata.gz: 5dde8e23c02270cb1b1cc29c059d03ae27b9160f
+  data.tar.gz: d398b3b9c4fc2edc3f190bea2a35e9dbaf4ae0fd
 SHA512:
-  metadata.gz: 3a6069d423d4a9166875aaaa13d7a10147eddc28035eaa46e330bf63e05ed9c88d3397ca42085a1135aaccf12f7059cb3f8b27ae5fa8af000c3e0085e3e2873f
-  data.tar.gz: 5a589ff7f10403e2dca274742b2e22f27f1ab370094f47168f6f16b543b569d92b0dd8da40e45cb33043b74a6319a4caa1eabbba098a190ce0047372ad25b59b
+  metadata.gz: 4f174851e2e863c779082a8d5fdfa39b46ac62effb31215514a01f0ed34d5bfabe33da4fd0a7df06b331c4999e8f3683c57e712757e1a49e31ced9176d7ad4cc
+  data.tar.gz: 28efd74cffc713594babe9a55318c447d541fad2ac5d8c1c3acde120b1f034fa16ecb6264c90545c9ef506e6daf6d3f26d7bdb95424c6193d5eea15771ad2a72

data/TODO.md

@@ -2,6 +2,8 @@
 
 - Rebuild spec fixtures for `list_folder`.
 - Add documentation on how to rebuild spec fixtures.
+- Chunked downloads, issue #8.
+- Chunked uploads, issue #18.
 
 # Upcoming
 
@@ -46,4 +48,7 @@ Release process:
 
 ## Publish doc
 
-1.
+1. `yardoc`
+2. Change dir to dropbox_api_doc, where branch gh-pages is checked out.
+3. Replace files with the updated ones.
+4. `git commit` & `git push origin gh-pages`.

data/api_coverage.md

@@ -15,8 +15,8 @@ what new moon means.
 API call | Status
 --- | :---:
 `/copy` | 🌕
-`/copy_reference/get` | 🌑
-`/copy_reference/save` | 🌑
+`/copy_reference/get` | 🌕
+`/copy_reference/save` | 🌕
 `/create_folder` | 🌕
 `/delete` | 🌕
 `/download` | 🌔

data/lib/dropbox_api.rb

@@ -57,6 +57,8 @@ require 'dropbox_api/errors/search_error'
 require 'dropbox_api/errors/settings_error'
 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_error'
 require 'dropbox_api/errors/create_shared_link_with_settings_error'
 require 'dropbox_api/errors/delete_error'
@@ -88,6 +90,8 @@ require 'dropbox_api/errors/get_account_error'
 require 'dropbox_api/result_builder'
 require 'dropbox_api/results/base'
 require 'dropbox_api/results/basic_account_batch'
+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'
 require 'dropbox_api/results/get_temporary_link_result'
 require 'dropbox_api/results/list_folder_result'
@@ -114,6 +118,8 @@ require 'dropbox_api/endpoints/content_download'
 require 'dropbox_api/endpoints/content_upload'
 require 'dropbox_api/endpoints/options_validator'
 require 'dropbox_api/endpoints/files/copy'
+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/delete'
 require 'dropbox_api/endpoints/files/download'

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

@@ -0,0 +1,21 @@
+module DropboxApi::Endpoints::Files
+  class CopyReferenceGet < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/copy_reference/get".freeze
+    ResultType  = DropboxApi::Results::GetCopyReferenceResult
+    ErrorType   = DropboxApi::Errors::GetCopyReferenceError
+
+    # Get a copy reference to a file or folder.
+    # This reference string can be used to save that file or folder
+    # to another user's Dropbox by passing it to {Client#copy_reference_save}.
+    #
+    # @param path [String] The path to the file or folder you want to get a
+    #   copy reference to.
+    # @return [DropboxApi::Results::GetCopyReferenceResult]
+    add_endpoint :copy_reference_get do |path|
+      perform_request({
+        :path => path
+      })
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module DropboxApi::Endpoints::Files
+  class CopyReferenceSave < DropboxApi::Endpoints::Rpc
+    Method      = :post
+    Path        = "/2/files/copy_reference/save".freeze
+    ResultType  = DropboxApi::Results::SaveCopyReferenceResult
+    ErrorType   = DropboxApi::Errors::SaveCopyReferenceError
+
+    # Save a copy reference returned by {Client#copy_reference_get} to the
+    # user's Dropbox.
+    #
+    # @param copy_reference [String] A copy reference returned by
+    #   {Client#copy_reference_get}.
+    # @param path [String] Path in the user's Dropbox that is the destination.
+    # @return [DropboxApi::Results::SaveCopyReferenceResult]
+    add_endpoint :copy_reference_save do |copy_reference, path|
+      perform_request({
+        :copy_reference => copy_reference,
+        :path => path
+      })
+    end
+  end
+end

data/lib/dropbox_api/errors/basic_error.rb

@@ -54,6 +54,7 @@ module DropboxApi::Errors
   class InsufficientSpaceError < BasicError; end
   class InternalError < BasicError; end
   class InvalidCommentError < BasicError; end
+  class InvalidCopyReferenceError < BasicError; end
   class InvalidCursorError < BasicError; end
   class InvalidDropboxIdError < BasicError; end
   class InvalidEmailError < BasicError; end

data/lib/dropbox_api/errors/get_copy_reference_error.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Errors
+  class GetCopyReferenceError < BasicError
+    ErrorSubtypes = {
+      :path => LookupError
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/save_copy_reference_error.rb

@@ -0,0 +1,11 @@
+module DropboxApi::Errors
+  class SaveCopyReferenceError < BasicError
+    ErrorSubtypes = {
+      :path => WriteError,
+      :invalid_copy_reference => InvalidCopyReferenceError,
+      :no_permission => NoPermissionError,
+      :not_found => NotFoundError,
+      :too_many_files => TooManyFilesError
+    }.freeze
+  end
+end

data/lib/dropbox_api/results/get_copy_reference_result.rb

@@ -0,0 +1,20 @@
+module DropboxApi::Results
+  class GetCopyReferenceResult < DropboxApi::Results::Base
+    # Metadata of the file or folder.
+    def resource
+      @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
+    end
+
+    # A copy reference to the file or folder.
+    def 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"])
+    end
+  end
+end

data/lib/dropbox_api/results/save_copy_reference_result.rb

@@ -0,0 +1,8 @@
+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"]
+    end
+  end
+end

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.1.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2017-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,8 @@ files:
 - lib/dropbox_api/endpoints/content_download.rb
 - lib/dropbox_api/endpoints/content_upload.rb
 - lib/dropbox_api/endpoints/files/copy.rb
+- lib/dropbox_api/endpoints/files/copy_reference_get.rb
+- lib/dropbox_api/endpoints/files/copy_reference_save.rb
 - lib/dropbox_api/endpoints/files/create_folder.rb
 - lib/dropbox_api/endpoints/files/delete.rb
 - lib/dropbox_api/endpoints/files/download.rb
@@ -189,6 +191,7 @@ files:
 - lib/dropbox_api/errors/download_error.rb
 - lib/dropbox_api/errors/file_member_action_error.rb
 - lib/dropbox_api/errors/get_account_error.rb
+- lib/dropbox_api/errors/get_copy_reference_error.rb
 - lib/dropbox_api/errors/get_metadata_error.rb
 - lib/dropbox_api/errors/http_error.rb
 - lib/dropbox_api/errors/list_folder_continue_error.rb
@@ -201,6 +204,7 @@ files:
 - lib/dropbox_api/errors/preview_error.rb
 - lib/dropbox_api/errors/relocation_error.rb
 - lib/dropbox_api/errors/restore_error.rb
+- lib/dropbox_api/errors/save_copy_reference_error.rb
 - lib/dropbox_api/errors/save_url_error.rb
 - lib/dropbox_api/errors/search_error.rb
 - lib/dropbox_api/errors/settings_error.rb
@@ -256,12 +260,14 @@ files:
 - lib/dropbox_api/results/add_file_member_result_list.rb
 - lib/dropbox_api/results/base.rb
 - lib/dropbox_api/results/basic_account_batch.rb
+- lib/dropbox_api/results/get_copy_reference_result.rb
 - lib/dropbox_api/results/get_temporary_link_result.rb
 - lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb
 - lib/dropbox_api/results/list_folder_longpoll_result.rb
 - lib/dropbox_api/results/list_folder_result.rb
 - lib/dropbox_api/results/list_revisions_result.rb
 - lib/dropbox_api/results/list_shared_links_result.rb
+- lib/dropbox_api/results/save_copy_reference_result.rb
 - lib/dropbox_api/results/save_url_job_status.rb
 - lib/dropbox_api/results/save_url_result.rb
 - lib/dropbox_api/results/search/match.rb