flickraw 0.9.5 → 0.9.6

data/README.rdoc

@@ -118,7 +118,7 @@ If you need to have several users authenticated at the same time in your applica
 
 There are some helpers to build flickr urls :
 
-=== url, url_m, url_s, url_t, url_b, url_z, url_o
+=== url, url_m, url_s, url_t, url_b, url_z, url_q, url_n, url_c, url_o
 
   info = flickr.photos.getInfo(:photo_id => "3839885270")
   FlickRaw.url_b(info) # => "http://farm3.static.flickr.com/2485/3839885270_6fb8b54e06_b.jpg"

data/examples/web_oauth.rb

@@ -0,0 +1,52 @@
+require 'flickraw'
+
+# A short howto for web flow authentication on the flickr website.
+# This would live inside a rails controller or alternative framework equivalent
+# Error handling left out for clarity :-)
+# Added by Darren Greaves (https://github.com/boncey/)
+#
+# You need an API key first, see http://www.flickr.com/services/api/keys/
+API_KEY=''
+SHARED_SECRET=''
+
+# This is the URL Flickr will redirect your users to once they agree to access
+@callback_url='http://localhost:3000/auth_controller/callback'
+
+FlickRaw.api_key=API_KEY
+FlickRaw.shared_secret=SHARED_SECRET
+
+# Users should hit this method to get the link which sends them to flickr
+def auth
+  flickr = FlickRaw::Flickr.new
+  token = flickr.get_request_token(:oauth_callback => URI.escape(@callback_url))
+  # You'll need to store the token somewhere for when the user is returned to the callback method
+  # I stick mine in memcache with their session key as the cache key
+
+  @auth_url = flickr.get_authorize_url(token['oauth_token'], :perms => 'delete')
+  # Stick @auth_url in your template for users to click
+end
+
+# Your users browser will be redirected here from Flickr (see @callback_url above)
+def callback
+  flickr = FlickRaw::Flickr.new
+
+  token = # Retrieve from cache or session etc - see above
+  oauth_token = params[:oauth_token]
+  oauth_verifier = params[:oauth_verifier]
+
+  raw_token = flickr.get_oauth_token(request_token['oauth_token'], request_token['oauth_token_secret'], oauth_verifier)
+  # raw_token is a hash like this {"user_nsid"=>"92023420%40N00", "oauth_token_secret"=>"XXXXXX", "username"=>"boncey", "fullname"=>"Darren%20Greaves", "oauth_token"=>"XXXXXX"}
+  # Use URI.unescape on the nsid and name parameters
+
+  oauth_token = raw_token["oauth_token"]
+  oauth_token_secret = raw_token["oauth_token_secret"]
+
+  # Store the oauth_token and oauth_token_secret in session or database
+  #   and attach to a Flickraw instance before calling any methods requiring authentication
+
+  # Attach the tokens to your flickr instance - you can now make authenticated calls with the flickr object
+  flickr.access_token = oauth_token
+  flickr.access_secret =[oauth_token_secret
+
+end
+

data/lib/flickraw.rb

@@ -5,7 +5,7 @@ require 'flickraw/response'
 require 'flickraw/api'
 
 module FlickRaw
-  VERSION='0.9.5'
+  VERSION='0.9.6'
   USER_AGENT = "FlickRaw/#{VERSION}"
 end
 

data/lib/flickraw/api.rb

@@ -19,7 +19,7 @@ module FlickRaw
   UPLOAD_PATH_SECURE=(END_POINT_SECURE + '/upload/').freeze
   REPLACE_PATH_SECURE=(END_POINT_SECURE + '/replace/').freeze
 
-  PHOTO_SOURCE_URL='http://farm%s.static.flickr.com/%s/%s_%s%s.%s'.freeze
+  PHOTO_SOURCE_URL='http://farm%s.staticflickr.com/%s/%s_%s%s.%s'.freeze
   URL_PROFILE='http://www.flickr.com/people/'.freeze
   URL_PHOTOSTREAM='http://www.flickr.com/photos/'.freeze
   URL_SHORT='http://flic.kr/p/'.freeze
@@ -102,13 +102,8 @@ module FlickRaw
 
     private
     def build_args(args={}, method = nil)
-      full_args = {'format' => 'json', 'nojsoncallback' => '1'}
-      full_args['method'] = method if method
-      args.each {|k, v|
-        v = v.to_s.encode("utf-8").force_encoding("ascii-8bit") if RUBY_VERSION >= "1.9"
-        full_args[k.to_s] = v
-      }
-      full_args
+      args['method'] = method if method
+      args.merge('format' => 'json', 'nojsoncallback' => '1')
     end
 
     def process_response(req, response)
@@ -176,6 +171,9 @@ module FlickRaw
     def url_t(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_t", "jpg"] end
     def url_b(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_b", "jpg"] end
     def url_z(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_z", "jpg"] end
+    def url_q(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_q", "jpg"] end
+    def url_n(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_n", "jpg"] end
+    def url_c(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_c", "jpg"] end
     def url_o(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.originalsecret, "_o", r.originalformat] end
     def url_profile(r); URL_PROFILE + (r.owner.respond_to?(:nsid) ? r.owner.nsid : r.owner) + "/" end
     def url_photopage(r); url_photostream(r) + r.id end
@@ -185,6 +183,8 @@ module FlickRaw
     def url_short_m(r); URL_SHORT + "img/" + base58(r.id) + "_m.jpg" end
     def url_short_s(r); URL_SHORT + "img/" + base58(r.id) + ".jpg" end
     def url_short_t(r); URL_SHORT + "img/" + base58(r.id) + "_t.jpg" end
+    def url_short_q(r); URL_SHORT + "img/" + base58(r.id) + "_q.jpg" end
+    def url_short_n(r); URL_SHORT + "img/" + base58(r.id) + "_n.jpg" end
     def url_photostream(r)
       URL_PHOTOSTREAM +
         if r.respond_to?(:pathalias) and r.pathalias

data/lib/flickraw/oauth.rb

@@ -12,9 +12,14 @@ module FlickRaw
     end
 
     class << self
+      def encode_value(v)
+        v = v.to_s.encode("utf-8").force_encoding("ascii-8bit") if RUBY_VERSION >= "1.9"
+        v.to_s
+      end
+
       def escape(s)
-        s.to_s.dup.gsub(/[^a-zA-Z0-9\-\.\_\~]/) {
-          sprintf("%%%02X", $&.unpack("C")[0])
+        encode_value(s).gsub(/[^a-zA-Z0-9\-\.\_\~]/) {
+          $&.unpack("C*").map{|i| sprintf("%%%02X", i) }.join
         }
       end
 
@@ -83,7 +88,8 @@ module FlickRaw
     end
 
     def post_form(url, token_secret, oauth_params = {}, params = {})
-      post(url, token_secret, oauth_params, params) {|request| request.form_data = params}
+      encoded_params = Hash[*params.map {|k,v| [OAuthClient.encode_value(k), OAuthClient.encode_value(v)]}.flatten]
+      post(url, token_secret, oauth_params, params) {|request| request.form_data = encoded_params}
     end
     
     def post_multipart(url, token_secret, oauth_params = {}, params = {})
@@ -97,16 +103,15 @@ module FlickRaw
             basename = File.basename(v.path).to_s if v.respond_to? :path
             basename ||= File.basename(v.base_uri).to_s if v.respond_to? :base_uri
             basename ||= "unknown"
-            basename = basename.encode("utf-8").force_encoding("ascii-8bit") if RUBY_VERSION >= "1.9"
             request.body << "--#{boundary}\r\n" <<
-              "Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{basename}\"\r\n" <<
+              "Content-Disposition: form-data; name=\"#{OAuthClient.encode_value(k)}\"; filename=\"#{OAuthClient.encode_value(basename)}\"\r\n" <<
               "Content-Transfer-Encoding: binary\r\n" <<
               "Content-Type: image/jpeg\r\n\r\n" <<
               v.read << "\r\n"
           else
             request.body << "--#{boundary}\r\n" <<
-              "Content-Disposition: form-data; name=\"#{k}\"\r\n\r\n" <<
-              "#{v}\r\n"
+              "Content-Disposition: form-data; name=\"#{OAuthClient.encode_value(k)}\"\r\n\r\n" <<
+              "#{OAuthClient.encode_value(v)}\r\n"
           end
         }
         

data/test/test.rb

@@ -28,6 +28,7 @@ class Basic < Test::Unit::TestCase
       flickr.auth.getFrob
       flickr.auth.getFullToken
       flickr.auth.getToken
+      flickr.auth.oauth.checkToken
       flickr.auth.oauth.getAccessToken
       flickr.blogs.getList
       flickr.blogs.getServices
@@ -38,6 +39,7 @@ class Basic < Test::Unit::TestCase
       flickr.contacts.getList
       flickr.contacts.getListRecentlyUploaded
       flickr.contacts.getPublicList
+      flickr.contacts.getTaggingSuggestions
       flickr.favorites.add
       flickr.favorites.getContext
       flickr.favorites.getList
@@ -71,7 +73,9 @@ class Basic < Test::Unit::TestCase
       flickr.panda.getPhotos
       flickr.people.findByEmail
       flickr.people.findByUsername
+      flickr.people.getGroups
       flickr.people.getInfo
+      flickr.people.getLimits
       flickr.people.getPhotos
       flickr.people.getPhotosOf
       flickr.people.getPublicGroups
@@ -127,6 +131,11 @@ class Basic < Test::Unit::TestCase
       flickr.photos.setPerms
       flickr.photos.setSafetyLevel
       flickr.photos.setTags
+      flickr.photos.suggestions.approveSuggestion
+      flickr.photos.suggestions.getList
+      flickr.photos.suggestions.rejectSuggestion
+      flickr.photos.suggestions.removeSuggestion
+      flickr.photos.suggestions.suggestLocation
       flickr.photos.transform.rotate
       flickr.photos.upload.checkTickets
       flickr.photosets.addPhoto
@@ -173,16 +182,16 @@ class Basic < Test::Unit::TestCase
       flickr.push.unsubscribe
       flickr.reflection.getMethodInfo
       flickr.reflection.getMethods
+      flickr.stats.getCSVFiles
       flickr.stats.getCollectionDomains
       flickr.stats.getCollectionReferrers
       flickr.stats.getCollectionStats
-      flickr.stats.getCSVFiles
       flickr.stats.getPhotoDomains
       flickr.stats.getPhotoReferrers
+      flickr.stats.getPhotoStats
       flickr.stats.getPhotosetDomains
       flickr.stats.getPhotosetReferrers
       flickr.stats.getPhotosetStats
-      flickr.stats.getPhotoStats
       flickr.stats.getPhotostreamDomains
       flickr.stats.getPhotostreamReferrers
       flickr.stats.getPhotostreamStats
@@ -195,6 +204,7 @@ class Basic < Test::Unit::TestCase
       flickr.tags.getListUser
       flickr.tags.getListUserPopular
       flickr.tags.getListUserRaw
+      flickr.tags.getMostFrequentlyUsed
       flickr.tags.getRelated
       flickr.test.echo
       flickr.test.login
@@ -407,11 +417,15 @@ class Basic < Test::Unit::TestCase
     id = "3839885270"
     info = flickr.photos.getInfo(:photo_id => id)
 
-    assert_equal "http://farm3.static.flickr.com/2485/3839885270_6fb8b54e06.jpg", FlickRaw.url(info)
-    assert_equal "http://farm3.static.flickr.com/2485/3839885270_6fb8b54e06_m.jpg", FlickRaw.url_m(info)
-    assert_equal "http://farm3.static.flickr.com/2485/3839885270_6fb8b54e06_s.jpg", FlickRaw.url_s(info)
-    assert_equal "http://farm3.static.flickr.com/2485/3839885270_6fb8b54e06_t.jpg", FlickRaw.url_t(info)
-    assert_equal "http://farm3.static.flickr.com/2485/3839885270_6fb8b54e06_b.jpg", FlickRaw.url_b(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06.jpg", FlickRaw.url(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_m.jpg", FlickRaw.url_m(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_s.jpg", FlickRaw.url_s(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_t.jpg", FlickRaw.url_t(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_b.jpg", FlickRaw.url_b(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_z.jpg", FlickRaw.url_z(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_q.jpg", FlickRaw.url_q(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_n.jpg", FlickRaw.url_n(info)
+    assert_equal "http://farm3.staticflickr.com/2485/3839885270_6fb8b54e06_c.jpg", FlickRaw.url_c(info)
 
     assert_equal "http://www.flickr.com/people/41650587@N02/", FlickRaw.url_profile(info)
     assert_equal "http://www.flickr.com/photos/41650587@N02/", FlickRaw.url_photostream(info)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickraw
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-04 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: maelclerambault@yahoo.fr
@@ -22,14 +22,15 @@ files:
 - examples/search.rb
 - examples/sinatra.rb
 - examples/upload.rb
-- test/test_upload.rb
-- test/test.rb
+- examples/web_oauth.rb
 - test/helper.rb
+- test/test.rb
+- test/test_upload.rb
 - lib/flickraw.rb
+- lib/flickraw/api.rb
 - lib/flickraw/oauth.rb
-- lib/flickraw/response.rb
 - lib/flickraw/request.rb
-- lib/flickraw/api.rb
+- lib/flickraw/response.rb
 - flickraw_rdoc.rb
 - LICENSE
 - README.rdoc
@@ -54,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Flickr library with a syntax close to the syntax described on http://www.flickr.com/services/api