dropbox 1.1.2 → 1.2.0

data/.gitignore

@@ -21,6 +21,7 @@ coverage
 rdoc
 pkg
 .rvmrc
+.bundle
 
 ## PROJECT::SPECIFIC
 keys.json

data/ChangeLog

@@ -1,3 +1,11 @@
+1.2 (2010-10-31)
+
+* Updated thumbnail method for changes in the thumbnail API.
+* Added the ability to upload files from +StringIO+ objects.
+* Added option to customize uploaded file's remote name.
+* Added proxy support for additional actions.
+* Modernized gem: RSpec 2.0 compatible, now uses Bundler, etc.
+
 1.1.2 (2010-10-6)
 
 * Added ability to perform OAuth authorization on behalf of the user.

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+# DEPENDENCIES
+gem 'oauth', '>= 0.3.6'
+gem 'json', '>= 1.2.0'
+gem 'multipart-post', '>= 1.0'
+gem 'mechanize', '>= 1.0.0'
+
+
+# DEVELOPMENT
+gem 'jeweler'
+
+# TEST
+gem 'rspec', '>= 2.0'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json (1.4.6)
+    json_pure (1.4.6)
+    mechanize (1.0.0)
+      nokogiri (>= 1.2.1)
+    multipart-post (1.0.1)
+    nokogiri (1.4.3.1)
+    oauth (0.4.3)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  json (>= 1.2.0)
+  mechanize (>= 1.0.0)
+  multipart-post (>= 1.0)
+  oauth (>= 0.3.6)
+  rspec (>= 2.0)

data/Rakefile

@@ -1,48 +1,32 @@
-require 'rubygems'
 require 'rake'
