dropbox-sdk-v2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a2322ad19040f1f574b4417ce7ca0134849ebe7
-  data.tar.gz: 636f09861b9ea96ab8b423da8b3daa257fd159b2
+  metadata.gz: 3012cc4be1ed874d4eb5584f39564e7812d93803
+  data.tar.gz: 7d0d205741968270914b5e4a719fa18dc7488edc
 SHA512:
-  metadata.gz: fc3d5b2ba162d750c1c6cbb462f788d8326b3092637d168754cef442223fdeff6743e582ddf5253a027425a3d7fe17536748a75ca3cfb1567515cb7c7c9b0d5b
-  data.tar.gz: 2daad67a615c21ed801e5638ef164b806eb9c4fc597d6e6df1277c1ba1f8b77fe7bd31ae28a2028da54f186286dd9125ecb8242bccec915310128b5400a1c571
+  metadata.gz: d21f8305e1a3b66d2d81219201df04bcecee3355067d92f83204b936371431cec2c718ec4db124048e4b39d6e79dff248212445785575440e014d5374cbb412d
+  data.tar.gz: 52723a3ae802a78155e8af7db3f37c940f70d6a356fbe2e648f357ad95684172e99b34a1271ab77b052d1d4be1da3a2cb9473cabed156fa3d1264e764dc7491e

data/README.md

@@ -27,6 +27,8 @@ gem 'dropbox-sdk-v2'
 
 ## Usage
 
