mwilliams-fleakr 0.5.1

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

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+module Fleakr::Support
+  class AttributeTest < Test::Unit::TestCase
+    context "An instance of the Attribute class" do
+
+      should "know the name of the attribute" do
+        attr = Attribute.new('foo')
+        attr.name.should == :foo
+      end
+
+      should "have a default source" do
+        attr = Attribute.new(:foo)
+        attr.sources.should == ['foo']
+      end
+      
+      should "be able to assign multiple sources" do
+        attr = Attribute.new(:foo, ['foo1', 'foo2'])
+        attr.sources.should == ['foo1', 'foo2']
+      end
+
+      should "pull the location from the source" do
+        attr = Attribute.new('foo')
+        attr.location('foo').should == 'foo'
+      end
+      
+      should "return the location when splitting" do
+        attr = Attribute.new('foo')
+        attr.split('foo').should == ['foo', nil]
+      end
+      
+      should "return the name for the location when splitting if the location isn't specified" do
+        attr = Attribute.new('foo')
+        attr.split('@bar').should == ['foo', 'bar']
+      end
+      
+      should "allow the setting of the location information" do
+        attr = Attribute.new('foo', 'bar')
+        attr.sources.should == ['bar']
+      end
+      
+      should "allow the setting of the attribute value" do
+        attr = Attribute.new('foo')
+        attr.attribute('@bogon').should == 'bogon'
+      end
+      
+      should "use the location as the attribute" do
+        attr = Attribute.new('foo')
+        attr.attribute('foo').should == 'foo'
+      end
+      
+      should "use the attribute for the attribute if specified" do
+        attr = Attribute.new(:id, '@nsid')
+        attr.attribute('@nsid').should == 'nsid'
+      end
+
+      should "be able to retrieve the node from the path" do
+        document = Hpricot.XML('<name>Bassdrive</name>')
+        expected = document.at('name')
+        
+        attr = Attribute.new(:name)
+        attr.node_for(document, 'name').should == expected
+      end
+      
+      should "be able to retrieve the node that contains the specified attribute" do
+        document = Hpricot.XML('<user id="1337" />')
+        expected = document.at('user')
+        
+        attr = Attribute.new(:id)
+        attr.node_for(document, '@id').should == expected
+      end
+
+      should "be able to retrieve the node for the specified attribute" do
+        document = Hpricot.XML('<user nsid="1337" />')
+        expected = document.at('user')
+        
+        attr = Attribute.new(:id, '@nsid')
+        attr.node_for(document, '@nsid').should == expected
+      end
+      
+      should "be able to pull simple values from an XML document" do
+        document = Hpricot.XML('<name>Bassdrive</name>')
+        attr = Attribute.new(:name)
+        attr.value_from(document).should == 'Bassdrive'
+      end
+
+      should "be able to pull an attribute value from the current XML node" do
+        document = Hpricot.XML('<user id="1337" />')
+        attr = Attribute.new(:id)
+        attr.value_from(document).should == '1337'
+      end
+        
+      should "be able to pull a specific attribute value from the current XML node" do
+        document = Hpricot.XML('<user nsid="1337" />')
+        attr = Attribute.new(:id, '@nsid')
+        attr.value_from(document).should  == '1337'
+      end
+
+      should "be able to pull an attribute value for a node and attribute" do
+        document = Hpricot.XML('<station><genre slug="dnb">Drum & Bass</genre></station>')
+        attr = Attribute.new(:slug, 'station/genre@slug')
+        attr.value_from(document).should == 'dnb'
+      end
+        
+      should "be able to pull a value from a nested XML node" do
+        document = Hpricot.XML('<rsp><user>blip</user></rsp>')
+        attr = Attribute.new(:user)
+        attr.value_from(document).should == 'blip'
+      end
+
+      should "return nil if it cannot find the specified node" do
+        document = Hpricot.XML('<user id="1" />')
+        attr = Attribute.new(:photoset, '@nsid')
+        attr.value_from(document).should be(nil)
+      end
+
+      should "be able to try a series of nodes to find a value" do
+        document = Hpricot.XML('<photoid>123</photoid>')
+
+        attr = Attribute.new(:id, ['photo@nsid', 'photoid'])
+        attr.value_from(document).should == '123'
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+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'
+  
+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).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}
+        flickr_object = stub()
+        
+        response = mock_request_cycle :for => 'people.getInfo', :with => {:id => id, :authenticate? => true}
+        FlickrObject.expects(:new).with(response.body).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
+      
+      context "when populating data from an XML document" do
+        setup do
+          xml = <<-XML
+            <name>Fleakr</name>
+            <desc>Awesome</desc>
+            <photoset id="1" />
+            <tag>Tag</tag>
+            <category>Category</category>
+          XML
+
+          @object = FlickrObject.new
+          @object.populate_from(Hpricot.XML(xml))
+        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
+      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_test.rb

