fleakr 0.4.3 → 0.5.0

data/README.rdoc

@@ -148,7 +148,12 @@ All tags have values, but for tags associated with photos there is some addition
     >> tag.author
     => #<Fleakr::Objects::User:0x1a149f0 @username="the decapitator", ... >
     
-See Fleakr::Objects::Tag for more information.
+Each tag can also have related tags:
+
+    >> user.photos.first.tags[1].related.first.related.first.to_s
+    => "face"
+    
+You get the idea - see Fleakr::Objects::Tag for more information.
 
 === Comments
 

data/Rakefile

@@ -18,7 +18,7 @@ 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.6.0')
+  s.add_dependency('hpricot', '~> 0.8.1')
   s.add_dependency('activesupport', '~> 2.0')
   s.add_dependency('loggable', '~> 0.2.0')
 end

data/lib/fleakr.rb

@@ -15,7 +15,8 @@ require 'active_support/core_ext/time'
 require 'active_support/inflector'
 require 'active_support/core_ext/string'
 
-require 'md5'
+require 'digest/md5'
+require 'fileutils'
 require 'loggable'
 
 require 'fleakr/api'

data/lib/fleakr/api/option.rb

@@ -121,9 +121,9 @@ module Fleakr
      
       def value # :nodoc: 
         case @value
-          when :safe: 1
-          when :moderate: 2
-          when :restricted: 3
+          when :safe        then 1
+          when :moderate    then 2
+          when :restricted  then 3
         end
       end
       
@@ -143,9 +143,9 @@ module Fleakr
       
       def value # :nodoc:
         case @value
-          when :photo: 1
-          when :screenshot: 2
-          when :other: 3
+          when :photo       then 1
+          when :screenshot  then 2
+          when :other       then 3
         end
       end
       

data/lib/fleakr/version.rb

@@ -2,8 +2,8 @@ module Fleakr
   module Version # :nodoc:
     
     MAJOR = 0
-    MINOR = 4
-    TINY  = 3
+    MINOR = 5
+    TINY  = 0
     
     def self.to_s
       [MAJOR, MINOR, TINY].join('.')

data/test/test_helper.rb

@@ -1,8 +1,9 @@
 $:.reject! { |e| e.include? 'TextMate' }
 
 require 'rubygems'
+require 'test/unit'
+require 'shoulda'
 require 'matchy'
-require 'context'
 require 'mocha'
 
 require File.dirname(__FILE__) + '/../lib/fleakr'
@@ -12,7 +13,7 @@ class Test::Unit::TestCase
   def self.should_autoload_when_accessing(*attributes)
     options = attributes.extract_options!
     attributes.each do |accessor_name|
-      it "should load the additional user information when accessing the :#{accessor_name} attribute" do
+      should "load the additional user information when accessing the :#{accessor_name} attribute" do
         klass = self.class.name.sub(/Test$/, '').constantize
               
         object = klass.new
@@ -23,13 +24,13 @@ class Test::Unit::TestCase
   end
 
   def self.should_have_a_value_for(attribute_test)
-    it "should have a value for :#{attribute_test.keys.first}" do
+    should "have a value for :#{attribute_test.keys.first}" do
       @object.send(attribute_test.keys.first).should == attribute_test.values.first
     end
   end
 
   def self.should_search_by(key)
-    it "should be able to perform a scoped search by :#{key}" do
+    should "be able to perform a scoped search by :#{key}" do
       photos = [stub()]
       search = stub(:results => photos)
       
@@ -53,7 +54,7 @@ class Test::Unit::TestCase
     
     attributes.each do |attribute|
       target_klass = "Fleakr::Objects::#{attribute.to_s.singularize.classify}".constantize
-      it "should be able to retrieve the #{class_name.downcase}'s #{attribute}" do
+      should "be able to retrieve the #{class_name.downcase}'s #{attribute}" do
         results = [stub()]
         object = this_klass.new
         object.stubs(:id).with().returns('1')
