fleakr 0.6.3 → 0.7.0

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

@@ -1,46 +1,60 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path('../../../../test_helper', __FILE__)
 
 class EmptyObject
   include Fleakr::Support::Object
 end
 
 class FlickrObject
-  
+
   include Fleakr::Support::Object
-  
+
   flickr_attribute :name
   flickr_attribute :description, :from => 'desc'
   flickr_attribute :id, :from => '@nsid'
   flickr_attribute :photoset_id, :from => 'photoset@id'
   flickr_attribute :tag, :category
-  
+
   find_one :by_id, :call => 'people.getInfo'
-  
+
+  has_many :associated_objects
+
+end
+
+module Fleakr
+  module Objects
+    class AssociatedObject
+
+      include Fleakr::Support::Object
+
+      find_all :by_flickr_object_id, :call => 'object.bogus'
+
+    end
+  end
 end
 
 module Fleakr
   class ObjectTest < Test::Unit::TestCase
-    
+
     context "A class method provided by the Flickr::Object module" do
-   
+
       should "have an empty list of attributes if none are supplied" do
         EmptyObject.attributes.should == []
       end
-      
+
       should "know the names of all its attributes" do
         FlickrObject.attributes.map {|a| a.name.to_s }.should == %w(name description id photoset_id tag category)
       end
-      
+
       should "be able to find by ID" do
         id = 1
         flickr_object = stub()
-        
+
         response = mock_request_cycle :for => 'people.getInfo', :with => {:id => id}
         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}
@@ -49,25 +63,55 @@ module Fleakr
 
         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
-      
+
     end
-    
+
     context "An instance method provided by the Flickr::Object module" do
-      
+
       should "have default reader methods" do
         [:name, :description, :id, :photoset_id, :tag, :category].each do |method_name|
           FlickrObject.new.respond_to?(method_name).should == true
         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
-      
+
+      should "be able to pass parameters to the association" do
+        object = FlickrObject.new
+        object.stubs(:authentication_options).with().returns({'key' => 'value'})
+        object.stubs(:id).returns('1')
+
+        Fleakr::Objects::AssociatedObject.expects(:find_all_by_flickr_object_id).with('1', {'key' => 'value', :per_page => '100'}).returns('collection')
+
+        object.associated_objects(:per_page => '100').should == 'collection'
+      end
+
+      should "cache the results of the association" do
+        object = FlickrObject.new
+        object.stubs(:id).returns('1')
+
+        Fleakr::Objects::AssociatedObject.expects(:find_all_by_flickr_object_id).with('1', {}).once.returns('collection')
+
+        2.times { object.associated_objects }
+      end
+
+      should "know not to cache the results of the association when there are different parameters" do
+        object = FlickrObject.new
+        object.stubs(:id).returns('1')
+
+        Fleakr::Objects::AssociatedObject.stubs(:find_all_by_flickr_object_id).with('1', {}).returns('collection_1')
+        Fleakr::Objects::AssociatedObject.stubs(:find_all_by_flickr_object_id).with('1', {:per_page => '100'}).returns('collection_2')
+
+        object.associated_objects.should == 'collection_1'
+        object.associated_objects(:per_page => '100').should == 'collection_2'
+      end
+
       context "when populating data from an XML document" do
         setup do
           xml = <<-XML
@@ -83,59 +127,59 @@ module Fleakr
           @object = FlickrObject.new
           @object.populate_from(@document)
         end
-        
+
         should "have the correct value for :name" do
           @object.name.should == 'Fleakr'
         end
-        
+
         should "have the correct value for :description" do
           @object.description.should == 'Awesome'
         end
-        
+
         should "have the correct value for :photoset_id" do
           @object.photoset_id.should == '1'
         end
-        
+
         should "have the correct value for :id" do
           document = Hpricot.XML('<object nsid="1" />').at('object')
           @object.populate_from(document)
-          
+
           @object.id.should == '1'
         end
-        
+
         should "have the correct value for :tag" do
           @object.tag.should == 'Tag'
         end
