fleakr 0.3.0 → 0.4.0

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

@@ -5,16 +5,52 @@ module Fleakr::Objects
 
     should_have_many :images
 
+    should_autoload_when_accessing :posted, :taken, :updated, :comment_count, :with => :load_info
+    should_autoload_when_accessing :url, :description, :with => :load_info
+
     describe "The Photo class" do
 
       should_find_all :photos, :by => :user_id, :call => 'people.getPublicPhotos', :path => 'rsp/photos/photo'
       should_find_all :photos, :by => :photoset_id, :call => 'photosets.getPhotos', :path => 'rsp/photoset/photo'
       should_find_all :photos, :by => :group_id, :call => 'groups.pools.getPhotos', :path => 'rsp/photos/photo'
+      
+      should_find_one :photo, :by => :id, :with => :photo_id, :call => 'photos.getInfo'
+
+
+      it "should be able to upload a photo and return the new photo information" do
+        filename = '/path/to/mugshot.jpg'
+        photo = stub()
+        
+        response = stub do |s|
+          s.stubs(:body).with().returns(Hpricot.XML('<photoid>123</photoid>'))
+        end
+        
+        Fleakr::Api::UploadRequest.expects(:with_response!).with(filename).returns(response)
+        Photo.expects(:find_by_id).with('123', :authenticate? => true).returns(photo)
+        
+        Photo.upload(filename).should == photo
+      end
 
     end
 
     describe "An instance of the Photo class" do
-      context "when populating from an XML document" do
+      
+      it "should be able to replace the associated photo data" do
+        filename = '/path/to/file.jpg'
+        response = stub(:body => 'body')
+        
+        params = {:type => :update, :photo_id => '1'}
+
+        Fleakr::Api::UploadRequest.expects(:with_response!).with(filename, params).returns(response)
+
+        photo = Photo.new
+        photo.stubs(:id).returns('1')
+        photo.expects(:populate_from).with('body')
+        
+        photo.replace_with(filename).should == photo
+      end
+      
+      context "when populating from the people_getPublicPhotos XML data" do
         before do
           @object = Photo.new(Hpricot.XML(read_fixture('people.getPublicPhotos')).at('rsp/photos/photo'))
         end
@@ -24,11 +60,69 @@ module Fleakr::Objects
         should_have_a_value_for :farm_id   => '4'
         should_have_a_value_for :server_id => '3250'
         should_have_a_value_for :secret    => 'cbc1804258'
-
+      end
+      
+      context "when populating from the photo upload XML data" do
+        before do
+          @object = Photo.new(Hpricot.XML('<photoid>123</photoid>'))
+        end
+        
+        should_have_a_value_for :id => '123'
+      end
+      
+      context "when populating from the photos_getInfo XML data" do
+        before do
+          @object = Photo.new(Hpricot.XML(read_fixture('photos.getInfo')))
+          
+        end
+        
+        should_have_a_value_for :id            => '1'
+        should_have_a_value_for :title         => 'Tree'
+        should_have_a_value_for :description   => 'A Tree'
+        should_have_a_value_for :farm_id       => '4'
+        should_have_a_value_for :server_id     => '3085'
+        should_have_a_value_for :secret        => 'secret'
+        should_have_a_value_for :posted        => '1230274722'
+        should_have_a_value_for :taken         => '2008-12-25 18:26:55'
+        should_have_a_value_for :updated       => '1230276652'
+        should_have_a_value_for :comment_count => '0'
+        should_have_a_value_for :url           => 'http://www.flickr.com/photos/yes/1'
+        
       end
       
       context "in general" do
         