+Also see the [full method documentation](http://www.rubydoc.info/gems/dropbox-sdk-v2/Dropbox/Client).
+
 Set up a client:
 ```ruby
 require 'dropbox'

data/lib/dropbox/client.rb

@@ -3,7 +3,11 @@ require 'json'
 require 'time'
 
 module Dropbox
+  # Client contains all the methods that map to the Dropbox API endpoints.
   class Client
+    # Initialize a new client.
+    #
+    # @param [String] access_token
     def initialize(access_token)
       unless access_token =~ /^[a-z0-9_-]{64}$/i
         raise ClientError.invalid_access_token
@@ -12,95 +16,173 @@ module Dropbox
       @access_token = access_token
     end
 
-    def copy(from, to)
-      resp = request('/files/copy', from_path: from, to_path: to)
+    # Copy a file or folder to a different location in the user's Dropbox.
+    #
+    # @param [String] from_path
+    # @param [String] to_path
+    # @return [Dropbox::Metadata]
+    def copy(from_path, to_path)
+      resp = request('/files/copy', from_path: from_path, to_path: to_path)
       parse_tagged_response(resp)
     end
 
+    # Create a folder at a given path.
+    #
+    # @param [String] path
+    # @return [Dropbox::FolderMetadata]
     def create_folder(path)
       resp = request('/files/create_folder', path: path)
       parse_tagged_response(resp, 'folder')
     end
 
+    # Delete the file or folder at a given path.
+    #
+    # @param [String] path
+    # @return [Dropbox::Metadata]
     def delete(path)
       resp = request('/files/delete', path: path)
       parse_tagged_response(resp)
     end
 
+    # Download a file from a user's Dropbox.
+    #
+    # @param [String] path
+    # @return [Dropbox::FileMetadata] metadata
+    # @return [HTTP::Response::Body] body
     def download(path)
       resp, body = content_request('/files/download', path: path)
       return parse_tagged_response(resp, 'file'), body
     end
 
-    def get_account(id)
-      resp = request('/users/get_account', account_id: id)
+    # Get information about a user's account.
+    #
+    # @param [String] account_id
+    # @return [Dropbox::BasicAccount]
+    def get_account(account_id)
+      resp = request('/users/get_account', account_id: account_id)
       parse_tagged_response(resp, 'basic_account')
     end
 
-    # Takes an array of account IDs and returns an array of BasicAccounts
-    def get_account_batch(ids)
+    # Get information about multiple user accounts.
+    #
+    # @param [Array<String>] account_ids
+    # @return [Array<Dropbox::BasicAccount>]
+    def get_account_batch(account_ids)
       resp = request('/users/get_account_batch', account_ids: ids)
       resp.map { |a| parse_tagged_response(a, 'basic_account') }
     end
 
+    # Get information about the current user's account.
+    #
+    # @return [Dropbox::FullAccount]
     def get_current_account
       resp = request('/users/get_current_account')
       parse_tagged_response(resp, 'full_account')
     end
 
+    # Get the metadata for a file or folder.
+    #
+    # @param [String] path
+    # @return [Dropbox::Metadata]
     def get_metadata(path)
       resp = request('/files/get_metadata', path: path)
       parse_tagged_response(resp)
     end
 
+    # Get a preview for a file.
+    #
+    # @param [String] path
+    # @return [Dropbox::FileMetadata] metadata
+    # @return [HTTP::Response::Body] body
     def get_preview(path)
       resp, body = content_request('/files/get_preview', path: path)
       return parse_tagged_response(resp, 'file'), body
     end
 
+    # Get the space usage information for the current user's account.
+    #
+    # @return [Dropbox::SpaceUsage]
     def get_space_usage
       resp = request('/users/get_space_usage')
       SpaceUsage.new(resp)
     end
 
+    # Get a temporary link to stream content of a file.
+    #
+    # @param [String] path
+    # @return [Dropbox::FileMetadata] metadata
+    # @return [String] link
     def get_temporary_link(path)
       resp = request('/files/get_temporary_link', path: path)
       return parse_tagged_response(resp['metadata'], 'file'), resp['link']
     end
 
+    # Get a thumbnail for an image.
+    #
+    # @param [String] path
+    # @param [String] format
+    # @param [String] size
+    # @return [Dropbox::FileMetadata] metadata
+    # @return [HTTP::Response::Body] body
     def get_thumbnail(path, format='jpeg', size='w64h64')
       resp, body = content_request('/files/get_thumbnail', path: path, format: format, size: size)
       return parse_tagged_response(resp, 'file'), body
     end
 
+    # Get the contents of a folder.
+    #
+    # @param [String] path
+    # @return [Array<Dropbox::Metadata]
     def list_folder(path)
       resp = request('/files/list_folder', path: path)
       resp['entries'].map { |e| parse_tagged_response(e) }
     end
 
+    # Get the revisions of a file.
+    #
+    # @param [String] path
+    # @return [Array<Dropbox::FileMetadata>] entries
+    # @return [Boolean] is_deleted
     def list_revisions(path)
       resp = request('/files/list_revisions', path: path)
       entries = resp['entries'].map { |e| parse_tagged_response(e, 'file') }
       return entries, resp['is_deleted']
     end
 
-    def move(from, to)
+    # Move a file or folder to a different location in the user's Dropbox.
+    #
+    # @param [String] from_path
+    # @param [String] to_path
+    # @return [Dropbox::Metadata]
+    def move(from_path, to_path)
       resp = request('/files/move', from_path: from, to_path: to)
       parse_tagged_response(resp)
     end
 
+    # Restore a file to a specific revision.
+    #
+    # @param [String] path
+    # @param [String] rev
+    # @return [Dropbox::FileMetadata]
     def restore(path, rev)
       resp = request('/files/restore', path: path, rev: rev)
       parse_tagged_response(resp, 'file')
     end
 
-    # Revokes the current access token and returns it
+    # Disable the access token used to authenticate the call.
+    #
+    # @return [void]
     def revoke_token
       r = HTTP.auth('Bearer ' + @access_token).post(API + '/auth/token/revoke')
       raise APIError.new(r) if r.code != 200
-      @access_token
     end
 
+    # Save a specified URL into a file in user's Dropbox.
+    #
+    # @param [String] path
+    # @param [String] url
+    # @return [String] the job id, if the processing is asynchronous.
+    # @return [Dropbox::FileMetadata] if the processing is synchronous.
     def save_url(path, url)
       resp = request('/files/save_url', path: path, url: url)
       case resp['.tag']
@@ -113,13 +195,26 @@ module Dropbox
       end
     end
 
-    def search(query, path='', max=100)
+    # Search for files and folders.
+    #
+    # @param [String] query
+    # @param [String] path
+    # @param [Integer] max_results
+    # @return [Array<Dropbox::Metadata>] matches
+    def search(query, path='', max_results=100)
       resp = request('/files/search', path: path, query: query, max_results: max)
       resp['matches'].map { |m| parse_tagged_response(m['metadata']) }
     end
 
-    # Body can be a String or an Enumerable
-    # Mode can be 'add', 'overwrite', or 'update'
+    # Create a new file.
+    #
+    # @param [String] path
+    # @param [String, Enumerable] body
+    # @param [String] mode
+    # @param [Boolean] autorename
+    # @param [String, Time] client_modified
+    # @param [Boolean] mute
+    # @return [Dropbox::FileMetadata]
     def upload(path, body, mode='add', autorename=false, client_modified=nil, mute=false)
       client_modified = client_modified.iso8601 if client_modified.is_a?(Time)
       resp = upload_request('/files/upload', body, path: path, mode: mode,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dropbox-sdk-v2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dylan Waits