dropbox 1.1.1 → 1.1.2

data/.gitignore

@@ -23,3 +23,4 @@ pkg
 .rvmrc
 
 ## PROJECT::SPECIFIC
+keys.json

data/ChangeLog

@@ -1,3 +1,15 @@
+1.1.2 (2010-10-6)
+
+* Added ability to perform OAuth authorization on behalf of the user.
+* Specs now test authorization against actual Dropbox API server.
+
+1.1.1 (2010-09-22)
+
+* http-proxy support added.
+* Session now persists SSL attribute.
+* Core extensions moved to a namespaced path to prevent conflicts.
+* Minor bug fixes.
+
 1.1.0 (2010-05-27)
 
 * Added thumbnails API method.

data/README.rdoc

@@ -75,6 +75,11 @@ account, and then upload a file to their Dropbox.
 
 == Testing Your Code
 
+The gem is fully specced. Run specs with +rake spec+. Before doing so, you will
+need to create a file called +keys.json+ in the project root containing your
+Dropbox API key and secret, as well as the email and password for a Dropbox
+account. See the +keys.json.example+ file to get started.
+
 fguillen has implemented a mock of the Dropbox API server:
 http://github.com/fguillen/DummyDropbox
 

data/Rakefile

@@ -17,6 +17,7 @@ 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.add_runtime_dependency "mechanize", ">= 1.0.0"
   end
   Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/dropbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dropbox}
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Morgan"]
-  s.date = %q{2010-09-22}
+  s.date = %q{2010-10-06}
   s.description = %q{An easy-to-use client library for the official Dropbox API.}
   s.email = %q{dropbox@timothymorgan.info}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "dropbox.gemspec",
+     "keys.json.example",
      "lib/dropbox.rb",
      "lib/dropbox/api.rb",
      "lib/dropbox/entry.rb",
@@ -72,17 +73,20 @@ Gem::Specification.new do |s|
       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"])
+    s.add_dependency(%q<mechanize>, [">= 1.0.0"])
   end
 end
 

data/keys.json.example

@@ -0,0 +1,6 @@
+{
+  "key": "abc123456789012",
+  "secret": "abc123456789012",
+  "email": "my@email.com",
+  "password": "mypassword123"
+}

data/lib/dropbox/session.rb

@@ -1,6 +1,7 @@
 # Defines the Dropbox::Session class.
 
 require 'oauth'
+require 'mechanize'
 
 module Dropbox
 
@@ -47,6 +48,11 @@ module Dropbox
 
   class Session
     include API
+    
+    # The email of a Dropbox account to automatically authorize.
+    attr_accessor :authorizing_user
+    # The password of a Dropbox account to automatically authorize.
+    attr_accessor :authorizing_password
 
     # Begins the authorization process. Provide the OAuth key and secret of your
     # API account, assigned by Dropbox. This is the first step in the
@@ -55,9 +61,18 @@ module Dropbox
     # Options:
     #
     # +ssl+:: If true, uses SSL to connect to the Dropbox API server.
+    # +authorizing_user+:: The email of a Dropbox account to automatically
+    #                      authorize.
+    # +authorizing_password+:: The password of a Dropbox account to
+    #                          automatically authorize.
 
     def initialize(oauth_key, oauth_secret, options={})
       @ssl = options[:ssl].to_bool
