dropbox_api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71bc2fe09bb0680e07ef7267a199993f8aa93cc5
-  data.tar.gz: 31df4bc163d59790a448e37cb695617fe168d99d
+  metadata.gz: c0eede08a0f815d30642620662824beb4772cd27
+  data.tar.gz: ffcd6a73b9f84613db886767ea931d86c23189b4
 SHA512:
-  metadata.gz: e05027a2944af74b33f56a1a7a6a124459fd0a1c604ebd4ebaa5db3403eed396247aeea1344c69f8828b1172eac17ee32a3fcce60f3a8f280d30d02d4c95e1fa
-  data.tar.gz: 99c5f3c37144305dc4a689902e7c61468ef2991ddf4713c4354e4dee7076a83ea87434a5cc6d19122e2de6c0f21bb3a4b96144b60cb94c919a0d3ae7c895bc25
+  metadata.gz: 9135f8db610192f4ec44b63b9133a61d06d0610f8c070732f8164e00f27ecb2a68c27b5aaf2b1092c44cb97cff980aaa2afca322146cbc07b9f6d86afff1a8c3
+  data.tar.gz: cc47310f7f6007517a1074137c5872c51c4f8da491f1ef09391c7a7d3678ae102e37c336af9cdaeddcb6f39da1601363b4f4f25ebf5c71285422f73086543d0c

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 rvm:
   # - 1.8.7
   # - 1.9.3
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0

data/.yardopts

@@ -1 +1,8 @@
-- api_coverage.md api_reference.md rails_setup.md
+--load yardoc/endpoint_handler.rb
+--load yardoc/rspec.rb
+--load yardoc/helpers/html_helper.rb
+lib/**/*.rb
+spec/endpoints/**/*_spec.rb
+-
+api_coverage.md
+rails_setup.md

data/README.md

@@ -72,11 +72,11 @@ auth_bearer.token #=> "VofXAX8D..."
 #### Standard OAuth 2 flow
 
 This is what many web applications will use. The process is described in
