dropbox 1.2.2 → 1.2.3

data/ChangeLog

@@ -1,3 +1,10 @@
+1.2.3 (2011-01-14)
+
+* Now supports caching metadata calls
+* Large uploads can use custom timeouts
+* Fix for updated multipart-post gem
+* SSL upload fix
+
 1.2.2 (2010-11-27)
 
 * Fixed dependency bug.

data/Gemfile.lock

@@ -3,25 +3,25 @@ GEM
   specs:
     diff-lcs (1.1.2)
     git (1.2.5)
-    jeweler (1.5.1)
+    jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     json (1.4.6)
     mechanize (1.0.0)
       nokogiri (>= 1.2.1)
-    multipart-post (1.0.1)
+    multipart-post (1.1.0)
     nokogiri (1.4.4)
     oauth (0.4.4)
     rake (0.8.7)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
+    rspec-mocks (2.4.0)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -13,13 +13,14 @@ http://developers.dropbox.com
 
  # STEP 1: Authorize the user
  session = Dropbox::Session.new('your_consumer_key', 'your_consumer_secret')
+ session.mode = :sandbox # might need to set this to :dropbox; consult your API account page
  puts "Visit #{session.authorize_url} to log in to Dropbox. Hit enter when you have done this."
  gets
  session.authorize
 
  # STEP 2: Play!
  session.upload('testfile.txt')
- uploaded_file = session.file('testfile.txt')
+ uploaded_file = session.file('testfile.txt', '/')
  puts uploaded_file.metadata.size
 
  uploaded_file.move 'new_name.txt'

data/VERSION

@@ -1 +1 @@
-1.2.2
+1.2.3

data/dropbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dropbox}
-  s.version = "1.2.2"
+  s.version = "1.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Morgan"]
-  s.date = %q{2010-11-27}
+  s.date = %q{2011-01-14}
   s.description = %q{An easy-to-use client library for the official Dropbox API.}
   s.email = %q{dropbox@timothymorgan.info}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "dropbox.gemspec",
+    "examples/upload_and_delete.rb",
     "keys.json.example",
     "lib/dropbox.rb",
     "lib/dropbox/api.rb",
