flickr_party 0.2.0

data/README.markdown

@@ -0,0 +1,46 @@
+Flickr Party
+============
+
+Wrapper for the Flickr API, with real application authentication, using HTTParty.
+
+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.
+
+Installation
+------------
+
+    sudo gem install flickr_party -s http://gemcutter.org
+    
+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')

data/lib/flickr_party.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'httparty'
+require 'md5'
+
+class FlickrParty
+
+  ENDPOINT = 'http://api.flickr.com/services/rest/'
+  
+  class PhotoURLError < RuntimeError; end
+  
+  include HTTParty
+  format :xml
+  
+  attr_accessor :token
+  
+  THIRD_LEVEL_METHODS = %w(add browse search delete create find echo login null)
+  
+  def initialize(api_key, secret, method=nil, token=nil)
+    @api_key = api_key
+    @secret = secret
+    @method = method
+    @token = token
+  end
+  
+  def method_missing(method_name, args={}, test=nil)
+    if @method.to_s.count('.') == 2 or method_name =~ /[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')
+      if @token
+        args.merge!('auth_token' => @token)
+      end
+      args.merge!(:api_sig => MD5.hexdigest(@secret + args.to_a.sort.to_s))
+      self.class.post(ENDPOINT, :body => args)
+    else
+      if @method
+        method = @method + '.' + method_name.to_s
+      else
+        method = method_name.to_s
+      end
+      self.class.new(@api_key, @secret, method, @token)
+    end
+  end
+  
+  def auth_url(perms='read')
+    @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}"
+  end
+  
+  def complete_auth
+    @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"
+    elsif size == 'o' and photo_hash['originalsecret'] and photo_hash['originalformat']
+      "http://farm#{photo_hash['farm']}.static.flickr.com/#{photo_hash['server']}/#{photo_hash['id']}_#{photo_hash['originalsecret']}_#{size}.#{photo_hash['originalformat']}"
+    elsif size.nil? or size == '-'
+      "http://farm#{photo_hash['farm']}.static.flickr.com/#{photo_hash['server']}/#{photo_hash['id']}_#{photo_hash['secret']}.jpg"
+    else
+      raise PhotoURLError, "Invalid size or missing keys in photo_hash. Valid sizes are m, s, t, b, o, and nil. For original (o) size, photo_hash must contain both 'originalsecret' and 'originalformat'."
+    end
+  end
+  
+  def self.stringify_hash_keys(hash)
+    hash.inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: flickr_party
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: tim@timmorgan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_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: 
+- 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: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Lightweight wrapper for Flickr API using HTTParty
+test_files: []
+