@@ -62,7 +63,7 @@ class Test::Unit::TestCase
         object.send(attribute).should == results
       end
       
-      it "should memoize the results for the #{class_name.downcase}'s #{attribute}" do
+      should "memoize the results for the #{class_name.downcase}'s #{attribute}" do
         object = this_klass.new
         
         target_klass.expects("find_all_by_#{finder_attribute}".to_sym).once.returns([])
@@ -82,7 +83,7 @@ class Test::Unit::TestCase
     options[:with] = options[:by] if options[:with].nil?
     params = {options[:with] => condition_value}
 
-    it "should be able to find a #{thing} by #{options[:by]}" do
+    should "be able to find a #{thing} by #{options[:by]}" do
       stub = stub()
       response = mock_request_cycle :for => options[:call], :with => params
 
@@ -96,7 +97,7 @@ class Test::Unit::TestCase
     klass          = "Fleakr::Objects::#{class_name}".constantize
     object_type    = class_name.downcase
     
-    it "should be able to find all #{thing} by #{options[:by]}" do
+    should "be able to find all #{thing} by #{options[:by]}" do
       condition_value = '1'
       finder_options = {(options[:using] || options[:by]) => condition_value}
     

data/test/unit/fleakr/api/file_parameter_test.rb

@@ -3,44 +3,44 @@ require File.dirname(__FILE__) + '/../../../test_helper'
 module Fleakr::Api
   class FileParameterTest < Test::Unit::TestCase
     
-    describe "An instance of the FileParameter class" do
+    context "An instance of the FileParameter class" do
       
-      before do
+      setup do
         @temp_dir = File.expand_path(create_temp_directory)
         @filename = "#{@temp_dir}/image.jpg"
       end
       
-      after do
+      teardown do
         FileUtils.rm_rf(@temp_dir)
       end
       
-      it "should know not to include itself in the parameter signature" do
+      should "know not to include itself in the parameter signature" do
         parameter = FileParameter.new('photo', @filename)
         parameter.include_in_signature?.should be(false)
       end
       
       {'jpg' => 'image/jpeg', 'png' => 'image/png', 'gif' => 'image/gif'}.each do |ext, mime_type|
-        it "should know the correct MIME type for an extension of #{ext}" do
+        should "know the correct MIME type for an extension of #{ext}" do
           parameter = FileParameter.new('photo', "#{@temp_dir}/image.#{ext}")
           parameter.mime_type.should == mime_type
         end
       end
       
-      it "should retrieve the contents of the file when accessing the value" do
+      should "retrieve the contents of the file when accessing the value" do
         File.expects(:read).with(@filename).returns('bopbip')
         
         parameter = FileParameter.new('photo', @filename)
         parameter.value.should == 'bopbip'
       end
       
-      it "should cache the file contents after retrieving them" do
+      should "cache the file contents after retrieving them" do
         File.expects(:read).with(@filename).once.returns('bopbip')
         
         parameter = FileParameter.new('photo', @filename)
         2.times { parameter.value }
       end
       
-      it "should know how to generate a form representation of itself" do
+      should "know how to generate a form representation of itself" do
         filename  = 'image.jpg'
         mime_type = 'image/jpeg'
 

data/test/unit/fleakr/api/method_request_test.rb

@@ -3,17 +3,17 @@ require File.dirname(__FILE__) + '/../../../test_helper'
 module Fleakr::Api
   class MethodRequestTest < Test::Unit::TestCase
 
-    describe "An instance of MethodRequest" do
+    context "An instance of MethodRequest" do
 
       context "with API credentials" do
 
-        before do
+        setup do
           @api_key = 'f00b4r'
           Fleakr.stubs(:api_key).with().returns(@api_key)
           Fleakr.stubs(:shared_secret).with().returns('sekrit')
         end
 
-        it "should know the full query parameters" do
+        should "know the full query parameters" do
           request = MethodRequest.new('flickr.people.findByUsername', :username => 'foobar')
 
           request.parameters[:api_key].value.should  == @api_key
