dropbox-api-petems 0.4.1 → 0.4.2

data/Gemfile

@@ -1,10 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in dropbox-api.gemspec
-gemspec
-
-gem "rspec"
-gem "rake"
-gem 'simplecov'
-gem "ruby-debug19"
-gem "yajl-ruby"
+gemspec

data/README.markdown

@@ -198,6 +198,27 @@ Stores a file with a provided body under a provided name and returns a Dropbox::
 client.upload 'file.txt', 'file body' # => #<Dropbox::API::File>
 ```
 
+### Dropbox::API::Client#chunked_upload
+
+Stores a file using the chunked upload endpoint. This method issues multiple requests, and optionally takes a block, passing in the current upload byte offset and a unique ID usable for resuming uploads. Use this for uploading large files.
+
+For more info, see [https://www.dropbox.com/developers/reference/api#chunked-upload](https://www.dropbox.com/developers/reference/api#chunked-upload)
+
+Standard use:
+
+```ruby
+client.chunked_upload 'file.txt', 'file or IO object' # => #<Dropbox::API::File>
+```
+
+Using a block to show upload progress and save the upload id:
+
+```ruby
+client.chunked_upload 'file.txt', 'file or IO object' do |offset, resp|
+  @upload_id = resp[:upload_id]
+  puts "Uploaded #{offset} bytes"
+end
+```
+
 ### Dropbox::API::Client#download
 
 Downloads a file with a provided name and returns it's content

data/dropbox-api.gemspec

@@ -9,13 +9,19 @@ Gem::Specification.new do |s|
   s.email       = ["p.morsou@gmail.com"]
   s.homepage    = "http://github.com/petems/dropbox-api-petems"
   s.summary     = "A Ruby client for the DropBox REST API (Originally by marcinbunsch, forked by petems)"
-  s.description = "To deliver a more Rubyesque experience when using the DropBox API."
+  s.description = "To deliver a more Rubyesque experience when using the DropBox API (forked by petems)."
 
   s.rubyforge_project = "dropbox-api"
 
-  s.add_dependency 'multi_json'
-  s.add_dependency 'oauth'
-  s.add_dependency 'hashie'
+  s.add_dependency 'multi_json', '1.7.9'
+  s.add_dependency 'oauth', '0.4.7'
+  s.add_dependency 'hashie', '2.0.5'
+
+  s.add_development_dependency 'rspec','2.14.1'
+  s.add_development_dependency 'rake', '10.1.0'
+  s.add_development_dependency 'simplecov', '0.7.1'
+  s.add_development_dependency 'ruby-debug19', '0.11.6'
+  s.add_development_dependency 'yajl-ruby', '1.1.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/dropbox-api/client/files.rb

@@ -24,6 +24,42 @@ module Dropbox
           Dropbox::API::File.init(response, self)
         end
 
+        def chunked_upload(path, file, options = {})
+          root     = options.delete(:root) || Dropbox::API::Config.mode
+          path     = Dropbox::API::Util.escape(path)
+          upload_url = '/chunked_upload'
+          commit_url = ['', "commit_chunked_upload", root, path].compact.join('/')
+
+          total_file_size = ::File.size(file)
+          chunk_size = options[:chunk_size] || 4*1024*1024 # default 4 MB chunk size
+          offset = options[:offset] || 0
+          upload_id = options[:upload_id]
+                    
+          while offset < total_file_size
+            data = file.read(chunk_size)
+            
+            query    = Dropbox::API::Util.query(options.merge(:offset => offset))
+            response = connection.put(:content, "#{upload_url}?#{query}", data, {
+              'Content-Type'   => "application/octet-stream",
+              "Content-Length" => data.length.to_s
+            })
+            
+            upload = Dropbox::API::Object.init(response, self)
+            options[:upload_id] ||= upload[:upload_id]
+            offset += upload[:offset].to_i - offset if upload[:offset] && upload[:offset].to_i > offset
+            yield offset, upload if block_given?
+          end
+          
+          query = Dropbox::API::Util.query({:upload_id => options[:upload_id]})
+          
+          response = connection.post(:content, "#{commit_url}?#{query}", "", {
+            'Content-Type'   => "application/octet-stream",
+            "Content-Length" => "0"
+          })
+
+          Dropbox::API::File.init(response, self)
+        end
+
         def copy_from_copy_ref(copy_ref, to, options = {})
           raw.copy({ 
             :from_copy_ref => copy_ref, 

data/lib/dropbox-api/connection/requests.rb

@@ -32,10 +32,12 @@ module Dropbox
               raise Dropbox::API::Error::Redirect.new("#{status} - Redirect Error")
             when 503
               parsed = MultiJson.decode(response.body)
-              raise Dropbox::API::Error.new("503 - Possible Rate Limiting: #{parsed["error"]}")
+              header_parse = MultiJson.decode(response.headers)
+              error_message = "#{parsed["error"]}. Retry after: #{header_parse['Retry-After']}"
+              raise Dropbox::API::Error.new("503 - #{error_message}")
             when 507
               raise Dropbox::API::Error::StorageQuota.new("507 - Dropbox storage quota exceeded.")
-            when 500..599
+            when 500..502, 504..506, 508..599
               parsed = MultiJson.decode(response.body)
               raise Dropbox::API::Error.new("#{status} - Server error. Check http://status.dropbox.com/")
             else

data/lib/dropbox-api/version.rb

@@ -1,5 +1,5 @@
 module Dropbox
   module API
-    VERSION = "0.4.1"
+    VERSION = "0.4.2"
   end
 end

data/spec/lib/dropbox-api/client_spec.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require "spec_helper"
+require "tempfile"
 
 describe Dropbox::API::Client do
 
@@ -114,6 +115,43 @@ describe Dropbox::API::Client do
     end
   end
 
+  describe "#chunked_upload" do
+
+    before do
+      @filename = "/tmp/dropbox-api-largefile-test"
+      @size = 5*1024*1024 # 5MB, to test the 4MB chunk size
+      @file = File.open(@filename, "w") {|f| f.write "a"*@size}
+    end
+
+    it "puts a 5MB file in dropbox" do
+      filename = "#{Dropbox::Spec.test_dir}/test-5MB-#{Dropbox::Spec.namespace}.txt"
+      response = @client.chunked_upload filename, File.open(@filename)
+      response.path.should == filename
+      response.bytes.should == @size
+    end
+
+    it "yields current offset and upload id" do
+      filename = "#{Dropbox::Spec.test_dir}/test-yield-#{Dropbox::Spec.namespace}.txt"
+      log_offset = ""
+      log_upload = ""
+      response = @client.chunked_upload filename, File.open(@filename) do |offset, upload|
+        offset.should be > 0
+        log_offset += "#{offset.to_s},"
+        log_upload += upload.inspect
+        upload[:upload_id].length.should eq(22)
+      end
+      response.path.should == filename
+      response.bytes.should == @size
+      log_offset.should match(/[\d]{7},[\d]{7},/)
+      log_upload.should include("Dropbox::API::Object","upload_id=")
+    end
+
+    after do
+      FileUtils.rm @filename
+    end
+
+  end
+
   describe "#search" do
 
     let(:term) { "searchable-test-#{Dropbox::Spec.namespace}" }
@@ -143,10 +181,10 @@ describe Dropbox::API::Client do
     it "copies a file from a copy_ref" do
       filename = "test/searchable-test-#{Dropbox::Spec.namespace}.txt"
       @client.upload filename, "Some file"
-      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}", :path => 'test'      
+      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}", :path => 'test'
       ref = response.first.copy_ref['copy_ref']
       @client.copy_from_copy_ref ref, "#{filename}.copied"
-      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}.txt.copied", :path => 'test'   
+      response = @client.search "searchable-test-#{Dropbox::Spec.namespace}.txt.copied", :path => 'test'
       response.size.should == 1
       response.first.class.should == Dropbox::API::File
     end

data/spec/lib/dropbox-api/connection_spec.rb

@@ -79,10 +79,10 @@ describe Dropbox::API::Connection do
     end
 
     it "raises a Dropbox::API::Error when the response is a 503" do
-      response = double :code => 503, :body => '{ "error": "rate limited" }'
+      response = double :code => 503, :body => '{ "error": "rate limited" }', :headers => '{ "Retry-After": "50" }'
       lambda do
         @connection.request { response }
-      end.should raise_error(Dropbox::API::Error, '503 - Possible Rate Limiting: rate limited')
+      end.should raise_error(Dropbox::API::Error, '503 - rate limited. Retry after: 50')
     end
 
     it "raises a Dropbox::API::Error::StorageQuota when the response is a 507" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dropbox-api-petems
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -16,50 +16,131 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.9
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-description: To deliver a more Rubyesque experience when using the DropBox API.
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: To deliver a more Rubyesque experience when using the DropBox API (forked
+  by petems).
 email:
 - p.morsou@gmail.com
 executables: []