reagent-fleakr 0.1.2 → 0.1.3

data/README.markdown

@@ -55,9 +55,18 @@ You can also grab photos for a particular set:
     >> user.sets.first.photos.first.title
     => "Untitled1"
 
+If you would prefer to just search photos, you can do that by tag for now:
+
+  >> search = Fleakr::Search.new(:tags => %w(macro))
+  => [#<Fleakr::Photo:0x118bc70 @title="Demure", @id="3076049945">, 
+      #<Fleakr::Photo:0x118b7d4 @title="Bark fly on Bay leaf", @id="3076052409">, ...
+  >> search.results.first.title
+  => "Demure"
+  >> search.results.first.id
+  => "3076049945"
+
 ## TODO
 
-* Refactor the attribute retrieval to something more reusable
 * Implement remaining bits of person, photoset, and photo-releated APIs
         
 ## License

data/lib/fleakr/attribute.rb

@@ -0,0 +1,26 @@
+module Fleakr
+  class Attribute
+
+    attr_reader :name, :xpath, :attribute
+
+    def initialize(name, options = {})
+      @name = name.to_sym
+      @attribute = options[:attribute]
+      
+      @xpath = options[:xpath]
+      @xpath ||= @name.to_s unless @attribute
+    end
+
+    def value_from(document)
+      node = document
+      
+      begin 
+        node = document.at(self.xpath) if self.xpath
+        self.attribute.nil? ? node.inner_text : node[self.attribute]
+      rescue NoMethodError
+        nil
+      end
+    end
+
+  end
+end

data/lib/fleakr/error.rb

@@ -3,8 +3,8 @@ module Fleakr
     
     include Fleakr::Object
     
-    flickr_attribute :code, :from => 'rsp/err', :attribute => 'code'
-    flickr_attribute :message, :from => 'rsp/err', :attribute => 'msg'
+    flickr_attribute :code, :xpath => 'rsp/err', :attribute => 'code'
+    flickr_attribute :message, :xpath => 'rsp/err', :attribute => 'msg'
     
   end
 end

data/lib/fleakr/object.rb

@@ -2,23 +2,30 @@ module Fleakr
   module Object
     
     module ClassMethods
+      
+      def attributes
+        @attributes ||= []
+      end
+      
       def flickr_attribute(name, options = {})
-        class_eval <<-CODE
-          def #{name}
-            if @#{name}.nil?
-              node = @response.at('#{options[:from]}')
-              @#{name} = #{options[:attribute].nil?} ? node.inner_text : node['#{options[:attribute]}']
-            end
-            @#{name}
-          end
-        CODE
+        self.attributes << Attribute.new(name, options)
+        class_eval "attr_reader :#{name}"
       end
+      
     end
     
     module InstanceMethods
-      def initialize(response)
-        @response = response
+      
+      def initialize(document = nil)
+        self.populate_from(document) unless document.nil?
+      end
+      
+      def populate_from(document)
+        self.class.attributes.each do |attribute|
+          instance_variable_set("@#{attribute.name}".to_sym, attribute.value_from(document))
+        end
       end
+      
     end
 
     def self.included(other)

data/lib/fleakr/photo.rb

@@ -4,6 +4,7 @@ module Fleakr
     include Fleakr::Object
     
     flickr_attribute :title, :attribute => 'title'
+    flickr_attribute :id, :attribute => 'id'
     
     def self.find_all_by_photoset_id(photoset_id)
       response = Request.with_response!('photosets.getPhotos', :photoset_id => photoset_id)

data/lib/fleakr/search.rb

@@ -0,0 +1,21 @@
+module Fleakr
+  class Search
+
+    attr_reader :tags
+
+    def initialize(parameters)
+      @tags = parameters[:tags]
+    end
+
+    def results
+      if @results.nil?
+        response = Request.with_response!('photos.search', :tags => self.tags.join(','))
+        @results = (response.body/'rsp/photos/photo').map do |flickr_photo|
+          Photo.new(flickr_photo)
+        end
+      end
+      @results
+    end
+
+  end
+end

data/lib/fleakr/set.rb

@@ -4,8 +4,8 @@ module Fleakr
     include Fleakr::Object
     
     flickr_attribute :id, :attribute => 'id'
-    flickr_attribute :title, :from => 'title'
-    flickr_attribute :description, :from => 'description'
+    flickr_attribute :title
+    flickr_attribute :description
     
     def self.find_all_by_user_id(user_id)
       response = Request.with_response!('photosets.getList', :user_id => user_id)

data/lib/fleakr/user.rb

@@ -3,8 +3,8 @@ module Fleakr
     
     include Fleakr::Object
     
-    flickr_attribute :id, :from => 'rsp/user', :attribute => 'nsid'
-    flickr_attribute :username, :from => 'rsp/user/username'
+    flickr_attribute :id, :xpath => 'rsp/user', :attribute => 'nsid'
+    flickr_attribute :username, :xpath => 'rsp/user/username'
     
     def self.find_by_username(username)
       response = Request.with_response!('people.findByUsername', :username => username)

data/lib/fleakr/version.rb

@@ -3,7 +3,7 @@ module Fleakr
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
     
     def self.to_s
       [MAJOR, MINOR, TINY].join('.')

data/lib/fleakr.rb

@@ -6,6 +6,7 @@ require 'net/http'
 require 'hpricot'
 
 require 'fleakr/object'
+require 'fleakr/attribute'
 require 'fleakr/photo'
 require 'fleakr/request'
 require 'fleakr/response'
@@ -13,3 +14,4 @@ require 'fleakr/error'
 require 'fleakr/set'
 require 'fleakr/user'
 require 'fleakr/group'
+require 'fleakr/search'

data/test/fixtures/photos.search.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<photos page="1" pages="385" perpage="100" total="38424">
+	<photo id="3076020861" owner="31987693@N05" secret="b956549c07" server="3278" farm="4" title="Mona and Lisa" ispublic="1" isfriend="0" isfamily="0" />
+	<photo id="3075386827" owner="9377349@N05" secret="4e40291b2d" server="3151" farm="4" title="IMG_0055 1.JPG" ispublic="1" isfriend="0" isfamily="0" />
+</photos>
+</rsp>

data/test/fleakr/attribute_test.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class AttributeTest < Test::Unit::TestCase
+    describe "An instance of the Attribute class" do
+
+      it "should know the name of the attribute" do
+        attr = Attribute.new('foo')
+        attr.name.should == :foo
+      end
+
+      it "should infer the xpath information from the attribute name" do
+        attr = Attribute.new('foo')
+        attr.xpath.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'
+      end
+      
+      it "should allow the setting of the xpath information" do
+        attr = Attribute.new('foo', :xpath => 'bar')
+        attr.xpath.should == 'bar'
+      end
+      
+      it "should have a default attribute value of nil" do
+        attr = Attribute.new('foo')
+        attr.attribute.should be(nil)
+      end
+      
+      it "should allow the setting of the attribute value" do
+        attr = Attribute.new('foo', :attribute => 'bogon')
+        attr.attribute.should == 'bogon'
+      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)
+      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.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')
+        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.value_from(document).should == 'dnb'
+      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.value_from(document).should be(nil)
+      end
+
+    end
+  end
+end

