reagent-fleakr 0.1.1 → 0.1.2

data/README.markdown

@@ -36,6 +36,16 @@ And that user's associated sets:
     => [#<Fleakr::Set:0x671358 @title="The Decapitator", @description="">, 
         #<Fleakr::Set:0x66d898 @title="londonpaper hijack", ...
 
+Or that user's groups:
+    
+    >> user.groups
+    => [#<Fleakr::Group:0x11f2330 ..., 
+        #<Fleakr::Group:0x11f2308 ...
+    >> user.groups.first.name
+    => "Rural Decay"
+    >> user.groups.first.id
+    => "14581414@N00"
+
 You can also grab photos for a particular set:
 
     >> user.sets.first

data/lib/fleakr.rb

@@ -5,4 +5,11 @@ require 'cgi'
 require 'net/http'
 require 'hpricot'
 
-Dir.glob(File.dirname(__FILE__) + '/**/*').each {|f| require f }
+require 'fleakr/object'
+require 'fleakr/photo'
+require 'fleakr/request'
+require 'fleakr/response'
+require 'fleakr/error'
+require 'fleakr/set'
+require 'fleakr/user'
+require 'fleakr/group'

data/lib/fleakr/error.rb

@@ -1,12 +1,10 @@
 module Fleakr
   class Error
     
-    attr_accessor :code, :message
+    include Fleakr::Object
     
-    def initialize(code, message)
-      self.code = code
-      self.message = message
-    end
+    flickr_attribute :code, :from => 'rsp/err', :attribute => 'code'
+    flickr_attribute :message, :from => 'rsp/err', :attribute => 'msg'
     
   end
 end

data/lib/fleakr/group.rb

@@ -0,0 +1,17 @@
+module Fleakr
+  class Group
+    
+    include Fleakr::Object
+    
+    flickr_attribute :id, :attribute => 'nsid'
+    flickr_attribute :name, :attribute => 'name'
+    
+    def self.find_all_by_user_id(user_id)
+      response = Request.with_response!('people.getPublicGroups', :user_id => user_id)
+      (response.body/'rsp/groups/group').map do |flickr_group|
+        Group.new(flickr_group)
+      end
+    end
+    
+  end
+end

data/lib/fleakr/object.rb

@@ -0,0 +1,30 @@
+module Fleakr
+  module Object
+    
+    module ClassMethods
+      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
+      end
+    end
+    
+    module InstanceMethods
+      def initialize(response)
+        @response = response
+      end
+    end
+
+    def self.included(other)
+      other.send(:extend, Fleakr::Object::ClassMethods)
+      other.send(:include, Fleakr::Object::InstanceMethods)
+    end    
+  end
+  
+end

data/lib/fleakr/photo.rb

@@ -1,5 +1,9 @@
 module Fleakr
   class Photo
+
+    include Fleakr::Object
+    
+    flickr_attribute :title, :attribute => 'title'
     
     def self.find_all_by_photoset_id(photoset_id)
       response = Request.with_response!('photosets.getPhotos', :photoset_id => photoset_id)
@@ -8,13 +12,5 @@ module Fleakr
       end
     end
     
-    def initialize(photo_body)
-      @response_body = photo_body
-    end
-    
-    def title
-      (@response_body).attributes['title']
-    end
-    
   end
 end

data/lib/fleakr/response.rb

@@ -14,10 +14,7 @@ module Fleakr
     end
     
     def error
-      if self.error?
-        node = (self.body/'rsp/err')
-        Error.new(node.attr('code'), node.attr('msg'))
-      end
+      Error.new(self.body) if self.error?
     end
     
   end

data/lib/fleakr/set.rb

@@ -1,19 +1,18 @@
 module Fleakr
   class Set
+
+    include Fleakr::Object
     
-    attr_accessor :id, :title, :description
+    flickr_attribute :id, :attribute => 'id'
+    flickr_attribute :title, :from => 'title'
+    flickr_attribute :description, :from => 'description'
     
     def self.find_all_by_user_id(user_id)
       response = Request.with_response!('photosets.getList', :user_id => user_id)
       
       (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
+        Set.new(flickr_set)
       end
-
     end
     
     def photos

data/lib/fleakr/user.rb

@@ -1,31 +1,28 @@
 module Fleakr
   class User
     
-    attr_accessor :id, :username
+    include Fleakr::Object
+    
+    flickr_attribute :id, :from => 'rsp/user', :attribute => 'nsid'
+    flickr_attribute :username, :from => 'rsp/user/username'
     
     def self.find_by_username(username)
       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
+    def self.find_by_email(email)
+      response = Request.with_response!('people.findByEmail', :find_email => email)
+      User.new(response.body)
     end
     
     def sets
       @set ||= Set.find_all_by_user_id(self.id)
     end
     
+    def groups
+      @groups ||= Group.find_all_by_user_id(self.id)
+    end
+    
   end
 end

data/lib/fleakr/version.rb

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

data/test/fixtures/people.findByEmail.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <user id="31066442@N69" nsid="31066442@N69">
+    <username>frootpantz</username>
+  </user>
+</rsp>

data/test/fixtures/people.getPublicGroups.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<groups>
+	<group nsid="13378274@N00" name="Group #1" admin="0" eighteenplus="0" />
+	<group nsid="52242140489@N01" name="Group #2" admin="0" eighteenplus="0" />
+</groups>
+</rsp>

data/test/fleakr/error_test.rb

@@ -6,7 +6,9 @@ module Fleakr
     describe "An instance of the Error class" do
       
       it "should have a code and a message" do
-        error = Error.new('1', 'User not found')
+        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"
+        
+        error = Error.new(Hpricot.XML(response_xml))
         
         error.code.should == '1'
         error.message.should == 'User not found'

data/test/fleakr/group_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class GroupTest < Test::Unit::TestCase
+
+    describe "The Group class" do
+      
+      it "should be able to find all groups by user ID" do
+        user_id = 'ABC123'
+        group_1, group_2 = [stub(), stub()]
+
+        response = mock_request_cycle :for => 'people.getPublicGroups', :with => {:user_id => user_id}
+
+        group_1_doc, group_2_doc = (response.body/'rsp/groups/group').map {|doc| doc }
+
+        Group.expects(:new).with(group_1_doc).returns(group_1)
+        Group.expects(:new).with(group_2_doc).returns(group_2)
+
+        Group.find_all_by_user_id(user_id).should == [group_1, group_2]
+      end
+
+    end
+    
+    describe "An instance of the Group class" do
+      context "when initializing from an Hpricot document" do
+        
+        before do
+          doc = (Hpricot.XML(read_fixture('people.getPublicGroups'))/'rsp/groups/group').first
+          @group = Group.new(doc)
+        end
+      
+        it "should have a value for :id" do
+          @group.id.should == '13378274@N00'
+        end
+        
+        it "should have a value for :name" do
+          @group.name.should == 'Group #1'
+        end
+        
+      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()
+          @set = Set.new(stub())
           @set.stubs(:id).with().returns('1')          
         end
 

data/test/fleakr/user_test.rb

@@ -4,41 +4,69 @@ module Fleakr
   class UserTest < Test::Unit::TestCase
 
     describe "The User class" do
-      
+    
       it "should be able to find a user by his username" do
-        mock_request_cycle :for => 'people.findByUsername', :with => {:username => 'frootpantz'}
+        user = stub()
+        response = mock_request_cycle :for => 'people.findByUsername', :with => {:username => 'frootpantz'}
         
-        user = User.find_by_username('frootpantz')
+        User.expects(:new).with(response.body).returns(user)
+        User.find_by_username('frootpantz').should == user
+      end
+    
+      it "should be able to find a user by his email" do
+        user = stub()
+        response = mock_request_cycle :for => 'people.findByEmail', :with => {:find_email => 'frootpantz@example.com'}
         
-        user.id.should       == '31066442@N69'
-        user.username.should == 'frootpantz'
+        User.expects(:new).with(response.body).returns(user)
+        User.find_by_email('frootpantz@example.com').should == user
       end
       
     end
-    
+
     describe "An instance of User" do
-      
+
       before do
-        @user_id = '1'
-        
-        @user = User.new(Hpricot.XML(read_fixture('people.findByUsername')))
-        @user.stubs(:id).with().returns(@user_id)
+        response_body = Hpricot.XML(read_fixture('people.findByUsername'))
+        @user = User.new(response_body)
+      end
+
+      it "should have a value for :id" do
+        @user.id.should == '31066442@N69'
       end
       
-      it "should retrieve the sets for this user" do
+      it "should have a value for :username" do
+        @user.username.should == 'frootpantz'
+      end
+      
+      it "should be able to retrieve the user's associated sets" do
         sets = [stub()]
-        Set.expects(:find_all_by_user_id).with(@user_id).returns(sets)
+        @user.stubs(:id).with().returns('1')
+
+        Set.expects(:find_all_by_user_id).with('1').returns(sets)
         
         @user.sets.should == sets
       end
       
       it "should memoize the results returned for this user's sets" do
         Set.expects(:find_all_by_user_id).once.returns([])
-        
         2.times { @user.sets }
       end
       
+      it "should be able to retrieve the user's associated groups" do
+        groups = [stub()]
+        @user.stubs(:id).with().returns('1')
+        
+        Group.expects(:find_all_by_user_id).with('1').returns(groups)
+        
+        @user.groups.should == groups
+      end
+      
+      it "should memoize the results returned for this user's group" do
+        Group.expects(:find_all_by_user_id).once.returns([])
+        2.times { @user.groups }
+      end
+      
     end
-    
+
   end
 end

data/test/test_helper.rb

@@ -17,6 +17,8 @@ class Test::Unit::TestCase
   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)
+    
+    response
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reagent-fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-29 00:00:00 -08:00
+date: 2008-11-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +34,8 @@ files:
 - Rakefile
 - lib/fleakr
 - lib/fleakr/error.rb
+- lib/fleakr/group.rb
+- lib/fleakr/object.rb
 - lib/fleakr/photo.rb
 - lib/fleakr/request.rb
 - lib/fleakr/response.rb
@@ -42,11 +44,14 @@ files:
 - lib/fleakr/version.rb
 - lib/fleakr.rb
 - test/fixtures
+- test/fixtures/people.findByEmail.xml
 - test/fixtures/people.findByUsername.xml
+- test/fixtures/people.getPublicGroups.xml
 - test/fixtures/photosets.getList.xml
 - test/fixtures/photosets.getPhotos.xml
 - test/fleakr
 - test/fleakr/error_test.rb
+- test/fleakr/group_test.rb
 - test/fleakr/photo_test.rb
 - test/fleakr/request_test.rb
 - test/fleakr/response_test.rb