reagent-fleakr 0.5.0 → 0.5.1

data/README.rdoc

@@ -89,7 +89,28 @@ When accessing a set, you can also grab all the photos that are in that set:
     => #<Fleakr::Objects::Photo:0x1140108 ... >
     >> user.sets.first.photos.first.title
     => "Untitled1"
+
+=== Contacts
+
+Besides pulling back a given user's public contacts list, you can also retrieve the list of 
+contacts for the currently authenticated user (see below about authentication).  For example,
+you can retrieve all contacts:
+
+    >> Fleakr.contacts
+    => [#<Fleakr::Objects::Contact:0x111ff84 @username="bryan.ray" ...>]
+    
+Or just the contacts marked as 'family':
+    
+    >> Fleakr.contacts(:family)
+    => [#<Fleakr::Objects::Contact:0x12db42c @username="Grandbob" ...>]
+    
+Or a specific page of contacts marked as 'friends':
     
+    >> Fleakr.contacts(:friends, :page => 3, :per_page => 5)
+    => [#<Fleakr::Objects::Contact:0x12a6c54 @username="Louise and BCG" ...>]
+
+See the documentation for Fleakr.contacts for what options are available.
+
 === Photos
 
 Each photo object contains metadata about a collection of images, each representing different
@@ -306,6 +327,16 @@ just the requests you need to tune the log level:
 Even if something doesn't go wrong, this is a good way to get a sense for when you're making
 API requests.
 
+== Contributors
+
+While Fleakr started as a labor of love for me, I'm glad that others have been interested
+in this project enough to contribute their ideas and code:
+
+* {John Guenin}[http://github.com/johng]
+* {Thomas Olausson}[http://github.com/latompa]
+
+Thanks!
+
 == Roadmap / TODO
 
 === 0.4.x

data/Rakefile

@@ -4,8 +4,6 @@ require 'rake/testtask'
 
 require 'lib/fleakr/version'
 
-task :default => :test
-
 spec = Gem::Specification.new do |s|
   s.name             = 'fleakr'
   s.version          = Fleakr::Version.to_s
@@ -18,9 +16,9 @@ spec = Gem::Specification.new do |s|
   s.homepage         = 'http://sneaq.net'
   s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
   
-  s.add_dependency('hpricot', '~> 0.8.1')
-  s.add_dependency('activesupport', '~> 2.0')
-  s.add_dependency('loggable', '~> 0.2.0')
+  s.add_dependency('hpricot', '>= 0.6.164')
+  s.add_dependency('activesupport', '>= 2.0')
+  s.add_dependency('loggable', '>= 0.2.0')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
@@ -33,6 +31,23 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs       = ['test']
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.verbose    = true
+    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
+  end
+  
+  task :default => :coverage
+  
+rescue LoadError
+  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
+  task :default => :test
+end
+
 desc 'Generate the gemspec to serve this Gem from Github'
 task :github do
   file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"

data/lib/fleakr.rb

@@ -130,6 +130,27 @@ module Fleakr
   def self.upload(glob, options = {})
     Dir[glob].map {|file| Fleakr::Objects::Photo.upload(file, options) }
   end
+  
+  # Get all contacts for the currently authenticated user.  The provided contact type can be
+  # one of the following:
+  #
+  # [:friends] Only contacts who are friends (and not family)
+  # [:family] Only contacts who are family (and not friends)
+  # [:both] Only contacts who are both friends and family
+  # [:neither] Only contacts who are neither friends nor family
+  #
+  # Additional parameters supported are:
+  #
+  # [:page] The page of results to return
+  # [:per_page] The number of contacts to retrieve per page
+  #
+  def self.contacts(contact_type = nil, additional_options = {})
+    options = {}
+    options.merge!(:filter => contact_type) unless contact_type.nil?
+    options.merge!(additional_options)
+    
+    Fleakr::Objects::Contact.find_all(options)
+  end
 
   # Get the authentication token needed for authenticated requests.  Will either use
   # a valid auth_token (if available) or a mini-token to generate the auth_token.

data/lib/fleakr/objects/contact.rb

@@ -5,18 +5,26 @@ module Fleakr
       include Fleakr::Support::Object
 
       flickr_attribute :id, :from => '@nsid'
-      flickr_attribute :username
+      flickr_attribute :username, :location
+      flickr_attribute :name, :from => '@realname'
       flickr_attribute :icon_server, :from => '@iconserver'
       flickr_attribute :icon_farm,   :from => '@iconfarm'
 
       # Retrieve a list of contacts for the specified user ID and return an initialized
-      # collection of #User objects
+      # collection of User objects
       def self.find_all_by_user_id(user_id)
         response = Fleakr::Api::MethodRequest.with_response!('contacts.getPublicList', :user_id => user_id)
         (response.body/'contacts/contact').map {|c| Contact.new(c).to_user }
       end
       
-      def to_user
+      # Retrieve a list of contacts for the currently authenticated user
+      def self.find_all(params = {})
+        response = Fleakr::Api::MethodRequest.with_response!('contacts.getList', params)
+        (response.body/'contacts/contact').map {|c| Contact.new(c) }
+      end
+      
+      # TODO: deprecate in favor of shared behavior as a module
+      def to_user # :nodoc:
         user = User.new
         self.class.attributes.each do |attribute|
           attribute_name = attribute.name

data/lib/fleakr/objects/photo.rb

@@ -12,6 +12,7 @@ module Fleakr
     # [title] The title of this photo
     # [description] The description of this photo
     # [secret] This photo's secret (used for sharing photo without permissions checking)
+    # [original_secret] This photo's original secret
     # [comment_count] Count of the comments attached to this photo
     # [url] This photo's page on Flickr
     # [square] The tiny square representation of this photo
@@ -46,6 +47,7 @@ module Fleakr
       flickr_attribute :owner_id, :from => ['@owner', 'owner@nsid']
       flickr_attribute :updated, :from => '@lastupdate'
       flickr_attribute :comment_count, :from => 'comments'
+      flickr_attribute :original_secret, :from => '@originalsecret'
 
       # TODO:
       # * visibility

data/lib/fleakr/version.rb

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

data/test/fixtures/contacts.getList.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<contacts page="1" pages="1" per_page="1000" perpage="1000" total="17">
+	<contact nsid="9302864@N42" username="blinky" iconserver="2263" iconfarm="3" ignored="0" realname="Mr Blinky" location="Middletown"/>
+	<contact nsid="63204625@N20" username="inky" iconserver="53" iconfarm="1" ignored="0" />
+</contacts>
+</rsp>

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

@@ -6,26 +6,34 @@ module Fleakr::Objects
     context "The Contact class" do
       
       should "return a list of users for a specified user's contacts" do
-        # user_1, user_2 = [stub(), stub()]
-        user_1 = stub()
-        user_2 = stub()
-        
+        user_1, user_2 = stub(), stub()
+
         contact_1, contact_2 = [stub(:to_user => user_1), stub(:to_user => user_2)]
-        
+
         response = mock_request_cycle :for => 'contacts.getPublicList', :with => {:user_id => '1'}
-        
+
         contact_1_doc, contact_2_doc = (response.body/'rsp/contacts/contact').to_a
-        
+
         Contact.stubs(:new).with(contact_1_doc).returns(contact_1)
         Contact.stubs(:new).with(contact_2_doc).returns(contact_2)
-        
+
         Contact.find_all_by_user_id('1').should == [user_1, user_2]
       end
       
+      should "return a list of users for an authenticated user" do
+        response = mock_request_cycle :for => 'contacts.getList', :with => {}
+        contact_1, contact_2 = [stub("contact"), stub('contact')]
+        contact_1_doc, contact_2_doc = (response.body/'rsp/contacts/contact').to_a
+
+        Contact.stubs(:new).with(contact_1_doc).returns(@contact_1)
+        Contact.stubs(:new).with(contact_2_doc).returns(@contact_2)
+        Contact.find_all.should == [@user_1, @user_2]
+      end
+      
     end
 
     context "An instance of the Contact class" do
-      context "when populating from an XML document" do
+      context "when populating from an XML document with public contacts" do
         setup do
           @object = Contact.new(Hpricot.XML(read_fixture('contacts.getPublicList')).at('contacts/contact'))
         end
@@ -36,6 +44,21 @@ module Fleakr::Objects
         should_have_a_value_for :icon_farm   => '3'
 
       end
+      
+      context "when populating from an XML document with authenticated user's contacts" do
+        setup do
+          @object = Contact.new(Hpricot.XML(read_fixture('contacts.getList')).at('contacts/contact'))
+        end
+
+        should_have_a_value_for :id           => '9302864@N42'
+        should_have_a_value_for :username     => 'blinky'
+        should_have_a_value_for :icon_server  => '2263'
+        should_have_a_value_for :icon_farm    => '3'
+        should_have_a_value_for :name         => 'Mr Blinky'
+        should_have_a_value_for :location     => 'Middletown'
+
+      end
+
 
       context "in general" do
         
@@ -45,7 +68,7 @@ module Fleakr::Objects
           
           User.stubs(:new).returns(user)
           
-          [:id, :username, :icon_server, :icon_farm].each do |method|
+          [:id, :username, :icon_server, :icon_farm, :name, :location].each do |method|
             contact.stubs(method).with().returns(method.to_s)
             user.expects("#{method}=".to_sym).with(method.to_s)
           end

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

@@ -90,18 +90,19 @@ module Fleakr::Objects
           
         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 :owner_id      => '31066442@N69'
-        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'
+        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 :owner_id         => '31066442@N69'
+        should_have_a_value_for :secret           => 'secret'
+        should_have_a_value_for :original_secret  => 'sekrit'
+        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
       

data/test/unit/fleakr_test.rb

@@ -29,6 +29,21 @@ class FleakrTest < Test::Unit::TestCase
       Fleakr.user(email).should == user
     end
     
+    should "find all contacts for the authenticated user" do
+      Fleakr::Objects::Contact.expects(:find_all).with({}).returns('contacts')
+      Fleakr.contacts.should == 'contacts'
+    end
+    
+    should "allow filtering when finding contacts for the authenticated user" do
+      Fleakr::Objects::Contact.expects(:find_all).with(:filter => :friends).returns('contacts')
+      Fleakr.contacts(:friends).should == 'contacts'
+    end
+    
+    should "allow passing of additional parameters when finding contacts for the authenticated user" do
+      Fleakr::Objects::Contact.expects(:find_all).with(:filter => :friends, :page => 1).returns('contacts')
+      Fleakr.contacts(:friends, :page => 1).should == 'contacts'
+    end
+    
     should "be able to perform text searches" do
       photos = [stub()]
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reagent-fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -07:00
+date: 2009-07-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.1
+        version: 0.6.164
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -28,7 +28,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: "2.0"
     version: 
@@ -38,7 +38,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 0.2.0
     version: 
@@ -93,6 +93,7 @@ files:
 - test/fixtures/auth.checkToken.xml
 - test/fixtures/auth.getFullToken.xml
 - test/fixtures/auth.getToken.xml
+- test/fixtures/contacts.getList.xml
 - test/fixtures/contacts.getPublicList.xml
 - test/fixtures/groups.pools.getPhotos.xml
 - test/fixtures/people.findByEmail.xml
@@ -144,7 +145,7 @@ files:
 - test/unit/fleakr/support/attribute_test.rb
 - test/unit/fleakr/support/object_test.rb
 - test/unit/fleakr_test.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://sneaq.net
 post_install_message: 
 rdoc_options: 
@@ -169,7 +170,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A small, yet powerful, gem to interface with Flickr photostreams
 test_files: []