data/test/fleakr/object_test.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class EmptyObject
+  include Fleakr::Object
+end
+
+class FlickrObject
+  
+  include Fleakr::Object
+  
+  flickr_attribute :name
+  flickr_attribute :description, :xpath => 'desc'
+  flickr_attribute :id, :attribute => 'nsid'
+  flickr_attribute :photoset_id, :xpath => 'photoset', :attribute => 'id'
+  
+end
+
+module Fleakr
+  class ObjectTest < Test::Unit::TestCase
+    
+    describe "A class method provided by the Flickr::Object module" do
+   
+      it "should have an empty list of attributes if none are supplied" do
+        EmptyObject.attributes.should == []
+      end
+      
+      it "should know the names of all its attributes" do
+        FlickrObject.attributes.map {|a| a.name.to_s }.should == %w(name description id photoset_id)
+      end
+      
+    end
+    
+    describe "An instance method provided by the Flickr::Object module" do
+      
+      it "should have default reader methods" do
+        [:name, :description, :id, :photoset_id].each do |method_name|
+          FlickrObject.new.respond_to?(method_name).should == true
+        end
+      end
+      
+      context "when populating data from an XML document" do
+        before do
+          xml = <<-XML
+            <name>Fleakr</name>
+            <desc>Awesome</desc>
+            <photoset id="1" />
+          XML
+
+          @object = FlickrObject.new
+          @object.populate_from(Hpricot.XML(xml))
+        end
+        
+        it "should have the correct value for :name" do
+          @object.name.should == 'Fleakr'
+        end
+        
+        it "should have the correct value for :description" do
+          @object.description.should == 'Awesome'
+        end
+        
+        it "should have the correct value for :photoset_id" do
+          @object.photoset_id.should == '1'
+        end
+        
+        it "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
+      end
+      
+      it "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
+      
+      it "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
+      
+      
+    end
+    
+  end
+end