-        
+
         should "have the correct value for :category" do
           @object.category.should == 'Category'
         end
-        
+
         should "maintain a reference to the original document" do
           @object.document.should == @document
         end
       end
-      
+
       should "populate its data from an XML document when initializing" do
         document = stub()
         FlickrObject.any_instance.expects(:populate_from).with(document)
-        
+
         FlickrObject.new(document)
       end
-      
+
       should "not attempt to populate itself from an XML document if one is not available" do
         FlickrObject.any_instance.expects(:populate_from).never
         FlickrObject.new
       end
-      
+
       should "not overwrite existing attributes when pulling in a partial new XML document" do
         object = FlickrObject.new(Hpricot.XML('<name>Fleakr</name>'))
         object.populate_from(Hpricot.XML('<desc>Awesome</desc>'))
-        
+
         object.name.should == 'Fleakr'
       end
-      
+
     end
-    
+
   end
 end

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

@@ -1,42 +1,42 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path('../../../../test_helper', __FILE__)
 
 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/support/url_expander_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+module Fleakr
+  module Support
+
+    class UrlExpanderTest < Test::Unit::TestCase
+
+      context "The UrlExpander class" do
+
+        should "be able to expand a URL" do
+          expander = stub() {|e| e.stubs(:expanded_path).with().returns('/expanded/path') }
+          UrlExpander.stubs(:new).with('url').returns(expander)
+
+          UrlExpander.expand('url').should == '/expanded/path'
+        end
+
+      end
+
+      context "An instance of the UrlExpander class" do
+
+        should "know the path that needs to be expanded" do
+          expander = UrlExpander.new('http://flic.kr/p/7a9yQV')
+          expander.path_to_expand.should == '/photo.gne?short=7a9yQV'
+        end
+
+        should "know the expanded path" do
+          response = stub()
+          client   = stub()
+
+          response.stubs(:[]).with('location').returns('/expanded/path')
+          client.stubs(:head).with('/photo.gne?short=7a9yQV').returns(response)
+
+          Net::HTTP.stubs(:start).with('www.flickr.com', 80).yields(client)
+
+          expander = UrlExpander.new('http://flic.kr/p/7a9yQV')
+          expander.expanded_path.should == '/expanded/path'
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,70 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+module Fleakr::Support
+  class UtilityTest < Test::Unit::TestCase
+
+    context "The Utility class" do
+
+      should "know the module and class name for a simple string" do
+        Utility.class_name_for('Module', 'foo').should == 'Module::Foo'
+      end
+
+      should "know the module and class name for a symbol" do
+        Utility.class_name_for('Module', :foo).should == 'Module::Foo'
+      end
+
+      should "know the module and class name for a string that contains an underscore" do
+        Utility.class_name_for('Module', 'foo_bar').should == 'Module::FooBar'
+      end
+
+      should "know the module and class name for a pluralized string" do
+        Utility.class_name_for('Module', 'foos').should == 'Module::Foo'
+      end
+
+      should "know the ID attribute for a simple class name" do
+        Utility.id_attribute_for('Foo').should == 'foo_id'
+      end
+
+      should "know the ID attribute for a namespaced class name" do
+        Utility.id_attribute_for('Namespace::Foo').should == 'foo_id'
+      end
+
+      should "know the ID attribute for a camelcased class name" do
+        Utility.id_attribute_for('FooBar').should == 'foo_bar_id'
+      end
+
+      should "know that nil is blank" do
+        Utility.blank?(nil).should be(true)
+      end
+
+      should "know that an empty string is blank" do
+        Utility.blank?('').should be(true)
+      end
+
+      should "know that a string with just spaces is blank" do
+        Utility.blank?(' ').should be(true)
+      end
+
+      should "return an array and an empty hash when extracting options from an array" do
+        array = ['a']
+        Utility.extract_options(array).should == [['a'], {}]
+      end
+
+      should "return an array and hash parts when extracting options from an array" do
+        array = ['a', {:key => 'value'}]
+        Utility.extract_options(array).should == [['a'], {:key => 'value'}]
+      end
+
+      should "not modify the original array when extracting options from the array" do
+        original_array = ['a', {:key => 'value'}]
+        array          = original_array.dup
+
+        Utility.extract_options(array)
+
+        array.should == original_array
+      end
+
+    end
+
+  end
+end

