objectiveflickr 0.9.4 → 0.9.5

data/History.txt

@@ -1,3 +1,33 @@
+2007-01-29 (0.9.5):
+	* Supports Flickr's new photo URL scheme (announced January 19, 2007):
+	  http://www.flickr.com/services/api/misc.urls.html
+	
+	  Flickr now requires API users to use the "originalsecret" and
+	  "originalformat" to retrieve the original photo--when it is
+	  accessible to the request maker (auth'ed or not) at all.
+	
+	  In order for this to work, you must supply an extra "extras"
+	  parameter, set to "original_format", when you're calling
+	  flickr.photo.search (the originalsecret will be returned back
+	  along the way), for example:
+	
+	      f.call("flickr.photo.search", ..., :extras=>"original_format")
+	
+	  For more information on flickr.photo.search, please refer to 
+	  http://www.flickr.com/services/api/flickr.photos.search.html
+	  
+	* :type key in module FlickrPhoto's helper methods is now
+	  deprecated, replaced by :format for the sake of naming consistency.
+	
+	* The change of Flickr's photo URL scheme has the implication that
+	  url_from_element_id, hash_from_element_id and element_id_from_hash
+	  will not work correctly with original photos. I'm still 
+	  considering encoding the extra originalformat and originalsecret
+	  values in the element_id scheme, but I'm reluctant since it seems
+	  that Flickr is doing its due to protect users' photos, which I
+	  think is the right thing to do.
+
+
 2007-01-08 (0.9.4):
     * Fixed a serious defect where API parameters, such as search text, 
       must be URL-escaped. There's a catch if you tried previously to use 

data/lib/objectiveflickr/flickr_invocation.rb

@@ -47,8 +47,12 @@ class FlickrInvocation
   # 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))
+    if params && params[:post]
+      rsp = FlickrResponse.new Net::HTTP.post_form(URI.parse(REST_ENDPOINT), post_params(method, params)).body
+    else
+      url = method_url(method, params)
+      rsp = FlickrResponse.new Net::HTTP.get(URI.parse(url))
+    end
     
     if @options[:raise_exception_on_error] && rsp.error?
       raise RuntimeError, rsp
@@ -61,9 +65,18 @@ class FlickrInvocation
   # to complete the Flickr authentication process (Flickr then uses
   # the callback address you've set previously to pass the
   # authentication frob back to your web app)
-  def login_url(permission)
-    sig = api_sig(:api_key => @api_key, :perms => permission.to_s)
-    url = "#{AUTH_ENDPOINT}?api_key=#{@api_key}&perms=#{permission}&api_sig=#{sig}"
+  #
+  # New in 0.9.5: frob parameter for desktop applications
+  # http://www.flickr.com/services/api/auth.howto.desktop.html
+  def login_url(permission, frob=nil)
+    if frob
+      sig = api_sig(:api_key => @api_key, :perms => permission.to_s, :frob=> frob)
+      url = "#{AUTH_ENDPOINT}?api_key=#{@api_key}&perms=#{permission}&frob=#{frob}&api_sig=#{sig}"
+    else
+      sig = api_sig(:api_key => @api_key, :perms => permission.to_s)
+      url = "#{AUTH_ENDPOINT}?api_key=#{@api_key}&perms=#{permission}&api_sig=#{sig}"
+    end
+    url
   end
     
   # DEPRECATED--Use FlickrPhoto.url_from_hash(params)
@@ -103,12 +116,39 @@ class FlickrInvocation
   
   private
   def method_url(method, params=nil)
+    url = "#{REST_ENDPOINT}?api_key=#{@api_key}&method=#{method}"
     p = params || {}
+    sign_params(method, p)
     
+    p.keys.each { |k| url += "&#{k.to_s}=#{CGI.escape(p[k].to_s)}" }
+    url
+  end
+
+  def post_params(method, params)
+    p = params ? params.clone : {}
+    p.delete :post
+    sign_params(method, p)
+    
+    # since we're using Net::HTTP.post_form to do the call,
+    # CGI escape is already done for us, so, no escape here
+    # p.keys.each { |k| p[k] = CGI.escape(p[k].to_s) }    
+    p
+  end
+  
+  def api_sig(params)
+    sigstr = @shared_secret
+    params.keys.sort { |x, y| x.to_s <=> y.to_s }.each do |k|
+      sigstr += k.to_s
+      sigstr += params[k].to_s
+    end
+    Digest::MD5.hexdigest(sigstr)
+  end
+  
+  # we add json parameter here, telling Flickr we want json!
+  def sign_params(method, p)
     p[:format] = 'json'
     p[:nojsoncallback] = 1
     
-    url = "#{REST_ENDPOINT}?api_key=#{@api_key}&method=#{method}"
     if p[:auth] || p["auth"] || p[:auth_token] || p["auth_token"]
       p.delete(:auth)
       p.delete("auth")
@@ -118,17 +158,6 @@ class FlickrInvocation
       p["api_sig"] = api_sig(sigp)
     end
     
-    p.keys.each { |k| url += "&#{k.to_s}=#{CGI.escape(p[k].to_s)}" }
-    url
-  end
-  
-  private
-  def api_sig(params)
-    sigstr = @shared_secret
-    params.keys.sort { |x, y| x.to_s <=> y.to_s }.each do |k|
-      sigstr += k.to_s
-      sigstr += params[k].to_s
-    end
-    Digest::MD5.hexdigest(sigstr)
+    p
   end
 end

data/lib/objectiveflickr/flickr_photo.rb

@@ -31,7 +31,14 @@ module FlickrPhoto
   end
 
   # This utility method returns the URL of a Flickr photo using
-  # the keys :farm, :server, :id, :secret, :size and :type  
+  # the keys :farm, :server, :id, :secret, :size and :format
+  #
+  # The :type key that is used in ObjectiveFlickr prior to 0.9.5 
+  # is deprecated. It is still supported, but support will be removed
+  # in 0.9.6.
+  #
+  # Since January 2007, Flickr requires API libraries to support
+  # :originalsecret and :originalformat
   def self.url_from_hash(params)
     self.url_from_normalized_hash(self.normalize_parameter(params))
   end
@@ -42,13 +49,13 @@ module FlickrPhoto
   # use in a div
   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("-")    
+    [prefix, p[:server], p[:id], p[:secret], p[:farm], p[:size], p[:format]].join("-")    
   end
 
   # This utility method breaks apart the photo id into Flickr photo
   # keys and returns the photo URL  
   def self.url_from_element_id(uid)
-    self.url_from_normalized_hash(self.hash_from_unique_id(uid))
+    self.url_from_normalized_hash(self.hash_from_element_id(uid))
   end
 
   # This utility method breaks apart the photo id into Flickr photo
@@ -59,7 +66,7 @@ module FlickrPhoto
     p = uid.split("-")
     {
       :server=>p[1], :id=>p[2], :secret=>p[3],
-      :farm=>p[4], :size=>p[5], :type=>p[6]
+      :farm=>p[4], :size=>p[5], :format=>p[6],
     }
   end
 
@@ -80,21 +87,39 @@ module FlickrPhoto
 
   private
   def self.url_from_normalized_hash(p)
-    url = "#{photo_url_base(p[:farm])}/#{p[:server]}/#{p[:id]}_#{p[:secret]}"
-    url += "_#{p[:size]}" if p[:size].length > 0
-    url += ".#{p[:type]}"
+    if p[:size]=="o" && p[:originalformat] && p[:originalsecret]
+      url = "#{photo_url_base(p[:farm])}/#{p[:server]}/#{p[:id]}_#{p[:originalsecret]}"
+      url += "_o"
+      url += ".#{p[:originalformat]}"      
+    else
+      url = "#{photo_url_base(p[:farm])}/#{p[:server]}/#{p[:id]}_#{p[:secret]}"
+      url += "_#{p[:size]}" if p[:size].length > 0
+      url += ".#{p[:format]}"
+    end
   end
 
   private
   def self.normalize_parameter(params)
-    {
+    h = {
       :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
+      :format => (params[:format] || params["format"] || params[:type] || params["type"] || "jpg").to_s
     }
+    
+    os = params[:originalsecret] || params["originalsecret"]
+    if os
+      h[:originalsecret] = os.to_s
+    end
+    
+    of = params[:originalformat] || params["originalformat"]
+    if of
+      h[:originalformat] = of.to_s
+    end
+    
+    h
   end
   
   private

data/lib/objectiveflickr/version.rb

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

data/test/objectiveflickr_test.rb

@@ -21,9 +21,10 @@ class ObjectiveFlickrTest < Test::Unit::TestCase
   end
   
   def test_echo_escaped_characters
-    r = @f.call("flickr.test.echo", :text=>"漢字 @ < > lorem ipsum")
+    r = @f.call("flickr.test.echo", :text=>"漢字 @ < > & lorem ipsum")
+    puts r.to_yaml
     assert(r.ok?, "response should be ok")
-    assert_equal(r["text"]["_content"], "漢字 @ < > lorem ipsum", "CJKV, HTML entities and other characters should be properly URL-escaped")
+    assert_equal("漢字 @ < > & lorem ipsum", r["text"]["_content"], "CJKV, HTML entities and other characters should be properly URL-escaped")
   end
   
   
@@ -75,10 +76,19 @@ class ObjectiveFlickrTest < Test::Unit::TestCase
     
     assert_equal(FlickrPhoto.url_from_element_id(uid), "http://farm321.static.flickr.com/1234/5678_90_b.jpg", "URL helper failed")    
     
-    params[:type] = 'jpg'
+    # type is deprecated
+    # params[:type] = 'jpg'
+    
+    params[:format] = 'jpg'
     h = FlickrPhoto.hash_from_element_id(uid)
     assert_equal(h, params, "hash_from_element_id failed")
 
+
+    params[:originalformat] = 'png'
+    params[:originalsecret] = '9999'
+    params[:size] = 'o'
+    assert_equal("http://farm321.static.flickr.com/1234/5678_9999_o.png", FlickrPhoto.url_from_hash(params), "URL helper failed")
+
   end 
   
   def test_buddy_icons

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.1
 specification_version: 1
 name: objectiveflickr
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
-date: 2007-01-09 00:00:00 +08:00
+  version: 0.9.5
+date: 2007-02-14 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
@@ -63,3 +63,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: