rdropbox 1.0.0 → 1.1.0

data/ChangeLog

@@ -0,0 +1,10 @@
+1.1.0 (2010-05-27)
+
+* Added thumbnails API method.
+* Changed name of gem from rdropbox to dropbox.
+* Fixed potential dependency issues.
+* Documentation updates.
+
+1.0.0 (2010-05-05)
+
+* Initial release.

data/README.rdoc

@@ -2,6 +2,10 @@
 
 An easy-to-use third-party interface to the RESTful Dropbox API.
 
+== Installation
+
+ gem install dropbox
+
 == Tutorial by Example
 
 First things first: Be sure you've gotten a consumer key and secret from
@@ -12,7 +16,6 @@ http://developers.dropbox.com
  puts "Visit #{session.authorize_url} to log in to Dropbox. Hit enter when you have done this."
  gets
  session.authorize
- session.sandbox = true
 
  # STEP 2: Play!
  session.upload('testfile.txt')
@@ -48,7 +51,7 @@ account, and then upload a file to their Dropbox.
      return redirect_to(:action => 'authorize') unless dropbox_session.authorized?
 
      if request.method == :post then
-       dropbox_session.upload params[:file], 'My Uploads', :sandbox => true
+       dropbox_session.upload params[:file], 'My Uploads'
        render :text => 'Uploaded OK'
      else
        # display a multipart file field form
@@ -67,6 +70,8 @@ account, and then upload a file to their Dropbox.
 * The Dropbox::Memoization module has some handy utility methods for memoizing
   server responses to reduce network calls. It's plug-in compatible with any
   caching strategy you might already have (memcache, etc.).
+* If you're using pingbacks, check out Dropbox::Event and Dropbox::Revision.
+  Those classes parse pingbacks from Dropbox into Ruby objects.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -17,8 +17,6 @@ begin
     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.rubyforge_project = "dropbox"
   end
   Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/dropbox.rb

@@ -1,3 +1,7 @@
+$stderr.puts "DEPRECATION NOTICE: The rdropbox gem has been renamed dropbox."
+$stderr.puts "Please uninstall this gem and install dropbox instead."
+$stderr.puts "Future updates will only be pushed to the dropbox gemspec."
+
 # Defines the Dropbox module.
 
 require 'cgi'
@@ -8,8 +12,19 @@ require 'set'
 require 'time'
 require 'tempfile'
 
-Dir.glob("#{File.expand_path File.dirname(__FILE__)}/extensions/*.rb") { |file| require file }
-Dir.glob("#{File.expand_path File.dirname(__FILE__)}/dropbox/*.rb") { |file| require file }
+require 'extensions/array'
+require 'extensions/hash'
+require 'extensions/module'
+require 'extensions/object'
+require 'extensions/string'
+require 'extensions/to_bool'
+
+require 'dropbox/memoization'
+require 'dropbox/api'
+require 'dropbox/entry'
+require 'dropbox/event'
+require 'dropbox/revision'
+require 'dropbox/session'
 
 # Container module for the all Dropbox API classes.
 
@@ -21,9 +36,17 @@ module Dropbox
   # The SSL host serving API requests.
   SSL_HOST = "https://api.dropbox.com"
   # Alternate hosts for other API requests.
-  ALTERNATE_HOSTS = { 'event_content' => 'http://api-content.dropbox.com', 'files' => "http://api-content.dropbox.com" }
+  ALTERNATE_HOSTS = {
+    'event_content' => 'http://api-content.dropbox.com',
+    'files' => 'http://api-content.dropbox.com',
+    'thumbnails' => 'http://api-content.dropbox.com'
+  }
   # Alternate SSL hosts for other API requests.
-  ALTERNATE_SSL_HOSTS = { 'event_content' => 'https://api-content.dropbox.com', 'files' => "https://api-content.dropbox.com" }
+  ALTERNATE_SSL_HOSTS = {
+    'event_content' => 'https://api-content.dropbox.com',
+    'files' => 'https://api-content.dropbox.com',
+    'thumbnails' => 'https://api-content.dropbox.com'
+  }
 
   def self.api_url(*paths_and_options) # :nodoc:
     params = paths_and_options.extract_options!

data/lib/dropbox/api.rb

@@ -1,6 +1,5 @@
 # Defines the Dropbox::API module.
 
-require "#{File.expand_path File.dirname(__FILE__)}/memoization"
 require 'json'
 require 'net/http/post/multipart'
 
@@ -29,9 +28,9 @@ module Dropbox
   #   are inaccessible.
   # * In Dropbox mode, the root is the user's Dropbox folder, and all files are
   #   accessible. This mode is typically only available to certain API users.
