latompa-fleakr 0.5.5 → 0.5.7

data/lib/fleakr/api/parameter_list.rb

@@ -22,11 +22,15 @@ module Fleakr
       #   => #<Fleakr::Api::ValueParameter:0x1656da4 @include_in_signature=true, @name="foo", @value="bar">
       #
       def initialize(options = {})
+        # TODO: need to find a way to move the unexpected behavior in Fleakr.token elsewhere
+        @api_options = options.extract!(:authenticate?)
+        
         @list = Hash.new
 
         options.each {|k,v| self << ValueParameter.new(k.to_s, v) }
 
         self << ValueParameter.new('api_key', Fleakr.api_key)
+        self << ValueParameter.new('auth_token', Fleakr.token.value) if authenticate?
       end
       
       # Add a new parameter (ValueParameter / FileParameter) to the list
@@ -41,6 +45,14 @@ module Fleakr
         !Fleakr.shared_secret.blank?
       end
       
+      # Should we send the auth_token with the request?
+      #
+      def authenticate?
+        @api_options.has_key?(:authenticate?) ? @api_options[:authenticate?] : !Fleakr.token.blank?
+      end
+      
+      # Access an individual parameter by key (symbol or string)
+      #
       def [](key)
         list[key.to_s]
       end

data/lib/fleakr/objects/photo.rb

@@ -40,7 +40,7 @@ module Fleakr
       def_delegators :context, :next, :previous
 
       flickr_attribute :id, :from => ['@id', 'photoid']
-      flickr_attribute :title, :description, :secret, :posted, :taken, :url
+      flickr_attribute :title, :description, :secret, :posted, :taken, :url, :dateupload
       flickr_attribute :farm_id, :from => '@farm'
       flickr_attribute :server_id, :from => '@server'
       flickr_attribute :owner_id, :from => ['@owner', 'owner@nsid']

data/lib/fleakr/version.rb

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

data/lib/fleakr.rb

@@ -85,7 +85,7 @@ module Fleakr
   # Generic catch-all exception for any API errors
   class ApiError < StandardError; end
 
-  mattr_accessor :api_key, :shared_secret
+  mattr_accessor :api_key, :shared_secret, :mini_token, :auth_token, :frob
 
   # Find a user based on some unique user data.  This method will try to find
   # the user based on username and will fall back to email if that fails.  Example:
@@ -138,34 +138,38 @@ module Fleakr
     Fleakr::Objects::Contact.find_all_contacts(params)
   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.
-  # #
-  # def self.token
-  #   @token ||= begin
-  #     if Fleakr.auth_token
-  #       Fleakr::Objects::AuthenticationToken.from_auth_token(Fleakr.auth_token)
-  #     elsif Fleakr.frob
-  #       Fleakr::Objects::AuthenticationToken.from_frob(Fleakr.frob)
-  #     elsif Fleakr.mini_token
-  #       Fleakr::Objects::AuthenticationToken.from_mini_token(Fleakr.mini_token)
-  #     end
-  #   end
-  # end
-  # 
-  # # Reset the cached token whenever setting a new value for the mini_token, auth_token, or frob
-  # #
-  # [:mini_token, :auth_token, :frob].each do |attribute|
-  #   class_eval <<-ACCESSOR
-  #     def self.#{attribute}=(#{attribute})
-  #       reset_token
-  #       @@#{attribute} = #{attribute}
-  #     end
-  #   ACCESSOR
-  # end
-  # 
-  # def self.reset_token # :nodoc: #
-  #   @token = nil
-  # 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.
+  #
+  def self.token
+    Thread.current[:token] ||= begin
+      if Fleakr.auth_token
+        Fleakr::Objects::AuthenticationToken.from_auth_token(Fleakr.auth_token)
+      elsif Fleakr.frob
+        Fleakr::Objects::AuthenticationToken.from_frob(Fleakr.frob)
+      elsif Fleakr.mini_token
+        Fleakr::Objects::AuthenticationToken.from_mini_token(Fleakr.mini_token)
+      end
+    end
+  end
+  
+  # Reset the cached token whenever setting a new value for the mini_token, auth_token, or frob
+  #
+  [:mini_token, :auth_token, :frob].each do |attribute|
+    class_eval <<-ACCESSOR
+    def self.#{attribute}=(#{attribute})
+      Fleakr.reset_token
+      Thread.current[:#{attribute}] = #{attribute}
+    end
+
+    def self.#{attribute}
+      Thread.current[:#{attribute}]
+    end
+    ACCESSOR
+  end
+  
+  def self.reset_token # :nodoc: #
+    Thread.current[:token] = nil
+  end
   
 end

data/test/fixtures/people.getPublicPhotos.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <rsp stat="ok">
 <photos page="1" pages="1" perpage="100" total="76">
-	<photo id="2924549350" owner="21775151@N06" secret="cbc1804258" server="3250" farm="4" title="Photo #1" ispublic="1" isfriend="0" isfamily="0" />
-	<photo id="2923697303" owner="21775151@N06" secret="649aa95f29" server="3208" farm="4" title="Photo #2" ispublic="1" isfriend="0" isfamily="0" />
+	<photo id="2924549350" owner="21775151@N06" secret="cbc1804258" server="3250" farm="4" title="Photo #1" ispublic="1" isfriend="0" isfamily="0" dateupload="555"/>
+	<photo id="2923697303" owner="21775151@N06" secret="649aa95f29" server="3208" farm="4" title="Photo #2" ispublic="1" isfriend="0" isfamily="0" dateupload="555"/>
 </photos>
 </rsp>

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

@@ -86,42 +86,42 @@ module Fleakr::Api
         @parameter_list.sign?.should be(true)
       end
       
-      # should "know that it doesn't need to authenticate the request by default" do
-      #   @parameter_list.authenticate?.should be(false)
-      # end
-      
-      # 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
-      
-      # 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)
-      #   parameter_list.authenticate?.should be(false)
-      # end
-      # 
-      
-      # 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
-      
-      # 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)
-      #   auth_param = parameter_list[:auth_token]
-      #   
-      #   auth_param.name.should == 'auth_token'
-      #   auth_param.value.should == 'toke'
-      #   auth_param.include_in_signature?.should be(true)
-      # end
+      should "know that it doesn't need to authenticate the request by default" do
+        @parameter_list.authenticate?.should be(false)
+      end
+      
+      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
+      
+      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)
+        parameter_list.authenticate?.should be(false)
+      end
+      
+      
+      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
+      
+      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)
+        auth_param = parameter_list[:auth_token]
+        
+        auth_param.name.should == 'auth_token'
+        auth_param.value.should == 'toke'
+        auth_param.include_in_signature?.should be(true)
+      end
       
       should "include the signature in the list of parameters if the request is to be signed" do
         parameter_list = ParameterList.new

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

