objectiveflickr 0.9.1 → 0.9.2

data/History.txt

@@ -0,0 +1,46 @@
+2006-12-27 (0.9.2):
+	* Added support for Flickr's new "farm" part newly found in its photo URLs
+	
+	* Your code needs no change, everything will just work, including
+	  those photo URL/div id helpers, but on the other hand...
+	  
+	* Deprecated methods in FlickrInvocation:
+
+	  * photo_url(params)
+	  * photo_div_id(params, prefix='photo')
+	  * photo_url_from_div_id(uid)
+	  * photo_info_from_div_id(uid)
+	 
+	  Those are methods that should never go into an invocation object.
+	  Instead they belong to a helper, so:
+	
+	* Created a FlickrPhoto module
+
+  	  FlickrPhoto.url_from_hash(params)
+	  FlickrPhoto.unique_id_from_hash(params, prefix)
+	  FlickrPhoto.url_from_unique_id(uid)
+	  FlickrPhoto.hash_from_unique_id(uid)
+
+	  Those helper functions now take place of their deprecated
+	  predecessors.
+	  
+    * Before :server_id and :server were both accepted hash key
+      for the "param" in those helper functions, now only :server
+      is accepted. This is in accordance with Flickr's own
+      naming convention.
+      
+    * You no longer need to set :auth=>true if you already supply
+      an :auth_token parameter when you make Flickr method calls.
+      Since :auth_token always implies that the call must be
+      authenticated, ObjectiveFlickr is happy to save a few strokes
+      for you. :)
+
+    
+2006-12-12 (0.9.1):
+	Added default_* methods into FlickrInvocation
+	Removed History.txt
+
+	
+2006-12-10 (0.9.0):
+	Initial release.
+

data/Manifest.txt

@@ -6,6 +6,7 @@ setup.rb
 lib/objectiveflickr.rb
 lib/objectiveflickr/version.rb
 lib/objectiveflickr/flickr_invocation.rb
+lib/objectiveflickr/flickr_photo.rb
 lib/objectiveflickr/flickr_response.rb
 test/test_helper.rb
 test/objectiveflickr_test.rb

data/lib/objectiveflickr/flickr_invocation.rb

@@ -7,16 +7,16 @@
 # Copyright:: Copyright (c) 2006 Lukhnos D. Liu
 # License:: Distributed under the New BSD License
 
-# This class plays the major role of the package. Named "FlickrInvocation"
-# to allude to the making of an RPC call.
-
 require 'rubygems'
 require 'net/http'
 require 'jcode'
 require 'digest/md5'
+
 $KCODE = 'UTF8'
 
-# FlickrInvocation
+# This class plays the major role of the package. Named "FlickrInvocation"
+# to allude to the making of an RPC call.
+
 class FlickrInvocation
   @@default_api_key = ''
   @@default_shared_secret = ''
@@ -25,7 +25,6 @@ class FlickrInvocation
   SHARED_SECRET = ''
   AUTH_ENDPOINT = 'http://flickr.com/services/auth/'
   REST_ENDPOINT = 'http://api.flickr.com/services/rest/'
-  PHOTOURL_BASE = 'http://static.flickr.com/'
 
   # Initializes the instance with the api_key (required) and an 
   # optional shared_secret (required only if you need to make 
@@ -42,6 +41,10 @@ class FlickrInvocation
   # if you want the method call to be signed (required when you
   # make authenticaed calls, e.g. flickr.auth.getFrob or 
   # any method call that requires an auth token)
+  #
+  # NOTE: If you supply :auth_token in the params hash, your API
+  # call will automatically be signed, and the call will be 
+  # treated by Flickr as an authenticated call
   def call(method, params=nil)
     url = method_url(method, params)
     rsp = FlickrResponse.new Net::HTTP.get(URI.parse(url))
@@ -62,31 +65,24 @@ class FlickrInvocation
     url = "#{AUTH_ENDPOINT}?api_key=#{@api_key}&perms=#{permission}&api_sig=#{sig}"
   end
     
-  # This utility method returns the URL of a Flickr photo using
-  # the keys :server_id, :id, :secret, :size and :type
+  # DEPRECATED--Use FlickrPhoto.url_from_hash(params)
   def photo_url(params)
-    photo_url_form(photo_params(params))
+    FlickrPhoto.url_from_hash(params)
   end
-  
-  # This utility method combines the Flickr photo keys (from which
-  # one gets the real URL of a photo) into a photo id that you can
-  # use in a div
+
+  # DEPRECATED--Use FlickrPhoto.unique_id_from_hash(params, prefix)
   def photo_div_id(params, prefix='photo')
-    p = photo_params(params)
-    [prefix, p[:server_id], p[:id], p[:secret], p[:size], p[:type]].join("-")
+    FlickrPhoto.unique_id_from_hash(params, prefix)
   end