+        before do
+          @photo = Photo.new
+          @time = Time.parse('2009-08-01 00:00:00')
+        end
+        
+        it "should be able to retrieve additional information about the current user" do
+          photo_id = '1'
+          photo = Photo.new
+          photo.expects(:id).with().returns(photo_id)
+          response = mock_request_cycle :for => 'photos.getInfo', :with => {:photo_id => photo_id}
+          
+          photo.expects(:populate_from).with(response.body)
+
+          photo.load_info
+        end
+        
+        it "should have a value for :posted_at" do
+          @photo.expects(:posted).with().returns("#{@time.to_i}")
+          @photo.posted_at.should == @time
+        end
+        
+        it "should have a value for :taken_at" do
+          @photo.expects(:taken).with().returns(@time.strftime('%Y-%m-%d %H:%M:%S'))
+          @photo.taken_at.should == @time
+        end
+        
+        it "should have a value for :updated_at" do
+          @photo.expects(:updated).with().returns("#{@time.to_i}")
+          @photo.updated_at.should == @time
+        end
+        
         it "should have a collection of images by size" do
           photo = Photo.new
           
@@ -62,40 +156,6 @@ module Fleakr::Objects
       end
     end
 
-    # context "in general" do
-    # 
-    #   before do
-    #     @photo = Photo.new
-    # 
-    #     @photo.stubs(:id).with().returns('1')
-    #     @photo.stubs(:farm_id).with().returns('2')
-    #     @photo.stubs(:server_id).with().returns('3')
-    #     @photo.stubs(:secret).with().returns('secret')
-    #   end
-    # 
-    #   it "should know the base URL to retrieve images" do
-    #     @photo.send(:base_url).should == "http://farm2.static.flickr.com/3/1_secret"
-    #   end
-    # 
-    # end
-
-    # context "with a base URL" do
-    # 
-    #   before do
-    #     @photo = Photo.new
-    #     @photo.stubs(:base_url).with().returns('url')
-    #   end
-    # 
-    #   [:square, :thumbnail, :small, :medium, :large].each do |size|
-    #     it "should have a :#{size} image" do
-    #       image = stub()
-    #       Image.expects(:new).with('url', size).returns(image)
-    #       
-    #       @photo.send(size).should == image
-    #     end
-    #   end
-    # 
-    # end
   end
 
 end

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

@@ -56,7 +56,7 @@ module Fleakr::Objects
       
       should "memoize the search results" do
         response = stub(:body => Hpricot.XML(read_fixture('photos.search')))
-        Fleakr::Api::Request.expects(:with_response!).with(kind_of(String), kind_of(Hash)).once.returns(response)
+        Fleakr::Api::MethodRequest.expects(:with_response!).with(kind_of(String), kind_of(Hash)).once.returns(response)
         
         (response.body/'rsp/photos/photo').each do |doc|
           Photo.expects(:new).with(doc).once

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

@@ -21,6 +21,7 @@ module Fleakr::Objects
         should_have_a_value_for :id          => '72157609490909659'
         should_have_a_value_for :title       => 'Second Set'
         should_have_a_value_for :description => 'This is the second set.'
+        should_have_a_value_for :count       => '138'
         
       end
       
@@ -34,14 +35,24 @@ module Fleakr::Objects
         end
         
         after { FileUtils.rm_rf(@tmp_dir) }
+
+        it "should know the prefix string based on the number of photos in the set" do
+          set = Set.new
+          set.stubs(:count).with().returns('5')
+          set.file_prefix(0).should == '1_'
+          
+          set.stubs(:count).with().returns('99')
+          set.file_prefix(0).should == '01_'
+        end
         
         it "should save all files of the specified size to the specified directory" do
           image = mock()
-          image.expects(:save_to).with("#{@tmp_dir}/set")
+          image.expects(:save_to).with("#{@tmp_dir}/set", '1_')
           
           photo = stub(:small => image)
 
           @set.stubs(:photos).with().returns([photo])
+          @set.stubs(:file_prefix).with(0).returns('1_')
           
           FileUtils.expects(:mkdir).with("#{@tmp_dir}/set")
           

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

@@ -3,22 +3,11 @@ require File.dirname(__FILE__) + '/../../../test_helper'
 module Fleakr::Objects
   class UserTest < Test::Unit::TestCase
 
