fleakr 0.5.2 → 0.6.0

data/test/unit/fleakr/api/upload_request_test.rb

@@ -5,11 +5,6 @@ module Fleakr::Api
 
     context "An instance of the UploadRequest class" do
 
-      setup do
-        @secret = 'sekrit'
-        Fleakr.stubs(:shared_secret).with().returns(@secret)
-      end
-      
       should "have a collection of upload_options" do
         request = UploadRequest.new('foo', :create, {:title => 'foo', :tags => %w(a b)})
         
@@ -23,15 +18,10 @@ module Fleakr::Api
       
       should "create a file parameter on initialization" do
         filename = '/path/to/image.jpg'
-
-        parameter = stub()
-        FileParameter.expects(:new).with('photo', filename).returns(parameter)
-
-        parameter_list = mock()
-        parameter_list.expects(:<<).with(parameter)
         
-        ParameterList.expects(:new).with({}).returns(parameter_list)
-
+        parameter_list = mock() {|p| p.expects(:add_upload_option).with(:photo, filename) }
+        UploadRequest.any_instance.stubs(:parameters).with().returns(parameter_list)
+        
         UploadRequest.new(filename)
       end
       
@@ -41,14 +31,14 @@ module Fleakr::Api
         
         Option.expects(:for).with(:title, 'foo').returns(option)
         
-        ParameterList.expects(:new).with({:title => 'foo'}).returns(stub(:<<))
+        ParameterList.expects(:new).with({:title => 'foo'}).returns(stub(:add_upload_option))
         
         UploadRequest.new('filename', :create, {:title => 'foo'})
       end
 
       context "after initialization" do
 
-        setup { ParameterList.stubs(:new).returns(stub(:<< => nil)) }
+        setup { ParameterList.stubs(:new).returns(stub(:add_upload_option => nil)) }
 
         should "default the type to :create" do
           request = UploadRequest.new('file')

data/test/unit/fleakr/objects/authentication_token_test.rb

@@ -41,6 +41,15 @@ module Fleakr::Objects
     
     context "An instance of the AuthenticationToken class" do
       
+      should "have an associated user" do
+        token = AuthenticationToken.new
+        token.stubs(:user_id).with().returns('1')
+        
+        User.expects(:find_by_id).with('1').returns('user')
+        
+        token.user.should == 'user'
+      end
+      
       context "when populating from an XML document" do
         
         setup do

data/test/unit/fleakr/objects/set_test.rb

@@ -4,16 +4,19 @@ module Fleakr::Objects
   class SetTest < Test::Unit::TestCase
 
     should_have_many :photos, :comments
+    
+    should_autoload_when_accessing :user_id, :with => :load_info
 
     context "The Set class" do
       
       should_find_all :sets, :by => :user_id, :call => 'photosets.getList', :path => 'rsp/photosets/photoset'
+      should_find_one :set, :by => :id, :with => :photoset_id, :call => 'photosets.getInfo', :path => 'rsp/photoset'
       
     end
 
     context "An instance of the Set class" do
       
-      context "when populating from an XML document" do
+      context "when populating from photosets.getList" do
         setup do
           @object = Set.new(Hpricot.XML(read_fixture('photosets.getList')).at('rsp/photosets/photoset'))
         end
@@ -26,6 +29,32 @@ module Fleakr::Objects
         
       end
       
+      context "when populating from photosets.getInfo" do
+        setup do
+          @object = Set.new
+          @object.populate_from(Hpricot.XML(read_fixture('photosets.getInfo')))
+        end
+        
+        should_have_a_value_for :user_id => '43955217@N05'
+      end
+      
+      should "know the URL for the photoset" do
+        s = Set.new
+        s.stubs(:user_id).with().returns('123')
+        s.stubs(:id).with().returns('456')
+        
+        s.url.should == "http://www.flickr.com/photos/123/sets/456/"
+      end
+      
+      should "be able to retrieve the user for the set" do
+        s = Set.new
+        s.stubs(:user_id).with().returns('1')
+        
+        User.expects(:find_by_id).with('1').returns('user')
+        
+        s.user.should == 'user'
+      end
+      
       should "know the primary photo in the set" do
         id    = '1'
         photo = stub()

data/test/unit/fleakr/support/object_test.rb

@@ -36,18 +36,19 @@ module Fleakr
         flickr_object = stub()
         
         response = mock_request_cycle :for => 'people.getInfo', :with => {:id => id}
