objectiveflickr 0.9.2 → 0.9.3

data/History.txt

@@ -1,3 +1,20 @@
+2007-01-04 (0.9.3):
+    * These methods from FlickrPhoto are deprecated:
+    
+	  * FlickrPhoto.unique_id_from_hash(params, prefix)
+	  * FlickrPhoto.url_from_unique_id(uid)
+	  * FlickrPhoto.hash_from_unique_id(uid)
+	  
+	  Instead, please call them by these new names:
+	  
+	  * FlickrPhoto.element_id_from_hash(params, prefix)
+	  * FlickrPhoto.url_from_element_id(uid)
+	  * FlickrPhoto.hash_from_element_id(uid)
+	  
+	  This is for the sake of naming consistency. "Element id" is more 
+	  web design talk. Henceforth the change.
+	  
+
 2006-12-27 (0.9.2):
 	* Added support for Flickr's new "farm" part newly found in its photo URLs
 	

data/lib/objectiveflickr/flickr_photo.rb

@@ -14,6 +14,16 @@
 
 module FlickrPhoto
   @photo_url_base = 'static.flickr.com'
+  @default_buddy_icon = 'http://www.flickr.com/images/buddyicon.jpg'
+  
+  # Helper that gets you the URL of the buddy icon of a given user
+  def self.buddy_icon_url(nsid, icon_server=nil, icon_farm=nil)
+    if !icon_server || icon_server.to_i == 0
+      return @default_buddy_icon
+    end
+    
+    "#{self.photo_url_base(icon_farm)}/#{icon_server}/buddyicons/#{nsid}.jpg"
+  end
 
   # Set the default photo base URL, without the http:// part
   def self.default_photo_url_base(b)
@@ -26,17 +36,18 @@ module FlickrPhoto
     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')
+  def self.element_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)
+  def self.url_from_element_id(uid)
     self.url_from_normalized_hash(self.hash_from_unique_id(uid))
   end
 
@@ -44,7 +55,7 @@ module FlickrPhoto
   # keys and returns a hash of the photo information
   #
   # NOTE: No sanitation check here
-  def self.hash_from_unique_id(uid)      
+  def self.hash_from_element_id(uid)      
     p = uid.split("-")
     {
       :server=>p[1], :id=>p[2], :secret=>p[3],
@@ -52,10 +63,24 @@ module FlickrPhoto
     }
   end
 
+  # DEPRECATED--Call element_id_from_hash instead
+  def self.unique_id_from_hash(params, prefix='photo')
+    self.element_id_from_hash(params, prefix)
+  end
+
+  # DEPRECATED--Call url_from_element_id instead
+  def self.url_from_unique_id(uid)
+    self.url_from_element_id(uid)
+  end
+
+  # DEPRECATED--Call hash_from_element_id instead
+  def self.hash_from_unique_id(uid)
+    self.hash_from_element_id(uid)
+  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 = "#{photo_url_base(p[:farm])}/#{p[:server]}/#{p[:id]}_#{p[:secret]}"
     url += "_#{p[:size]}" if p[:size].length > 0
     url += ".#{p[:type]}"
   end
@@ -71,5 +96,11 @@ module FlickrPhoto
       :type => (params[:type] || params["type"] || "jpg").to_s
     }
   end
+  
+  private
+  def self.photo_url_base(farm_id=nil)
+    urlbase = (farm_id && farm_id.to_s.length > 0) ? "http://farm#{farm_id}." : "http://"
+    "#{urlbase}#{@photo_url_base}"
+  end
 end
 

data/lib/objectiveflickr/version.rb

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

data/test/objectiveflickr_test.rb

@@ -56,22 +56,26 @@ class ObjectiveFlickrTest < Test::Unit::TestCase
     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')
+    uid = FlickrPhoto.element_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')
+    uid = FlickrPhoto.element_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")    
+    assert_equal(FlickrPhoto.url_from_element_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")
+    h = FlickrPhoto.hash_from_element_id(uid)
+    assert_equal(h, params, "hash_from_element_id failed")
 
   end 
   
-  
+  def test_buddy_icons
+    assert_equal FlickrPhoto.buddy_icon_url("12345678@N1234"), "http://www.flickr.com/images/buddyicon.jpg"
+    assert_equal FlickrPhoto.buddy_icon_url("12345678@N1234", "92"), "http://static.flickr.com/92/buddyicons/12345678@N1234.jpg"
+    assert_equal FlickrPhoto.buddy_icon_url("12345678@N1234", "92", "1"), "http://farm1.static.flickr.com/92/buddyicons/12345678@N1234.jpg"
+  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.2
-date: 2006-12-27 00:00:00 +08:00
+  version: 0.9.3
+date: 2007-01-05 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