-  
-  # This utility method breaks apart the photo id into Flickr photo
-  # keys and returns the photo URL
-  def photo_url_from_div_id(params)
-    photo_url(photo_info_from_div_id(params))
+
+  # DEPRECATED--Use FlickrPhoto.url_from_unique_id(uid)
+  def photo_url_from_div_id(uid)
+    FlickrPhoto.url_from_unique_id(uid)
   end
 
-  # This utility method breaks apart the photo id into Flickr photo
-  # keys and returns a hash of the photo information
-  def photo_info_from_div_id(params)
-    p = params.split("-")
-    { :server_id=>p[1], :id=>p[2], :secret=>p[3], :size=>p[4], :type=>p[5] }
+  # DEPRECATED--Use FlickrPhoto.hash_from_unique_id(uid)
+  def photo_info_from_div_id(uid)
+    FlickrPhoto.hash_from_unique_id(uid)
   end
 
   # set the default API key
@@ -98,7 +94,8 @@ class FlickrInvocation
   def self.default_shared_secret(s)
     @@default_shared_secret=s
   end
-  
+
+  # set the default options, e.g. :raise_exception_on_error=>true  
   def self.default_options(o)
     @@default_options = o
   end
@@ -111,7 +108,7 @@ class FlickrInvocation
     p[:nojsoncallback] = 1
     
     url = "#{REST_ENDPOINT}?api_key=#{@api_key}&method=#{method}"
-    if p[:auth] || p["auth"]
+    if p[:auth] || p["auth"] || p[:auth_token] || p["auth_token"]
       p.delete(:auth)
       p.delete("auth")
       sigp = p
@@ -124,36 +121,13 @@ class FlickrInvocation
     url
   end
   
-  private
-  def photo_url_form(p)
-    url = "#{PHOTOURL_BASE}#{p[:server_id]}/#{p[:id]}_#{p[:secret]}"
-    if p[:size].length > 0
-      url += "_#{p[:size]}"
-    end
-
-    url += ".#{p[:type]}"
-  end
-
-  private
-  def photo_params(params)
-    {
-      :server_id => params[:server] || params["server"] || params[:server_id] || params["server_id"] || "",
-      :id => params[:id] || params["id"] || "",
-      :secret => params[:secret] || params["secret"] || "",
-      :size => params[:size] || params["size"] || "",
-      :type => params[:type] || params["type"] || "jpg"
-    }
-  end
-
   private
   def api_sig(params)
     sigstr = @shared_secret
-    params.keys.sort { |x, y| x.to_s <=> y.to_s }.each { |k|
+    params.keys.sort { |x, y| x.to_s <=> y.to_s }.each do |k|
       sigstr += k.to_s
       sigstr += params[k].to_s
-    }  
-    md5str = Digest::MD5.hexdigest(sigstr)
-    # print "sigstr=#{sigstr}, md5str=#{md5str}\n"
-    md5str
+    end
+    Digest::MD5.hexdigest(sigstr)
   end
 end

data/lib/objectiveflickr/flickr_photo.rb

@@ -0,0 +1,75 @@
+# objectiveflickr is a minimalistic Flickr API library that uses REST-style calls 
+# and receives JSON response blocks, resulting in very concise code. Named so in 
+# order to echo another Flickr library of mine, under the same name, developed 
+# for Objective-C.
+#
+# Author:: Lukhnos D. Liu (mailto:lukhnos@gmail.com)
+# Copyright:: Copyright (c) 2006 Lukhnos D. Liu
+# License:: Distributed under the New BSD License
+
+# This helper module provides a set of utility methods for Flickr photos.
+# Methods such as unique_id_from_hash and url_from_unique_id are 
+# helpful when you try to move the photo id data to and fro your web 
+# apps. 
+
+module FlickrPhoto
+  @photo_url_base = 'static.flickr.com'
+
+  # Set the default photo base URL, without the http:// part
+  def self.default_photo_url_base(b)
+    @photo_url_base = b
+  end
+
+  # This utility method returns the URL of a Flickr photo using
+  # the keys :farm, :server, :id, :secret, :size and :type  
+  def self.url_from_hash(params)
+    self.url_from_normalized_hash(self.normalize_parameter(params))
+  end
+
+  # This utility method combines the Flickr photo keys (from which
+  # one gets the real URL of a photo) into a photo id that you can
+  # use in a div
+  def self.unique_id_from_hash(params, prefix='photo')
+    p = self.normalize_parameter(params)
+    [prefix, p[:server], p[:id], p[:secret], p[:farm], p[:size], p[:type]].join("-")    
+  end
+
+  # This utility method breaks apart the photo id into Flickr photo
+  # keys and returns the photo URL  
+  def self.url_from_unique_id(uid)
+    self.url_from_normalized_hash(self.hash_from_unique_id(uid))
+  end
+
+  # This utility method breaks apart the photo id into Flickr photo
+  # keys and returns a hash of the photo information
+  #
+  # NOTE: No sanitation check here
+  def self.hash_from_unique_id(uid)      
+    p = uid.split("-")
+    {
+      :server=>p[1], :id=>p[2], :secret=>p[3],
+      :farm=>p[4], :size=>p[5], :type=>p[6]
+    }
+  end
+
+  private
+  def self.url_from_normalized_hash(p)
+    urlbase = (p[:farm] && p[:farm].to_s.length > 0) ? "http://farm#{p[:farm]}." : "http://"
+    url = "#{urlbase}#{@photo_url_base}/#{p[:server]}/#{p[:id]}_#{p[:secret]}"
+    url += "_#{p[:size]}" if p[:size].length > 0
+    url += ".#{p[:type]}"
+  end
+
+  private
+  def self.normalize_parameter(params)
+    {
+      :farm => (params[:farm] || params["farm"] || "").to_s,
+      :server => (params[:server] || params["server"] || "").to_s,
+      :id => (params[:id] || params["id"] || "").to_s,
+      :secret => (params[:secret] || params["secret"] || "").to_s,
+      :size => (params[:size] || params["size"] || "").to_s,
+      :type => (params[:type] || params["type"] || "jpg").to_s
+    }
+  end
+end
+