-        FlickrObject.expects(:new).with(response.body).returns(flickr_object)
+        FlickrObject.expects(:new).with(response.body, :id => id).returns(flickr_object)
         
         FlickrObject.find_by_id(id).should == flickr_object
       end
       
       should "be able to pass parameters to the :find_by_id method" do
-        id = 1
-        params = {:authenticate? => true}
+        id            = 1
+        params        = {:authenticate? => true}
+        full_params   = {:id => id, :authenticate? => true}
         flickr_object = stub()
-        
-        response = mock_request_cycle :for => 'people.getInfo', :with => {:id => id, :authenticate? => true}
-        FlickrObject.expects(:new).with(response.body).returns(flickr_object)
+
+        response = mock_request_cycle :for => 'people.getInfo', :with => full_params
+        FlickrObject.expects(:new).with(response.body, full_params).returns(flickr_object)
         
         FlickrObject.find_by_id(id, params).should == flickr_object
       end
@@ -62,6 +63,11 @@ module Fleakr
         end
       end
       
+      should "be able to capture the :auth_token from options sent along to the new object" do
+        object = EmptyObject.new(nil, {:foo => 'bar', :auth_token => 'toke'})
+        object.authentication_options.should == {:auth_token => 'toke'}
+      end
+      
       context "when populating data from an XML document" do
         setup do
           xml = <<-XML

data/test/unit/fleakr/support/request_test.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+class BasicRequest
+  include Fleakr::Support::Request
+  
+  def endpoint_url
+    'http://example.com'
+  end
+  
+end
+
+module Fleakr
+  class RequestTest < Test::Unit::TestCase
+    
+    context "An instance of the BasicRequest class with the Request mix-in" do
+      
+      should "have a collection of parameters" do
+        params = {:perms => 'read'}
+        Fleakr::Api::ParameterList.expects(:new).with(params, true).returns('params')
+        
+        request = BasicRequest.new(params)
+        request.parameters.should == 'params'
+      end
+      
+      should "know not to authenticate the request if asked not to" do
+        Fleakr::Api::ParameterList.expects(:new).with({:perms => 'read'}, false).returns('params')
+        
+        request = BasicRequest.new(:perms => 'read', :authenticate? => false)
+        request.parameters.should == 'params'
+      end
+      
+      should "know the endpoint with full URL parameters" do
+        request = BasicRequest.new
+        request.parameters.stubs(:to_query).with().returns('query')
+        
+        request.endpoint_uri.to_s.should == 'http://example.com?query'
+      end
+      
+    end
+    
+  end
+end

data/test/unit/fleakr_test.rb

@@ -4,7 +4,7 @@ class FleakrTest < Test::Unit::TestCase
   
   context "The Fleakr module" do
     
-    [:api_key, :shared_secret, :mini_token, :auth_token].each do |attribute|
+    [:api_key, :shared_secret, :auth_token].each do |attribute|
       should "be able to set a value for :#{attribute}" do
         value = 'value'
         
@@ -15,7 +15,7 @@ class FleakrTest < Test::Unit::TestCase
     
     should "provide a means to find a user by his username" do
       user = stub()
-      Fleakr::Objects::User.expects(:find_by_username).with('username').returns(user)
+      Fleakr::Objects::User.expects(:find_by_username).with('username', {}).returns(user)
       Fleakr.user('username').should == user
     end
     
@@ -23,8 +23,8 @@ class FleakrTest < Test::Unit::TestCase
       user = stub()
       email = 'user@host.com'
       
-      Fleakr::Objects::User.stubs(:find_by_username).with(email).raises(Fleakr::ApiError)
-      Fleakr::Objects::User.expects(:find_by_email).with(email).returns(user)
+      Fleakr::Objects::User.stubs(:find_by_username).with(email, {}).raises(Fleakr::ApiError)
+      Fleakr::Objects::User.expects(:find_by_email).with(email, {}).returns(user)
       
       Fleakr.user(email).should == user
     end
@@ -33,9 +33,9 @@ class FleakrTest < Test::Unit::TestCase
       user = stub()
       url = 'http://flickr.com/photos/user'
       
-      Fleakr::Objects::User.stubs(:find_by_username).with(url).raises(Fleakr::ApiError)
-      Fleakr::Objects::User.stubs(:find_by_email).with(url).raises(Fleakr::ApiError)
-      Fleakr::Objects::User.expects(:find_by_url).with(url).returns(user)
+      Fleakr::Objects::User.stubs(:find_by_username).with(url, {}).raises(Fleakr::ApiError)
+      Fleakr::Objects::User.stubs(:find_by_email).with(url, {}).raises(Fleakr::ApiError)
+      Fleakr::Objects::User.expects(:find_by_url).with(url, {}).returns(user)
             
       Fleakr.user(url).should == user
     end
