rdropbox 1.0.0

data/spec/dropbox/session_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Dropbox::Session do
+  describe ".new" do
+    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
+
+      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)
+    end
+    
+    it "should use the SSL host if :ssl => true is given" 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::SSL_HOST
+
+      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, :ssl => true)
+    end
+
+    it "should get the request token" do
+      consumer_mock = mock('OAuth::Consumer')
+      consumer_mock.should_receive(:get_request_token).once
+      OAuth::Consumer.stub!(:new).and_return(consumer_mock)
+
+      Dropbox::Session.new('foo', 'bar')
+    end
+  end
+
+  describe "#authorize_url" do
+    before :each do
+      consumer_mock = mock("OAuth::Consumer")
+      @token_mock = mock("OAuth::RequestToken")
+      consumer_mock.stub!(:get_request_token).and_return(@token_mock)
+      OAuth::Consumer.stub!(:new).and_return(consumer_mock)
+      @session = Dropbox::Session.new('foo', 'bar')
+    end
+
+    it "should raise an error if the session is already authorized" do
+      @session.stub!(:authorized?).and_return(true)
+
+      lambda { @session.authorize_url }.should raise_error(Dropbox::AlreadyAuthorizedError)
+    end
+
+    it "should call authorize_url on the request token" do
+      @token_mock.should_receive(:authorize_url).once
+      @session.authorize_url
+    end
+
+    it "should pass all parameters to the request token" do
+      @token_mock.should_receive(:authorize_url).once.with(:a, 'b', :c => 123)
+      @session.authorize_url(:a, 'b', :c => 123)
+    end
+  end
+
+  describe "#authorize" do
+    before :each do
+      consumer_mock = mock("OAuth::Consumer")
+      @token_mock = mock("OAuth::RequestToken")
+      consumer_mock.stub!(:get_request_token).and_return(@token_mock)
+      OAuth::Consumer.stub!(:new).and_return(consumer_mock)
+      @session = Dropbox::Session.new('foo', 'bar')
+    end
+
+    it "should call get_access_token on the request_token and pass the given options" do
+      options = { :foo => 'bar' }
+      @token_mock.should_receive(:get_access_token).once.with(options)
+      @session.authorize(options)
+    end
+
+    it "should make authorized? return true if an access token is returned" do
+      @token_mock.stub!(:get_access_token).and_return(Object.new)
+      @session.authorize({ 'foo' => 'bar' })
+      @session.should be_authorized
+    end
+
+    it "should make authorized? return false if no access token is returned" do
+      @token_mock.stub!(:get_access_token).and_return(nil)
+      @session.authorize({ 'foo' => 'bar' })
+      @session.should_not be_authorized
+    end
+
+    it "should return true if authorized" do
+      @token_mock.stub!(:get_access_token).and_return(Object.new)
+      @session.authorize({ 'foo' => 'bar' }).should be_true
+    end
+
+    it "should return false if unauthorized" do
+      @token_mock.stub!(:get_access_token).and_return(nil)
+      @session.authorize({ 'foo' => 'bar' }).should be_false
+    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")
+      @token_mock = mock("OAuth::RequestToken")
+      @consumer_mock.stub!(:get_request_token).and_return(@token_mock)
+      OAuth::Consumer.stub!(:new).and_return(@consumer_mock)
+      @session = Dropbox::Session.new('foo', 'bar')
+    end
+
+    it "should return the consumer key and secret and the request token and secret in YAML form if unauthorized" do
+      @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" ].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
+    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').and_return(mock_session)
+      
+      Dropbox::Session.deserialize([ 'key', 'secret', false, 'a', 'b' ].to_yaml).should eql(mock_session)
+      #TODO request token remains opaque for purposes of testing
+    end
+
+    it "should return a properly initialized authorized instance" do
+      pending "access token remains opaque for purposes of testing"
+    end
+  end
+end

data/spec/dropbox_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dropbox do
+  describe ".api_url" do
+    before :each do
+      @prefix = "#{Dropbox::HOST}/#{Dropbox::VERSION}/"
+    end
+    
+    it "should use the HOST and VERSION" do
+      Dropbox.api_url.should eql(@prefix)
+    end
+    
+    it "should use the SSL_HOST if :ssl => true is given" do
+      Dropbox.api_url(:ssl => true).should eql("#{Dropbox::SSL_HOST}/#{Dropbox::VERSION}/")
+    end
+
+    it "should concatenate path elements with slashes" do
+      Dropbox.api_url("foo", :bar, 123).should eql(@prefix + "foo/bar/123")
+    end
+
+    it "should use the trailing hash as query params" do
+      [ @prefix + "foo/bar?string=val&hash=123", @prefix + "foo/bar?hash=123&string=val" ].should include(Dropbox.api_url("foo", :bar, 'string' => 'val', :hash => 123))
+    end
+    
+    it "should strip the :ssl option from query params" do
+      prefix = "#{Dropbox::SSL_HOST}/#{Dropbox::VERSION}/"
+      [ prefix + "foo/bar?string=val&hash=123", prefix + "foo/bar?hash=123&string=val" ].should include(Dropbox.api_url("foo", :bar, 'string' => 'val', :hash => 123, :ssl => true))
+    end
+
+    it "should CGI-escape path elements and query parameters" do
+      Dropbox.api_url("foo space", "amp&ersand" => 'eq=uals').should eql(@prefix + "foo%20space?amp%26ersand=eq%3Duals")
+    end
+    
+    it "should use the alternate host if supplied" do
+      Dropbox.api_url('files').should eql("#{Dropbox::ALTERNATE_HOSTS['files']}/#{Dropbox::VERSION}/files")
+    end
+    
+    it "should use the alternate SSL host if :ssl => true is given" do
+      Dropbox.api_url('files', :ssl => true).should eql("#{Dropbox::ALTERNATE_SSL_HOSTS['files']}/#{Dropbox::VERSION}/files")
+    end
+  end
+
+  describe ".check_path" do
+    it "should raise an exception if the path contains a backslash" do
+      lambda { Dropbox.check_path "hello\\there" }.should raise_error(ArgumentError)
+    end
+
+    it "should raise an exception if the path is longer than 256 characters" do
+      lambda { Dropbox.check_path "a"*257 }.should raise_error(ArgumentError)
+    end
+
+    it "should otherwise return the path unchanged" do
+      path = "valid path/here"
+      lambda { Dropbox.check_path(path).should eql(path) }.should_not raise_error
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color -fs

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$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'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: rdropbox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    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 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id004
+description: An easy-to-use client library for the official Dropbox API.
+email: dropbox@timothymorgan.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- dropbox.gemspec
+- lib/dropbox.rb
+- lib/dropbox/api.rb
+- lib/dropbox/entry.rb
+- lib/dropbox/event.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
+- 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
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: dropbox
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby client library for the official Dropbox API
+test_files: 
+- spec/dropbox/api_spec.rb
+- spec/dropbox/entry_spec.rb
+- spec/dropbox/event_spec.rb
+- spec/dropbox/revision_spec.rb
+- spec/dropbox/session_spec.rb
+- spec/dropbox_spec.rb
+- spec/spec_helper.rb