-
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "dropbox"
-    gem.version = File.read("VERSION").chomp.strip
-    gem.summary = %Q{Ruby client library for the official Dropbox API}
-    gem.description = %Q{An easy-to-use client library for the official Dropbox API.}
-    gem.email = "dropbox@timothymorgan.info"
-    gem.homepage = "http://github.com/RISCfuture/dropbox"
-    gem.authors = ["Tim Morgan"]
-
-    gem.files += FileList["lib/dropbox/*.rb"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_runtime_dependency "oauth", ">= 0.3.6"
-    gem.add_runtime_dependency "json", ">= 1.2.0"
-    gem.add_runtime_dependency "multipart-post", ">= 1.0"
-    gem.add_runtime_dependency "mechanize", ">= 1.0.0"
-  end
-  Jeweler::GemcutterTasks.new
-  Jeweler::RubyforgeTasks.new
+  require 'bundler'
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+  puts "Bundler is not installed; install with `gem install bundler`."
+  exit 1
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+Bundler.require :default
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "dropbox"
+  gem.summary = %Q{Ruby client library for the official Dropbox API}
+  gem.description = %Q{An easy-to-use client library for the official Dropbox API.}
+  gem.email = "dropbox@timothymorgan.info"
+  gem.homepage = "http://github.com/RISCfuture/dropbox"
+  gem.authors = [ "Tim Morgan" ]
+  gem.add_dependency 'oauth', '>= 0.3.6'
+  gem.add_dependency 'json', '>= 1.2.0'
+  gem.add_dependency 'multipart-post', '>= 1.0'
+  gem.add_dependency 'mechanize', '>= 1.0.0'
 end
+Jeweler::GemcutterTasks.new
 
-task :spec => :check_dependencies
-
-task :default => :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
 require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+Rake::RDocTask.new(:doc) do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION').chomp.strip : ""
 
   rdoc.rdoc_dir = 'rdoc'
@@ -51,3 +35,5 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task(default: :spec)

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/dropbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dropbox}
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Morgan"]
-  s.date = %q{2010-10-06}
+  s.date = %q{2010-10-31}
   s.description = %q{An easy-to-use client library for the official Dropbox API.}
   s.email = %q{dropbox@timothymorgan.info}
   s.extra_rdoc_files = [
@@ -20,7 +20,10 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     ".rspec",
      "ChangeLog",
+     "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -46,7 +49,6 @@ Gem::Specification.new do |s|
      "spec/dropbox/revision_spec.rb",
      "spec/dropbox/session_spec.rb",
      "spec/dropbox_spec.rb",
-     "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/RISCfuture/dropbox}
@@ -69,20 +71,17 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_runtime_dependency(%q<oauth>, [">= 0.3.6"])
       s.add_runtime_dependency(%q<json>, [">= 1.2.0"])
       s.add_runtime_dependency(%q<multipart-post>, [">= 1.0"])
       s.add_runtime_dependency(%q<mechanize>, [">= 1.0.0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<oauth>, [">= 0.3.6"])
       s.add_dependency(%q<json>, [">= 1.2.0"])
       s.add_dependency(%q<multipart-post>, [">= 1.0"])
       s.add_dependency(%q<mechanize>, [">= 1.0.0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<oauth>, [">= 0.3.6"])
     s.add_dependency(%q<json>, [">= 1.2.0"])
     s.add_dependency(%q<multipart-post>, [">= 1.0"])

data/lib/dropbox/api.rb

@@ -88,7 +88,7 @@ module Dropbox
       api_body :get, 'files', root(options), *rest
       #TODO streaming, range queries
     end
-    
+
     # Downloads a minimized thumbnail for a file. Pass the path to the file,
     # optionally the size of the thumbnail you want, and any additional options.
     # See https://www.dropbox.com/developers/docs#thumbnails for a list of valid
@@ -105,6 +105,8 @@ module Dropbox
     #
     # Options:
     #
+    # +format+:: The image format (see the API documentation for supported
+    #            formats).
     # +mode+:: Temporarily changes the API mode. See the MODES array.
     #
     # Examples:
@@ -116,18 +118,13 @@ module Dropbox
     # Get the thumbnail for an image in the +medium+ size:
     #
     #  session.thumbnail('my/image.jpg', 'medium')
-    
-    def thumbnail(*args)
-      options = args.extract_options!
-      path = args.shift
-      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?
-      
+
+    def thumbnail(path, options={})\
       path = path.sub(/^\//, '')
       rest = Dropbox.check_path(path).split('/')
       rest << { :ssl => @ssl }
-      rest.last[:size] = size if size
-      
+      rest.last.merge! options
+
       begin
         api_body :get, 'thumbnails', root(options), *rest
       rescue Dropbox::UnsuccessfulResponseError => e
@@ -141,18 +138,22 @@ module Dropbox
     # of the remote file will be identical to that of the local file. You can
     # provide any of the following for the first parameter:
     #
-    # * a +File+ object, in which case the name of the local file is used, or
-    # * a path to a file, in which case that file's name is used.
+    # * a +File+ object (in which case the name of the local file is used),
+    # * a path to a file (in which case that file's name is used), or
+    # * a +StringIO+ (in which case the <tt>:as</tt> option must be specified.
     #
     # Options:
     #
     # +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).
     #
     # Examples:
     #
     #  session.upload 'music.pdf', '/' # upload a file by path to the root directory
     #  session.upload 'music.pdf, 'music/' # upload a file by path to the music folder
     #  session.upload File.new('music.pdf'), '/' # same as the first example
+    #  session.upload open('http://www.example.com/index.html'), :as => 'example.html' # upload from a StringIO stream (requires open-uri)
 
     def upload(local_file, remote_path, options={})
       if local_file.kind_of?(File) or local_file.kind_of?(Tempfile) then
@@ -163,9 +164,15 @@ module Dropbox
         file = File.new(local_file)
         name = File.basename(local_file)
         local_path = local_file
+      elsif local_file.kind_of?(StringIO) then
+        raise(ArgumentError, "Must specify the :as option when uploading from StringIO") unless options[:as]
+        file = local_file
+        local_path = options[:as]
       else
-        raise ArgumentError, "local_file must be a File or file path"
+        raise ArgumentError, "local_file must be a File, StringIO, or file path"
       end
+      
+      name = options.delete(:as).to_s if options[:as]
 
       remote_path = remote_path.sub(/^\//, '')
       remote_path = Dropbox.check_path(remote_path).split('/')
@@ -188,8 +195,9 @@ module Dropbox
                                                        name,
                                                        local_path))
       request['authorization'] = oauth_signature.join(', ')
-      
-      response = Net::HTTP.start(uri.host, uri.port) { |http| http.request(request) }
+
+      proxy = URI.parse(@proxy || "")
+      response = Net::HTTP::Proxy(proxy.host, proxy.port).new(uri.host, uri.port).request(request)
       if response.kind_of?(Net::HTTPSuccess) then
         begin
           return JSON.parse(response.body).symbolize_keys_recursively.to_struct_recursively
@@ -264,7 +272,7 @@ module Dropbox
     # +mode+:: Temporarily changes the API mode. See the MODES array.
     #
     # 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 = path.sub(/^\//, '')
       path.sub! /\/$/, ''
@@ -388,7 +396,7 @@ module Dropbox
       #args.last[:hash] = options[:hash] if options[:hash]
       args.last[:list] = !(options[:suppress_list].to_bool)
       args.last[:ssl] = @ssl
-      
+
       begin
         parse_metadata(get(*args)).to_struct_recursively
       rescue UnsuccessfulResponseError => error
@@ -419,7 +427,7 @@ module Dropbox
       metadata(path, options.merge(:suppress_list => false)).contents
     end
     alias :ls :list
-    
+
     def event_metadata(target_events, options={}) # :nodoc:
       get 'event_metadata', :ssl => @ssl, :root => root(options), :target_events => target_events
     end
@@ -558,17 +566,17 @@ module Dropbox
   # limit.
 
   class TooManyEntriesError < FileError; end
-  
+
   # Raised when the event_metadata method returns an error.
-  
+
   class PingbackError < StandardError
     # The HTTP error code returned by the event_metadata method.
     attr_reader :code
-    
+
     def initialize(code) # :nodoc
       @code = code
     end
-    
+
     def to_s # :nodoc:
       "#{self.class.to_s} code #{@code}"
     end

data/lib/dropbox/session.rb

@@ -131,7 +131,7 @@ module Dropbox
 
           login_form.login_email  = @authorizing_user
           login_form.login_password = @authorizing_password
-          auth_page = login_form.submit()
+          auth_page = login_form.submit
 
           auth_form = auth_page.form_with(:action => 'authorize')
           if auth_form
@@ -145,6 +145,12 @@ module Dropbox
       authorize
     end
 
+    # Returns the OAuth access_token which allows access to token and secret.
+
+    def access_token
+      @access_token || raise(UnauthorizedError, "You need to authorize the Dropbox user before you can call API methods")
+    end
+
     # Serializes this object into a string that can then be recreated with the
     # Dropbox::Session.deserialize method.
 
@@ -179,13 +185,9 @@ module Dropbox
 
     private
 
-    def access_token
-      @access_token || raise(UnauthorizedError, "You need to authorize the Dropbox user before you can call API methods")
-    end
-
     def clone_with_host(host)
       session = dup
-      consumer = OAuth::Consumer.new(@consumer.key, @consumer.secret, :site => host)
+      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)
       return session

data/spec/dropbox/api_spec.rb

@@ -30,7 +30,8 @@ def stub_for_upload_testing
   @response.stub!(:kind_of?).with(Net::HTTPSuccess).and_return(true)
   @response.stub!(:body).and_return('{"test":"val"}')
 
-  Net::HTTP.stub!(:start).and_return(@response)
+  @http = mock('Net::HTTP', :request => @response)
+  Net::HTTP.stub!(:new).and_return(@http)
 end
 
 def response_acts_as(subclass)
@@ -121,11 +122,6 @@ describe Dropbox::API do
       @session.thumbnail(path)
     end
     
-    it "should pass along a size" do
-      should_receive_api_method_with_arguments @token_mock, :get, 'thumbnails', { :size => 'medium' }, @response, 'path/to/file', 'sandbox'
-      @session.thumbnail "path/to/file", 'medium'
-    end
-    
     it "should raise an error if too many arguments are given" do
       lambda { @session.thumbnail "path/to/file", 'large', 'oops', :foo => 'bar' }.should raise_error(ArgumentError)
     end
@@ -553,6 +549,11 @@ describe Dropbox::API do
           UploadIO.should_receive(:convert!).once.with(@file, anything, File.basename(__FILE__), __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__)
+          @session.upload @file, 'remote/', :as => 'myfile.txt'
+        end
       end
 
       describe "given a String object" do
@@ -566,11 +567,32 @@ describe Dropbox::API do
           UploadIO.should_receive(:convert!).once.with(@file, anything, File.basename(__FILE__), __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__)
+          @session.upload @string, 'remote/', :as => 'myfile.txt'
+        end
       end
 
       it "should raise an error if given an unknown argument type" do
         lambda { @session.upload 123, 'path' }.should raise_error(ArgumentError)
       end
+
+      describe "given a StringIO object and a filename" do
+        before :each do
+          @string_io = StringIO.new("test123")
+          @filename = "test.txt"
+        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)
+          @session.upload @string_io, 'remote/', :as => @filename
+        end
+
+        it "should raise an exception if the :as option is not specified" do
+          lambda { @session.upload @string_io, 'remote/' }.should raise_error(ArgumentError)
+        end
+      end
     end
 
     describe "request" do
@@ -621,7 +643,8 @@ describe Dropbox::API do
 
       it "should send the request" do
         uri = URI.parse(Dropbox::ALTERNATE_HOSTS['files'])
-        Net::HTTP.should_receive(:start).once.with(uri.host, uri.port).and_return(@response)
+        @http = mock('Net::HTTP', :request => @response)
+        Net::HTTP.stub!(:new).and_return(@http)
 
         @session.upload __FILE__, 'test'
       end
@@ -631,7 +654,8 @@ describe Dropbox::API do
         @session.authorize
         
         uri = URI.parse(Dropbox::ALTERNATE_SSL_HOSTS['files'])
-        Net::HTTP.should_receive(:start).once.with(uri.host, uri.port).and_return(@response)
+        @http = mock('Net::HTTP', :request => @response)
+        Net::HTTP.stub!(:new).and_return(@http)
 
         @session.upload __FILE__, 'test'
       end

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
+Bundler.require :default, :test
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rubygems'
-require 'dropbox.rb'
-require 'spec'
-require 'spec/autorun'
+
+require 'dropbox'
 
 module ExternalKeysFileHelper
   def read_keys_file
@@ -11,7 +11,7 @@ module ExternalKeysFileHelper
       raise "Please add a keys.json file to the project directory containing your Dropbox API key and secret. See keys.json.example to get started."
     end
     
-    keys_file_contents = open("keys.json", "r").read()
+    keys_file_contents = open("keys.json", "r").read
     data = JSON.parse(keys_file_contents)
     unless %w( key secret email password ).all? { |key| data.include? key }
       raise "Your keys.json file does contain all the required information. See keys.json.example for more help."
@@ -21,6 +21,6 @@ module ExternalKeysFileHelper
   end
 end
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.include(ExternalKeysFileHelper)
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -14,28 +14,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 -07:00
+date: 2010-10-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
-  type: :development
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: oauth
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,11 +30,11 @@ dependencies:
         - 6
         version: 0.3.6
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -61,11 +45,11 @@ dependencies:
         - 0
         version: 1.2.0
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: multipart-post
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,11 +59,11 @@ dependencies:
         - 0
         version: "1.0"
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: mechanize
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,7 +74,8 @@ dependencies:
         - 0
         version: 1.0.0
   type: :runtime
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *id004
 description: An easy-to-use client library for the official Dropbox API.
 email: dropbox@timothymorgan.info
 executables: []
@@ -104,7 +89,10 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- .rspec
 - ChangeLog
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -130,7 +118,6 @@ files:
 - spec/dropbox/revision_spec.rb
 - spec/dropbox/session_spec.rb
 - spec/dropbox_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/RISCfuture/dropbox
@@ -146,6 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -1468643052692495920
       segments: 
       - 0
       version: "0"