@@ -55,6 +56,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby client library for the official Dropbox API}
   s.test_files = [
+    "examples/upload_and_delete.rb",
     "spec/dropbox/api_spec.rb",
     "spec/dropbox/entry_spec.rb",
     "spec/dropbox/event_spec.rb",

data/examples/upload_and_delete.rb

@@ -0,0 +1,24 @@
+require 'dropbox'
+
+unless File.exist?('keys.json')
+  raise "Create a keys.json file with your Dropbox API credentials. See keys.json.example to get started."
+end
+
+settings = JSON.parse(File.read('keys.json'))
+
+session = Dropbox::Session.new(settings['key'], settings['secret'])
+session.mode = :sandbox
+puts "Visit #{session.authorize_url} to log in to Dropbox. Hit enter when you have done this."
+gets
+session.authorize
+
+# upload a file
+puts "Uploading ChangeLog..."
+session.upload 'ChangeLog', '/'
+uploaded_file = session.file('ChangeLog')
+puts "Done! #{uploaded_file.inspect}"
+puts uploaded_file.metadata.size
+
+puts "Deleting file..."
+uploaded_file.delete
+puts "Done!"

data/lib/dropbox/api.rb

@@ -147,6 +147,9 @@ module Dropbox
     # +mode+:: Temporarily changes the API mode. See the MODES array.
     # +as+:: Specify a custom name for the uploaded file (required when
     #        uploading from a +StringIO+ stream).
+    # +timeout+:: The amount of time to wait for a response from the Dropbox
+    #             server (in seconds). By default it's 60; set this higher when
+    #             uploading large files.
     #
     # Examples:
     #
@@ -168,11 +171,17 @@ module Dropbox
         raise(ArgumentError, "Must specify the :as option when uploading from StringIO") unless options[:as]
         file = local_file
         local_path = options[:as]
+        
+        # hack for bug in UploadIO
+        class << file
+          attr_accessor :path
+        end
+        file.path = local_path
       else
         raise ArgumentError, "local_file must be a File, StringIO, or file path"
       end
       
-      name = options.delete(:as).to_s if options[:as]
+      name = File.basename(options.delete(:as)) if options[:as]
 
       remote_path = remote_path.sub(/^\//, '')
       remote_path = Dropbox.check_path(remote_path).split('/')
@@ -189,15 +198,18 @@ module Dropbox
       oauth_signature = oauth_request.to_hash['authorization']
 
       request = Net::HTTP::Post::Multipart.new(uri.path,
-                                               'file' => UploadIO.convert!(
+                                               'file' => UploadIO.new(
                                                        file,
                                                        'application/octet-stream',
-                                                       name,
-                                                       local_path))
+                                                       name))
       request['authorization'] = oauth_signature.join(', ')
 
       proxy = URI.parse(@proxy || "")
-      response = Net::HTTP::Proxy(proxy.host, proxy.port).new(uri.host, uri.port).request(request)
+      http = Net::HTTP::Proxy(proxy.host, proxy.port).new(uri.host, uri.port)
+      http.use_ssl = @ssl
+      http.read_timeout = options[:timeout] if options[:timeout]
+      response = http.request(request)
+
       if response.kind_of?(Net::HTTPSuccess) then
         begin
           return JSON.parse(response.body).symbolize_keys_recursively.to_struct_recursively
@@ -380,9 +392,12 @@ module Dropbox
     # +limit+:: Set this value to limit the number of entries returned when
     #           listing a directory. If the result has more than this number of
     #           entries, a TooManyEntriesError will be raised.
+    # +prior_response+:: The response from a prior call to metadata for the same
+    #                    path. If the metadata has not changed since the prior
+    #                    call, the entire metadata will not be re-downloaded.
+    #                    Operation is undefined if the given value was for a
+    #                    call to metadata with a different path.
     # +mode+:: Temporarily changes the API mode. See the MODES array.
-    #
-    # TODO hash option seems to return HTTPBadRequest for now
 
     def metadata(path, options={})
       path = path.sub(/^\//, '')
@@ -393,7 +408,7 @@ module Dropbox
       args += Dropbox.check_path(path).split('/')
       args << Hash.new
       args.last[:file_limit] = options[:limit] if options[:limit]
-      #args.last[:hash] = options[:hash] if options[:hash]
+      args.last[:hash] = options[:prior_response].hash if options[:prior_response] and options[:prior_response].hash
       args.last[:list] = !(options[:suppress_list].to_bool)
       args.last[:ssl] = @ssl
 
@@ -402,7 +417,7 @@ module Dropbox
       rescue UnsuccessfulResponseError => error
         raise TooManyEntriesError.new(path) if error.response.kind_of?(Net::HTTPNotAcceptable)
         raise FileNotFoundError.new(path) if error.response.kind_of?(Net::HTTPNotFound)
-        #return :not_modified if error.kind_of?(Net::HTTPNotModified)
+        return options[:prior_response] if error.response.kind_of?(Net::HTTPNotModified)
         raise error
       end
     end

data/lib/dropbox/entry.rb

@@ -31,10 +31,16 @@ module Dropbox
       @path = path
     end
 
-    # Delegates to Dropbox::API#metadata.
+    # Delegates to Dropbox::API#metadata. Additional options:
+    #
+    # +force+:: Normally, subsequent calls to this method will use cached
+    #           results if the file hasn't been changed. To download the full
+    #           metadata even if the file has not been changed, set this to
+    #           +true+.
 
     def metadata(options={})
-      @session.metadata path, options
+      @previous_metadata = nil if options.delete(:force)
+      @previous_metadata = @session.metadata path, (@previous_metadata ? options.merge(:prior_response => @previous_metadata) : options)
     end
     alias :info :metadata
     

data/lib/dropbox/session.rb

@@ -189,7 +189,7 @@ module Dropbox
       session = dup
       consumer = OAuth::Consumer.new(@consumer.key, @consumer.secret, :site => host, :proxy => @proxy)
       session.instance_variable_set :@consumer, consumer
-      session.instance_variable_set :@access_token, OAuth::AccessToken.new(consumer, @access_token.token, @access_token.secret)
+      session.instance_variable_set :@access_token, OAuth::AccessToken.new(consumer, @access_token.token, @access_token.secret) if @access_token
       return session
     end
   end

data/spec/dropbox/api_spec.rb

@@ -30,7 +30,7 @@ def stub_for_upload_testing
   @response.stub!(:kind_of?).with(Net::HTTPSuccess).and_return(true)
   @response.stub!(:body).and_return('{"test":"val"}')
 
-  @http = mock('Net::HTTP', :request => @response)
+  @http = mock('Net::HTTP', :request => @response, :use_ssl= => nil)
   Net::HTTP.stub!(:new).and_return(@http)
 end
 
@@ -502,6 +502,19 @@ describe Dropbox::API do
       response.directory?.should be_true
       response.hsh.directory?.should be_false
     end
+
+    it "should add a hash option when prior_response is set" do
+      should_receive_api_method_with_arguments @token_mock, :get, 'metadata', { :list => 'true', :hash => '123abc' }, @response, 'some/file', 'sandbox'
+      @session.metadata 'some/file', :prior_response => mock('metadata response', :hash => '123abc')
+    end
+
+    it "should return the prior_response when the response code is 304" do
+      response_acts_as Net::HTTPNotModified
+      @token_mock.stub!(:get).and_return(@response)
+      prior = mock('metadata response', :hash => '123abc')
+
+      @session.metadata('path', :prior_response => prior).should eql(prior)
+    end
   end
 
   describe "#list" do
@@ -546,12 +559,12 @@ describe Dropbox::API do
         end
 
         it "should use the File object as the stream" do
-          UploadIO.should_receive(:convert!).once.with(@file, anything, File.basename(__FILE__), __FILE__)
+          UploadIO.should_receive(:new).once.with(@file, anything, File.basename(__FILE__))
           @session.upload @file, 'remote/'
         end
 
         it "should accept a custom file name via the :as parameter" do
-          UploadIO.should_receive(:convert!).once.with(@file, anything, 'myfile.txt', __FILE__)
+          UploadIO.should_receive(:new).once.with(@file, anything, 'myfile.txt')
           @session.upload @file, 'remote/', :as => 'myfile.txt'
         end
       end
@@ -564,12 +577,12 @@ describe Dropbox::API do
         end
 
         it "should use the file at that path as the stream" do
-          UploadIO.should_receive(:convert!).once.with(@file, anything, File.basename(__FILE__), __FILE__)
+          UploadIO.should_receive(:new).once.with(@file, anything, File.basename(__FILE__))
           @session.upload @string, 'remote/'
         end
 
         it "should accept a custom file name via the :as parameter" do
-          UploadIO.should_receive(:convert!).once.with(@file, anything, 'myfile.txt', __FILE__)
+          UploadIO.should_receive(:new).once.with(@file, anything, 'myfile.txt')
           @session.upload @string, 'remote/', :as => 'myfile.txt'
         end
       end
@@ -585,7 +598,7 @@ describe Dropbox::API do
         end
 
         it "should use the StringIO as the stream and take filename from the options" do
-          UploadIO.should_receive(:convert!).once.with(@string_io, anything, @filename, @filename)
+          UploadIO.should_receive(:new).once.with(@string_io, anything, @filename)
           @session.upload @string_io, 'remote/', :as => @filename
         end
 
@@ -593,6 +606,11 @@ describe Dropbox::API do
           lambda { @session.upload @string_io, 'remote/' }.should raise_error(ArgumentError)
         end
       end
+
+      it "should accept a custom read timeout" do
+        @http.should_receive(:read_timeout=).once.with(10)
+        @session.upload StringIO.new('test123'), 'remote/', :as => 'name.txt', :timeout => 10
+      end
     end
 
     describe "request" do
@@ -636,14 +654,14 @@ describe Dropbox::API do
       end
 
       it "should create a multipart POST request with the 'file' parameter set to the file of type application/octet-stream" do
-        Net::HTTP::Post::Multipart.should_receive(:new).once.with("/#{Dropbox::VERSION}/files/sandbox/hello", hash_including('file' => an_instance_of(File))).and_return(@request)
+        Net::HTTP::Post::Multipart.should_receive(:new).once.with("/#{Dropbox::VERSION}/files/sandbox/hello", hash_including('file' => an_instance_of(UploadIO))).and_return(@request)
 
         @session.upload __FILE__, 'hello'
       end
 
       it "should send the request" do
         uri = URI.parse(Dropbox::ALTERNATE_HOSTS['files'])
-        @http = mock('Net::HTTP', :request => @response)
+        @http = mock('Net::HTTP', :request => @response, :use_ssl= => nil)
         Net::HTTP.stub!(:new).and_return(@http)
 
         @session.upload __FILE__, 'test'
@@ -654,7 +672,7 @@ describe Dropbox::API do
         @session.authorize
         
         uri = URI.parse(Dropbox::ALTERNATE_SSL_HOSTS['files'])
-        @http = mock('Net::HTTP', :request => @response)
+        @http = mock('Net::HTTP', :request => @response, :use_ssl= => nil)
         Net::HTTP.stub!(:new).and_return(@http)
 
         @session.upload __FILE__, 'test'

data/spec/dropbox/entry_spec.rb

@@ -22,6 +22,26 @@ describe Dropbox::Entry do
 
       @entry.metadata(:sandbox => true)
     end
+
+    it "should record prior responses and use them automatically" do
+      result = mock('result')
+
+      @session.should_receive(:metadata).once.with(@path, {}).and_return(result)
+      @entry.metadata.should eql(result)
+
+      @session.should_receive(:metadata).once.with(@path, { :prior_response => result }).and_return(result)
+      @entry.metadata.should eql(result)
+    end
+
+    it "... unless :force is set to true" do
+      result = mock('result')
+
+      @session.should_receive(:metadata).once.with(@path, {}).and_return(result)
+      @entry.metadata
+
+      @session.should_receive(:metadata).once.with(@path, {}).and_return(result)
+      @entry.metadata(:force => true)
+    end
   end
 
   describe "#move" do

data/spec/dropbox/revision_spec.rb

@@ -133,6 +133,10 @@ describe Dropbox::Revision do
   end
 
   describe "#content_loaded?" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should return true if the content is loaded" do
       pretend_content_and_metadata_is_loaded @revision, @session
       @revision.should be_content_loaded
@@ -140,6 +144,10 @@ describe Dropbox::Revision do
   end
 
   describe "#metadata_loaded?" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should return true if the metadata is loaded" do
       pretend_content_and_metadata_is_loaded @revision, @session
       @revision.should be_metadata_loaded
@@ -147,6 +155,10 @@ describe Dropbox::Revision do
   end
 
   describe "#latest?" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should raise an exception if the metadata is not yet loaded" do
       lambda { @revision.latest? }.should raise_error(Dropbox::NotLoadedError)
     end
@@ -163,6 +175,10 @@ describe Dropbox::Revision do
   end
 
   describe "#directory?" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should raise an exception if the metadata is not yet loaded" do
       lambda { @revision.directory? }.should raise_error(Dropbox::NotLoadedError)
     end
@@ -179,6 +195,10 @@ describe Dropbox::Revision do
   end
 
   describe "#modified" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should raise an exception if the metadata is not yet loaded" do
       lambda { @revision.modified }.should raise_error(Dropbox::NotLoadedError)
     end
@@ -190,6 +210,10 @@ describe Dropbox::Revision do
   end
 
   describe "#error?" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should return true if there was an error" do
       pretend_error_occurred @revision
       @revision.should be_error
@@ -202,6 +226,10 @@ describe Dropbox::Revision do
   end
   
   describe "#deleted?" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should raise an exception if the metadata is not yet loaded" do
       lambda { @revision.deleted? }.should raise_error(Dropbox::NotLoadedError)
     end
@@ -222,6 +250,10 @@ describe Dropbox::Revision do
   end
 
   describe "#content" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should raise an exception if the content is not yet loaded" do
       lambda { @revision.content }.should raise_error(Dropbox::NotLoadedError)
     end
@@ -234,6 +266,7 @@ describe Dropbox::Revision do
 
   describe "#method_missing" do
     before :each do
+      @session = mock('Dropbox::Session')
       pretend_content_and_metadata_is_loaded @revision, @session, :size => 123
     end
 
@@ -251,6 +284,10 @@ describe Dropbox::Revision do
   end
 
   describe "#metadata_for_latest_revision" do
+    before :each do
+      @session = mock('Dropbox::Session')
+    end
+
     it "should raise an error if metadata has not yet been loaded" do
       lambda { @revision.metadata_for_latest_revision @session }.should raise_error(Dropbox::NotLoadedError)
     end
@@ -272,6 +309,7 @@ describe Dropbox::Revision do
     describe "with an error" do
       before :each do
         @metadata = { :error => 403 }
+        @session = mock('Dropbox::Session')
       end
 
       it "should set the error attribute" do
@@ -301,6 +339,7 @@ describe Dropbox::Revision do
             :mtime => (Time.now.to_i - rand(60*60*24*30)),
             :latest => (rand(2) == 0)
         }
+        @session = mock('Dropbox::Session')
       end
 
       it "should clear the error attribute" do

data/spec/dropbox/session_spec.rb

@@ -169,7 +169,7 @@ describe Dropbox::Session do
     end
   end
 
-  describe "with Dropbox keys " do
+  describe "with Dropbox keys" do
     before(:all) do
       @keys = read_keys_file
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 3
+  version: 1.2.3
 platform: ruby
 authors: 
 - Tim Morgan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-27 00:00:00 -08:00
+date: 2011-01-14 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -124,6 +124,7 @@ files:
 - Rakefile
 - VERSION
 - dropbox.gemspec
+- examples/upload_and_delete.rb
 - keys.json.example
 - lib/dropbox.rb
 - lib/dropbox/api.rb
@@ -159,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4053087587025660672
+      hash: -350803918686472919
       segments: 
       - 0
       version: "0"
@@ -179,6 +180,7 @@ signing_key:
 specification_version: 3
 summary: Ruby client library for the official Dropbox API
 test_files: 
+- examples/upload_and_delete.rb
 - spec/dropbox/api_spec.rb
 - spec/dropbox/entry_spec.rb
 - spec/dropbox/event_spec.rb