data/test/fleakr/photo_test.rb

@@ -19,6 +19,10 @@ module Fleakr
         it "should have the proper title" do
           @photos.map {|p| p.title}.should == ['Photo #1', 'Photo #2']
         end
+        
+        it "should have the proper id" do
+          @photos.map {|p| p.id }.should == %w(3044163577 3045001128)
+        end
       
       end
       

data/test/fleakr/search_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class SearchTest < Test::Unit::TestCase
+    
+    describe "An instance of the Search class" do
+      
+      it "should be able to search photos based on tags" do
+        response = mock_request_cycle :for => 'photos.search', :with => {:tags => 'one,two'}
+        
+        photo_1, photo_2 = [stub(), stub()]
+        photo_1_doc, photo_2_doc = (response.body/'rsp/photos/photo').map {|doc| doc }
+
+        Photo.expects(:new).with(photo_1_doc).returns(photo_1)
+        Photo.expects(:new).with(photo_2_doc).returns(photo_2)
+
+        search = Search.new(:tags => %w(one two))
+        search.results.should == [photo_1, photo_2]
+      end
+      
+      should "memoize the search results" do
+        response = stub(:body => Hpricot.XML(read_fixture('photos.search')))
+        Request.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
+        end
+        
+        search = Search.new(:tags => %w(foo))
+        
+        2.times { search.results }
+      end
+      
+      
+    end
+    
+  end
+end

data/test/fleakr/set_test.rb

@@ -35,7 +35,7 @@ module Fleakr
       context "when accessing its list of photos" do
         
         before do
-          @set = Set.new(stub())
+          @set = Set.new
           @set.stubs(:id).with().returns('1')          
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reagent-fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-30 00:00:00 -08:00
+date: 2008-12-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,12 +33,14 @@ files:
 - README.markdown
 - Rakefile
 - lib/fleakr
+- lib/fleakr/attribute.rb
 - lib/fleakr/error.rb
 - lib/fleakr/group.rb
 - lib/fleakr/object.rb
 - lib/fleakr/photo.rb
 - lib/fleakr/request.rb
 - lib/fleakr/response.rb
+- lib/fleakr/search.rb
 - lib/fleakr/set.rb
 - lib/fleakr/user.rb
 - lib/fleakr/version.rb
@@ -47,14 +49,18 @@ files:
 - test/fixtures/people.findByEmail.xml
 - test/fixtures/people.findByUsername.xml
 - test/fixtures/people.getPublicGroups.xml
+- test/fixtures/photos.search.xml
 - test/fixtures/photosets.getList.xml
 - test/fixtures/photosets.getPhotos.xml
 - test/fleakr
+- test/fleakr/attribute_test.rb
 - test/fleakr/error_test.rb
 - test/fleakr/group_test.rb
+- test/fleakr/object_test.rb
 - test/fleakr/photo_test.rb
 - test/fleakr/request_test.rb
 - test/fleakr/response_test.rb
+- test/fleakr/search_test.rb
 - test/fleakr/set_test.rb
 - test/fleakr/user_test.rb
 - test/test_helper.rb