@@ -67,12 +67,13 @@ module Fleakr::Objects
           @object = Photo.new(Hpricot.XML(read_fixture('people.getPublicPhotos')).at('rsp/photos/photo'))
         end
 
-        should_have_a_value_for :id        => '2924549350'
-        should_have_a_value_for :title     => 'Photo #1'
-        should_have_a_value_for :farm_id   => '4'
-        should_have_a_value_for :server_id => '3250'
-        should_have_a_value_for :secret    => 'cbc1804258'
-        should_have_a_value_for :owner_id  => '21775151@N06'
+        should_have_a_value_for :id         => '2924549350'
+        should_have_a_value_for :title      => 'Photo #1'
+        should_have_a_value_for :farm_id    => '4'
+        should_have_a_value_for :server_id  => '3250'
+        should_have_a_value_for :secret     => 'cbc1804258'
+        should_have_a_value_for :owner_id   => '21775151@N06'
+        should_have_a_value_for :dateupload => '555'
         
       end
       

data/test/unit/fleakr_test.rb

@@ -4,7 +4,7 @@ class FleakrTest < Test::Unit::TestCase
   
   context "The Fleakr module" do
     
-    [:api_key, :shared_secret].each do |attribute|
+    [:api_key, :shared_secret, :mini_token, :auth_token].each do |attribute|
       should "be able to set a value for :#{attribute}" do
         value = 'value'
         
@@ -74,98 +74,90 @@ class FleakrTest < Test::Unit::TestCase
       Fleakr.upload(filename, :title => 'bop bip').should == [new_image]
     end
     