-    def self.should_autoload_when_accessing(*attributes)
-      options = attributes.extract_options!
-      attributes.each do |accessor_name|
-        it "should load the additional user information when accessing the :#{accessor_name} attribute" do
-          user = User.new
-          user.expects(options[:with]).with()
-          user.send(accessor_name)
-        end
-      end
-    end
-    
     should_search_by :user_id
 
     should_have_many :photos, :groups, :sets, :contacts
     
-    should_autoload_when_accessing :name, :photos_url, :profile_url, :photos_count, :with => :load_info
+    should_autoload_when_accessing :name, :photos_url, :profile_url, :photos_count, :location, :with => :load_info
     should_autoload_when_accessing :icon_server, :icon_farm, :pro, :admin, :icon_url, :with => :load_info
 
     describe "The User class" do
@@ -38,6 +27,7 @@ module Fleakr::Objects
         should_have_a_value_for :id           => '31066442@N69'
         should_have_a_value_for :username     => 'frootpantz'
         should_have_a_value_for :name         => 'Sir Froot Pantz'
+        should_have_a_value_for :location     => 'The Moon'
         should_have_a_value_for :photos_url   => 'http://www.flickr.com/photos/frootpantz/'
         should_have_a_value_for :profile_url  => 'http://www.flickr.com/people/frootpantz/'
         should_have_a_value_for :photos_count => '3907'
@@ -93,10 +83,6 @@ module Fleakr::Objects
           @user.admin?.should be(true)
         end
         
-        
-        
-
-        
       end
     end
 

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

@@ -9,60 +9,118 @@ module Fleakr::Support
         attr.name.should == :foo
       end
 
-      it "should infer the xpath information from the attribute name" do
-        attr = Attribute.new('foo')
-        attr.xpath.should == 'foo'
+      it "should have a default source" do
+        attr = Attribute.new(:foo)
+        attr.sources.should == ['foo']
       end
       
-      it "should use a string value for the xpath from the inferred attribute name" do
-        attr = Attribute.new(:foo)
-        attr.xpath.should == 'foo'
+      it "should be able to assign multiple sources" do
+        attr = Attribute.new(:foo, ['foo1', 'foo2'])
+        attr.sources.should == ['foo1', 'foo2']
+      end
+
+      it "should pull the location from the source" do
+        attr = Attribute.new('foo')
+        attr.location('foo').should == 'foo'
       end
       
-      it "should allow the setting of the xpath information" do
-        attr = Attribute.new('foo', :xpath => 'bar')
-        attr.xpath.should == 'bar'
+      it "should return the location when splitting" do
+        attr = Attribute.new('foo')
+        attr.split('foo').should == ['foo', nil]
       end
       
-      it "should have a default attribute value of nil" do
+      it "should return the name for the location when splitting if the location isn't specified" do
         attr = Attribute.new('foo')
-        attr.attribute.should be(nil)
+        attr.split('@bar').should == ['foo', 'bar']
+      end
+      
+      it "should allow the setting of the location information" do
+        attr = Attribute.new('foo', 'bar')
+        attr.sources.should == ['bar']
       end
       
       it "should allow the setting of the attribute value" do
-        attr = Attribute.new('foo', :attribute => 'bogon')
-        attr.attribute.should == 'bogon'
+        attr = Attribute.new('foo')
+        attr.attribute('@bogon').should == 'bogon'
+      end
+      
+      it "should use the location as the attribute" do
+        attr = Attribute.new('foo')
+        attr.attribute('foo').should == 'foo'
       end
       
-      it "should not infer the xpath value when the attribute is set" do
-        attr = Attribute.new(:foo, :attribute => 'bogon')
-        attr.xpath.should be(nil)
+      it "should use the attribute for the attribute if specified" do
+        attr = Attribute.new(:id, '@nsid')
+        attr.attribute('@nsid').should == 'nsid'
+      end
+
+      it "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
+      
+      it "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
+
+      it "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
       
       it "should be able to pull simple values from an XML document" do
         document = Hpricot.XML('<name>Bassdrive</name>')