+
+      # necessary for the automatic authorization in #authorize!
+      @authorizing_user = options[:authorizing_user] if options[:authorizing_user]
+      @authorizing_password = options[:authorizing_password] if options[:authorizing_password]
+
       @proxy = options[:proxy] || ENV["HTTP_PROXY"] || ENV["http_proxy"]
       @proxy = nil if options[:noproxy].to_bool
       @consumer = OAuth::Consumer.new(oauth_key, oauth_secret,
@@ -103,6 +118,32 @@ module Dropbox
     def authorized?
       @access_token.to_bool
     end
+    
+    # Automatically complete the authorization step of the OAuth process. You
+    # must have provided the +authorizing_user+ and +authorizing_password+
+    # options. Raises a Dropbox::UnauthorizedError on failure.
+    
+    def authorize!
+      begin
+        a = Mechanize.new
+        a.get(authorize_url) do |page|
+          login_form = page.form_with(:action => '/login')
+
+          login_form.login_email  = @authorizing_user
+          login_form.login_password = @authorizing_password
+          auth_page = login_form.submit()
+
+          auth_form = auth_page.form_with(:action => 'authorize')
+          if auth_form
+            auth_button = auth_form.button_with(:value => "Allow")
+            auth_form.click_button
+          end
+        end
+      rescue OAuth::Unauthorized => e
+        raise Dropbox::UnauthorizedError
+      end
+      authorize
+    end
 
     # Serializes this object into a string that can then be recreated with the
     # Dropbox::Session.deserialize method.
@@ -114,7 +155,7 @@ module Dropbox
         [ @consumer.key, @consumer.secret, authorized?, @request_token.token, @request_token.secret, @ssl ].to_yaml
       end
     end
-    
+
     # Deserializes an instance from a string created from the serialize method.
     # Returns the recreated instance.
 
@@ -128,7 +169,7 @@ module Dropbox
       else
         session.instance_variable_set :@request_token, OAuth::RequestToken.new(session.instance_variable_get(:@consumer), token, token_secret)
       end
-      
+
       return session
     end
 

data/spec/dropbox/session_spec.rb

@@ -15,7 +15,7 @@ describe Dropbox::Session do
 
       Dropbox::Session.new(key, secret)
     end
-    
+
     it "should use the SSL host if :ssl => true is given" do
       key = 'test_key'
       secret = 'test_secret'
@@ -29,7 +29,7 @@ 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'
@@ -117,10 +117,6 @@ describe Dropbox::Session do
     end
   end
 
-  describe "#authorized?" do
-    #TODO this method remains opaque for purposes of testing
-  end
-
   describe "#serialize" do
     before :each do
       @consumer_mock = mock("OAuth::Consumer")
@@ -138,7 +134,7 @@ describe Dropbox::Session do
 
       @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")
@@ -148,34 +144,95 @@ describe Dropbox::Session do
 
       @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
-      pending "access token is opaque"
-    end
   end
 
   describe ".deserialize" do
+    before :each do
+      @mock_session = mock('Dropbox::Session')
+    end
+
     it "should raise an error if an improper YAML is provided" do
       lambda { Dropbox::Session.deserialize([ 1, 2, 3].to_yaml) }.should raise_error(ArgumentError)
     end
 
     it "should return a properly initialized unauthorized instance" do
-      mock_session = mock('Dropbox::Session')
-      Dropbox::Session.should_receive(:new).once.with('key', 'secret', :ssl => true).and_return(mock_session)
-      
-      Dropbox::Session.deserialize([ 'key', 'secret', false, 'a', 'b', true ].to_yaml).should eql(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', 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)
+      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
+  end
+
+  describe "with Dropbox keys " do
+    before(:all) do
+      @keys = read_keys_file
+    end
+
+    def new_session
+      Dropbox::Session.new(@keys['key'], @keys['secret'], :authorizing_user => @keys['email'], :authorizing_password => @keys['password'])
+    end
+
+    describe "#authorized?" do
+      before(:each) do
+        @session = new_session
+      end
+
+      it "should be false for sessions that have not been authorized" do
+        @session.should_not be_authorized
+      end
+
+      it "should be true for sessions that have been authorized" do
+        @session.authorize!
+        @session.should be_authorized
+      end
+    end
+
+    describe "#authorize!" do
+      describe "with credentials" do
+        before(:each) do
+          @session = new_session
+        end
+
+        it "should not fail" do
+          lambda { @session.authorize! }.should_not raise_error
+        end
+
+        it "should return the result of #authorize" do
+          @session.should_receive(:authorize).and_return("winner!")
+          @session.authorize!.should == "winner!"
+        end
+      end
+
+      describe "with no credentials" do
+        it "should fail" do
+          @session = Dropbox::Session.new(@keys['key'], @keys['password'])
+          lambda { @session.authorize! }.should raise_error
+        end
+      end
+    end
+
+    describe ".deserialize" do
+      it "should return a properly initialized authorized instance" do
+        @session = new_session
+        @session.authorize!.should be_true
+        @session_clone = Dropbox::Session.deserialize(@session.serialize)
+
+        @session.serialize.should == @session_clone.serialize
+      end
     end
 
-    it "should return a properly initialized authorized instance" do
-      pending "access token remains opaque for purposes of testing"
+    describe "#serialize" do
+      it "should return the consumer key and secret and the access token and secret in YAML form if authorized" do
+        @session = new_session
+        @session.authorize!.should be_true
+        @session.serialize.should eql([ @keys['key'], @keys['secret'], true, @session.send(:access_token).token, @session.send(:access_token).secret, false ].to_yaml)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,22 @@ require 'dropbox.rb'
 require 'spec'
 require 'spec/autorun'
 
+module ExternalKeysFileHelper
+  def read_keys_file
+    unless File.exist?('keys.json')
+      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()
+    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."
+    end
+    
+    data
+  end
+end
+
 Spec::Runner.configure do |config|
-  
+  config.include(ExternalKeysFileHelper)
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Tim Morgan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-22 00:00:00 -07:00
+date: 2010-10-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,6 +76,21 @@ dependencies:
         version: "1.0"
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id005
 description: An easy-to-use client library for the official Dropbox API.
 email: dropbox@timothymorgan.info
 executables: []
@@ -95,6 +110,7 @@ files:
 - Rakefile
 - VERSION
 - dropbox.gemspec
+- keys.json.example
 - lib/dropbox.rb
 - lib/dropbox/api.rb
 - lib/dropbox/entry.rb