-    # should "be able to reset the cached token" do
-    #    @token = stub()
-    #    Fleakr.expects(:auth_token).with().at_least_once.returns('abc123')
-    #    Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('abc123').times(2).returns(@token)
-    #    Fleakr.token # once
-    #    Fleakr.reset_token
-    #    Fleakr.token # twice
-    #  end
-    #  
-    #  should "not have a token by default" do
-    #    Fleakr.expects(:mini_token).with().returns(nil)
-    #    Fleakr.expects(:auth_token).with().returns(nil)
-    #    Fleakr.expects(:frob).with().returns(nil)
-    #    
-    #    Fleakr.token.should be(nil)
-    #  end
-    #  
-    #  [:mini_token, :auth_token, :frob].each do |attribute|
-    #    should "reset_token when :#{attribute} is set" do
-    #      Fleakr.expects(:reset_token).with().at_least_once
-    #      Fleakr.send("#{attribute}=".to_sym, 'value')
-    #    end
-    #  end
+    should "be able to reset the cached token" do
+      @token = stub()
+      Fleakr.expects(:auth_token).with().at_least_once.returns('abc123')
+      Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('abc123').times(2).returns(@token)
+      Fleakr.token # once
+      Fleakr.reset_token
+      Fleakr.token # twice
+    end
+    
+    [:mini_token, :auth_token, :frob].each do |attribute|
+      should "reset_token when :#{attribute} is set" do
+        Fleakr.expects(:reset_token).with().at_least_once
+        Fleakr.send("#{attribute}=".to_sym, 'value')
+      end
+    end
+    
+    context "when generating an AuthenticationToken from an auth_token string" do
+
+      setup do
+        @token = stub()
+        
+        Fleakr.expects(:auth_token).with().at_least_once.returns('abc123')
+        Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('abc123').returns(@token)
+      end
+
+      # Make sure to clear the cache
+      teardown { Fleakr.auth_token = nil }
+      
+      should "return the token" do
+        Fleakr.token.should == @token
+      end
+      
+      should "cache the result" do
+        2.times { Fleakr.token }
+      end
+
+    end
+    
+    context "when generating an AuthenticationToken from a frob string" do
+
+      setup do
+        @token = stub()
+        
+        Fleakr.expects(:auth_token).with().at_least_once.returns(nil)
+        Fleakr.expects(:frob).with().at_least_once.returns('abc123')
+        Fleakr::Objects::AuthenticationToken.expects(:from_frob).with('abc123').returns(@token)
+      end
+
+      # Make sure to clear the cache
+      teardown { Fleakr.frob = nil }
+      
+      should "return the token" do
+        Fleakr.token.should == @token
+      end
+      
+      should "cache the result" do
+        2.times { Fleakr.token }
+      end
+
+    end
+    
+    context "when generating an AuthenticationToken from a mini_token string" do
+      
+      setup do
+        @token = stub()
+
+        Fleakr.expects(:auth_token).with().at_least_once.returns(nil)
+        Fleakr.expects(:mini_token).with().at_least_once.returns('123-123-123')
+        Fleakr::Objects::AuthenticationToken.expects(:from_mini_token).with('123-123-123').returns(@token)          
+      end
+      
+      # Make sure to clear the cache
+      teardown { Fleakr.mini_token = nil }
+      
+      should "return the token" do
+        Fleakr.token.should == @token
+      end
+      
+      should "cache the result" do
+        2.times { Fleakr.token }
+      end
+      
+    end
     
-   #  context "when generating an AuthenticationToken from an auth_token string" do
-   # 
-   #     setup do
-   #       @token = stub()
-   #       
-   #       Fleakr.expects(:auth_token).with().at_least_once.returns('abc123')
-   #       Fleakr::Objects::AuthenticationToken.expects(:from_auth_token).with('abc123').returns(@token)
-   #     end
-   # 
-   #     # Make sure to clear the cache
-   #     teardown { Fleakr.auth_token = nil }
-   #     
-   #     should "return the token" do
-   #       Fleakr.token.should == @token
-   #     end
-   #     
-   #     should "cache the result" do
-   #       2.times { Fleakr.token }
-   #     end
-   # 
-   #   end
-   #   
-   #   context "when generating an AuthenticationToken from a frob string" do
-   # 
-   #     setup do
-   #       @token = stub()
-   #       
-   #       Fleakr.expects(:auth_token).with().at_least_once.returns(nil)
-   #       Fleakr.expects(:frob).with().at_least_once.returns('abc123')
-   #       Fleakr::Objects::AuthenticationToken.expects(:from_frob).with('abc123').returns(@token)
-   #     end
-   # 
-   #     # Make sure to clear the cache
-   #     teardown { Fleakr.frob = nil }
-   #     
-   #     should "return the token" do
-   #       Fleakr.token.should == @token
-   #     end
-   #     
-   #     should "cache the result" do
-   #       2.times { Fleakr.token }
-   #     end
-   # 
-   #   end
-   #   
-   #   context "when generating an AuthenticationToken from a mini_token string" do
-   #     
-   #     setup do
-   #       @token = stub()
-   # 
-   #       Fleakr.expects(:auth_token).with().at_least_once.returns(nil)
-   #       Fleakr.expects(:mini_token).with().at_least_once.returns('123-123-123')
-   #       Fleakr::Objects::AuthenticationToken.expects(:from_mini_token).with('123-123-123').returns(@token)          
-   #     end
-   #     
-   #     # Make sure to clear the cache
-   #     teardown { Fleakr.mini_token = nil }
-   #     
-   #     should "return the token" do
-   #       Fleakr.token.should == @token
-   #     end
-   #     
-   #     should "cache the result" do
-   #       2.times { Fleakr.token }
-   #     end
-   #     
-   #   end
-   #   
-   end
+  end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: latompa-fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
+  version: 0.5.7
 platform: ruby
 authors: 
 - Patrick Reagan