-        attr = Attribute.new('name')
+        attr = Attribute.new(:name)
         attr.value_from(document).should == 'Bassdrive'
       end
-      
+
       it "should be able to pull an attribute value from the current XML node" do
-        document = Hpricot.XML('<user id="1337" />').at('user')
-        attr = Attribute.new(:id, :attribute => 'id')
+        document = Hpricot.XML('<user id="1337" />')
+        attr = Attribute.new(:id)
         attr.value_from(document).should == '1337'
       end
-      
+        
+      it "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
+
       it "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, :xpath => 'station/genre', :attribute => 'slug')
+        attr = Attribute.new(:slug, 'station/genre@slug')
         attr.value_from(document).should == 'dnb'
       end
-      
+        
+      it "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
+
       it "should return nil if it cannot find the specified node" do
         document = Hpricot.XML('<user id="1" />')
-        attr = Attribute.new(:photoset, :attribute => 'id')
+        attr = Attribute.new(:photoset, '@nsid')
         attr.value_from(document).should be(nil)
       end
 
+      it "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

@@ -9,9 +9,11 @@ class FlickrObject
   include Fleakr::Support::Object
   
   flickr_attribute :name
-  flickr_attribute :description, :xpath => 'desc'
-  flickr_attribute :id, :attribute => 'nsid'
-  flickr_attribute :photoset_id, :xpath => 'photoset', :attribute => 'id'
+  flickr_attribute :description, :from => 'desc'
+  flickr_attribute :id, :from => '@nsid'
+  flickr_attribute :photoset_id, :from => 'photoset@id'
+  
+  find_one :by_id, :call => 'people.getInfo'
   
 end
 
@@ -28,6 +30,27 @@ module Fleakr
         FlickrObject.attributes.map {|a| a.name.to_s }.should == %w(name description id photoset_id)
       end
       
+      it "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
+      
+      it "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
     
     describe "An instance method provided by the Flickr::Object module" do

data/test/unit/fleakr_test.rb

@@ -4,11 +4,13 @@ class FleakrTest < Test::Unit::TestCase
   
   describe "The Fleakr module" do
     
-    it "should be able to set an API key" do
-      key = 'f00b4r'
-      Fleakr.api_key = key
-      
-      Fleakr.api_key.should == key
+    [:api_key, :shared_secret, :mini_token, :auth_token].each do |attribute|
+      it "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
     
     it "should provide a means to find a user by his username" do
@@ -21,7 +23,7 @@ class FleakrTest < Test::Unit::TestCase
       user = stub()
       email = 'user@host.com'
       
-      Fleakr::Objects::User.stubs(:find_by_username).with(email).raises(Fleakr::Api::Request::ApiError)
+      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
@@ -38,6 +40,63 @@ class FleakrTest < Test::Unit::TestCase
       Fleakr::Objects::Search.expects(:new).with(:tags => %w(one two)).returns(stub(:results => []))
       Fleakr.search(:tags => %w(one two))
     end
+   
+    it "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
+    
+    context "when generating an AuthenticationToken from an auth_token string" do
+
+      before 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
+      after { Fleakr.instance_variable_set(:@token, nil) }
+      
+      it "should return the token" do
+        Fleakr.token.should == @token
+      end
+      
+      it "should cache the result" do
+        2.times { Fleakr.token }
+      end
+
+    end
+    
+    context "when generating an AuthenticationToken from a mini_token string" do
+      
+      before 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
+      after { Fleakr.instance_variable_set(:@token, nil) }
+      
+      it "should return the token" do
+        Fleakr.token.should == @token
+      end
+      
+      it "should cache the result" do
+        2.times { Fleakr.token }
+      end
+      
+    end
     
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-12 00:00:00 -05:00
+date: 2009-01-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,9 +45,19 @@ files:
 - Rakefile
 - lib/fleakr
 - lib/fleakr/api