-  # * In metadata-only mode, the root is the Dropbox folder, but read-only
-  #   access is not available. Operations that modify the user's files will
-  #  fail.
+  # * In metadata-only mode, the root is the Dropbox folder, but write access
+  #   is not available. Operations that modify the user's files will
+  #   fail.
   #
   # You should configure the Dropbox::Session instance to use whichever mode
   # you chose when you set up your application:
@@ -63,8 +62,8 @@ module Dropbox
     alias :dir :entry
 
     # Returns a +Struct+ with information about the user's account. See
-    # http://developers.dropbox.com/python/base.html#account-info for more
-    # information on the data returned.
+    # https://www.dropbox.com/developers/docs#account-info for more information
+    # on the data returned.
 
     def account
       get('account', 'info', :ssl => @ssl).to_struct_recursively
@@ -89,6 +88,53 @@ 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
+    # size specifiers.
+    #
+    # Returns the content of the thumbnail image as a +String+. The thumbnail
+    # data is in JPEG format. Returns +nil+ if the file does not have a
+    # thumbnail. You can check if a file has a thumbnail using the metadata
+    # method.
+    #
+    # Because of the way this API method works, if you pass in the name of a
+    # file that does not exist, you will not receive a 404, but instead just get
+    # +nil+.
+    #
+    # Options:
+    #
+    # +mode+:: Temporarily changes the API mode. See the MODES array.
+    #
+    # Examples:
+    #
+    # Get the thumbnail for an image (default thunmbnail size):
+    #
+    #  session.thumbnail('my/image.jpg')
+    #
+    # 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?
+      
+      path.sub! /^\//, ''
+      rest = Dropbox.check_path(path).split('/')
+      rest << { :ssl => @ssl }
+      rest.last[:size] = size if size
+      
+      begin
+        api_body :get, 'thumbnails', root(options), *rest
+      rescue Dropbox::UnsuccessfulResponseError => e
+        raise unless e.response.code.to_i == 404
+        return nil
+      end
+    end
 
     # Uploads a file to a path relative to the configured mode's root. The
     # +remote_path+ parameter is taken to be the path portion _only_; the name
@@ -314,7 +360,7 @@ module Dropbox
     # true).
     #
     # For information on the schema of the return struct, see the Dropbox API
-    # at http://developers.dropbox.com/python/base.html#metadata
+    # at https://www.dropbox.com/developers/docs#metadata
     #
     # The +modified+ key will be converted into a +Time+ instance. The +is_dir+
     # key will also be available as <tt>directory?</tt>.

data/lib/dropbox/entry.rb

@@ -82,6 +82,12 @@ module Dropbox
       @session.download path, options
     end
     alias :body :download
+    
+    # Delegates to Dropbox::API#thumbnail.
+    
+    def thumbnail(*args)
+      @session.thumbnail path, *args
+    end
 
     # Delegates to Dropbox::API#link.
 
@@ -93,4 +99,4 @@ module Dropbox
       "#<#{self.class.to_s} #{path}>"
     end
   end
-end
+end

data/lib/dropbox/event.rb

@@ -96,7 +96,6 @@ module Dropbox
     end
 
     def process_metadata(metadata)
-      p metadata
       metadata.each do |user_id, namespaces|
         namespaces.each do |namespace_id, journals|
           journals.each do |journal_id, attributes|

data/{dropbox.gemspec → rdropbox.gemspec}