data/test/unit/fleakr_test.rb

@@ -1,153 +1,160 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require File.expand_path('../../test_helper', __FILE__)
 
 class FleakrTest < Test::Unit::TestCase
-  
+
   context "The Fleakr module" do
-    
+
     [:api_key, :shared_secret, :auth_token].each do |attribute|
       should "be able to set a value for :#{attribute}" do
         value = 'value'
-        
+
         Fleakr.send("#{attribute}=".to_sym, value)
         Fleakr.send(attribute).should == value
       end
     end
-    
+
     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.user('username').should == user
     end
-    
+
     should "fall back to finding a user by email if finding by username fails" do
       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.user(email).should == user
     end
-    
+
     should "fall back to finding a user by URL if username and email both fail" do
       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.user(url).should == user
     end
 
     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.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'
     end
-    
+
     should "allow filtering when finding contacts for the authenticated user" do
       Fleakr::Objects::Contact.expects(:find_all).with(:filter => :friends).returns('contacts')
       Fleakr.contacts(:friends).should == 'contacts'
     end
-    
+
     should "allow passing of additional parameters when finding contacts for the authenticated user" do
       Fleakr::Objects::Contact.expects(:find_all).with(:filter => :friends, :page => 1).returns('contacts')
       Fleakr.contacts(:friends, :page => 1).should == 'contacts'
     end
-    
+
     should "be able to perform text searches" do
       photos = [stub()]
-      
+
       Fleakr::Objects::Search.expects(:new).with(:text => 'foo').returns(stub(:results => photos))
       Fleakr.search('foo').should == photos
     end
-    
+
     should "be able to perform searches based on tags" do
       Fleakr::Objects::Search.expects(:new).with(:tags => %w(one two)).returns(stub(:results => []))
       Fleakr.search(:tags => %w(one two))
     end
-   
+
     # TODO: refactor uploading tests?
     should "be able to upload a collection of images" do
       glob      = '*.jpg'
       filenames = %w(one.jpg two.jpg)
-      
+
       Dir.expects(:[]).with(glob).returns(filenames)
-      
+
       Fleakr::Objects::Photo.expects(:upload).with('one.jpg', {})
       Fleakr::Objects::Photo.expects(:upload).with('two.jpg', {})
-      
+
       Fleakr.upload(glob)
     end
-    
+
     should "return recently uploaded photos" do
       filename  = '/path/to/image.jpg'
       new_image = stub()
-      
+
       Dir.expects(:[]).with(filename).returns([filename])
       Fleakr::Objects::Photo.expects(:upload).with(filename, {}).returns(new_image)
-      
+
       Fleakr.upload(filename).should == [new_image]
     end
-    
+
     should "be able to pass options for the uploaded files" do
       filename  = '/path/to/image.jpg'
       new_image = stub()
-      
+
       Dir.expects(:[]).with(filename).returns([filename])
       Fleakr::Objects::Photo.expects(:upload).with(filename, :title => 'bop bip').returns(new_image)
-      
+
       Fleakr.upload(filename, :title => 'bop bip').should == [new_image]
     end
-    
+
     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.authorization_url.should == 'auth_url'
     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)
-      
+
       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
-    
+
     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
-    
+
     should "be able to get the user for the provided auth token" do
       token = stub() {|t| t.stubs(:user).with().returns('user') }
-      
+
       Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('toke').returns(token)
-      
+
       Fleakr.user_for_token('toke').should == 'user'
     end
-    
+
+    should "be able to find the correct resource for a URL" do
+      url = stub() {|u| u.stubs(:resource).with().returns('resource') }
+      Fleakr::Objects::Url.expects(:new).with('url').returns(url)
+
+      Fleakr.resource_from_url('url').should == 'resource'
+    end
+
   end
-  
+
 end