@@ -21,24 +21,25 @@ module Fleakr::Api
           request.parameters[:username].value.should == 'foobar'
         end
         
-        it "should translate a shorthand API call" do
+        should "translate a shorthand API call" do
           request = MethodRequest.new('people.findByUsername')
           request.parameters[:method].value.should == 'flickr.people.findByUsername'
         end
         
-        it "should know the endpoint with full parameters" do
+        should "know the endpoint with full parameters" do
           query_parameters = 'foo=bar'
         
           request = MethodRequest.new('people.getInfo')
           request.parameters.stubs(:to_query).returns(query_parameters)
         
-          uri_mock = mock() {|m| m.expects(:query=).with(query_parameters)}
+          uri_mock = mock()
+          uri_mock.expects(:query=).with(query_parameters)
           URI.expects(:parse).with("http://api.flickr.com/services/rest/").returns(uri_mock)
         
           request.__send__(:endpoint_uri).should == uri_mock
         end
         
-        it "should be able to make a request" do
+        should "be able to make a request" do
           endpoint_uri = stub()
           
           request = MethodRequest.new('people.findByUsername')
@@ -49,7 +50,7 @@ module Fleakr::Api
           request.send
         end
         
-        it "should create a response from the request" do
+        should "create a response from the request" do
           response_xml  = '<xml>'
           response_stub = stub()
         
@@ -62,7 +63,7 @@ module Fleakr::Api
           request.send.should == response_stub
         end
         
-        it "should be able to make a full request and response cycle" do
+        should "be able to make a full request and response cycle" do
           method = 'flickr.people.findByUsername'
           params = {:username => 'foobar'}
 
@@ -73,7 +74,7 @@ module Fleakr::Api
           MethodRequest.with_response!(method, params).should == response
         end
         
-        it "should raise an exception when the full request / response cycle has errors" do
+        should "raise an exception when the full request / response cycle has errors" do
           method = 'flickr.people.findByUsername'
           params = {:username => 'foobar'}
           

data/test/unit/fleakr/api/option_test.rb

@@ -5,12 +5,12 @@ module Fleakr::Api
   class OptionTest < Test::Unit::TestCase
     
     def self.should_know_the_class_for(type, options)
-      it "should know the class for the :#{type} type" do
+      should "know the class for the :#{type} type" do
         Option.class_for(type).should == options[:is]
       end
     end
     
-    describe "The Option class" do
+    context "The Option class" do
       should_know_the_class_for :title,       :is => Fleakr::Api::SimpleOption
       should_know_the_class_for :description, :is => Fleakr::Api::SimpleOption
       should_know_the_class_for :tags,        :is => Fleakr::Api::TagOption
@@ -19,7 +19,7 @@ module Fleakr::Api
       should_know_the_class_for :type,        :is => Fleakr::Api::TypeOption
       should_know_the_class_for :hide?,       :is => Fleakr::Api::HiddenOption
       
-      it "should be able to create an option for a type" do
+      should "be able to create an option for a type" do
         option = stub()
         
         Option.expects(:class_for).with(:title).returns(Fleakr::Api::SimpleOption)
@@ -33,18 +33,18 @@ module Fleakr::Api
   
   class SimpleOptionTest < Test::Unit::TestCase
     
-    describe "An instance of the SimpleOption class" do
-      it "should have a type" do
+    context "An instance of the SimpleOption class" do
+      should "have a type" do
         so = SimpleOption.new(:title, 'blip')
         so.type.should == :title
       end
       
-      it "should have a value" do
+      should "have a value" do
         so = SimpleOption.new(:title, 'blip')
         so.value.should == 'blip'
       end
       
-      it "should be able to generate a hash representation of itself" do
+      should "be able to generate a hash representation of itself" do
         so = SimpleOption.new(:title, 'blip')
         so.to_hash.should == {:title => 'blip'}
       end
