dropbox-sdk 1.3 → 1.5.1

data/CHANGELOG

@@ -1,3 +1,13 @@
+1.5.1 (2012-8-20)
+* Fixed packaging.
+
+1.5 (2012-8-15)
+* Support for uploading large files via /chunked_upload
+
+1.3.1 (2012-5-16)
+* Increase metadata() file list limit to 25,000 (used to be 10,000).
+* Use CGI.escape() instead of the deprecated URI.escape().
+
 1.3 (2012-3-26)
 * Add support for the /delta API.
 * Add support for the "copy ref" API.

data/lib/dropbox_sdk.rb

@@ -9,9 +9,9 @@ module Dropbox # :nodoc:
     API_SERVER = "api.dropbox.com"
     API_CONTENT_SERVER = "api-content.dropbox.com"
     WEB_SERVER = "www.dropbox.com"
-
+    
     API_VERSION = 1
-    SDK_VERSION = "1.3"
+    SDK_VERSION = "1.5.1"
 
     TRUSTED_CERT_FILE = File.join(File.dirname(__FILE__), 'trusted-certs.crt')
 end
@@ -401,6 +401,107 @@ class DropboxClient
         parse_response(response)
     end
 
+    # Returns a ChunkedUploader object.
+    #
+    # Args:
+    # * file_obj: The file-like object to be uploaded.  Must support .read()
+    # * total_size: The total size of file_obj
+    def get_chunked_uploader(file_obj, total_size)
+        ChunkedUploader.new(self, file_obj, total_size)
+    end
+
+    # ChunkedUploader is responsible for uploading a large file to Dropbox in smaller chunks.
+    # This allows large files to be uploaded and makes allows recovery during failure.
+    class ChunkedUploader
+        attr_accessor :file_obj, :total_size, :offset, :upload_id, :client
+
+        def initialize(client, file_obj, total_size)
+            @client = client
+            @file_obj = file_obj
+            @total_size = total_size
+            @upload_id = nil
+            @offset = 0
+        end
+
+        # Uploads data from this ChunkedUploader's file_obj in chunks, until
+        # an error occurs. Throws an exception when an error occurs, and can
+        # be called again to resume the upload.
+        #
+        # Args:
+        # * chunk_size: The chunk size for each individual upload.  Defaults to 4MB.
+        def upload(chunk_size=4*1024*1024)
+            last_chunk = nil
+
+            while @offset < @total_size
+                if not last_chunk
+                    last_chunk = @file_obj.read(chunk_size)
+                end
+
+                resp = {}
+                begin
+                    resp = @client.parse_response(@client.partial_chunked_upload(last_chunk, @upload_id, @offset))
+                    last_chunk = nil
+                rescue DropboxError => e
+                    resp = JSON.parse(e.http_response.body)
+                    raise unless resp.has_key? 'offset'
+                end
+
+                if resp.has_key? 'offset' and resp['offset'] > @offset
+                    @offset += (resp['offset'] - @offset) if resp['offset']
+                    last_chunk = nil
+                end
+                @upload_id = resp['upload_id'] if resp['upload_id']
+            end
+        end
+
+        # Completes a file upload
+        #
+        # Args:
+        # * to_path: The directory path to upload the file to. If the destination
+        #   directory does not yet exist, it will be created.
+        # * overwrite: Whether to overwrite an existing file at the given path. [default is False]
+        #   If overwrite is False and a file already exists there, Dropbox
+        #   will rename the upload to make sure it doesn't overwrite anything.
+        #   You must check the returned metadata to know what this new name is.
+        #   This field should only be True if your intent is to potentially
+        #   clobber changes to a file that you don't know about.
+        # * parent_rev: The rev field from the 'parent' of this upload.
+        #   If your intent is to update the file at the given path, you should
+        #   pass the parent_rev parameter set to the rev value from the most recent
+        #   metadata you have of the existing file at that path. If the server
+        #   has a more recent version of the file at the specified path, it will
+        #   automatically rename your uploaded file, spinning off a conflict.
+        #   Using this parameter effectively causes the overwrite parameter to be ignored.
+        #   The file will always be overwritten if you send the most-recent parent_rev,
+        #   and it will never be overwritten you send a less-recent one.
+        #
+        # Returns:
+        # *  A Hash with the metadata of file just uploaded.
+        #    For a detailed description of what this call returns, visit:
+        #    https://www.dropbox.com/developers/reference/api#metadata
+        def finish(to_path, overwrite=false, parent_rev=nil)
+            response = @client.commit_chunked_upload(to_path, @upload_id, overwrite, parent_rev)
+            @client.parse_response(response)
+        end
+    end
+
+    def commit_chunked_upload(to_path, upload_id, overwrite=false, parent_rev=nil)  #:nodoc
+        params = {'overwrite' => overwrite.to_s,
+                  'upload_id' => upload_id,
+                  'parent_rev' => parent_rev.to_s,
+                }
+        @session.do_post(build_url("/commit_chunked_upload/#{@root}#{format_path(to_path)}", params, content_server=true))
+    end
+
+    def partial_chunked_upload(data, upload_id=nil, offset=nil)  #:nodoc
+        params = {}
+        params['upload_id'] = upload_id.to_s if upload_id
+        params['offset'] = offset.to_s if offset
+        @session.do_put(build_url('/chunked_upload', params, content_server=true),
+                                {'Content-Type' => "application/octet-stream"},
+                                data)
+    end
+
     # Download a file
     #
     # Args:
