flickr_party 0.2.1 → 0.3.0

data/README.markdown

@@ -1,46 +1,41 @@
 Flickr Party
 ============
 
-Wrapper for the Flickr API, with real application authentication, using HTTParty.
+Flickr Party is the simplest possible thing that might work for you. We build on HTTParty, and do a bit of `method_missing` magic to accept any method that the official Flickr API supports.
 
-About
------
-
-This piece of code uses HTTParty for its magic. All Flickr methods should
-be supported, but you'll still need to reference the Flickr API docs heavily
-and understand how they work.
-
-All method calls are automatically signed and include the authentication token.
+You can also (optionally) do authenticated API calls using the `auth_url` and `complete_auth` methods (see below).
 
 Installation
 ------------
 
-    sudo gem install flickr_party -s http://gemcutter.org
+```sh
+gem install flickr_party
+```
     
 Usage
 -----
 
-    require 'rubygems'
-    require 'flickr_party'
-    
-    API_KEY = '...'
-    SECRETE = '...'
-    
-    f = FlickrParty.new(API_KEY, SECRET)
-    
-    # The code supports real application authentication.
-    url = f.auth_url # returns the url you should send the user to
-    `open #{url}` # open in browser
-    
-    # This is just a way to pause until the user says go.
-    # If you're building a gui app or web-based app, you will obviously do something different.
-    print 'Press any key once you have authorized the app...'
-    require "highline/system_extensions"
-    HighLine::SystemExtensions.get_character
-    
-    f.complete_auth
-    
-    # The wrapper uses method_missing to accept any method supported by the API (now or in the future).
-    # For instance, the method "flickr.activity.userPhotos" is called with the code below.
-    
-    f.flickr.activity.userPhotos('timeframe' => '10d')
+```ruby
+require 'rubygems'
+require 'flickr_party'
+
+# get your key and secret from:
+# http://www.flickr.com/services/apps
+API_KEY = '...'
+SECRET = '...'
+
+f = FlickrParty.new(API_KEY, SECRET)
+
+# if you want to do authenticated calls, authenticate the user like so:
+f.auth_url # open this in a browser for the user to confirm
+# wait until confirmed, and then save the auth token...
+token = f.complete_auth
+
+# call any API method by calling it on the FlickrParty object directly
+# pass in any needed parameters as a hash
+# pass in the auth_token if authentication is required for this call
+data = f.flickr.activity.userPhotos('timeframe' => '10d', 'auth_token' => token)
+
+# data is presented vary raw, in the "rsp" key...
+data['rsp'] # => data
+```

data/lib/flickr_party.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'httparty'
-require 'md5'
+require 'digest/md5'
 
 class FlickrParty
 
@@ -25,11 +25,14 @@ class FlickrParty
   def method_missing(method_name, args={}, test=nil)
     if @method.to_s.count('.') == 2 or method_name.to_s =~ /[A-Z]/ or THIRD_LEVEL_METHODS.include?(method_name.to_s)
       args = self.class.stringify_hash_keys(args)
-      args.merge!('api_key' => @api_key, 'method' => @method + '.' + method_name.to_s, 'format' => 'rest')
+      args.merge!('api_key' => @api_key, 'method' => @method + '.' + method_name.to_s)
       if @token
         args.merge!('auth_token' => @token)
       end
-      args.merge!(:api_sig => MD5.hexdigest(@secret + args.to_a.sort.to_s))
+      args_to_s = ""
+      args.sort.each{|a| args_to_s += a[0].to_s + a[1].to_s }
+      sig = Digest::MD5.hexdigest(@secret.to_s + args_to_s)
+      args.merge!(:api_sig => sig)
       self.class.post(ENDPOINT, :body => args)
     else
       if @method
@@ -41,17 +44,18 @@ class FlickrParty
     end
   end
   
-  def auth_url(perms='read')
+  def auth_url(perms='read', extra = nil)
     @frob = self.flickr.auth.getFrob['rsp']['frob']
-    sig = MD5.hexdigest("#{@secret}api_key#{@api_key}frob#{@frob}perms#{perms}")
-    "http://flickr.com/services/auth/?api_key=#{@api_key}&perms=#{perms}&frob=#{@frob}&api_sig=#{sig}"
+    sig = Digest::MD5.hexdigest("#{@secret}api_key#{@api_key}extra#{extra}frob#{@frob}perms#{perms}")
+    "http://flickr.com/services/auth/?api_key=#{@api_key}&perms=#{perms}&frob=#{@frob}&api_sig=#{sig}&extra=#{extra}"
   end
   
-  def complete_auth
+  def complete_auth(frob='put_your_frob_here')
+    @frob ||= frob
     @auth = self.flickr.auth.getToken('frob' => @frob)['rsp']['auth']
     @token = @auth['token']
   end
-  
+
   def photo_url(photo_hash, size=nil)
     if %w(m s t b).include?(size)
       "http://farm#{photo_hash['farm']}.static.flickr.com/#{photo_hash['server']}/#{photo_hash['id']}_#{photo_hash['secret']}_#{size}.jpg"

metadata

@@ -1,65 +1,62 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: flickr_party
-version: !ruby/object:Gem::Version 
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-10-21 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: httparty
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: httparty
 description: 
 email: tim@timmorgan.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.markdown
 - lib/flickr_party.rb
-has_rdoc: true
 homepage: http://github.com/seven1m/flickr_party
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Lightweight wrapper for Flickr API using HTTParty
 test_files: []
-