-- lib/fleakr/api/request.rb
+- lib/fleakr/api/file_parameter.rb
+- lib/fleakr/api/method_request.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/hash.rb
+- lib/fleakr/core_ext.rb
 - lib/fleakr/objects
+- lib/fleakr/objects/authentication_token.rb
 - lib/fleakr/objects/contact.rb
 - lib/fleakr/objects/error.rb
 - lib/fleakr/objects/group.rb
@@ -56,12 +66,16 @@ files:
 - lib/fleakr/objects/search.rb
 - lib/fleakr/objects/set.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/contacts.getPublicList.xml
 - test/fixtures/groups.pools.getPhotos.xml
 - test/fixtures/people.findByEmail.xml
@@ -69,6 +83,7 @@ files:
 - test/fixtures/people.getInfo.xml
 - test/fixtures/people.getPublicGroups.xml
 - test/fixtures/people.getPublicPhotos.xml
+- test/fixtures/photos.getInfo.xml
 - test/fixtures/photos.getSizes.xml
 - test/fixtures/photos.search.xml
 - test/fixtures/photosets.getList.xml
@@ -77,9 +92,17 @@ files:
 - test/unit
 - test/unit/fleakr
 - test/unit/fleakr/api
-- test/unit/fleakr/api/request_test.rb
+- test/unit/fleakr/api/file_parameter_test.rb
+- test/unit/fleakr/api/method_request_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/hash_test.rb
 - test/unit/fleakr/objects
+- test/unit/fleakr/objects/authentication_token_test.rb
 - test/unit/fleakr/objects/contact_test.rb
 - test/unit/fleakr/objects/error_test.rb
 - test/unit/fleakr/objects/group_test.rb
@@ -118,6 +141,6 @@ rubyforge_project:
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: A teeny tiny gem to interface with Flickr photostreams
+summary: A small, yet powerful, gem to interface with Flickr photostreams
 test_files: []
 

data/lib/fleakr/api/request.rb

@@ -1,58 +0,0 @@
-module Fleakr
-  module Api # :nodoc:
-    
-    # = Request
-    #
-    # Performs requests against the Flickr API and returns response objects (Flickr::Api::Response)
-    # that contain Hpricot documents for further parsing and inspection.  This class is used internally
-    # in all the defined model objects.
-    #
-    class Request
-
-      # Generic catch-all exception for any API errors
-      class ApiError < StandardError; end
-
-      # Makes a request to the Flickr API and returns a valid Response object.  If
-      # there are errors on the response it will rais an ApiError exception
-      def self.with_response!(method, additional_parameters = {})
-        request = Request.new(method, additional_parameters)
-        response = request.send
-
-        raise(ApiError, "Code: #{response.error.code} - #{response.error.message}") if response.error?
-
-        response
-      end
-
-      # Create a new request for the specified API method and pass along any additional
-      # parameters.  The Flickr API uses namespacing for its methods - this is optional
-      # when calling this method.
-      #
-      # This must be called after initializing the library with the required API key
-      # see (#Fleakr.api_key=)
-      def initialize(method, additional_parameters = {})
-        method = method.sub(/^(flickr\.)?/, 'flickr.')
-
-        default_parameters = {:api_key => Fleakr.api_key, :method => method}
-        @parameters = default_parameters.merge(additional_parameters)
-      end
-
-      def send # :nodoc:
-        Response.new(Net::HTTP.get(endpoint_uri))
-      end
-
-      private
-      def endpoint_uri
-        uri = URI.parse('http://api.flickr.com/services/rest/')
-        uri.query = query_parameters
-        uri
-      end
-
-      def query_parameters
-        @parameters.map {|key,value| "#{key}=#{CGI.escape(value)}" }.join('&')
-      end
-
-
-
-    end
-  end
-end