@@ -557,7 +658,7 @@ class DropboxClient
     # * file_limit: The maximum number of file entries to return within
     #   a folder. If the number of files in the directory exceeds this
     #   limit, an exception is raised. The server will return at max
-    #   10,000 files within a folder.
+    #   25,000 files within a folder.
     # * hash: Every directory listing has a hash parameter attached that
     #   can then be passed back into this function later to save on
     #   bandwidth. Rather than returning an unchanged folder's contents, if
@@ -571,7 +672,7 @@ class DropboxClient
     # * A Hash object with the metadata of the file or folder (and contained files if
     #   appropriate).  For a detailed description of what this call returns, visit:
     #   https://www.dropbox.com/developers/reference/api#metadata
-    def metadata(path, file_limit=10000, list=true, hash=nil, rev=nil, include_deleted=false)
+    def metadata(path, file_limit=25000, list=true, hash=nil, rev=nil, include_deleted=false)
         params = {
             "file_limit" => file_limit.to_s,
             "list" => list.to_s,
@@ -697,9 +798,9 @@ class DropboxClient
     # Arguments:
     # * from_path: The path to the file to be thumbnailed.
     # * size: A string describing the desired thumbnail size. At this time,
-    #   'small', 'medium', and 'large' are officially supported sizes
-    #   (32x32, 64x64, and 128x128 respectively), though others may
-    #   be available. Check https://www.dropbox.com/developers/reference/api#thumbnails
+    #   'small' (32x32), 'medium' (64x64), 'large' (128x128), 's' (64x64),
+    #   'm' (128x128), 'l' (640x640), and 'xl' (1024x1024) are officially supported sizes.
+    #   Check https://www.dropbox.com/developers/reference/api#thumbnails
     #   for more details. [defaults to large]
     # Returns:
     # * The thumbnail data
@@ -708,7 +809,7 @@ class DropboxClient
         parse_response(response, raw=true)
     end
 
-    # Download a thumbnail for an image alongwith the image's metadata.
+    # Download a thumbnail for an image along with the image's metadata.
     #
     # Arguments:
     # * from_path: The path to the file to be thumbnailed.
@@ -788,9 +889,7 @@ class DropboxClient
     # Returns:
     # * The HTTPResponse for the thumbnail request.
     def thumbnail_impl(from_path, size='large') # :nodoc:
-        from_path = format_path(from_path, false)
-
-        raise DropboxError.new("size must be small medium or large. (not '#{size})") unless ['small','medium','large'].include?(size)
+        from_path = format_path(from_path, true)
 
         params = {
             "size" => size
@@ -833,7 +932,7 @@ class DropboxClient
         path = "/fileops/copy"
 
         params = {'from_copy_ref' => copy_ref,
-                  'to_path' => "#{format_path(to_path)}",
+                  'to_path' => "#{to_path}",
                   'root' => @root}
 
         response = @session.do_post(build_url(path, params))
@@ -856,7 +955,7 @@ class DropboxClient
 
         if params
             target.query = params.collect {|k,v|
-                URI.escape(k) + "=" + URI.escape(v)
+                CGI.escape(k) + "=" + CGI.escape(v)
             }.join("&")
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dropbox-sdk
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: 1.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 -07:00
-default_executable: 
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156604720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156604720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "        A library that provides a plain function-call interface to
   the\n        Dropbox API web endpoints.\n"
 email:
@@ -39,7 +43,6 @@ files:
 - web_file_browser.rb
 - lib/dropbox_sdk.rb
 - lib/trusted-certs.crt
-has_rdoc: true
 homepage: http://www.dropbox.com/developers/
 licenses:
 - MIT
@@ -61,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Dropbox REST API Client.