-Dropbox's [OAuth guide](https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web).
+Dropbox's [OAuth guide]
+(https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web).
 
 If you have a Rails application, you might be interested in this [setup
- guide](rails_setup.md).
-
+guide](http://www.rubydoc.info/gems/dropbox_api/file/rails_setup.md).
 
 ### Performing API calls
 
@@ -98,14 +98,10 @@ result.has_more?
 #=> false
 ```
 
-Refer to the
-[documentation](http://www.rubydoc.info/gems/dropbox_api)
-to see the details for each endpoint, you can find them all in the following
-3 modules:
-
- - [Files](http://www.rubydoc.info/gems/dropbox_api/DropboxApi/Endpoints/Files)
- - [Sharing](http://www.rubydoc.info/gems/dropbox_api/DropboxApi/Endpoints/Sharing)
- - [Users](http://www.rubydoc.info/gems/dropbox_api/DropboxApi/Endpoints/Users)
+The instance of `Client` we've initialized is the one you'll be using to
+perform API calls. You can check the class' documentation to find
+[all available endpoints]
+(http://www.rubydoc.info/gems/dropbox_api/DropboxApi/Client)
 
 ## Dependencies
 
@@ -127,9 +123,10 @@ commits and tags, and push the `.gem` file to
 
 ## Contributing
 
-Any help will be much appreciated. It should be quite easy to implement most
-of the [endpoints that are still pending](api_coverage.md) by looking at the
-exising implementations (check out the `dropbox_api/endpoints` folder).
+Any help will be much appreciated. The easiest way to help is to implement one
+or more of the [endpoints that are still pending]
+(http://www.rubydoc.info/gems/dropbox_api/file/api_coverage.md). To see how the
+endpoints are implemented, check out the `lib/dropbox_api/endpoints` folder.
 
 If you want to help but you're unsure how to get started, please get in touch
 by opening an issue.

data/TODO.md

@@ -31,6 +31,10 @@ TOKEN: VofXAX8DO1sAAAAAAAAEEyqrmzbYmFVaDQKj48yVUfhyhfOomXiG8emqP1xQGRnJ
 
 # Release guide
 
+Previous checks:
+- CI passing?
+
+Release process:
 1. Bump version in `version.rb`.
 2. Create tag and write release notes in Github.com.
 3. `git fetch`

data/api_coverage.md

@@ -7,7 +7,8 @@ you need is missing. This document indicates what endpoints have been
 implemented.
 
 Full moon means fully implemented. Half moon means that the basic functionality
-of the endpoint has been implemented but some options may be missing.
+of the endpoint has been implemented but some options may be missing. Guess
+what new moon means.
 
 ## Files namespace
 
@@ -42,11 +43,11 @@ API call | Status
 `/search` | 🌔
 `/upload` | 🌕
 `/upload_session/append` | 🌑
-`/upload_session/append_v2` | 🌑
-`/upload_session/finish` | 🌑
+`/upload_session/append_v2` | 🌕
+`/upload_session/finish` | 🌕
 `/upload_session/finish_batch` | 🌑
 `/upload_session/finish_batch/check` | 🌑
-`/upload_session/start` | 🌑
+`/upload_session/start` | 🌕
 
 ## Sharing namespace
 API call | Status

data/lib/dropbox_api.rb

@@ -40,7 +40,9 @@ require 'dropbox_api/metadata/folder_link'
 require 'dropbox_api/metadata/shared_link'
 require 'dropbox_api/metadata/space_allocation'
 require 'dropbox_api/metadata/space_usage'
+require 'dropbox_api/metadata/upload_session_cursor'
 require 'dropbox_api/metadata/write_mode'
+require 'dropbox_api/metadata/commit_info'
 
 require 'dropbox_api/errors/http_error'
 require 'dropbox_api/errors/basic_error'
@@ -71,6 +73,9 @@ require 'dropbox_api/errors/list_folder_longpoll_error'
 require 'dropbox_api/errors/preview_error'
 require 'dropbox_api/errors/add_member_selector_error'
 require 'dropbox_api/errors/shared_folder_access_error'
+require 'dropbox_api/errors/upload_session_offset_error'
+require 'dropbox_api/errors/upload_session_lookup_error'
+require 'dropbox_api/errors/upload_session_finish_error'
 require 'dropbox_api/errors/upload_write_failed_error'
 require 'dropbox_api/errors/upload_error'
 require 'dropbox_api/errors/poll_error'
@@ -96,6 +101,7 @@ require 'dropbox_api/results/search_result'
 require 'dropbox_api/results/share_folder_launch'
 require 'dropbox_api/results/shared_folder_members'
 require 'dropbox_api/results/void_result'
+require 'dropbox_api/results/upload_session_start'
 
 require 'dropbox_api/client'
 require 'dropbox_api/connection_builder'
@@ -125,6 +131,9 @@ require 'dropbox_api/endpoints/files/save_url'
 require 'dropbox_api/endpoints/files/save_url_check_job_status'
 require 'dropbox_api/endpoints/files/search'
 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/sharing/add_file_member'
 require 'dropbox_api/endpoints/sharing/add_folder_member'
 require 'dropbox_api/endpoints/sharing/list_folder_members'

data/lib/dropbox_api/client.rb

@@ -4,6 +4,7 @@ module DropboxApi
       @connection_builder = ConnectionBuilder.new(oauth_bearer)
     end
 
+    # @!visibility private
     def self.add_endpoint(name, endpoint)
       define_method(name) do |*args, &block|
         endpoint.new(@connection_builder).send(name, *args, &block)

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::Resource
     ErrorType   = DropboxApi::Errors::RelocationError
 
-    # @method copy(from, to)
     # Copy a file or folder to a different location in the user's Dropbox.
     # If the source path is a folder all its contents will be copied.
     #

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::Folder
     ErrorType   = DropboxApi::Errors::CreateFolderError
 
-    # @method create_folder(path)
     # Create a folder at a given path.
     #
     # @param path [String] Path in the user's Dropbox to create.

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::Resource
     ErrorType   = DropboxApi::Errors::DeleteError
 
-    # @method delete(path)
     # Delete the file or folder at a given path.
     #
     # If the path is a folder, all its contents will be deleted too.

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::File
     ErrorType   = DropboxApi::Errors::DownloadError
 
-    # @method download(path)
     # Download a file from a user's Dropbox.
     #
     # @param path [String] The path of the file to download.

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method get_metadata(path, options = {})
     # Returns the metadata for a file or folder.
     #
     # Note: Metadata for the root folder is unsupported.

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::File
     ErrorType   = DropboxApi::Errors::PreviewError
 
-    # @method get_preview(path)
     # Get a preview for a file. Currently previews are only generated for the
     # files with the following extensions: .doc, .docx, .docm, .ppt, .pps,
     # .ppsx, .ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Results::GetTemporaryLinkResult
     ErrorType   = DropboxApi::Errors::GetMetadataError
 
-    # @method get_temporary_link(path)
     # Get a temporary link to stream content of a file. This link will expire
     # in four hours and afterwards you will get 410 Gone. Content-Type of the
     # link is determined automatically by the file's mime type.

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method get_thumbnail(path, options = {})
     # Get a thumbnail for an image.
     #
     # This method currently supports files with the following file extensions:

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_folder(path, options = {})
     # Returns the contents of a folder.
     #
     # @param path [String] The path to the folder you want to read.

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

@@ -8,7 +8,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Results::ListFolderResult
     ErrorType   = DropboxApi::Errors::ListFolderContinueError
 
-    # @method list_folder_continue(cursor)
     # Once a cursor has been retrieved from `list_folder`, use this to paginate
     # through all files and retrieve updates to the folder.
     #

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

@@ -7,21 +7,24 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_folder_get_latest_cursor(options)
-    # A way to quickly get a cursor for the folder's state. Unlike list_folder,
-    # list_folder_get_latest_cursor 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.
+    # A way to quickly get a cursor for the folder's state. Unlike
+    # {DropboxApi::API#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.
     #
-    # @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
-    #   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 path [String] The path to the folder you want to read.
+    # @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+,
+    #   +FileMetadata.media_info+ is set for photo and video. The default for
+    #   this field is +false+.
+    # @option options include_deleted [Boolean] If +true+,
+    #   {DropboxApi::Metadata::DeletedMetadata} will be returned for deleted
+    #   file or folder, otherwise {DropboxApi::Errors::LookupError} will be
+    #   returned. The default for this field is +false+.
     add_endpoint :list_folder_get_latest_cursor do |options = {}|
       validate_options([
         :path,

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_folder_longpoll(path, options = {})
     # A longpoll endpoint to wait for changes on an account. In conjunction
     # with list_folder, this call gives you a low-latency way to monitor an
     # account for file changes. The connection will block until there are
@@ -17,11 +16,11 @@ module DropboxApi::Endpoints::Files
     #
     # @param cursor [String] A cursor as returned by list_folder or
     #   list_folder_continue.
-    # @option timeout [Numeric] A timeout in seconds. The request will block
-    # for at most this length of time, plus up to 90 seconds of random jitter
-    # added to avoid the thundering herd problem. Care should be taken when
-    # using this parameter, as some network infrastructure does not support
-    # long timeouts. The default for this field is 30.
+    # @option options timeout [Numeric] A timeout in seconds. The request will
+    #   block for at most this length of time, plus up to 90 seconds of random
+    #   jitter added to avoid the thundering herd problem. Care should be taken
+    #   when using this parameter, as some network infrastructure does not
+    #   support long timeouts. The default for this field is 30.
     add_endpoint :list_folder_longpoll do |cursor, options = {}|
       validate_options([
         :timeout

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_revisions(path, options = {})
     # Return revisions of a file
     #
     # @param path [String] The path to file you want to see the revisions of.

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method move(from, to, options)
     # Move a file or folder to a different location in the user's Dropbox.
     #
     # If the source path is a folder all its contents will be moved.

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Metadata::File
     ErrorType   = DropboxApi::Errors::RestoreError
 
-    # @method restore(path, rev)
     # Restore a file to a specific revision
     #
     # @param path [String] The path to the file you want to restore.

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Results::SaveUrlResult
     ErrorType   = DropboxApi::Errors::SaveUrlError
 
-    # @method save_url(path, url)
     # Save a specified URL into a file in user's Dropbox. If the given path
     # already exists, the file will be renamed to avoid the conflict (e.g.
     # myfile (1).txt).

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

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Files
     ResultType  = DropboxApi::Results::SaveUrlJobStatus
     ErrorType   = DropboxApi::Errors::PollError
 
-    # @method save_url_check_job_status(job_id)
     # Check the status of a +save_url+ job.
     #
     # @param job_id [String] Id of the asynchronous job. This is the value of

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method search(query, path = "", options = {})
     # Searches for files and folders.
     #
     # Note: Recent changes may not immediately be reflected in search results

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Files
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method upload(path, content, options = {})
     # Creates a new file.
     #
     # Do not use this to upload a file larger than 150 MB. Instead, create an

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

@@ -0,0 +1,33 @@
+module DropboxApi::Endpoints::Files
+  class UploadSessionAppendV2 < DropboxApi::Endpoints::ContentUpload
+    Method      = :post
+    Path        = "/2/files/upload_session/append_v2".freeze
+    ResultType  = DropboxApi::Results::VoidResult
+    ErrorType   = DropboxApi::Errors::UploadSessionLookupError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # Append more data to an upload session.
+    #
+    # When the parameter +close+ is set, this call will close the session.
+    #
+    # A single request should not upload more than 150 MB of file contents.
+    #
+    # @param cursor [DropboxApi::Metadata::UploadSessionCursor] Contains the
+    #   upload session ID and the offset.
+    # @option options close [Boolean] If +true+, the current session will be
+    #   closed, at which point you won't be able to call
+    #   {Client#upload_session_append_v2} anymore with the current session.
+    #   The default for this field is +false+.
+    # @see UploadSessionCursor
+    add_endpoint :upload_session_append_v2 do |cursor, content, options = {}|
+      validate_options([
+        :close
+      ], options)
+
+      perform_request(options.merge({
+        :cursor => cursor.to_hash
+      }), content)
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module DropboxApi::Endpoints::Files
+  class UploadSessionFinish < DropboxApi::Endpoints::ContentUpload
+    Method      = :post
+    Path        = "/2/files/upload_session/finish".freeze
+    ResultType  = DropboxApi::Metadata::File
+    ErrorType   = DropboxApi::Errors::UploadSessionFinishError
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # Finish an upload session and save the uploaded data to the given file
+    # path.
+    #
+    # A single request should not upload more than 150 MB of file contents.
+    #
+    # @param cursor [DropboxApi::Metadata::UploadSessionCursor] Contains the
+    #   upload session ID and the offset.
+    # @param commit [DropboxApi::Metadata::CommitInfo] Contains the path and
+    # other optional modifiers for the commit.
+    add_endpoint :upload_session_finish do |cursor, commit, content = nil|
+      perform_request({
+        :cursor => cursor.to_hash,
+        :commit => commit.to_hash
+      }, content)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module DropboxApi::Endpoints::Files
+  class UploadSessionStart < DropboxApi::Endpoints::ContentUpload
+    Method      = :post
+    Path        = "/2/files/upload_session/start".freeze
+    ResultType  = DropboxApi::Results::UploadSessionStart
+    ErrorType   = nil
+
+    include DropboxApi::Endpoints::OptionsValidator
+
+    # Upload sessions allow you to upload a single file in one or more
+    # requests, for example where the size of the file is greater than 150 MB.
+    #
+    # This call starts a new upload session with the given data. You can then
+    # use {Client#upload_session_append_v2} to add more data and
+    # {Client#upload_session_finish} to save all the data to a file in Dropbox.
+    #
+    # A single request should not upload more than 150 MB of file contents.
+    #
+    # @option options close [Boolean] If +true+, the current session will be
+    #   closed, at which point you won't be able to call
+    #   {Client#upload_session_append_v2} anymore with the current session.
+    #   The default for this field is +false+.
+    # @return [DropboxApi::Metadata::UploadSessionCursor] The session cursor
+    #   that you can use to continue the upload afterwards.
+    add_endpoint :upload_session_start do |content, options = {}|
+      validate_options([
+        :close
+      ], options)
+
+      session = perform_request(options, content)
+
+      DropboxApi::Metadata::UploadSessionCursor.new({
+        "session_id" => session.session_id,
+        "offset" => content.size
+      })
+    end
+  end
+end

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method add_file_member(file, members, options = {})
     # Adds specified members to a file.
     #
     # The +members+ parameter can be an +Array+ or a single member element. Each

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method add_folder_member(folder_id, members, options = {})
     # Allows an owner or editor (if the ACL update policy allows) of a shared
     # folder to add another member.
     #

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

@@ -5,14 +5,14 @@ module DropboxApi::Endpoints::Sharing
     ResultType  = DropboxApi::Metadata::SharedLink
     ErrorType   = DropboxApi::Errors::CreateSharedLinkWithSettingsError
 
-    # @method create_shared_link_with_settings(path, settings = {})
     # Create a shared link with custom settings. If no settings are given then
     # the default visibility is :public. (The resolved
     # visibility, though, may depend on other aspects such as team and shared
     # folder settings).
     #
-    # @param path [String]
-    # @option settings [SharedLinkSettings]
+    # @param path [String] The path to be shared by the shared link.
+    # @param settings [SharedLinkSettings] The requested settings for the newly
+    #   created shared link This field is optional.
     # @return [DropboxApi::Metadata::SharedLink]
     add_endpoint :create_shared_link_with_settings do |path, settings = {}|
       # NOTE: This endpoint accepts an additional option `settings` which

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_folder_members(folder_id, actions = [], options = {})
     # Returns shared folder membership by its folder ID.
     #
     # Apps must have full Dropbox access to use this endpoint.

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method list_shared_links(options)
     # List shared links of this user.
     #
     # If no path is given or the path is empty, returns a list of all shared

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

@@ -7,7 +7,6 @@ module DropboxApi::Endpoints::Sharing
 
     include DropboxApi::Endpoints::OptionsValidator
 
-    # @method share_folder(path, options = {})
     # Share a folder with collaborators.
     #
     # Most sharing will be completed synchronously. Large folders will be

data/lib/dropbox_api/endpoints/users/get_account.rb

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Users
     ResultType  = DropboxApi::Metadata::BasicAccount
     ErrorType   = DropboxApi::Errors::GetAccountError
 
-    # @method get_account(account_id)
     # Get information about a user's account.
     #
     # @param account_id [String] A user's account identifier.

data/lib/dropbox_api/endpoints/users/get_account_batch.rb

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Users
     ResultType  = DropboxApi::Results::BasicAccountBatch
     ErrorType   = DropboxApi::Errors::GetAccountError
 
-    # @method get_account_batch(account_ids)
     # Get information about multiple user accounts. At most 300 accounts may
     # be queried per request.
     #

data/lib/dropbox_api/endpoints/users/get_current_account.rb

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Users
     ResultType  = DropboxApi::Metadata::BasicAccount
     ErrorType   = nil
 
-    # @method get_current_account
     # Get information about the current user's account.
     #
     # @return [BasicAccount] Detailed information about the current user's account.

data/lib/dropbox_api/endpoints/users/get_space_usage.rb

@@ -5,7 +5,6 @@ module DropboxApi::Endpoints::Users
     ResultType  = DropboxApi::Metadata::SpaceUsage
     ErrorType   = nil
 
-    # @method get_space_usage
     # Get the space usage information for the current user's account.
     #
     # @return [SpaceUsage] Information about a user's space usage and quota.

data/lib/dropbox_api/errors/basic_error.rb

@@ -34,6 +34,8 @@ module DropboxApi::Errors
   class CantNestSharedFolderError < BasicError; end
   class CantShareOutsideTeamError < BasicError; end
   class ContainsSharedFolderError < BasicError; end
+  class CursorClosedError < BasicError; end
+  class CursorNotClosedError < BasicError; end
   class DisallowedNameError < BasicError; end
   class DisallowedSharedLinkPolicyError < BasicError; end
   class DownloadFailedError < BasicError; end
@@ -83,6 +85,7 @@ module DropboxApi::Errors
   class TooManyFilesError < BasicError; end
   class TooManyMembersError < BasicError; end
   class TooManyPendingInvitesError < BasicError; end
+  class TooManySharedFolderTargetsError < BasicError; end
   class UnmountedError < BasicError; end
   class UnsupportedContentError < BasicError; end
   class UnsupportedExtensionError < BasicError; end

data/lib/dropbox_api/errors/upload_session_finish_error.rb

@@ -0,0 +1,9 @@
+module DropboxApi::Errors
+  class UploadSessionFinishError < BasicError
+    ErrorSubtypes = {
+      :lookup_failed => UploadSessionLookupError,
+      :path => WriteError,
+      :too_many_shared_folder_targets => TooManySharedFolderTargetsError
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/upload_session_lookup_error.rb

@@ -0,0 +1,10 @@
+module DropboxApi::Errors
+  class UploadSessionLookupError < BasicError
+    ErrorSubtypes = {
+      :not_found => NotFoundError,
+      :incorrect_offset => UploadSessionOffsetError,
+      :closed => CursorClosedError,
+      :not_closed => CursorNotClosedError
+    }.freeze
+  end
+end

data/lib/dropbox_api/errors/upload_session_offset_error.rb

@@ -0,0 +1,8 @@
+module DropboxApi::Errors
+  class UploadSessionOffsetError < BasicError
+    def initialize(message, metadata)
+      message = "#{message}, correct offset: #{metadata['correct_offset']}"
+      super message, metadata
+    end
+  end
+end

data/lib/dropbox_api/metadata/commit_info.rb

@@ -0,0 +1,9 @@
+module DropboxApi::Metadata
+  class CommitInfo < Base
+    field :path, String
+    field :mode, DropboxApi::Metadata::WriteMode
+    field :autorename, :boolean, :optional
+    field :client_modified, Time, :optional
+    field :mute, :boolean, :optional
+  end
+end

data/lib/dropbox_api/metadata/resource.rb

@@ -2,7 +2,7 @@ module DropboxApi::Metadata
   # This class is used as an adapter so we can create an object of the pertinent
   # class when we need to infer the type from the data.
   #
-  # For example, calling Resource.new({".tag" => "file", :name => ...}) will
+  # For example, calling +Resource.new({".tag" => "file", :name => ...})+ will
   # instantiate a `File` object.
   #
   # So this could initalize an object of either `File`, `Folder` or `Deleted`.

data/lib/dropbox_api/metadata/upload_session_cursor.rb

@@ -0,0 +1,11 @@
+module DropboxApi::Metadata
+  # Example of a serialized {UploadSessionCursor} object:
+  #   {
+  #     "session_id": "AAAAAAAABCJ61k9yZZtn8Q",
+  #     "offset":9
+  #   }
+  class UploadSessionCursor < Base
+    field :session_id, String
+    field :offset, Integer
+  end
+end

data/lib/dropbox_api/metadata/write_mode.rb

@@ -33,42 +33,48 @@ module DropboxApi::Metadata
 
     # @example
     #   DropboxApi::Metadata::WriteMode.new :add
-    #
     # @example
     #   DropboxApi::Metadata::WriteMode.new :overwrite
-    #
     # @example
     #   DropboxApi::Metadata::WriteMode.new :update, "a1c10ce0dd78"
-    def initialize(write_mode, rev = nil)
-      @write_mode = write_mode.to_sym
-      @rev = rev
+    # @example
+    #   DropboxApi::Metadata::WriteMode.new({
+    #     ".tag"=>"update",
+    #     "update"=>"a1c10ce0dd78"
+    #   })
+    def initialize(write_mode, options = nil)
+      case write_mode
+      when Hash
+        @write_mode = write_mode
+      when String, ::Symbol
+        @write_mode = {
+          ".tag" => write_mode
+        }
+        @write_mode[write_mode.to_s] = options unless options.nil?
+      end
+      @write_mode[".tag"] = @write_mode[".tag"].to_sym
 
       check_validity
     end
 
     def check_validity
-      unless valid_mode? @write_mode
-        raise ArgumentError, "Invalid write mode: #{value}"
+      unless valid_mode? @write_mode[".tag"]
+        raise ArgumentError, "Invalid write mode: #{@write_mode[".tag"]}"
       end
 
-      if @write_mode == :update && @rev.nil?
+      if @write_mode[".tag"] == :update && @write_mode["update"].nil?
         raise ArgumentError, "Mode `:update` expects a `rev` number"
       end
     end
 
     def to_hash
-      hash = {
-        ".tag" => @write_mode
-      }
-      hash["update"] = @rev if @write_mode == :update
-
-      hash
+      @write_mode
     end
 
     private
 
     def valid_mode?(value)
-      VALID_WRITE_MODES.include? value.to_sym
+      VALID_WRITE_MODES.include? value
     end
   end
 end

data/lib/dropbox_api/results/upload_session_start.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Results
+  class UploadSessionStart < DropboxApi::Results::Base
+    def session_id
+      @data["session_id"]
+    end
+  end
+end

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

data/yardoc/endpoint_handler.rb

@@ -0,0 +1,67 @@
+module YARD
+  class EndpointHandler < Handlers::Ruby::MethodHandler
+    handles method_call(:add_endpoint)
+    namespace_only
+
+    process do
+      register(
+        CodeObjects::MethodObject.new(namespace, name) do |m|
+          m.parameters = parameters
+        end,
+        CodeObjects::MethodObject.new(P("DropboxApi::Client"), name) do |m|
+          m.parameters = parameters
+          m.group = namespace.namespace.name.downcase
+        end
+      )
+    end
+
+    def name
+      statement.parameters.first.jump(:tstring_content, :ident).source
+    end
+
+    def parameters
+      # This method is taken from YARD, ideally we would just use it but I
+      # couldn't find a way to invoke it from here, so I had to copy it over.
+      # It would be nice to get rid of this method and use YARD's
+      # implementation instead.
+      #
+      # Reference to original code:
+      #   YARD gem (0.9.5): lib/yard/handlers/ruby/method_handler.rb
+      #   Github: https://git.io/vMLQp
+      args = statement.jump(:block_var).jump(:params)
+      return [] unless args.is_a? YARD::Parser::Ruby::ParameterNode
+
+      params = []
+
+      if args.unnamed_required_params
+        params += args.unnamed_required_params.map {|a| [a.source, nil] }
+      end
+
+      if args.unnamed_optional_params
+        params += args.unnamed_optional_params.map do |a|
+          [a[0].source, a[1].source]
+        end
+      end
+
+      params << ['*' + args.splat_param.source, nil] if args.splat_param
+
+      if args.unnamed_end_params
+        params += args.unnamed_end_params.map {|a| [a.source, nil] }
+      end
+
+      if args.named_params
+        params += args.named_params.map do |a|
+          [a[0].source, a[1] ? a[1].source : nil]
+        end
+      end
+
+      if args.double_splat_param
+        params << ['**' + args.double_splat_param.source, nil]
+      end
+
+      params << ['&' + args.block_param.source, nil] if args.block_param
+
+      params
+    end
+  end
+end

data/yardoc/helpers/html_helper.rb

@@ -0,0 +1,22 @@
+module YARD
+  module Templates::Helpers
+    module HtmlHelper
+      def unindent(str)
+        indent_size = str.split("\n").map do |line|
+          line = untab(line)
+          white_span = line[/\A(\s+)/]
+
+          white_span.nil? ? nil : white_span.size
+        end.compact.min
+
+        str.gsub(/^( ){#{indent_size}}/, '')
+      end
+
+      def untab(str, tab_size = 2)
+        tab_space = 2
+
+        str.gsub("\t", " " * tab_space)
+      end
+    end
+  end
+end

data/yardoc/rspec.rb

@@ -0,0 +1,35 @@
+YARD::Templates::Engine.register_template_path File.expand_path("#{__FILE__}/../templates")
+
+class RSpecDescribeHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:describe)
+
+  def process
+    objname = statement.parameters.first.jump(:string_content).source
+    if statement.parameters[1]
+      src = statement.parameters[1].jump(:string_content).source
+      objname += (src[0] == "#" ? "" : "::") + src
+    end
+    obj = {:spec => owner ? (owner[:spec] || "") : ""}
+    obj[:spec] += objname
+    parse_block(statement.last.last, owner: obj)
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+end
+
+class RSpecItHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:it)
+
+  def process
+    return if owner.nil?
+    obj = P(owner[:spec])
+    return if obj.is_a?(Proxy)
+
+    obj[:specifications] ||= []
+    obj[:specifications] << {
+      name: statement.parameters.first.jump(:string_content).source,
+      file: statement.file,
+      line: statement.line,
+      source: statement.last.last.source
+    }
+  end
+end

data/yardoc/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,4 @@
+.test_code {
+  font-size: 13px;
+  line-height: normal;
+}

data/yardoc/templates/default/method_details/html/specs.erb

@@ -0,0 +1,22 @@
+<% if object[:specifications] %>
+<div class="tags">
+  <p class="tag_title">Specifications:</p>
+  <ul class="specs">
+    <% for spec in object[:specifications] %>
+      <li>
+        <%=h spec[:name] %>
+        <table class="source_code test_code">
+          <tr>
+            <td>
+              <pre class="lines"><%= "\n\n\n" %><%= spec[:source].split("\n").size.times.to_a.map {|i| spec[:line] + i }.join("\n") %></pre>
+            </td>
+            <td>
+              <pre class="code"><span class="info file"># File '<%= h spec[:file] %>', line <%= object.line %></span><%= "\n\n" %><%= html_syntax_highlight(unindent(spec[:source])) %></pre>
+            </td>
+          </tr>
+        </table>
+      </li>
+    <% end %>
+  </ul>
+</div>
+<% end %>

data/yardoc/templates/default/method_details/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.last.place(:specs).before(:source)
+end

data/yardoc/templates/default/method_details/text/specs.erb

@@ -0,0 +1,9 @@
+<% if object[:specifications] %>
+
+Specifications:
+---------------
+
+<% for spec in object[:specifications] %>
+<%= indent wrap("- " + spec[:name]) %>
+<% end %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,7 +132,6 @@ files:
 - Rakefile
 - TODO.md
 - api_coverage.md
-- api_reference.md
 - bin/console
 - bin/setup
 - dropbox_api.gemspec
@@ -162,6 +161,9 @@ files:
 - lib/dropbox_api/endpoints/files/save_url_check_job_status.rb
 - lib/dropbox_api/endpoints/files/search.rb
 - lib/dropbox_api/endpoints/files/upload.rb
+- lib/dropbox_api/endpoints/files/upload_session_append_v2.rb
+- lib/dropbox_api/endpoints/files/upload_session_finish.rb
+- lib/dropbox_api/endpoints/files/upload_session_start.rb
 - lib/dropbox_api/endpoints/options_validator.rb
 - lib/dropbox_api/endpoints/rpc.rb
 - lib/dropbox_api/endpoints/rpc_notify.rb
@@ -208,6 +210,9 @@ files:
 - lib/dropbox_api/errors/sharing_user_error.rb
 - lib/dropbox_api/errors/too_many_requests_error.rb
 - lib/dropbox_api/errors/upload_error.rb
+- lib/dropbox_api/errors/upload_session_finish_error.rb
+- lib/dropbox_api/errors/upload_session_lookup_error.rb
+- lib/dropbox_api/errors/upload_session_offset_error.rb
 - lib/dropbox_api/errors/upload_write_failed_error.rb
 - lib/dropbox_api/errors/write_conflict_error.rb
 - lib/dropbox_api/errors/write_error.rb
@@ -216,6 +221,7 @@ files:
 - lib/dropbox_api/metadata/add_member.rb
 - lib/dropbox_api/metadata/base.rb
 - lib/dropbox_api/metadata/basic_account.rb
+- lib/dropbox_api/metadata/commit_info.rb
 - lib/dropbox_api/metadata/deleted.rb
 - lib/dropbox_api/metadata/field.rb
 - lib/dropbox_api/metadata/file.rb
@@ -241,6 +247,7 @@ files:
 - lib/dropbox_api/metadata/symbol.rb
 - lib/dropbox_api/metadata/team.rb
 - lib/dropbox_api/metadata/team_member_info.rb
+- lib/dropbox_api/metadata/upload_session_cursor.rb
 - lib/dropbox_api/metadata/write_mode.rb
 - lib/dropbox_api/middleware/decode_result.rb
 - lib/dropbox_api/result_builder.rb
@@ -259,9 +266,18 @@ files:
 - lib/dropbox_api/results/search_result.rb
 - lib/dropbox_api/results/share_folder_launch.rb
 - lib/dropbox_api/results/shared_folder_members.rb
+- lib/dropbox_api/results/upload_session_start.rb
 - lib/dropbox_api/results/void_result.rb
 - lib/dropbox_api/version.rb
 - rails_setup.md
+- yardoc/endpoint_handler.rb
+- yardoc/helpers/html_helper.rb
+- yardoc/rspec.rb
+- yardoc/templates/default/fulldoc/html/css/common.css
+- yardoc/templates/default/layout/html/setup.rb
+- yardoc/templates/default/method_details/html/specs.erb
+- yardoc/templates/default/method_details/setup.rb
+- yardoc/templates/default/method_details/text/specs.erb
 homepage: https://github.com/Jesus/dropbox_api
 licenses:
 - MIT
@@ -287,4 +303,3 @@ signing_key:
 specification_version: 4
 summary: Library for communicating with Dropbox API v2
 test_files: []
-has_rdoc: yard

data/api_reference.md

@@ -1,25 +0,0 @@
-# @title API Reference
-
-{render:DropboxApi::Endpoints::Files::Copy#copy}
-{render:DropboxApi::Endpoints::Files::CreateFolder#create_folder}
-{render:DropboxApi::Endpoints::Files::Delete#delete}
-{render:DropboxApi::Endpoints::Files::Download#download}
-{render:DropboxApi::Endpoints::Files::GetMetadata#get_metadata}
-{render:DropboxApi::Endpoints::Files::GetPreview#get_preview}
-{render:DropboxApi::Endpoints::Files::GetTemporaryLink#get_temporary_link}
-{render:DropboxApi::Endpoints::Files::GetThumbnail#get_thumbnail}
-{render:DropboxApi::Endpoints::Files::ListFolder#list_folder}
-{render:DropboxApi::Endpoints::Files::ListFolderContinue#list_folder_continue}
-{render:DropboxApi::Endpoints::Files::ListFolderGetLatestCursor#list_folder_get_latest_cursor}
-{render:DropboxApi::Endpoints::Files::ListFolderLongpoll#list_folder_longpoll}
-{render:DropboxApi::Endpoints::Files::ListRevisions#list_revisions}
-{render:DropboxApi::Endpoints::Files::Move#move}
-{render:DropboxApi::Endpoints::Files::Restore#restore}
-{render:DropboxApi::Endpoints::Files::Search#search}
-{render:DropboxApi::Endpoints::Files::Upload#upload}
-
-{render:DropboxApi::Endpoints::Sharing::AddFolderMember#add_folder_member}
-{render:DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings#create_shared_link_with_settings}
-{render:DropboxApi::Endpoints::Sharing::ListFolderMembers#list_folder_members}
-{render:DropboxApi::Endpoints::Sharing::ListSharedLinks#list_shared_links}
-{render:DropboxApi::Endpoints::Sharing::ShareFolder#share_folder}