data/lib/objectiveflickr/flickr_response.rb

@@ -7,16 +7,16 @@
 # Copyright:: Copyright (c) 2006 Lukhnos D. Liu
 # License:: Distributed under the New BSD License
 
-# This class encapusulates Flickr's JSON response block. Error code
-# and error messsage are read from the response block. This class
-# is intended to be simple and minimalistic, since the data body
-# can be extracted very easily.
-
 require 'rubygems'
 require 'json'
 require 'jcode'
 $KCODE = 'UTF8'
 
+# This class encapusulates Flickr's JSON response block. Error code
+# and error messsage are read from the response block. This class
+# is intended to be simple and minimalistic, since the data body
+# can be extracted very easily.
+
 class FlickrResponse
   attr_reader :data
   

data/lib/objectiveflickr/version.rb

@@ -2,7 +2,7 @@ module ObjectiveFlickr #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 9
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/objectiveflickr_test.rb

@@ -1,4 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
+require 'yaml'
 
 class ObjectiveFlickrTest < Test::Unit::TestCase
 
@@ -38,4 +39,39 @@ class ObjectiveFlickrTest < Test::Unit::TestCase
     assert(e.message.error?, "response should be an error")
     assert_equal(e.message.error_message, "Invalid API Key (Key not found)", "error message should be 'invalid API key'")
   end
+  
+  def test_deprecated_photo_helpers    
+    f = FlickrInvocation.new
+    params = {:server=>1234, :id=>5678, :secret=>90, :farm=>321}
+    assert_equal(f.photo_url(params), "http://farm321.static.flickr.com/1234/5678_90.jpg", "URL helper failed")
+    uid = f.photo_div_id(params)
+    assert_equal(uid, "photo-1234-5678-90-321--jpg", "UID failed")
+  end
+  
+  def test_photo_helpers
+    params = {:server=>"1234", :id=>"5678", :secret=>"90" }
+        
+    assert_equal(FlickrPhoto.url_from_hash(params), "http://static.flickr.com/1234/5678_90.jpg", "URL helper failed")
+    params[:farm] = "321"
+    assert_equal(FlickrPhoto.url_from_hash(params), "http://farm321.static.flickr.com/1234/5678_90.jpg", "URL helper failed")
+    params[:farm] = nil
+    
+    uid = FlickrPhoto.unique_id_from_hash(params, 'blah')
+    assert_equal(uid, "blah-1234-5678-90---jpg", "UID failed")
+    
+    params[:farm] = "321"
+    params[:size] = 'b'
+    uid = FlickrPhoto.unique_id_from_hash(params, 'blah')
+    assert_equal(uid, "blah-1234-5678-90-321-b-jpg", "UID failed")
+
+    
+    assert_equal(FlickrPhoto.url_from_unique_id(uid), "http://farm321.static.flickr.com/1234/5678_90_b.jpg", "URL helper failed")    
+    
+    params[:type] = 'jpg'
+    h = FlickrPhoto.hash_from_unique_id(uid)
+    assert_equal(h, params, "hash_from_unique_id failed")
+
+  end 
+  
+  
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: objectiveflickr
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
-date: 2006-12-12 00:00:00 -05:00
+  version: 0.9.2
+date: 2006-12-27 00:00:00 +08:00
 summary: objectiveflickr is a minimalistic Flickr API library that uses REST-style calls and receives JSON response blocks, resulting in very concise code. Named so in order to echo another Flickr library of mine, under the same name, developed for Objective-C.
 require_paths: 
 - lib
@@ -37,6 +37,7 @@ files:
 - lib/objectiveflickr.rb
 - lib/objectiveflickr/version.rb
 - lib/objectiveflickr/flickr_invocation.rb
+- lib/objectiveflickr/flickr_photo.rb
 - lib/objectiveflickr/flickr_response.rb
 - test/test_helper.rb
 - test/objectiveflickr_test.rb