@@ -43,13 +43,19 @@ class FleakrTest < Test::Unit::TestCase
     should "not return nil if a user cannot be found" do
       data = 'data'
       
-      Fleakr::Objects::User.stubs(:find_by_username).with(data).raises(Fleakr::ApiError)
-      Fleakr::Objects::User.stubs(:find_by_email).with(data).raises(Fleakr::ApiError)
-      Fleakr::Objects::User.stubs(:find_by_url).with(data).raises(Fleakr::ApiError)
+      Fleakr::Objects::User.stubs(:find_by_username).with(data, {}).raises(Fleakr::ApiError)
+      Fleakr::Objects::User.stubs(:find_by_email).with(data, {}).raises(Fleakr::ApiError)
+      Fleakr::Objects::User.stubs(:find_by_url).with(data, {}).raises(Fleakr::ApiError)
             
       Fleakr.user(data).should be_nil
     end
     
+    should "provide additional options to the finder call if supplied" do
+      user = stub()
+      Fleakr::Objects::User.expects(:find_by_username).with('username', :auth_token => 'toke').returns(user)
+      Fleakr.user('username', :auth_token => 'toke').should == user
+    end
+    
     should "find all contacts for the authenticated user" do
       Fleakr::Objects::Contact.expects(:find_all).with({}).returns('contacts')
       Fleakr.contacts.should == 'contacts'
@@ -110,96 +116,36 @@ class FleakrTest < Test::Unit::TestCase
       Fleakr.upload(filename, :title => 'bop bip').should == [new_image]
     end
     
-    should "be able to reset the cached token" do
-      @token = stub()
-      Fleakr.expects(:auth_token).with().at_least_once.returns('abc123')
-      Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('abc123').times(2).returns(@token)
-      Fleakr.token # once
-      Fleakr.reset_token
-      Fleakr.token # twice
-    end
-    
-    should "not have a token by default" do
-      Fleakr.expects(:mini_token).with().returns(nil)
-      Fleakr.expects(:auth_token).with().returns(nil)
-      Fleakr.expects(:frob).with().returns(nil)
+    should "be able to generate the authorization_url with default permissions" do
+      request = stub() {|r| r.stubs(:authorization_url).with().returns('auth_url') }
+      Fleakr::Api::AuthenticationRequest.expects(:new).with(:perms => :read).returns(request)
       
-      Fleakr.token.should be(nil)
+      Fleakr.authorization_url.should == 'auth_url'
     end
     
-    [:mini_token, :auth_token, :frob].each do |attribute|
-      should "reset_token when :#{attribute} is set" do
-        Fleakr.expects(:reset_token).with().at_least_once
-        Fleakr.send("#{attribute}=".to_sym, 'value')
-      end
-    end
-    
-    context "when generating an AuthenticationToken from an auth_token string" do
-
-      setup do
-        @token = stub()
-        
-        Fleakr.expects(:auth_token).with().at_least_once.returns('abc123')
-        Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('abc123').returns(@token)
-      end
-
-      # Make sure to clear the cache
-      teardown { Fleakr.auth_token = nil }
-      
-      should "return the token" do
-        Fleakr.token.should == @token
-      end
+    should "be able to specify different permissions when generating the authorization_url" do
+      request = stub() {|r| r.stubs(:authorization_url).with().returns('auth_url') }
+      Fleakr::Api::AuthenticationRequest.expects(:new).with(:perms => :delete).returns(request)
       
-      should "cache the result" do
-        2.times { Fleakr.token }
-      end
-
+      Fleakr.authorization_url(:delete).should == 'auth_url'
+    end
+   
+    should "be able to retrieve a token from the provided frob" do
+      Fleakr::Objects::AuthenticationToken.expects(:from_frob).with('frob').returns('toke')
+      Fleakr.token_from_frob('frob').should == 'toke'
     end
     
-    context "when generating an AuthenticationToken from a frob string" do
-
-      setup do
-        @token = stub()
-        
-        Fleakr.expects(:auth_token).with().at_least_once.returns(nil)
-        Fleakr.expects(:frob).with().at_least_once.returns('abc123')
-        Fleakr::Objects::AuthenticationToken.expects(:from_frob).with('abc123').returns(@token)
-      end
-
-      # Make sure to clear the cache
-      teardown { Fleakr.frob = nil }
-      
-      should "return the token" do
-        Fleakr.token.should == @token
-      end
-      
-      should "cache the result" do
-        2.times { Fleakr.token }
-      end
-
+    should "be able to retrieve a token from the provided mini-token" do
+      Fleakr::Objects::AuthenticationToken.expects(:from_mini_token).with('mini_token').returns('toke')
+      Fleakr.token_from_mini_token('mini_token').should == 'toke'
     end
     