@@ -54,19 +54,19 @@ module Fleakr::Api
 
   class TagOptionTest < Test::Unit::TestCase
     
-    describe "An instance of the TagOption class" do
+    context "An instance of the TagOption class" do
       
-      it "should normalize the input value to an array" do
+      should "normalize the input value to an array" do
         to = TagOption.new(:tags, 'blip')
         to.value.should == ['blip']
       end
       
-      it "should be able to generate a hash representation of itself with tags joined on spaces" do
+      should "be able to generate a hash representation of itself with tags joined on spaces" do
         to = TagOption.new(:tags, %w(bop bip))
         to.to_hash.should == {:tags => '"bop" "bip"'}
       end
       
-      it "should quote tag values with spaces" do
+      should "quote tag values with spaces" do
         to = TagOption.new(:tags, ['tag', 'one with spaces'])
         to.to_hash.should == {:tags => '"tag" "one with spaces"'}
       end
@@ -76,33 +76,33 @@ module Fleakr::Api
   
   class ViewOptionTest < Test::Unit::TestCase
     
-    describe "An instance of the ViewOption class" do
-      it "should be able to generate a hash representation for viewing by :everyone" do
+    context "An instance of the ViewOption class" do
+      should "be able to generate a hash representation for viewing by :everyone" do
         vo = ViewOption.new(:viewable_by, :everyone)
         vo.to_hash.should == {:is_public => 1, :is_family => 0, :is_friend => 0}
       end
 
-      it "should be able to generate a hash representation for viewing by :family" do
+      should "be able to generate a hash representation for viewing by :family" do
         vo = ViewOption.new(:viewable_by, :family)
         vo.to_hash.should == {:is_public => 0, :is_family => 1, :is_friend => 0}
       end
       
-      it "should be able to generate a hash representation for viewing by :friends" do
+      should "be able to generate a hash representation for viewing by :friends" do
         vo = ViewOption.new(:viewable_by, :friends)
         vo.to_hash.should == {:is_public => 0, :is_family => 0, :is_friend => 1}
       end
       
-      it "should know the visibility is public if value is set to :everyone" do
+      should "know the visibility is public if value is set to :everyone" do
         vo = ViewOption.new(:viewable_by, :everyone)
         vo.public?.should be(true)
       end
       
-      it "should know the visibility is not public if :everyone is not the only value" do
+      should "know the visibility is not public if :everyone is not the only value" do
         vo = ViewOption.new(:viewable_by, [:everyone, :family])
         vo.public?.should be(false)
       end
       
-      it "should know that its visible to friends and family if specified as such" do
+      should "know that its visible to friends and family if specified as such" do
         vo = ViewOption.new(:viewable_by, [:friends, :family])
         vo.friends?.should be(true)
         vo.family?.should be(true)
@@ -114,19 +114,19 @@ module Fleakr::Api
 
   class LevelOptionTest < Test::Unit::TestCase
     
-    describe "An instance of the LevelOption class" do
+    context "An instance of the LevelOption class" do
       
-      it "should be able to generate a hash representation for the :safe level" do
+      should "be able to generate a hash representation for the :safe level" do
         lo = LevelOption.new(:level, :safe)
         lo.to_hash.should == {:safety_level => 1}
       end
       
-      it "should be able to generate a hash representation for the :moderate level" do
+      should "be able to generate a hash representation for the :moderate level" do
         lo = LevelOption.new(:level, :moderate)
         lo.to_hash.should == {:safety_level => 2}
       end
       
-      it "should be able to generate a hash representation for the :restricted level" do
+      should "be able to generate a hash representation for the :restricted level" do
         lo = LevelOption.new(:level, :restricted)
         lo.to_hash.should == {:safety_level => 3}
       end
@@ -137,19 +137,19 @@ module Fleakr::Api
 
   class TypeOptionTest < Test::Unit::TestCase
     
-    describe "An instance of the TypeOption class" do
+    context "An instance of the TypeOption class" do
       
