dropbox 1.1.0 → 1.1.1

data/.gitignore

@@ -20,5 +20,6 @@ tmtags
 coverage
 rdoc
 pkg
+.rvmrc
 
 ## PROJECT::SPECIFIC

data/README.rdoc

@@ -73,6 +73,11 @@ account, and then upload a file to their Dropbox.
 * If you're using pingbacks, check out Dropbox::Event and Dropbox::Revision.
   Those classes parse pingbacks from Dropbox into Ruby objects.
 
+== Testing Your Code
+
+fguillen has implemented a mock of the Dropbox API server:
+http://github.com/fguillen/DummyDropbox
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/dropbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dropbox}
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Morgan"]
-  s.date = %q{2010-05-27}
+  s.date = %q{2010-09-22}
   s.description = %q{An easy-to-use client library for the official Dropbox API.}
   s.email = %q{dropbox@timothymorgan.info}
   s.extra_rdoc_files = [
@@ -30,15 +30,15 @@ Gem::Specification.new do |s|
      "lib/dropbox/api.rb",
      "lib/dropbox/entry.rb",
      "lib/dropbox/event.rb",
+     "lib/dropbox/extensions/array.rb",
+     "lib/dropbox/extensions/hash.rb",
+     "lib/dropbox/extensions/module.rb",
+     "lib/dropbox/extensions/object.rb",
+     "lib/dropbox/extensions/string.rb",
+     "lib/dropbox/extensions/to_bool.rb",
      "lib/dropbox/memoization.rb",
      "lib/dropbox/revision.rb",
      "lib/dropbox/session.rb",
-     "lib/extensions/array.rb",
-     "lib/extensions/hash.rb",
-     "lib/extensions/module.rb",
-     "lib/extensions/object.rb",
-     "lib/extensions/string.rb",
-     "lib/extensions/to_bool.rb",
      "spec/dropbox/api_spec.rb",
      "spec/dropbox/entry_spec.rb",
      "spec/dropbox/event_spec.rb",

data/lib/dropbox.rb

@@ -8,12 +8,12 @@ require 'set'
 require 'time'
 require 'tempfile'
 
-require 'extensions/array'
-require 'extensions/hash'
-require 'extensions/module'
-require 'extensions/object'
-require 'extensions/string'
-require 'extensions/to_bool'
+require 'dropbox/extensions/array'
+require 'dropbox/extensions/hash'
+require 'dropbox/extensions/module'
+require 'dropbox/extensions/object'
+require 'dropbox/extensions/string'
+require 'dropbox/extensions/to_bool'
 
 require 'dropbox/memoization'
 require 'dropbox/api'

data/lib/dropbox/api.rb

@@ -82,7 +82,7 @@ module Dropbox
     # +mode+:: Temporarily changes the API mode. See the MODES array.
 
     def download(path, options={})
-      path.sub! /^\//, ''
+      path = path.sub(/^\//, '')
       rest = Dropbox.check_path(path).split('/')
       rest << { :ssl => @ssl }
       api_body :get, 'files', root(options), *rest
@@ -123,7 +123,7 @@ module Dropbox
       size = args.shift
       raise ArgumentError, "thumbnail takes a path, an optional size, and optional options" unless path.kind_of?(String) and (size.kind_of?(String) or size.nil?) and args.empty?
       
-      path.sub! /^\//, ''
+      path = path.sub(/^\//, '')
       rest = Dropbox.check_path(path).split('/')
       rest << { :ssl => @ssl }
       rest.last[:size] = size if size
@@ -167,7 +167,7 @@ module Dropbox
         raise ArgumentError, "local_file must be a File or file path"
       end
 
-      remote_path.sub! /^\//, ''
+      remote_path = remote_path.sub(/^\//, '')
       remote_path = Dropbox.check_path(remote_path).split('/')
 
       remote_path << { :ssl => @ssl }
@@ -217,8 +217,8 @@ module Dropbox
     # TODO The API documentation says this method returns 404/403 if the source or target is invalid, but it actually returns 5xx.
 
     def copy(source, target, options={})
-      source.sub! /^\//, ''
-      target.sub! /^\//, ''
+      source = source.sub(/^\//, '')
+      target = target.sub(/^\//, '')
       target << File.basename(source) if target.ends_with?('/')
       begin
         parse_metadata(post('fileops', 'copy', :from_path => Dropbox.check_path(source), :to_path => Dropbox.check_path(target), :root => root(options), :ssl => @ssl)).to_struct_recursively
@@ -243,7 +243,7 @@ module Dropbox
     # TODO The API documentation says this method returns 403 if the path already exists, but it actually appends " (1)" to the end of the name and returns 200.
 
     def create_folder(path, options={})
-      path.sub! /^\//, ''
+      path = path.sub(/^\//, '')
       path.sub! /\/$/, ''
       begin
         parse_metadata(post('fileops', 'create_folder', :path => Dropbox.check_path(path), :root => root(options), :ssl => @ssl)).to_struct_recursively
@@ -266,7 +266,7 @@ module Dropbox
     # TODO The API documentation says this method returns 404 if the path does not exist, but it actually returns 5xx.
     
     def delete(path, options={})
-      path.sub! /^\//, ''
+      path = path.sub(/^\//, '')
       path.sub! /\/$/, ''
       begin
         api_response(:post, 'fileops', 'delete', :path => Dropbox.check_path(path), :root => root(options), :ssl => @ssl)
@@ -296,8 +296,8 @@ module Dropbox
     # TODO The API documentation says this method returns 404/403 if the source or target is invalid, but it actually returns 5xx.
 
     def move(source, target, options={})
-      source.sub! /^\//, ''
-      target.sub! /^\//, ''
+      source = source.sub(/^\//, '')
+      target = target.sub(/^\//, '')
       target << File.basename(source) if target.ends_with?('/')
       begin
         parse_metadata(post('fileops', 'move', :from_path => Dropbox.check_path(source), :to_path => Dropbox.check_path(target), :root => root(options), :ssl => @ssl)).to_struct_recursively
@@ -322,7 +322,7 @@ module Dropbox
 
     def rename(path, new_name, options={})
       raise ArgumentError, "Names cannot have slashes in them" if new_name.include?('/')
-      path.sub! /\/$/, ''
+      path = path.sub(/\/$/, '')
       destination = path.split('/')
       destination[destination.size - 1] = new_name
       destination = destination.join('/')
@@ -339,7 +339,7 @@ module Dropbox
     # +mode+:: Temporarily changes the API mode. See the MODES array.
 
     def link(path, options={})
-      path.sub! /^\//, ''
+      path = path.sub(/^\//, '')
       begin
         rest = Dropbox.check_path(path).split('/')
         rest << { :ssl => @ssl }
@@ -377,7 +377,7 @@ module Dropbox
     # TODO hash option seems to return HTTPBadRequest for now
 
     def metadata(path, options={})
-      path.sub! /^\//, ''
+      path = path.sub(/^\//, '')
       args = [
               'metadata',
               root(options)

data/lib/{extensions → dropbox/extensions}/hash.rb

@@ -22,7 +22,7 @@ class Hash # :nodoc:
     hsh.each { |k, v| hsh[k] = v.symbolize_keys_recursively if v.kind_of?(Hash) }
     hsh.each { |k, v| hsh[k] = v.map { |i| i.kind_of?(Hash) ? i.symbolize_keys_recursively : i } if v.kind_of?(Array) }
     return hsh
-  end
+  end unless method_defined?(:symbolize_keys_recursively)
 
   def stringify_keys # :nodoc:
     inject({}) do |options, (key, value)|
@@ -40,7 +40,7 @@ class Hash # :nodoc:
     hsh.each { |k, v| hsh[k] = v.stringify_keys_recursively if v.kind_of?(Hash) }
     hsh.each { |k, v| hsh[k] = v.map { |i| i.kind_of?(Hash) ? i.stringify_keys_recursively : i } if v.kind_of?(Array) }
     return hsh
-  end
+  end unless method_defined?(:stringify_keys_recursively)
 
   def to_struct # :nodoc:
     struct = Struct.new(*keys).new(*values)
@@ -50,12 +50,12 @@ class Hash # :nodoc:
       struct.eigenclass.send(:define_method, key.to_sym) { return val }
     end
     return struct
-  end
+  end unless method_defined?(:to_struct)
 
   def to_struct_recursively # :nodoc:
     hsh = dup
     hsh.each { |k, v| hsh[k] = v.to_struct_recursively if v.kind_of?(Hash) }
     hsh.each { |k, v| hsh[k] = v.map { |i| i.kind_of?(Hash) ? i.to_struct_recursively : i } if v.kind_of?(Array) }
     return hsh.to_struct
-  end
+  end unless method_defined?(:to_struct_recursively)
 end

data/lib/{extensions → dropbox/extensions}/object.rb

@@ -1,5 +1,5 @@
 class Object # :nodoc:
   def eigenclass # :nodoc:
     (class << self; self; end)
-  end
+  end unless method_defined?(:eigenclass)
 end

data/lib/{extensions → dropbox/extensions}/to_bool.rb

@@ -1,17 +1,17 @@
-class Object # :nodoc:
-  def to_bool # :nodoc:
-    true
-  end
-end
-
 class FalseClass # :nodoc:
   def to_bool # :nodoc:
     false
-  end
+  end unless method_defined?(:to_bool)
 end
 
 class NilClass # :nodoc:
   def to_bool # :nodoc:
     false
-  end
+  end unless method_defined?(:to_bool)
 end
+
+class Object # :nodoc:
+  def to_bool # :nodoc:
+    true
+  end unless method_defined?(:to_bool)
+end

data/lib/dropbox/session.rb

@@ -58,8 +58,11 @@ module Dropbox
 
     def initialize(oauth_key, oauth_secret, options={})
       @ssl = options[:ssl].to_bool
+      @proxy = options[:proxy] || ENV["HTTP_PROXY"] || ENV["http_proxy"]
+      @proxy = nil if options[:noproxy].to_bool
       @consumer = OAuth::Consumer.new(oauth_key, oauth_secret,
                                       :site => (@ssl ? Dropbox::SSL_HOST : Dropbox::HOST),
+                                      :proxy => @proxy,
                                       :request_token_path => "/#{Dropbox::VERSION}/oauth/request_token",
                                       :authorize_path => "/#{Dropbox::VERSION}/oauth/authorize",
                                       :access_token_path => "/#{Dropbox::VERSION}/oauth/access_token")
@@ -106,9 +109,9 @@ module Dropbox
 
     def serialize
       if authorized? then
-        [ @consumer.key, @consumer.secret, authorized?, @access_token.token, @access_token.secret ].to_yaml
+        [ @consumer.key, @consumer.secret, authorized?, @access_token.token, @access_token.secret, @ssl ].to_yaml
       else
-        [ @consumer.key, @consumer.secret, authorized?, @request_token.token, @request_token.secret ].to_yaml
+        [ @consumer.key, @consumer.secret, authorized?, @request_token.token, @request_token.secret, @ssl ].to_yaml
       end
     end
     
@@ -116,10 +119,10 @@ module Dropbox
     # Returns the recreated instance.
 
     def self.deserialize(data)
-      consumer_key, consumer_secret, authorized, token, token_secret = YAML.load(StringIO.new(data))
+      consumer_key, consumer_secret, authorized, token, token_secret, ssl = YAML.load(StringIO.new(data))
       raise ArgumentError, "Must provide a properly serialized #{self.to_s} instance" unless [ consumer_key, consumer_secret, token, token_secret ].all? and authorized == true or authorized == false
 
-      session = self.new(consumer_key, consumer_secret)
+      session = self.new(consumer_key, consumer_secret, :ssl => ssl)
       if authorized then
         session.instance_variable_set :@access_token, OAuth::AccessToken.new(session.instance_variable_get(:@consumer), token, token_secret)
       else

data/spec/dropbox/session_spec.rb

@@ -7,6 +7,7 @@ describe Dropbox::Session do
       secret = 'test_secret'
       options_hash = [ 'request_token', 'authorize', 'access_token' ].inject({}) { |hsh, cur| hsh["#{cur}_path".to_sym] = "/#{Dropbox::VERSION}/oauth/#{cur}" ; hsh }
       options_hash[:site] = Dropbox::HOST
+      options_hash[:proxy] = nil
 
       consumer_mock = mock('OAuth::Consumer')
       consumer_mock.stub!(:get_request_token)
@@ -20,6 +21,7 @@ describe Dropbox::Session do
       secret = 'test_secret'
       options_hash = [ 'request_token', 'authorize', 'access_token' ].inject({}) { |hsh, cur| hsh["#{cur}_path".to_sym] = "/#{Dropbox::VERSION}/oauth/#{cur}" ; hsh }
       options_hash[:site] = Dropbox::SSL_HOST
+      options_hash[:proxy] = nil
 
       consumer_mock = mock('OAuth::Consumer')
       consumer_mock.stub!(:get_request_token)
@@ -27,6 +29,20 @@ describe Dropbox::Session do
 
       Dropbox::Session.new(key, secret, :ssl => true)
     end
+    
+    it "should create a new OAuth::Consumer" do
+      key = 'test_key'
+      secret = 'test_secret'
+      options_hash = [ 'request_token', 'authorize', 'access_token' ].inject({}) { |hsh, cur| hsh["#{cur}_path".to_sym] = "/#{Dropbox::VERSION}/oauth/#{cur}" ; hsh }
+      options_hash[:site] = Dropbox::HOST
+      options_hash[:proxy] = proxy = mock('proxy')
+
+      consumer_mock = mock('OAuth::Consumer')
+      consumer_mock.stub!(:get_request_token)
+      OAuth::Consumer.should_receive(:new).once.with(key, secret, options_hash).and_return(consumer_mock)
+
+      Dropbox::Session.new(key, secret, :proxy => proxy)
+    end
 
     it "should get the request token" do
       consumer_mock = mock('OAuth::Consumer')
@@ -120,7 +136,17 @@ describe Dropbox::Session do
       @token_mock.stub!(:token).and_return("request token")
       @token_mock.stub!(:secret).and_return("request token secret")
 
-      @session.serialize.should eql([ "consumer key", "consumer secret", false, "request token", "request token secret" ].to_yaml)
+      @session.serialize.should eql([ "consumer key", "consumer secret", false, "request token", "request token secret", false ].to_yaml)
+    end
+    
+    it "should serialize the SSL setting" do
+      @session = Dropbox::Session.new('foo', 'bar', :ssl => true)
+      @consumer_mock.stub!(:key).and_return("consumer key")
+      @consumer_mock.stub!(:secret).and_return("consumer secret")
+      @token_mock.stub!(:token).and_return("request token")
+      @token_mock.stub!(:secret).and_return("request token secret")
+
+      @session.serialize.should eql([ "consumer key", "consumer secret", false, "request token", "request token secret", true ].to_yaml)
     end
 
     it "should return the consumer key and secret and the access token and secret in YAML form if authorized" do
@@ -135,11 +161,18 @@ describe Dropbox::Session do
 
     it "should return a properly initialized unauthorized instance" do
       mock_session = mock('Dropbox::Session')
-      Dropbox::Session.should_receive(:new).once.with('key', 'secret').and_return(mock_session)
+      Dropbox::Session.should_receive(:new).once.with('key', 'secret', :ssl => true).and_return(mock_session)
       
-      Dropbox::Session.deserialize([ 'key', 'secret', false, 'a', 'b' ].to_yaml).should eql(mock_session)
+      Dropbox::Session.deserialize([ 'key', 'secret', false, 'a', 'b', true ].to_yaml).should eql(mock_session)
       #TODO request token remains opaque for purposes of testing
     end
+    
+    it "should allow the SSL option to be left out" do
+      mock_session = mock('Dropbox::Session')
+      Dropbox::Session.should_receive(:new).once.with('key', 'secret', :ssl => nil).and_return(mock_session)
+      
+      Dropbox::Session.deserialize([ 'key', 'secret', false, 'a', 'b' ].to_yaml).should eql(mock_session)
+    end
 
     it "should return a properly initialized authorized instance" do
       pending "access token remains opaque for purposes of testing"

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: dropbox
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Tim Morgan
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 -07:00
+date: 2010-09-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 2
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 0
         - 3
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
         - 2
@@ -74,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 1
         - 0
@@ -104,15 +99,15 @@ files:
 - lib/dropbox/api.rb
 - lib/dropbox/entry.rb
 - lib/dropbox/event.rb
+- lib/dropbox/extensions/array.rb
+- lib/dropbox/extensions/hash.rb
+- lib/dropbox/extensions/module.rb
+- lib/dropbox/extensions/object.rb
+- lib/dropbox/extensions/string.rb
+- lib/dropbox/extensions/to_bool.rb
 - lib/dropbox/memoization.rb
 - lib/dropbox/revision.rb
 - lib/dropbox/session.rb
-- lib/extensions/array.rb
-- lib/extensions/hash.rb
-- lib/extensions/module.rb
-- lib/extensions/object.rb
-- lib/extensions/string.rb
-- lib/extensions/to_bool.rb
 - spec/dropbox/api_spec.rb
 - spec/dropbox/entry_spec.rb
 - spec/dropbox/event_spec.rb
@@ -135,7 +130,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -144,7 +138,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"