-    context "when generating an AuthenticationToken from a mini_token string" do
-      
-      setup do
-        @token = stub()
-
-        Fleakr.expects(:auth_token).with().at_least_once.returns(nil)
-        Fleakr.expects(:mini_token).with().at_least_once.returns('123-123-123')
-        Fleakr::Objects::AuthenticationToken.expects(:from_mini_token).with('123-123-123').returns(@token)          
-      end
+    should "be able to get the user for the provided auth token" do
+      token = stub() {|t| t.stubs(:user).with().returns('user') }
       
-      # Make sure to clear the cache
-      teardown { Fleakr.mini_token = nil }
-      
-      should "return the token" do
-        Fleakr.token.should == @token
-      end
-      
-      should "cache the result" do
-        2.times { Fleakr.token }
-      end
+      Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('toke').returns(token)
       
+      Fleakr.user_for_token('toke').should == 'user'
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-18 00:00:00 -04:00
+date: 2009-10-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,10 +53,10 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
+- lib/fleakr/api/authentication_request.rb
 - lib/fleakr/api/file_parameter.rb
 - lib/fleakr/api/method_request.rb
 - lib/fleakr/api/option.rb
-- lib/fleakr/api/parameter.rb
 - lib/fleakr/api/parameter_list.rb
 - lib/fleakr/api/response.rb
 - lib/fleakr/api/upload_request.rb
@@ -82,6 +82,7 @@ files:
 - lib/fleakr/objects.rb
 - lib/fleakr/support/attribute.rb
 - lib/fleakr/support/object.rb
+- lib/fleakr/support/request.rb
 - lib/fleakr/support.rb
 - lib/fleakr/version.rb
 - lib/fleakr.rb
@@ -104,6 +105,7 @@ files:
 - test/fixtures/photos.getSizes.xml
 - test/fixtures/photos.search.xml
 - test/fixtures/photosets.comments.getList.xml
+- test/fixtures/photosets.getInfo.xml
 - test/fixtures/photosets.getList.xml
 - test/fixtures/photosets.getPhotos.xml
 - test/fixtures/tags.getListPhoto.xml
@@ -111,11 +113,11 @@ files:
 - test/fixtures/tags.getRelated.xml
 - test/fixtures/urls.lookupUser.xml
 - test/test_helper.rb
+- test/unit/fleakr/api/authentication_request_test.rb
 - test/unit/fleakr/api/file_parameter_test.rb
 - test/unit/fleakr/api/method_request_test.rb
 - test/unit/fleakr/api/option_test.rb
 - test/unit/fleakr/api/parameter_list_test.rb
-- test/unit/fleakr/api/parameter_test.rb
 - test/unit/fleakr/api/response_test.rb
 - test/unit/fleakr/api/upload_request_test.rb
 - test/unit/fleakr/api/value_parameter_test.rb
@@ -137,6 +139,7 @@ files:
 - test/unit/fleakr/objects/user_test.rb
 - test/unit/fleakr/support/attribute_test.rb
 - test/unit/fleakr/support/object_test.rb
+- test/unit/fleakr/support/request_test.rb
 - test/unit/fleakr_test.rb
 has_rdoc: true
 homepage: http://sneaq.net

data/lib/fleakr/api/parameter.rb

@@ -1,35 +0,0 @@
-module Fleakr
-  module Api # :nodoc:
-
-    # = Parameter
-    # 
-    # Base class for other parameters that get passed to the Flickr API - see
-    # #FileParameter and #ValueParameter for examples
-    #
-    class Parameter
-     
-      attr_reader :name
-     
-      # A new named parameter (never used directly)
-      #
-      def initialize(name, include_in_signature = true)
-        @name                 = name
-        @include_in_signature = include_in_signature
-      end
-      
-      # Should this parameter be used when generating the signature?
-      #
-      def include_in_signature?
-        (@include_in_signature == true) ? true : false
-      end
-      
-      # Used for sorting when generating a signature
-      #
-      def <=>(other)
-        self.name <=> other.name
-      end
-      
-    end
-    
-  end
-end