-      it "should be able to generate a hash representation for the :photo type" do
+      should "be able to generate a hash representation for the :photo type" do
         to = TypeOption.new(:type, :photo)
         to.to_hash.should == {:content_type => 1}
       end
       
-      it "should be able to generate a hash representation for the :screenshot type" do
+      should "be able to generate a hash representation for the :screenshot type" do
         to = TypeOption.new(:type, :screenshot)
         to.to_hash.should == {:content_type => 2}
       end
       
-      it "should be able to generate a hash representation for the :other type" do
+      should "be able to generate a hash representation for the :other type" do
         to = TypeOption.new(:type, :other)
         to.to_hash.should == {:content_type => 3}
       end
@@ -160,14 +160,14 @@ module Fleakr::Api
   
   class HiddenOptionTest < Test::Unit::TestCase
     
-    describe "An instance of the HiddenOption class" do
+    context "An instance of the HiddenOption class" do
       
-      it "should be able to generate a hash representation when set to true" do
+      should "be able to generate a hash representation when set to true" do
         ho = HiddenOption.new(:hide?, true)
         ho.to_hash.should == {:hidden => 2}
       end
       
-      it "should be able to generate a hash representation when set to false" do
+      should "be able to generate a hash representation when set to false" do
         ho = HiddenOption.new(:hide?, false)
         ho.to_hash.should == {:hidden => 1}
       end

data/test/unit/fleakr/api/parameter_list_test.rb

@@ -3,9 +3,9 @@ require File.dirname(__FILE__) + '/../../../test_helper'
 module Fleakr::Api
   class ParameterListTest < Test::Unit::TestCase
     
-    describe "An instance of the ParameterList class" do
+    context "An instance of the ParameterList class" do
       
-      before do
+      setup do
         @api_key = 'key'
         @secret  = 'foobar'
 
@@ -13,46 +13,46 @@ module Fleakr::Api
         @parameter_list = ParameterList.new
       end
       
-      it "should contain the :api_key by default" do
+      should "contain the :api_key by default" do
         @parameter_list[:api_key].name.should == 'api_key'
         @parameter_list[:api_key].value.should == @api_key
         @parameter_list[:api_key].include_in_signature?.should be(true)
       end
       
-      it "should be able to create an initial list of parameters" do
+      should "be able to create an initial list of parameters" do
         parameter_list = ParameterList.new(:one => 'two')
         parameter_list[:one].value.should == 'two'
       end
       
-      it "should be able to add parameters to its list" do
+      should "be able to add parameters to its list" do
         parameter = ValueParameter.new('foo', 'bar')
         
         @parameter_list << parameter
         @parameter_list['foo'].should == parameter
       end
       
-      it "should allow access to parameters by symbol" do
+      should "allow access to parameters by symbol" do
         parameter = ValueParameter.new('foo', 'bar')
         @parameter_list << parameter
         
         @parameter_list[:foo].should == parameter
       end
       
-      it "should overwrite existing values when a duplicate is added" do
+      should "overwrite existing values when a duplicate is added" do
         length = @parameter_list.instance_variable_get(:@list).length
         2.times {@parameter_list << ValueParameter.new('foo', 'bar') }
         
         @parameter_list.instance_variable_get(:@list).length.should == length + 1
       end
       
-      it "should be able to calculate the signature of the parameters" do
+      should "be able to calculate the signature of the parameters" do
         Fleakr.stubs(:shared_secret).with().returns(@secret)
         
         @parameter_list << ValueParameter.new('foo', 'bar')
         @parameter_list.signature.should == Digest::MD5.hexdigest("#{@secret}api_key#{@api_key}foobar")
       end
       
-      it "should use the correct order when signing a list of multiple parameters" do
+      should "use the correct order when signing a list of multiple parameters" do
         Fleakr.stubs(:shared_secret).with().returns(@secret)
         
         @parameter_list << ValueParameter.new('z', 'a')
