jerrett-simple-flickr 0.1.0

data/README

@@ -0,0 +1,34 @@
+Simple-Flickr
+Jerrett Taylor (jerrett@gmail.com)
+
+DESCRIPTION:
+
+  This is an interface into the Flickr REST API. There are a bunch of various libraries that do this, 
+  but most of the ones I found are out of date and no longer work with the new(ish) Flickr API,
+  partially work, or resulted in general funkyness. 
+  
+  At the moment, this does what I need. Feel free to do what you want with it, and let me know if 
+  you make changes, fix bugs, or add any features - i'd be more than happy to accept any patches!
+
+FEATURES/PROBLEMS: 
+
+  This currently only provides a wrapper around public data (non-authenticated stuff), but it would not be
+  too tricky to add authenticated stuff in at a later date, should it be needed. 
+
+  This currently provides wrapping for people, photos, and photosets. For anything else, you can use the 
+  Flickr::Client#request and get hpricot documents back, which are easy to parse... or, submit a patch with the missing
+  wrappers!
+
+SYNOPSIS:
+
+   client = Flickr::Client.new( 'apikey' )
+   person = client.person( 'jerrett taylor' ) 
+   => #<Flickr::Person:0x11e5e14 ...>>
+   person.photosets.first.title
+   => "Macro"
+   person.photosets.first.photos
+   => [#<Flickr::Photo:0x116ab10 ...>
+
+REQUIREMENTS: 
+  - Hpricot
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/gempackagetask'
+
+Dir[ "tasks/**/*.rake" ].each { | tasks | load tasks } 
+
+desc "Run specs"
+task :default => :spec
+
+spec = Gem::Specification.new do |s|
+  s.name         = 'simple-flickr'
+  s.version      = '0.1.0'
+  s.summary      = "A wrapper for Flickrs REST API"
+  s.description  = "A wrapper for Flickrs REST API."
+
+  s.author       = "Jerrett Taylor"
+  s.email        = "jerrett@gmail.com"
+  s.homepage     = "http://github.com/jerrett/simple-flickr"
+  
+  # code
+  s.require_path = "lib"
+  s.files        = %w( README Rakefile ) + Dir["{spec,lib}/**/*"]
+ 
+  # rdoc
+  s.has_rdoc         = false
+ 
+  # Dependencies
+  s.add_dependency "hpricot", [">= 0.6.0"]
+  
+  # Requirements
+  s.required_ruby_version = ">= 1.8.6"
+  
+  s.platform = Gem::Platform::RUBY
+end
+
+desc "create .gemspec file (useful for github)"
+task :gemspec do
+  filename = "#{spec.name}.gemspec"
+  File.open(filename, "w") do |f|
+    f.puts spec.to_ruby
+  end
+end

data/lib/simple-flickr.rb

@@ -0,0 +1,57 @@
+$:.unshift File.dirname(__FILE__)
+
+# A good starting point is Flickr::Client. Quick and simple example usage:
+#   
+#   client = Flickr::Client.new( 'apikey' )
+#   person = client.person( 'jerrett taylor' ) 
+#   => #<Flickr::Person:0x11e5e14 ...>>
+#   person.photosets.first.title
+#   => "Macro"
+#   person.photosets.first.photos
+#   => [#<Flickr::Photo:0x116ab10 ...>]
+#  
+# There is some basic caching, so the above example while making two calls 
+# to person.photosets, would only contact flickr once. 
+#
+# All Proxy classes include Flickr::Proxy which grants them Flickr::Proxy#api_query. This 
+# allows you to retreive a collection  directly, for example if you want to get a list
+# of photosets and you know the internal flickr user id (or 'nsid'), you 
+# can do the following:
+#   
+#   client = Flickr::Client.new( 'yourapikey' )
+#   PhotoSet.api_query( 'photosets.getPhotos', client, :photoset_id => 1234 )
+#  
+# Similarly, you could get a list of all of a people photos or favorites:
+#   
+#   client = Flickr::Client.new( 'yourapikey' )
+#   Photo.api_query( 'favorites.getPublicList', client, :user_id => 'flickruserid' )
+#   Photo.api_query( 'people.getPublicPhotos', client, :user_id => 'flickruserid' )
+#  
+# The benifit of this is that it will only do a single request, since you don't 
+# need to lookup the ID's if you have them already.
+module Flickr
+  class RequestError < StandardError
+    attr_accessor :status, :message
+    def initialize( status, message )
+      @status, @message = status.to_i, message
+    end
+    
+    def to_s
+      "#{message} (#{status})"
+    end
+  end
+end
+
+# Dependencies
+require 'rubygems'
+require 'hpricot'
+require 'open-uri'
+require 'uri'
+
+# Classes
+require 'simple-flickr/proxy'
+require 'simple-flickr/client'
+require 'simple-flickr/person'
+require 'simple-flickr/photos'
+require 'simple-flickr/photo'
+require 'simple-flickr/photo_set'

data/lib/simple-flickr/client.rb

@@ -0,0 +1,91 @@
+module Flickr
+  # This can be used to make any raw request to Flickr, 
+  # using Flickr::Client#request.
+  # 
+  # You will be greeted with an Hpricot document in return, 
+  # which you will then have to parse yourself. Lucky for you, 
+  # Flickr provides pretty clean responses and very nice documentation
+  # (at http://www.flickr.com/services/api/), so it should be pretty
+  # easy to deal with. 
+  #
+  # Use this if the rest of this library doesn't wrap the calls you
+  # need, or if you just want to do it all your way instead.
+  class Client
+    REST_ENDPOINT = "http://api.flickr.com/services/rest"
+   
+    # Create a new Flickr::Client object.
+    #
+    # === Parameters
+    # api_key<String>:: The API Key provided to you by flickr.
+    #
+    # Please see http://www.flickr.com/services/api/
+    # for more information.
+    def initialize( api_key )
+      @api_key = api_key
+      @cached_requests = {}
+    end
+
+    # This is just to make it nicer to look at. Without this, the @cached_requests pile up and make a mess.
+    def inspect # :nodoc:
+      "<Flickr::Client api_key=\"#{@api_key}\">"
+    end
+    
+    # Locate a person using their username or email address.
+    #
+    # === Parameters
+    # :query<String>:: The flickr username or email address of the person you want to find.
+    #
+    # === Returns
+    # Flickr::Person:: Proxy object representing a Flickr person.
+    def person( query )
+      Person.find( query, self )
+    end
+
+    # Find a single photo using the Flickr photo ID
+    #
+    # === Parameters
+    # :photo_id<String>:: The flickr photo id (should be a ~10-digit integer)
+    def photo( photo_id )
+      Photo.find( photo_id, self )
+    end
+    
+    # Find a single photoset using the Flickr photoset ID
+    #
+    # === Parameters
+    # :photoset_id<String>:: The flickr photoset id (should be a ~10-digit integer)
+    def photoset( photoset_id )
+      PhotoSet.find( photoset_id, self )
+    end
+    
+    # Make a request to flickr. This will cache (per Flickr::Client instance) requests to avoid uneccesary traffic.
+    # This will raise a Flickr::RequestError if something goes wrong.
+    # 
+    # === Parameters
+    # :method<String>:: The method to call. This is any method from the Flickr API:  http://www.flickr.com/services/api/ (but 
+    # without the leading 'flickr.' in front of the method call.
+    # :arguments<Hash>:: An (optional) hash of key/value arguments. This is whatever arguments the method you are calling expects.
+    #
+    # === Returns
+    # Hpricot::Elem:: An Hpricot Elem object, representing the XML response.
+    #
+    #   flickr = Flickr::Client.new( 'myapikey' )
+    #   flickr.request( 'favorites.getPublicList', :user_id => '66273938@N00', :per_page => 5 )
+    def request( method, arguments = {} )
+      url = REST_ENDPOINT + "?" + arguments.merge( 
+        :api_key => @api_key, 
+        :method => "flickr.#{method}" 
+      ).collect { | key, value | "#{key}=#{URI.encode(value.to_s)}" }.sort.join( '&' )
+      
+      return @cached_requests[ url ] if @cached_requests.has_key? url
+      
+      begin 
+        response = Hpricot.XML( open(url).read ).at('rsp')
+      rescue Timeout::Error, OpenURI::HTTPError, Errno::ECONNRESET, SocketError, Errno::ECONNREFUSED => e
+        raise RequestError.new(0, e)
+      end
+      raise RequestError.new(response.at('err')['code'], response.at('err')['msg']) unless response['stat'] == 'ok'
+      
+      @cached_requests[ url ] = response
+    end
+  end
+end

data/lib/simple-flickr/person.rb

@@ -0,0 +1,103 @@
+module Flickr
+  
+  # Represents a Flickr Person.
+  #
+  # You can find a Flickr::Person by email or by username, 
+  # using Flickr::Person#find. 
+  class Person
+    include Proxy
+    
+    def initialize( xml, client ) # :nodoc:
+      super( xml, client )
+
+      @attributes.merge!( 
+        'id' => xml[ 'nsid' ],
+        'profileurl' => xml.search('profileurl').text,
+        'photosurl' => xml.search('photosurl').text,
+        'location' => xml.search('location').text,
+        'realname' => xml.search('realname').text,
+        'username' => xml.search('username').text
+      )
+    end
+    
+    # Return the most recent photos from a persons photostream. 
+    # 
+    # === Arguments
+    # :options<Hash>:: This is a hash of options that will be passed to flickr. For more details
+    # on what you can pass, please check out http://www.flickr.com/services/api/flickr.people.getPublicPhotos.html
+    #
+    # === Returns
+    # [Flickr::Photo]:: An array of Flickr::Photo objects.
+    def photos( options = {} )
+      Photo.api_query( 'people.getPublicPhotos', @client, options.merge(:user_id => id)  )
+    end
+    
+    # Return the persons photosets.
+    # 
+    # === Returns
+    # [Flickr::PhotoSet]:: An array of Flickr::PhotoSet objects.
+    def photosets
+      PhotoSet.api_query( 'photosets.getList', @client, :user_id => id )
+    end
+    
+    # Return the most recent photos from a persons favorites. 
+    # 
+    # === Arguments
+    # :options<Hash>:: This is a hash of options that will be passed to flickr. For more details
+    # on what you can pass, please check out http://www.flickr.com/services/api/flickr.favorites.getPublicList.html
+    #
+    # === Returns
+    # [Flickr::Photo]:: An array of Flickr::Photo objects.
+    def favorites( options )
+      Photo.api_query( 'favorites.getPublicList', @client, options.merge(:user_id => id) )
+    end
+    
+    # Find a person on Flickr using their flickr username or email address.
+    #
+    # === Parameters
+    # :query<String>:: The Flickr username or email address of the person.
+    # :client<Flickr::Client>:: A Flickr::Client to use for communication with flickr.
+    #
+    # === Returns
+    # Flickr::Person:: An instance of Flickr::Person representing the person, or nil
+    # if no people can be found.
+    def self.find( query, client )
+      return nil unless query.is_a? String
+      
+      begin
+        if query.include? '@'
+          xml = client.request( 'people.findByEmail', :find_email => query )       
+        else
+          xml = client.request( 'people.findByUsername', :username => query )
+        end
+      rescue => e
+        return nil if e.respond_to? :status and e.status == 1
+        raise e
+      end
+      
+      find_by_id( xml.at('user')['nsid'], client )
+    end
+
+    # Find a user using their flickr user id. Use this if you already know the NSID
+    # of a user, instead of #find.
+    #
+    # === Parameters
+    # :user_id<String>:: The Flickr User id (NSID).
+    # :client<Flickr::Client>:: A Flickr::Client to use for communication with flickr.
+    #
+    # === Returns
+    # Flickr::Person:: An instance of Flickr::Person representing the person, or nil
+    # if no people can be found.
+    def self.find_by_id( user_id, client )
+      begin
+        userxml = client.request( 'people.getInfo', :user_id => user_id )
+      rescue => e
+        return nil if e.respond_to? :status and e.status == 1
+        raise e
+      end
+      
+      new( userxml.at('person'), client )
+    end
+    
+  end
+end

data/lib/simple-flickr/photo.rb

@@ -0,0 +1,71 @@
+module Flickr
+  # Represents a Flickr Photo.
+  class Photo
+    include Proxy
+    include Comparable
+    
+    # http://www.flickr.com/services/api/misc.urls.html
+    PHOTO_SIZES = { 'square' => '_s', 'thumbnail' => '_t', 'small' => '_m', 'medium' => '', 'large' => '_b' }
+
+    # Initialize the photo with an extra hack to ensure that various attributes are
+    # present, no matter whether flicker provides them as attributes or as seperate
+    # nodes (or by several different names, occasionally)
+    #
+    # === Parameters
+    # See Flickr::Proxy#initialize
+    def initialize( xml, client )
+      super( xml, client )
+      @attributes['title'] ||= xml.search('title').text
+      @attributes['description'] = xml.search('description').text
+      @attributes['uploaded_at'] = Time.at((@attributes.delete('dateuploaded') or @attributes.delete('dateupload')).to_i)
+      @attributes['owner'] ||= xml.at('owner').attributes['nsid'] if xml.at('owner')
+    end
+
+    # Get the person associated with this photo
+    #
+    # === Returns
+    # Flickr::Person: The associated person object
+    def person
+      Person.find_by_id( owner, @client )
+    end
+
+    # Comparison with another Flickr::PHoto.
+    #
+    # === Parameters
+    # :other<Flickr::Photo>: The other photo to compare to.
+    #
+    # === Returns 
+    # Integer: -1, 0, 1 if the id of this Photo is less than, equal to, or greater than the +other+ Photo.
+    def <=>( other )
+      return 0 if self.id == other.id
+      self.id < other.id ? -1 : 1
+    end
+    
+    # Return the url to an image for the specified size. This does not currently support 'original'. 
+    #
+    # === Parameters
+    # :size<String>:: The desired size of the image. Can be +square+, +thumbnail+, +small+, +medium+, or +large+.
+    #
+    # === Returns
+    # String:: The url to the image.
+    def url( size = 'medium' )
+      "http://farm#{farm}.static.flickr.com/#{server}/#{id}_#{secret}#{PHOTO_SIZES[size]}.jpg"
+    end
+    
+    # Find Photos using a Flickr API method, a Flickr::Client and a hash of options. 
+    #
+    # This works the same as Flickr::Proxy#api_query, only it returns a Flickr::Photos object instead of an Array.
+    def self.api_query( api_method, client, options )
+      Flickr::Photos.new( client.request(api_method, options).at('photos|photoset'), client ) # Photosets, unlike every other photos result, returns in a <photosets> node instead of <photos>.
+    end
+
+    # Find a single photo using the Flickr photo ID and a Flickr::Client
+    #
+    # === Parameters
+    # :photo_id<String>:: The flickr photo id (should be a ~10-digit integer)
+    # :client<Flickr::Client>:: The flickr client object to use
+    def self.find( photo_id, client )
+      Photo.new( client.request('photos.getInfo', :photo_id => photo_id).at('photo'), client )
+    end
+  end
+end

data/lib/simple-flickr/photo_set.rb

@@ -0,0 +1,42 @@
+module Flickr
+  
+  # Represents a Flickr Photo Set.
+  class PhotoSet
+    include Proxy
+    
+    def initialize( xml, client ) # :nodoc:
+      super( xml, client )
+      @attributes[ 'title' ] = xml.at('title').inner_text 
+      @attributes[ 'description' ] = xml.at('description').inner_text 
+    end
+
+    # Return the most recent photos for this photoset. 
+    # 
+    # === Arguments
+    # :options<Hash>:: This is a hash of options that will be passed to flickr. For more details
+    # on what you can pass, please check out http://www.flickr.com/services/api/flickr.photosets.getPhotos.html
+    #
+    # === Returns
+    # [Flickr::Photo]:: An array of Flickr::Photo objects.
+    def photos( options = {} )
+      Photo.api_query( 'photosets.getPhotos', @client, options.merge(:photoset_id => id) )
+    end
+    
+    # Get the person associated with this photoset
+    #
+    # === Returns
+    # Flickr::Person: The associated person object
+    def person
+      Person.find_by_id( owner, @client )
+    end
+    
+    # Find a single photo using the Flickr photo ID and a Flickr::Client
+    #
+    # === Parameters
+    # :photoset_id<String>:: The flickr photoset id (should be a ~10-digit integer)
+    # :client<Flickr::Client>:: The flickr client object to use
+    def self.find( photoset_id, client )
+      PhotoSet.new( client.request('photosets.getInfo', :photoset_id => photoset_id).at('photoset'), client )
+    end
+  end
+end

data/lib/simple-flickr/photos.rb

@@ -0,0 +1,62 @@
+module Flickr
+  # A collection of Photos. 
+  class Photos
+    include Enumerable
+
+    def offset
+      (current_page-1) * per_page
+    end
+
+    def current_page
+      @attributes['page'].to_i
+    end
+
+    def per_page
+      (@attributes['perpage'] || @attributes['per_page']).to_i
+    end
+
+    def total_entries
+      @attributes['total'].to_i
+    end
+
+    def total_pages
+      (total_entries.to_f / per_page).ceil
+    end
+
+    def next_page
+      total_pages > current_page ? current_page+1 : nil
+    end
+
+    def previous_page
+      current_page > 1 ? current_page-1 : nil
+    end
+    
+    # Create a new Flickr::Photos collection using the provided Hpricot::Elem object, which should
+    # contain an appropriate Photo response in XML from Flickr. 
+    def initialize( result_xml, client )
+      @photos = result_xml.search( 'photo' ).collect { |xml| Flickr::Photo.new( xml, client ) }
+      @attributes = result_xml.attributes
+    end
+    
+    # Iterate through all the Flickr::Photo objects.
+    def each
+      @photos.each { |photo| yield photo }
+    end
+    
+    # Is this collection of photos empty?
+    def empty?
+      to_a.empty?
+    end
+    
+    # How big is this collection?
+    def size
+      to_a.size
+    end
+    alias_method :length, :size
+    
+    # Allow Photos to be accessed as an Array
+    def [](n)
+      to_a[n]
+    end
+  end
+end

data/lib/simple-flickr/proxy.rb

@@ -0,0 +1,72 @@
+module Flickr
+  # Flickr Proxy
+  # 
+  # This contains shared functionality for Flickr Proxy classes.
+  # 
+  # Any class that includes this should call super on initialize to pass 
+  # in the XML and Flickr::Client instance, if they overide initialize.
+  # 
+  # All attributes from the Hpricto::Elem passed in to initialize will be grabbed
+  # and mapped to method calls, for example: 
+  # 
+  #   xml => #<Hpricot::Doc {emptyelem <foo id="3" foo="bar">}>
+  #   
+  #   test = Myclass.new( xml, client )
+  #   test.id   => "3"
+  #   test.foo  => "bar" 
+  module Proxy
+    attr_accessor :attributes
+    
+    # Create a new proxy class. This needs an Hpricot::Elem 
+    # of the XML returned from Flickr, from Flickr::Client#request. 
+    #
+    # Typically you don't want to call this directly, and should be using
+    # the +find+ method of the class instead.
+    # 
+    # === Parameters
+    # :xml<Hpricot::Elem>:: XML from Flickr, in Hpricot form. 
+    # :client<Flickr::Client>:: A Flickr::Client to use for communication with flickr.
+    def initialize( xml, client )
+      @attributes = xml.attributes
+      @client = client
+    end
+    
+    # Return the id, instead of the object_id
+    def id # :nodoc:
+      @attributes[ 'id' ]
+    end
+    
+    # This maps method calls to attributes.
+    def method_missing( method, *args ) # :nodoc:
+      return @attributes[method.to_s] if @attributes[method.to_s]
+      super
+    end
+
+    # Class methods.
+    module ClassMethods
+      # Find objects using a Flickr API method, a Flickr::Client and a hash of options. 
+      #
+      # this is mostly intended for internal use, but can also be used to directly call
+      # specific api methods.
+      #
+      # === Parameters 
+      # :client<Flickr::Client>:: Instance of a Flickr::Client to use to make the request.
+      # :api_method<String>:: The Flickr API method to use. Must return nodes matching the class this is called on. (example, 'photosets' for Flickr::PhotoSet)
+      # :options<Hash>:: Options to be passed along to the Flickr API Method.
+      #
+      # === Returns
+      # Array[Flickr::Photo]:: An Array of Flickr::Photo objects. 
+      def api_query(api_method, client, options = {} ) 
+        client.request( api_method, options ).search( self.to_s.gsub('Flickr::','').downcase ).collect { |xml| new( xml, client ) }
+      end
+    end
+    
+    def self.included(klass) # :nodoc:
+      klass.extend(ClassMethods)
+    end
+  end
+end
+
+
+
+

data/spec/client_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Flickr::Client do
+  before( :each ) do 
+    @flickr = Flickr::Client.new( 'my-api-key' )
+  end
+  
+  it 'should make a request to a flickr method with no arguments' do 
+    @flickr.should_receive( :open ).with( Flickr::Client::REST_ENDPOINT + '?api_key=my-api-key&method=flickr.test.echo' ).and_return( VALID_FLICKR_RESPONSE )
+    @flickr.request( 'test.echo' )
+  end 
+
+  it 'should make a request to a flickr method with arguments passed' do 
+    @flickr.should_receive( :open ).with( Flickr::Client::REST_ENDPOINT + '?api_key=my-api-key&method=flickr.favorites.getList&per_page=4&user_id=123456789N00' ).and_return( VALID_FLICKR_RESPONSE )
+    @flickr.request( 'favorites.getList', :user_id => '123456789N00', :per_page => 4 )
+  end
+  
+  [Timeout::Error.new(nil), OpenURI::HTTPError.new(nil,nil), Errno::ECONNRESET, SocketError, Errno::ECONNREFUSED].each do |e| 
+    it "should raise an appropriate error if open-uri raises #{e}" do
+      @flickr.should_receive( :open ).and_raise( e )
+      proc { @flickr.request( 'test.echo' ) }.should raise_error( Flickr::RequestError )
+    end
+  end
+
+  it 'should raise an appropriate error if something goes wrong with the request' do 
+    @flickr.should_receive( :open ).and_return( INVALID_FLICKR_RESPONSE )
+    proc { @flickr.request( 'test.echo' ) }.should raise_error( Flickr::RequestError )
+  end
+  
+  it 'should cache requests returning the correct result and not make uneccesary calls to flickr' do 
+    @flickr.should_receive( :open ).once.and_return( VALID_FLICKR_RESPONSE )
+    
+    response = Hpricot.XML( VALID_FLICKR_RESPONSE.read ).at( 'rsp' )
+    @flickr.request( 'favorites.getList', :user_id => '123456789N00', :per_page => 4 ).to_s.should == response.to_s
+    @flickr.request( 'favorites.getList', :user_id => '123456789N00', :per_page => 4 ).to_s.should == response.to_s
+  end
+  
+  it 'should request a user passing self in as the client' do 
+    user = mock('flickr user')
+    Flickr::Person.should_receive( :find ).with( 'ennoia', @flickr ).and_return( user )
+    @flickr.person( 'ennoia' ).should == user
+  end
+
+  it 'should request a photo passing self in as the client' do
+    photo = mock('flickr photo')
+    Flickr::Photo.should_receive( :find ).with( 'myphoto', @flickr ).and_return( photo )
+    @flickr.photo( 'myphoto' ).should == photo
+  end
+end
+
+

data/spec/person_spec.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Flickr::Person do
+  before( :each ) do 
+    @client = mock( 'Flickr::Client' )
+  end
+  
+  describe 'when finding a person' do 
+    before( :each ) do
+      @find_user_xml = Hpricot.parse( '<rsp stat="ok"><user nsid="66273938@N00" id="66273938@N00"><username>Ennoia</username></user></rsp>' )
+      @person_xml = Hpricot.parse( '<rsp stat="ok"><person nsid="12037949754@N01" isadmin="0" ispro="0" iconserver="122" iconfarm="1">
+	<username>bees</username><realname>Cal Henderson</realname><mbox_sha1sum>eea6cd28e3d0003ab51b0058a684d94980b727ac</mbox_sha1sum>
+	<location>Vancouver, Canada</location><photosurl>http://www.flickr.com/photos/bees/</photosurl><profileurl>http://www.flickr.com/people/bees/</profileurl> 
+	<photos><firstdate>1071510391</firstdate><firstdatetaken>1900-09-02 09:11:24</firstdatetaken><count>449</count></photos></person></rsp>')
+      
+      @person = mock( 'Flickr::Person' )
+    end
+    
+    it 'should find a person by email address' do 
+      @client.should_receive( :request ).with( 'people.findByEmail' , :find_email => 'foo@bar.com' ).and_return( @find_user_xml )
+      Flickr::Person.should_receive( :find_by_id ).with( '66273938@N00', @client ).and_return( @person )
+      Flickr::Person.find( 'foo@bar.com' , @client ).should == @person
+    end
+    
+    it 'should find a person by username' do 
+      @client.should_receive( :request ).with( 'people.findByUsername' , :username => 'ennoia' ).and_return( @find_user_xml )
+      Flickr::Person.should_receive( :find_by_id ).with( '66273938@N00', @client ).and_return( @person )
+      Flickr::Person.find( 'ennoia' , @client ).should == @person
+    end
+  
+    it 'should return nil if no person was found' do 
+      @client.should_receive( :request ).and_raise( Flickr::RequestError.new( '1', 'Not found') )
+      Flickr::Person.find( 'sdfsdfsd', @client ).should == nil
+    end
+    
+    it 'should raise an exception if any other error is encountered' do 
+      @client.should_receive( :request ).and_raise( Flickr::RequestError.new( '101', 'Not found') )
+      proc { Flickr::Person.find( 'sdfsdfsd', @client ) }.should raise_error( Flickr::RequestError ) 
+    end
+    
+    it 'should return nil if something invalid is passed in (non string)' do 
+      Flickr::Person.find(nil, @client).should == nil
+    end
+    
+    it 'should find a user by the flickr userid' do 
+      @client.should_receive( :request ).with( 'people.getInfo', :user_id => '66273938@N00' ).and_return( @person_xml )
+      Flickr::Person.should_receive( :new ).with( @person_xml.at('person'), @client ).and_return( @person )
+      Flickr::Person.find_by_id( '66273938@N00' , @client ).should == @person
+    end
+    
+    it 'should return nil if no person was found by id' do 
+      @client.should_receive( :request ).and_raise( Flickr::RequestError.new( '1', 'Not found') )
+      Flickr::Person.find_by_id( 'sdfsdfsd', @client ).should == nil
+    end
+  end
+end
+
+describe Flickr::Person do
+  before( :each ) do 
+    @client = mock( 'Flickr::Client' )
+    user_xml = Hpricot.parse( '<rsp stat="ok"><person nsid="12037949754@N01" isadmin="0" ispro="0" iconserver="122" iconfarm="1">
+	<username>bees</username><realname>Cal Henderson</realname><mbox_sha1sum>eea6cd28e3d0003ab51b0058a684d94980b727ac</mbox_sha1sum>
+	<location>Vancouver, Canada</location><photosurl>http://www.flickr.com/photos/bees/</photosurl><profileurl>http://www.flickr.com/people/bees/</profileurl> 
+	<photos><firstdate>1071510391</firstdate><firstdatetaken>1900-09-02 09:11:24</firstdatetaken><count>449</count></photos></person></rsp>')
+    @person = Flickr::Person.new( user_xml.at('person'), @client )
+  end
+
+  it 'should include proxy' do 
+    Flickr::Photo.included_modules.include?( Flickr::Proxy ).should == true
+  end
+  
+  it 'should set the id' do
+    @person.id.should == '12037949754@N01'
+  end
+
+  it 'should use the passed in client' do 
+    @person.instance_variable_get( :'@client' ).should == @client
+  end
+  
+  it 'should return the users photos' do 
+    photos = mock( 'photos' )
+    Flickr::Photo.should_receive( :api_query ).with( 'people.getPublicPhotos', @client, :user_id => '12037949754@N01', :per_page => 2 ).and_return( photos )
+    @person.photos( :per_page => 2).should == photos    
+  end
+  
+  it 'should return the users favorites' do 
+    photos = mock( 'photos' )
+    Flickr::Photo.should_receive( :api_query ).with( 'favorites.getPublicList', @client, :user_id => '12037949754@N01', :per_page => 2 ).and_return( photos )
+    @person.favorites( :per_page => 2).should == photos    
+  end
+  
+  it 'should return the users photosets' do 
+    photosets = mock( 'photosets' )
+    Flickr::PhotoSet.should_receive( :api_query ).with( 'photosets.getList', @client, :user_id => '12037949754@N01' ).and_return( photosets )
+    @person.photosets.should == photosets    
+  end
+end
+

data/spec/photo_set_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Flickr::PhotoSet do
+  before( :each ) do 
+    @client = mock( 'Flickr::Client' )
+    user_xml = Hpricot.parse( '<photos page="2" pages="89" perpage="10" total="881"><photoset id="5" primary="2483" secret="abcdef" server="8" photos="4" farm="1"><title>Test</title><description>foo</description></photoset></photosets>' )
+    @photoset = Flickr::PhotoSet.new( user_xml.at('photoset'), @client )
+  end
+
+  it 'should include proxy' do 
+    Flickr::PhotoSet.included_modules.include?( Flickr::Proxy ).should == true
+  end
+  
+  it 'should grab the title and description from the xml' do
+    @photoset.title.should == 'Test'
+    @photoset.description.should == 'foo'
+  end
+
+  it 'should use the passed in client' do 
+    @photoset.instance_variable_get( :'@client' ).should == @client
+  end
+  
+  it 'should return photos for the current photoset' do 
+    set = mock('photo set')
+    Flickr::Photo.should_receive( :api_query ).with( 'photosets.getPhotos', @client, :photoset_id => '5').and_return( set )
+    @photoset.photos.should == set
+  end
+end

data/spec/photo_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Flickr::Photo do
+  before( :each ) do 
+    @client = mock( 'Flickr::Client' )
+    @xml = Hpricot.parse( '<photos page="2" pages="89" perpage="10" total="881"><photo id="2636" owner="47058503995@N01" farm="1" secret="a123456" server="2" title="test_04" ispublic="1" isfriend="0" isfamily="0" /></photos>' )
+    @photo = Flickr::Photo.new( @xml.at('photo'), @client )
+  end
+
+  it 'should include proxy' do 
+    Flickr::Photo.included_modules.include?( Flickr::Proxy ).should == true
+  end
+  
+  it 'should use the passed in client' do 
+    @photo.instance_variable_get( :'@client' ).should == @client
+  end
+
+  it 'should fetch "person" when it is requested' do
+    @photo.should_receive(:owner).and_return('owner_id')
+    Flickr::Person.should_receive(:find_by_id).with('owner_id', @client).and_return('person')
+    @photo.person.should == 'person'
+  end
+
+  it 'should fetch a single photo on a call to Photo.find' do
+    @photo_data = mock('photo', :at => 'photodata')
+    @client.should_receive(:request).with('photos.getInfo', :photo_id => 'myphoto').and_return(@photo_data)
+    Flickr::Photo.should_receive(:new).with('photodata', @client).and_return('my photo object')
+    Flickr::Photo.find('myphoto', @client)
+  end
+  
+  it 'should return the url of the image for the requested size' do
+    @photo.url.should == 'http://farm1.static.flickr.com/2/2636_a123456.jpg'
+    @photo.url( 'small' ).should == 'http://farm1.static.flickr.com/2/2636_a123456_m.jpg'
+  end
+  
+  it 'should implement <=> based on id' do 
+    @photo
+    photo2 = mock( 'photo', :id => '2636' )
+    photo3 = mock( 'photo', :id => '2637' )
+    photo4 = mock( 'photo', :id => '2635' )
+    
+    (@photo <=> photo2).should == 0
+    (@photo <=> photo3).should == -1
+    (@photo <=> photo4).should == 1
+  end
+  
+  it 'should include comparable' do
+    Flickr::Photo.included_modules.include?( Comparable ).should == true
+  end
+  
+  it 'should create a new Photos collection with the results of the photos node in the returned xml' do 
+    @client.should_receive( :request ).with( 'person.listPhotos', :foo => 'bar' ).and_return( @xml )
+    Flickr::Photos.should_receive( :new ).with( @xml.at('photos'), @client )
+    Flickr::Photo.api_query(  'person.listPhotos', @client, :foo => 'bar')  
+  end
+  
+  it 'should create a new Photos collection with the results of the photosets node in the returned xml' do 
+    photosets_xml = Hpricot.parse( '<photosets page="2" pages="89" perpage="10" total="881"><photo id="2636" owner="47058503995@N01" farm="1" secret="a123456" server="2" title="test_04" ispublic="1" isfriend="0" isfamily="0" /></photosets>' )
+  
+    @client.should_receive( :request ).with( 'person.listPhotos', :foo => 'bar' ).and_return( photosets_xml )
+    Flickr::Photos.should_receive( :new ).with( photosets_xml.at('photoset'), @client )
+    Flickr::Photo.api_query(  'person.listPhotos', @client, :foo => 'bar')  
+  end
+end

data/spec/photos_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Flickr::Photos do
+  before( :each ) do 
+    @client = mock( 'Flickr::Client' )
+    @photos_xml = Hpricot.parse( '<photos page="2" pages="89" perpage="10" total="881"><photo id="2636" owner="47058503995@N01" farm="1" secret="a123456" server="2" title="test_04" ispublic="1" isfriend="0" isfamily="0" /></photos>' )
+    @photo = mock( 'photo' )
+    Flickr::Photo.stub!( :new ).and_return( @photo )
+    
+    @photos = Flickr::Photos.new( @photos_xml.at('photos'), @client )
+  end
+  
+  it 'should implement size' do
+    @photos.size.should == 1
+  end
+  
+  it 'should implement each' do 
+    @photos.each { |photo| photo }.should == [@photo]
+  end
+  
+  it 'should implement empty?' do 
+    @photos.empty?.should == false
+  end
+
+  it 'should implement pagination methods' do
+    @photos.offset.should == 10
+    @photos.current_page.should == 2
+    @photos.previous_page.should == 1
+    @photos.next_page.should == 3
+    @photos.total_entries.should == 881
+    @photos.total_pages.should == 89
+  end
+end
+
+describe Flickr::Photos do
+   it 'should create a collection of photos from passed in xml' do 
+    client = mock( 'Flickr::Client' )
+    photos_xml = Hpricot.parse( '<photos page="2" pages="89" perpage="10" total="881"><photo id="2636" owner="47058503995@N01" farm="1" secret="a123456" server="2" title="test_04" ispublic="1" isfriend="0" isfamily="0" /><photo id="2637" owner="47058503995@N01" farm="1" secret="a123456" server="2" title="test_05" ispublic="1" isfriend="0" isfamily="0" /></photos>' )
+    photos = Flickr::Photos.new( photos_xml.at('photos'), client )
+   
+    photos[0].id.should == '2636'
+    photos[0].title.should == 'test_04'
+    photos[0].should be_kind_of(Flickr::Photo)
+    
+    photos[1].id.should == '2637'
+  end
+end

data/spec/proxy_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class Flickr::ProxyTest
+  include Flickr::Proxy
+end
+
+describe Flickr::ProxyTest do
+  
+  describe 'when dealing with attributes' do 
+    before( :each ) do 
+      @client = mock( 'Flickr::Client' )
+      @xml = Hpricot.parse( '<doc><proxytest id="2636" var1="test" foo="bar" /></doc>' ).at( 'proxytest' )
+    end
+
+    it 'should set the attributes' do 
+      proxy = Flickr::ProxyTest.new( @xml, @client )
+      proxy.id.should == "2636"
+      proxy.var1.should == "test"
+      proxy.foo.should == "bar"
+    end
+    
+    it 'should set the client' do 
+      proxy = Flickr::ProxyTest.new( @xml, @client )
+      proxy.instance_variable_get( :'@client' ).should == @client
+    end
+  end
+  
+  describe 'when calling api_query' do 
+    it 'should make a request to get photosets for the current user id' do 
+      @client.should_receive( :request ).with( 'photosets.getList', { :user_id => '66273938@N00' } ).and_return( stub('hpricot result', :search => [] ) ) 
+      Flickr::ProxyTest.api_query( 'photosets.getList', @client, :user_id => '66273938@N00' )
+    end
+    
+    it 'should return PhotoSet objects created with the returned xml for each photo' do 
+      result = mock( 'Hpricot XML Result')
+      test1_xml,test2_xml = mock('hpricot xml'), mock('hpricot xml')
+      test1, test2 = mock('test'), mock('photo')
+      
+      @client.should_receive( :request ).and_return( result )
+      result.should_receive( :search ).with( 'proxytest' ).and_return( [test1_xml, test2_xml] )
+      
+      Flickr::ProxyTest.should_receive( :new ).with( test1_xml, @client ).and_return( test1 )
+      Flickr::ProxyTest.should_receive( :new ).with( test2_xml, @client ).and_return( test2 )
+      
+      Flickr::ProxyTest.api_query( 'proxytest.getList', @client ).should == [test1,test2]
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../lib/simple-flickr'
+require 'ruby-debug'
+
+# Let's make sure we don't contact flickr during specs.
+# Overide open (open-uri) to just return flickr-xmli
+
+class MockFlickrResponse
+  def initialize(xml); @xml = xml; end
+  def read; @xml; end
+end
+
+VALID_FLICKR_RESPONSE = MockFlickrResponse.new( '<?xml version="1.0" encoding="utf-8" ?><rsp stat="ok"></rsp>' )
+INVALID_FLICKR_RESPONSE = MockFlickrResponse.new(  '<?xml version="1.0" encoding="utf-8" ?><rsp stat="fail"><err code="101" msg="Something went wrong" /></rsp>' )
+
+class Flickr::Base
+  def open( url )
+    VALID_FLICKR_RESPONSE
+  end
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: jerrett-simple-flickr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jerrett Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+description: A wrapper for Flickrs REST API.
+email: jerrett@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- spec/client_spec.rb
+- spec/person_spec.rb
+- spec/photo_set_spec.rb
+- spec/photo_spec.rb
+- spec/photos_spec.rb
+- spec/proxy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/simple-flickr
+- lib/simple-flickr/client.rb
+- lib/simple-flickr/person.rb
+- lib/simple-flickr/photo.rb
+- lib/simple-flickr/photo_set.rb
+- lib/simple-flickr/photos.rb
+- lib/simple-flickr/proxy.rb
+- lib/simple-flickr.rb
+has_rdoc: false
+homepage: http://github.com/jerrett/simple-flickr
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  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 wrapper for Flickrs REST API
+test_files: []
+