@@ -0,0 +1,171 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class FleakrTest < Test::Unit::TestCase
+  
+  context "The Fleakr module" do
+    
+    [:api_key, :shared_secret, :mini_token, :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 "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 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)
+      
+      Fleakr.token.should be(nil)
+    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 "cache the result" do
+        2.times { Fleakr.token }
+      end
+
+    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
+
+    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
+      
+      # 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
+      
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: mwilliams-fleakr
+version: !ruby/object:Gem::Version 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Patrick Reagan, Matthew Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: loggable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+description: 
+email: reaganpr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/fleakr
+- lib/fleakr/api
+- 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
+- lib/fleakr/api/value_parameter.rb
+- lib/fleakr/api.rb
+- lib/fleakr/core_ext
+- lib/fleakr/core_ext/false_class.rb
+- lib/fleakr/core_ext/hash.rb
+- lib/fleakr/core_ext/true_class.rb
+- lib/fleakr/core_ext.rb
+- lib/fleakr/objects
+- lib/fleakr/objects/authentication_token.rb
+- lib/fleakr/objects/comment.rb
+- lib/fleakr/objects/contact.rb
+- lib/fleakr/objects/error.rb
+- lib/fleakr/objects/group.rb
+- lib/fleakr/objects/image.rb
+- lib/fleakr/objects/photo.rb
+- lib/fleakr/objects/photo_context.rb
+- lib/fleakr/objects/search.rb
+- lib/fleakr/objects/set.rb
+- lib/fleakr/objects/tag.rb
+- lib/fleakr/objects/user.rb
+- lib/fleakr/objects.rb
+- lib/fleakr/support
+- lib/fleakr/support/attribute.rb
+- lib/fleakr/support/object.rb
+- lib/fleakr/support.rb
+- lib/fleakr/version.rb
+- lib/fleakr.rb
+- test/fixtures
+- test/fixtures/auth.checkToken.xml
+- test/fixtures/auth.getFullToken.xml
+- test/fixtures/auth.getToken.xml
+- test/fixtures/contacts.getPublicList.xml
+- test/fixtures/groups.pools.getPhotos.xml
+- test/fixtures/people.findByEmail.xml
+- test/fixtures/people.findByUsername.xml
+- test/fixtures/people.getInfo.xml
+- test/fixtures/people.getPublicGroups.xml
+- test/fixtures/people.getPublicPhotos.xml
+- test/fixtures/photos.comments.getList.xml
+- test/fixtures/photos.getContext.xml
+- test/fixtures/photos.getInfo.xml
+- test/fixtures/photos.getSizes.xml
+- test/fixtures/photos.search.xml
+- test/fixtures/photosets.comments.getList.xml
+- test/fixtures/photosets.getList.xml
+- test/fixtures/photosets.getPhotos.xml
+- test/fixtures/tags.getListPhoto.xml
+- test/fixtures/tags.getListUser.xml
+- test/fixtures/tags.getRelated.xml
+- test/test_helper.rb
+- test/unit
+- test/unit/fleakr
+- test/unit/fleakr/api
+- 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
+- test/unit/fleakr/core_ext
+- test/unit/fleakr/core_ext/false_class_test.rb
+- test/unit/fleakr/core_ext/hash_test.rb
+- test/unit/fleakr/core_ext/true_class_test.rb
+- test/unit/fleakr/objects
+- test/unit/fleakr/objects/authentication_token_test.rb
+- test/unit/fleakr/objects/comment_test.rb
+- test/unit/fleakr/objects/contact_test.rb
+- test/unit/fleakr/objects/error_test.rb
+- test/unit/fleakr/objects/group_test.rb
+- test/unit/fleakr/objects/image_test.rb
+- test/unit/fleakr/objects/photo_context_test.rb
+- test/unit/fleakr/objects/photo_test.rb
+- test/unit/fleakr/objects/search_test.rb
+- test/unit/fleakr/objects/set_test.rb
+- test/unit/fleakr/objects/tag_test.rb
+- test/unit/fleakr/objects/user_test.rb
+- test/unit/fleakr/support
+- test/unit/fleakr/support/attribute_test.rb
+- test/unit/fleakr/support/object_test.rb
+- test/unit/fleakr_test.rb
+has_rdoc: true
+homepage: http://sneaq.net
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A small, yet powerful, gem to interface with Flickr photostreams
+test_files: []
+