@@ -61,7 +61,7 @@ module Fleakr::Api
         @parameter_list.signature.should == Digest::MD5.hexdigest("#{@secret}azapi_key#{@api_key}za")
       end
       
-      it "should ignore the parameters that aren't included in the signature" do
+      should "ignore the parameters that aren't included in the signature" do
         Fleakr.stubs(:shared_secret).with().returns(@secret)
         
         @parameter_list << ValueParameter.new('foo', 'bar')
@@ -70,34 +70,34 @@ module Fleakr::Api
         @parameter_list.signature.should == Digest::MD5.hexdigest("#{@secret}api_key#{@api_key}foobar")
       end
       
-      it "should be able to generate a boundary for post data" do
+      should "be able to generate a boundary for post data" do
         rand = '0.123'
         
         @parameter_list.stubs(:rand).with().returns(stub(:to_s => rand))
         @parameter_list.boundary.should == Digest::MD5.hexdigest(rand)
       end
       
-      it "should know that it doesn't need to sign the request by default" do
+      should "know that it doesn't need to sign the request by default" do
         @parameter_list.sign?.should be(false)
       end
       
-      it "should know that it needs to sign the request when a shared secret is available" do
+      should "know that it needs to sign the request when a shared secret is available" do
         Fleakr.expects(:shared_secret).with().returns(@secret)
         @parameter_list.sign?.should be(true)
       end
       
-      it "should know that it doesn't need to authenticate the request by default" do
+      should "know that it doesn't need to authenticate the request by default" do
         @parameter_list.authenticate?.should be(false)
       end
       
-      it "should know to authenticate the request when a token is available" do
+      should "know to authenticate the request when a token is available" do
         Fleakr.stubs(:token).with().returns(stub(:value => 'toke'))
         parameter_list = ParameterList.new
 
         parameter_list.authenticate?.should be(true)
       end
       
-      it "should not authenticate the request if it's been specifically told not to" do
+      should "not authenticate the request if it's been specifically told not to" do
         Fleakr.expects(:token).with().never
         
         parameter_list = ParameterList.new(:authenticate? => false)
@@ -105,14 +105,14 @@ module Fleakr::Api
       end
       
       
-      it "should know to authenticate the request when asked" do
+      should "know to authenticate the request when asked" do
         Fleakr.expects(:token).with().returns(stub(:value => 'toke'))
         
         parameter_list = ParameterList.new(:authenticate? => true)
         parameter_list.authenticate?.should be(true)
       end
       
-      it "should contain the :auth_token parameter in the list if the request is to be authenticated" do
+      should "contain the :auth_token parameter in the list if the request is to be authenticated" do
         Fleakr.expects(:token).with().returns(stub(:value => 'toke'))
         
         parameter_list = ParameterList.new(:authenticate? => true)
@@ -123,7 +123,7 @@ module Fleakr::Api
         auth_param.include_in_signature?.should be(true)
       end
       
-      it "should include the signature in the list of parameters if the request is to be signed" do
+      should "include the signature in the list of parameters if the request is to be signed" do
         parameter_list = ParameterList.new
         
         parameter_list.stubs(:sign?).with().returns(true)
@@ -138,7 +138,7 @@ module Fleakr::Api
       
       context "with associated parameters" do
       
-        before do
+        setup do
           @p1 = ValueParameter.new('a', 'b')
           @p2 = ValueParameter.new('c', 'd')
       
@@ -151,11 +151,11 @@ module Fleakr::Api
           @parameter_list.stubs(:list).with().returns('a' => @p1, 'c' => @p2)
         end
       
-        it "should be able to generate a query representation of itself" do
+        should "be able to generate a query representation of itself" do
           @parameter_list.to_query.should == 'q1&q2'
         end
       
-        it "should be able to represent a form representation of itself" do
+        should "be able to represent a form representation of itself" do
           @parameter_list.stubs(:boundary).returns('bound')
           
           expected =