@@ -4,26 +4,27 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{dropbox}
-  s.version = "1.0.0"
+  s.name = %q{rdropbox}
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Morgan"]
-  s.date = %q{2010-05-05}
-  s.description = %q{An easy-to-use interface to the RESTful Dropbox API.}
+  s.date = %q{2010-05-27}
+  s.description = %q{An easy-to-use client library for the official Dropbox API.}
   s.email = %q{dropbox@timothymorgan.info}
   s.extra_rdoc_files = [
-    "LICENSE",
+    "ChangeLog",
+     "LICENSE",
      "README.rdoc"
   ]
   s.files = [
     ".document",
      ".gitignore",
+     "ChangeLog",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "dropbox.gemspec",
      "lib/dropbox.rb",
      "lib/dropbox/api.rb",
      "lib/dropbox/entry.rb",
@@ -37,6 +38,7 @@ Gem::Specification.new do |s|
      "lib/extensions/object.rb",
      "lib/extensions/string.rb",
      "lib/extensions/to_bool.rb",
+     "rdropbox.gemspec",
      "spec/dropbox/api_spec.rb",
      "spec/dropbox/entry_spec.rb",
      "spec/dropbox/event_spec.rb",
@@ -49,9 +51,8 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/RISCfuture/dropbox}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{dropbox}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Ruby Dropbox interface}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby client library for the official Dropbox API}
   s.test_files = [
     "spec/dropbox/api_spec.rb",
      "spec/dropbox/entry_spec.rb",
@@ -66,7 +67,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    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"])

data/spec/dropbox/api_spec.rb

@@ -96,6 +96,63 @@ describe Dropbox::API do
       @session.download(path)
     end
   end
+  
+  describe "#thumbnail" do
+    it "should call the thumbnails API method" do
+      should_receive_api_method_with_arguments @token_mock, :get, 'thumbnails', {}, @response, 'path/to/file', 'sandbox'
+      @session.thumbnail "path/to/file"
+    end
+
+    it "should strip a leading slash" do
+      should_receive_api_method_with_arguments @token_mock, :get, 'thumbnails', {}, @response, 'path/to/file', 'sandbox'
+      @session.thumbnail "/path/to/file"
+    end
+
+    it "should return the body of the response" do
+      @token_mock.stub!(:get).and_return(@response)
+      @session.thumbnail("path/to/file").should eql("response body")
+    end
+
+    it "should check the path" do
+      path = "test/path"
+      Dropbox.should_receive(:check_path).once.with(path).and_return(path)
+      @token_mock.stub!(:get).and_return(@response)
+
+      @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
+    
+    it "should raise an error if invalid arguments are given" do
+      lambda { @session.thumbnail "path/to/file", 'large', :not_string }.should raise_error(ArgumentError)
+      lambda { @session.thumbnail "path/to/file", 'large', 'oops', 'not_hash' }.should raise_error(ArgumentError)
+    end
+    
+    it "should return nil if a 404 is received" do
+      request_mock = mock('Request')
+      response_mock = mock('Response', :code => '404')
+      error = Dropbox::UnsuccessfulResponseError.new(request_mock, response_mock)
+      @token_mock.stub!(:get).and_raise(error)
+      
+      @session.thumbnail('foo').should be_nil
+    end
+    
+    it "should raise any other response codes" do
+      request_mock = mock('Request')
+      response_mock = mock('Response', :code => '500')
+      error = Dropbox::UnsuccessfulResponseError.new(request_mock, response_mock)
+      @token_mock.stub!(:get).and_raise(error)
+      
+      lambda { @session.thumbnail('foo') }.should raise_error(Dropbox::UnsuccessfulResponseError)
+    end
+  end
 
   describe "#copy" do
     before :each do

data/spec/dropbox/entry_spec.rb

@@ -125,6 +125,36 @@ describe Dropbox::Entry do
       @entry.download(:sandbox => true)
     end
   end
+  
+  describe "#thumbnail" do
+    it "should delegate to the session and return the result" do
+      result = mock('result')
+      @session.should_receive(:thumbnail).once.with(@path).and_return(result)
+
+      @entry.thumbnail.should eql(result)
+    end
+    
+    it "should pass along a size" do
+      result = mock('result')
+      @session.should_receive(:thumbnail).once.with(@path, 'medium').and_return(result)
+
+      @entry.thumbnail('medium').should eql(result)
+    end
+
+    it "should pass along options" do
+      result = mock('result')
+      @session.should_receive(:thumbnail).once.with(@path, { :sandbox => true }).and_return(result)
+
+      @entry.thumbnail(:sandbox => true).should eql(result)
+    end
+    
+    it "should pass along a size and options" do
+      result = mock('result')
+      @session.should_receive(:thumbnail).once.with(@path, 'medium', { :sandbox => true }).and_return(result)
+
+      @entry.thumbnail('medium', :sandbox => true).should eql(result)
+    end
+  end
 
   describe "#link" do
     it "should delegate to the session and return the result" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdropbox
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-05 00:00:00 -07:00
+date: 2010-05-27 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 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -35,9 +38,11 @@ dependencies:
   name: oauth
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 0
         - 3
@@ -49,9 +54,11 @@ dependencies:
   name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 1
         - 2
@@ -63,9 +70,11 @@ dependencies:
   name: multipart-post
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
@@ -79,16 +88,17 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- ChangeLog
 - LICENSE
 - README.rdoc
 files: 
 - .document
 - .gitignore
+- ChangeLog
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
-- dropbox.gemspec
 - lib/dropbox.rb
 - lib/dropbox/api.rb
 - lib/dropbox/entry.rb
@@ -102,6 +112,7 @@ files:
 - lib/extensions/object.rb
 - lib/extensions/string.rb
 - lib/extensions/to_bool.rb
+- rdropbox.gemspec
 - spec/dropbox/api_spec.rb
 - spec/dropbox/entry_spec.rb
 - spec/dropbox/event_spec.rb
@@ -120,23 +131,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
-rubyforge_project: dropbox
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby client library for the official Dropbox API