reagent-fleakr 0.1.0 → 0.1.1

data/README.markdown

@@ -6,12 +6,50 @@ A teeny tiny gem to interface with Flickr photostreams
 
 ## Installation
 
-    sudo gem install fleakr
+    sudo gem install reagent-fleakr --source=http://gems.github.com
+    
+Or ...
+
+    $ git clone git://github.com/reagent/fleakr.git
+    $ cd fleakr
+    $ rake gem && sudo gem install pkg/fleakr-<version>.gem
 
 ## Usage
 
-    require 'fleakr'
+Before doing anything, require the library:
+
+    >> require 'rubygems'
+    >> require 'fleakr'
+
+Then, set your API key (only need to do this once per session):
+
+    >> Fleakr::Request.api_key = '<your api key here>'
+    
+Find a user by username:
+
+    >> user = Fleakr::User.find_by_username('the decapitator')
+    => #<Fleakr::User:0x692648 @username="the decapitator", @id="21775151@N06">
+
+And that user's associated sets:
+
+    >> user.sets
+    => [#<Fleakr::Set:0x671358 @title="The Decapitator", @description="">, 
+        #<Fleakr::Set:0x66d898 @title="londonpaper hijack", ...
+
+You can also grab photos for a particular set:
+
+    >> user.sets.first
+    => #<Fleakr::Set:0x1195bbc @title="The Decapitator", @id="72157603480986566", @description="">
+    >> user.sets.first.photos.first
+    => #<Fleakr::Photo:0x1140108 ... >
+    >> user.sets.first.photos.first.title
+    => "Untitled1"
+
+## TODO
 
+* Refactor the attribute retrieval to something more reusable
+* Implement remaining bits of person, photoset, and photo-releated APIs
+        
 ## License
 
 Copyright (c) 2008 Patrick Reagan (reaganpr@gmail.com)

data/lib/fleakr/error.rb

@@ -0,0 +1,12 @@
+module Fleakr
+  class Error
+    
+    attr_accessor :code, :message
+    
+    def initialize(code, message)
+      self.code = code
+      self.message = message
+    end
+    
+  end
+end

data/lib/fleakr/photo.rb

@@ -0,0 +1,20 @@
+module Fleakr
+  class Photo
+    
+    def self.find_all_by_photoset_id(photoset_id)
+      response = Request.with_response!('photosets.getPhotos', :photoset_id => photoset_id)
+      (response.body/'rsp/photoset/photo').map do |photo_body|
+        Photo.new(photo_body)
+      end
+    end
+    
+    def initialize(photo_body)
+      @response_body = photo_body
+    end
+    
+    def title
+      (@response_body).attributes['title']
+    end
+    
+  end
+end

data/lib/fleakr/request.rb

@@ -1,6 +1,8 @@
 module Fleakr
   class Request
 
+    class ApiError < StandardError; end
+
     def self.api_key=(key)
       @api_key = key
     end
@@ -9,6 +11,15 @@ module Fleakr
       @api_key
     end
     
+    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
+    
     def endpoint_uri
       uri = URI.parse('http://api.flickr.com/services/rest/')
       uri.query = self.query_parameters
@@ -16,7 +27,7 @@ module Fleakr
     end
     
     def query_parameters
-      @parameters.map {|key,value| "#{key}=#{value}" }.join('&')
+      @parameters.map {|key,value| "#{key}=#{CGI.escape(value)}" }.join('&')
     end
     
     def initialize(method, additional_parameters = {})

data/lib/fleakr/response.rb

@@ -13,5 +13,12 @@ module Fleakr
       (self.body/'rsp').attr('stat') != 'ok'
     end
     
+    def error
+      if self.error?
+        node = (self.body/'rsp/err')
+        Error.new(node.attr('code'), node.attr('msg'))
+      end
+    end
+    
   end
 end

data/lib/fleakr/set.rb

@@ -1,13 +1,14 @@
 module Fleakr
   class Set
     
-    attr_accessor :title, :description
+    attr_accessor :id, :title, :description
     
     def self.find_all_by_user_id(user_id)
-      response = Request.new('photosets.getList', :user_id => user_id).send
+      response = Request.with_response!('photosets.getList', :user_id => user_id)
       
-      (response.body/'photosets/photoset').map do |flickr_set|
+      (response.body/'rsp/photosets/photoset').map do |flickr_set|
         set = Set.new
+        set.id = (flickr_set).attributes['id']
         set.title = (flickr_set/'title').inner_text
         set.description = (flickr_set/'description').inner_text
         set
@@ -15,5 +16,9 @@ module Fleakr
 
     end
     
+    def photos
+      @photos ||= Photo.find_all_by_photoset_id(self.id)
+    end
+    
   end
 end

data/lib/fleakr/user.rb

@@ -4,13 +4,23 @@ module Fleakr
     attr_accessor :id, :username
     
     def self.find_by_username(username)
-      response = Fleakr::Request.new('people.findByUsername', :username => username).send
-      
-      user = User.new
-      user.id = (response.body/'rsp/user').attr('id')
-      user.username = (response.body/'rsp/user/username').inner_text
-      
-      user
+      response = Request.with_response!('people.findByUsername', :username => username)
+      User.new(response.body)
+    end
+    
+    # flickr_attribute :id, :from => 'user', :attribute => 'nsid'
+    # flickr_attribute :username, :from => 'user/username', :text => true
+    
+    def initialize(response_body)
+      @response_body = (response_body/'rsp')
+    end
+    
+    def id
+      (@response_body/'user').attr('id')
+    end
+    
+    def username
+      (@response_body/'user/username').inner_text
     end
     
     def sets

data/lib/fleakr/version.rb

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

data/lib/fleakr.rb

@@ -1,6 +1,7 @@
 $:.unshift(File.dirname(__FILE__))
 
 require 'uri'
+require 'cgi'
 require 'net/http'
 require 'hpricot'
 

data/test/fixtures/photosets.getList.xml

@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <rsp stat="ok">
-<photosets>
-	<photoset videos="0" primary="3044180117" farm="4" photos="138" id="72157609490909659" server="3012" secret="01cd1a741d">
-		<title>Second Set</title>
-		<description>This is the second set.</description>
-	</photoset>
-	<photoset videos="0" primary="2988511085" farm="4" photos="139" id="72157608538140671" server="3241" secret="a7b90926ba">
-		<title>First Set</title>
-		<description>This is the first set.</description>
-	</photoset>
-</photosets>
+  <photosets>
+  	<photoset videos="0" primary="3044180117" farm="4" photos="138" id="72157609490909659" server="3012" secret="01cd1a741d">
+  		<title>Second Set</title>
+  		<description>This is the second set.</description>
+  	</photoset>
+  	<photoset videos="0" primary="2988511085" farm="4" photos="139" id="72157608538140671" server="3241" secret="a7b90926ba">
+  		<title>First Set</title>
+  		<description>This is the first set.</description>
+  	</photoset>
+  </photosets>
 </rsp>

data/test/fixtures/photosets.getPhotos.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <photoset id="72157609490909659" primary="3044180117" owner="31066442@N69" ownername="frootpantz" page="1" per_page="500" perpage="500" pages="1" total="138">
+  	<photo id="3044163577" secret="fa27e5a824" server="3153" farm="4" title="Photo #1" isprimary="0" />
+  	<photo id="3045001128" secret="a8c0e51b39" server="3204" farm="4" title="Photo #2" isprimary="0" />
+  </photoset>
+</rsp>

data/test/fleakr/error_test.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class ErrorTest < Test::Unit::TestCase
+    
+    describe "An instance of the Error class" do
+      
+      it "should have a code and a message" do
+        error = Error.new('1', 'User not found')
+        
+        error.code.should == '1'
+        error.message.should == 'User not found'
+      end
+      
+    end
+    
+    
+  end
+end

data/test/fleakr/photo_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class PhotoTest < Test::Unit::TestCase
+    
+    describe "The Photo class" do
+      
+      context "when finding all photos by photoset ID" do
+        
+        before do
+          mock_request_cycle :for => 'photosets.getPhotos', :with => {:photoset_id => '1'}
+          @photos = Photo.find_all_by_photoset_id('1')
+        end  
+      
+        it "should have the correct number of items" do
+          @photos.length.should == 2
+        end
+      
+        it "should have the proper title" do
+          @photos.map {|p| p.title}.should == ['Photo #1', 'Photo #2']
+        end
+      
+      end
+      
+    end
+    
+  end
+end

data/test/fleakr/request_test.rb

@@ -29,6 +29,11 @@ module Fleakr
           
           request.query_parameters.split('&').sort.should == expected
         end
+
+        it "should escape the keys and values in the parameter list" do
+          request = Request.new('flickr.people.findByUsername', :username => 'the decapitator')
+          request.query_parameters.split('&').include?("username=#{CGI.escape('the decapitator')}").should be(true)
+        end
         
         it "should translate a shorthand API call" do
           request = Request.new('people.findByUsername')
@@ -71,6 +76,22 @@ module Fleakr
           request.send.should == response_stub
         end
         
+        it "should be able to make a full request and response cycle" do
+          response = stub(:error? => false)
+          Response.expects(:new).with(kind_of(String)).returns(response)
+          
+          Request.with_response!('flickr.people.findByUsername', :username => 'foobar').should == response
+        end
+        
+        it "should raise an exception when the full request / response cycle has errors" do
+          response = stub(:error? => true, :error => stub(:code => '1', :message => 'User not found'))
+          Response.stubs(:new).with(kind_of(String)).returns(response)
+          
+          lambda do
+            Request.with_response!('flickr.people.findByUsername', :username => 'foobar')
+          end.should raise_error(Fleakr::Request::ApiError)
+        end
+        
       end
 
     end

data/test/fleakr/response_test.rb

@@ -29,6 +29,19 @@ module Fleakr
         
         response.error?.should be(true)
       end
+      
+      it "should not have an error if there are no errors in the XML" do
+        response = Response.new(read_fixture('people.findByUsername'))
+        response.error.should be(nil)
+      end
+      
+      it "should have an error if there is an error in the response" do
+        response_xml = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<rsp stat=\"fail\">\n\t<err code=\"1\" msg=\"User not found\" />\n</rsp>\n"
+        response = Response.new(response_xml)
+        
+        response.error.code.should == '1'
+        response.error.message.should == 'User not found'
+      end
 
     end
 

data/test/fleakr/set_test.rb

@@ -2,35 +2,59 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 module Fleakr
   class SetTest < Test::Unit::TestCase
-    
-    def mock_request_cycle(options)
-      response = stub(:body => read_fixture(options[:for]))
-      Request.expects(:new).with(options[:for], options[:with]).returns(stub(:send => response))
-    end
-    
+
     describe "The Set class" do
-      
       context "When finding all sets for a user_id" do
         before do
           user_id = '31066442@N69'
           mock_request_cycle :for => 'photosets.getList', :with => {:user_id => user_id}
-          
+
           @sets = Set.find_all_by_user_id(user_id)
         end
-        
+
         it "should return an array with the expected number of elements" do
           @sets.length.should == 2
         end
-        
+
         it "should have the proper titles for each set in the collection" do
           @sets.map {|s| s.title }.should == ["Second Set", "First Set"]
         end
-        
+
         it "should have the proper descriptions for each set in the collection" do
           @sets.map {|s| s.description }.should == ['This is the second set.', 'This is the first set.']
         end
+
+        it "should have the correct IDs for each of the sets" do
+          @sets.map {|s| s.id }.should == %w(72157609490909659 72157608538140671)
+        end
+
+      end
+    end
+
+    describe "An instance of the Set class" do
+      context "when accessing its list of photos" do
+        
+        before do
+          @set = Set.new()
+          @set.stubs(:id).with().returns('1')          
+        end
+
+        it "should retrieve a list of photos" do
+          photos = [stub()]
+
+          Photo.expects(:find_all_by_photoset_id).with('1').returns(photos)
+
+          @set.photos.should == photos
+        end
+        
+        it "should memoize the list of photos retrieved" do
+          Photo.expects(:find_all_by_photoset_id).once.returns([])
+          2.times { @set.photos }
+        end
         
       end
+
     end
+
   end
 end

data/test/fleakr/user_test.rb

@@ -6,8 +6,7 @@ module Fleakr
     describe "The User class" do
       
       it "should be able to find a user by his username" do
-        response = stub(:body => read_fixture('people.findByUsername'))
-        Request.expects(:new).with('people.findByUsername', :username => 'frootpantz').returns(stub(:send => response))
+        mock_request_cycle :for => 'people.findByUsername', :with => {:username => 'frootpantz'}
         
         user = User.find_by_username('frootpantz')
         
@@ -22,7 +21,7 @@ module Fleakr
       before do
         @user_id = '1'
         
-        @user = User.new
+        @user = User.new(Hpricot.XML(read_fixture('people.findByUsername')))
         @user.stubs(:id).with().returns(@user_id)
       end
       

data/test/test_helper.rb

@@ -11,7 +11,12 @@ class Test::Unit::TestCase
   
   def read_fixture(method_call)
     fixture_path = File.dirname(__FILE__) + '/fixtures'
-    Hpricot.XML(File.read("#{fixture_path}/#{method_call}.xml"))
+    File.read("#{fixture_path}/#{method_call}.xml")
+  end
+  
+  def mock_request_cycle(options)
+    response = stub(:body => Hpricot.XML(read_fixture(options[:for])))
+    Fleakr::Request.expects(:with_response!).with(options[:for], options[:with]).returns(response)
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reagent-fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -33,6 +33,8 @@ files:
 - README.markdown
 - Rakefile
 - lib/fleakr
+- lib/fleakr/error.rb
+- lib/fleakr/photo.rb
 - lib/fleakr/request.rb
 - lib/fleakr/response.rb
 - lib/fleakr/set.rb
@@ -42,7 +44,10 @@ files:
 - test/fixtures
 - test/fixtures/people.findByUsername.xml
 - test/fixtures/photosets.getList.xml
+- test/fixtures/photosets.getPhotos.xml
 - test/fleakr
+- test/fleakr/error_test.rb
+- test/fleakr/photo_test.rb
 - test/fleakr/request_test.rb
 - test/fleakr/response_test.rb
 - test/fleakr/set_test.rb