commonthread-flickr_fu 0.1.6

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 CommonThread, LLC
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,110 @@
+= flickr-fu
+
+== Contact
+
+  Author: Ben Wyrosdick
+  Email: ben [at] commonthread.com
+  Lighthouse: http://commonthread.lighthouseapp.com/projects/12069-flickr_fu/overview
+  Main Repository: http://github.com/commonthread/flickr_fu/tree/master
+
+== Getting Started
+
+  You need to first get an API key as detailed here:
+
+  http://www.flickr.com/services/api/misc.api_keys.html
+  
+== Installation
+
+  sudo gem install flickr-fu
+
+== Documentation
+
+  RDoc Documentation can be found here:
+
+  http://www.commonthread.com/projects/flickr_fu/rdoc/
+
+== Authorization
+
+  To authorise your application to access Flickr using your API key you will
+  need to access a specific URL.
+  
+  To generate this URL run the following and when presented with the URL 
+  access it from your browser. Confirm the application has permission at 
+  the level you have specified.
+  
+  Finally, cache the token (this will create the token cache file)
+  
+  If you have an invalid API key you will see errors such as:
+  
+  "100: Invalid API Key"
+  
+  If you don't follow the process below to authorise your application
+  you will see errors such as:
+  
+  "98: Login failed / Invalid auth token" or 
+  "99: User not logged in / Insufficient permissions"
+  
+== Authorization Example
+
+  require 'flickr_fu'
+  
+  flickr = Flickr.new('flickr.yml')
+  
+  puts "visit the following url, then click <enter> once you have authorized:"
+
+  # request write permissions
+  puts flickr.auth.url(:write)
+  
+  gets
+  
+  flickr.auth.cache_token
+
+== Search Example
+
+  require 'flickr_fu'
+
+  flickr = Flickr.new('flickr.yml')
+
+  photos = flickr.photos.search(:tags => 'ruby-flickr')
+
+  puts "found #{photos.size} photo(s)"
+
+  photos.each do |photo|
+    puts photo.title
+    puts photo.description unless [nil, ''].include?(photo.description)
+    [:square, :thumbnail, :small, :medium, :large, :original].each do |size|
+      puts "#{size}: #{photo.url(size)}"
+    end
+    puts "comments: #{photo.comments.size}"
+    photo.comments.each do |comment|
+      intro = "#{comment.author_name} says - "
+      puts "#{intro}\"#{comment.comment.gsub("\n", "\n"+(" "*intro.length))}\""
+    end
+    puts "notes: #{photo.notes.size}"
+    photo.notes.each do |note|
+      puts "[#{note.x},#{note.y} ~ #{note.width}x#{note.height}] - \"#{note.note}\""
+    end
+    puts
+    puts
+  end
+  
+== Another Search Example
+
+  If searching for photos by user id then you need to specify the 'alias' - without
+  intervention this is usually set by Flickr and is an alphanumeric string. 
+  
+  To find out the user id for a given user, you can use the tool at:
+  
+  http://idgettr.com/
+  
+  And replace the line in the above sample to query on user id:
+  
+  photos = flickr.photos.search(:user_id => 'your_user_id_here')
+
+== Patch Contributers
+
+  Chris Ledet
+  Maciej Biłas
+  Mike Perham
+  Chris Anderton
+  Luke Francl

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+desc 'Default: run unit tests.'
+task :default => :test
+ 
+desc 'Test the contact_info plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+ 
+desc 'Generate documentation for the contact_info plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ruby-flickr'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/flickr_fu.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name     = "flickr_fu"
+  s.version  = "0.1.6"
+  s.date     = "2008-09-12"
+  s.summary  = "Provides a ruby interface to flickr via the REST api"
+  s.email    = "ben@commonthread.com"
+  s.homepage = "http://github.com/commonthread/flickr_fu"
+  s.description = "Provides a ruby interface to flickr via the REST api"
+  s.has_rdoc = true
+  s.authors  = ["Ben Wyrosdick"]
+  s.files    = ["README",
+		"LICENSE",
+		"Rakefile",
+		"flickr_fu.gemspec",
+		"lib/flickr/auth.rb",
+		"lib/flickr/base.rb",
+		"lib/flickr/comment.rb",
+		"lib/flickr/license.rb",
+		"lib/flickr/note.rb",
+		"lib/flickr/people.rb",
+		"lib/flickr/person.rb",
+		"lib/flickr/photo.rb",
+		"lib/flickr/photo_response.rb",
+		"lib/flickr/photos.rb",
+		"lib/flickr/size.rb",
+		"lib/flickr/status.rb",
+		"lib/flickr/test.rb",
+		"lib/flickr/token.rb",
+		"lib/flickr/uploader.rb",
+		"lib/flickr_fu.rb"]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+  s.add_dependency("mime-types", ["> 0.0.0"])
+  s.add_dependency("xml-magic", ["> 0.0.0"])
+end

data/lib/flickr/auth.rb

@@ -0,0 +1,69 @@
+class Flickr::Auth < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # get or return a frob to use for authentication
+  def frob
+    @frob ||= get_frob
+  end
+
+  # generates the authorization url to allow access to a flickr account.
+  # 
+  # Params
+  # * perms (Optional)
+  #     sets the permision level to grant on the flickr account.
+  #       :read - permission to read private information (DEFAULT)
+  #       :write - permission to add, edit and delete photo metadata (includes 'read')
+  #       :delete - permission to delete photos (includes 'write' and 'read')
+  # 
+  def url(perms = :read)
+    options = {:api_key => @flickr.api_key, :perms => perms, :frob => self.frob}
+    @flickr.sign_request(options)
+    Flickr::Base::AUTH_ENDPOINT + "?" + options.collect{|k,v| "#{k}=#{v}"}.join('&')
+  end
+
+  # gets the token object for the current frob
+  # 
+  # Params
+  # * pass_through (Optional)
+  #     Boolean value that determines if a call will be made to flickr to find a taken for the current frob if empty
+  # 
+  def token(pass_through = true)
+    @token ||= get_token(pass_through) rescue nil
+  end
+
+  # saves the current token to the cache file if token exists
+  # 
+  # Param
+  # * filename (Optional)
+  #     filename of the cache file. defaults to the file passed into Flickr.new
+  # 
+  def cache_token(filename = @flickr.token_cache)
+    if filename and self.token
+      cache_file = File.open(filename, 'w+')
+      cache_file.puts self.token.to_yaml
+      cache_file.close
+      true
+    else
+      false
+    end
+  end
+
+  private
+  def get_frob
+    rsp = @flickr.send_request('flickr.auth.getFrob')
+
+    rsp.frob.to_s
+  end
+
+  def get_token(pass_through)
+    if @flickr.token_cache and File.exists?(@flickr.token_cache)
+      YAML.load_file(@flickr.token_cache)
+    elsif pass_through
+      rsp = @flickr.send_request('flickr.auth.getToken', {:frob => self.frob})
+
+      Token.new(:token => rsp.auth.token.to_s, :permisions => rsp.auth.perms.to_s, :user_id => rsp.auth.user[:nsid], :username => rsp.auth.user[:username], :user_real_name => rsp.auth.user[:fullname])
+    end
+  end
+end

data/lib/flickr/base.rb

@@ -0,0 +1,102 @@
+module Flickr
+  def self.new(*params)
+    Flickr::Base.new(*params)
+  end
+  
+  class Base
+    attr_reader :api_key, :api_secret, :token_cache
+    
+    REST_ENDPOINT = 'http://api.flickr.com/services/rest/'
+    AUTH_ENDPOINT = 'http://flickr.com/services/auth/'
+    UPLOAD_ENDPOINT = 'http://api.flickr.com/services/upload/'
+    
+    # create a new flickr object
+    # 
+    # Params
+    # * config_file (Required)
+    #     yaml file to load configuration from
+    # * token_cache (Optional)
+    #     location of the token cache file. This will override the setting in the config file
+    # 
+    # Config Example (yaml file)
+    # 
+    # ---
+    # key: YOUR_API_KEY
+    # secret: YOUR_API_SECRET
+    # token_cache: token.yml
+    # 
+    def initialize(config_file, token_cache = nil)
+      config = YAML.load_file(config_file)
+      
+      @api_key = config['key']
+      @api_secret = config['secret']
+      @token_cache = token_cache || config['token_cache']
+      
+      raise 'flickr config file must contain an api key and secret' unless @api_key and @api_secret
+    end
+
+    # sends a request to the flcikr REST api
+    # 
+    # Params
+    # * method (Required)
+    #     name of the flickr method (ex. flickr.photos.search)
+    # * options (Optional)
+    #     hash of query parameters, you do not need to include api_key, api_sig or auth_token because these are added automatically
+    # * http_method (Optional)
+    #     choose between a GET and POST http request. Valid options are:
+    #       :get (DEFAULT)
+    #       :post
+    # * endpoint (Optional)
+    #     url of the api endpoint
+    # 
+    def send_request(method, options = {}, http_method = :get, endpoint = REST_ENDPOINT)
+      options.merge!(:api_key => @api_key, :method => method)
+      sign_request(options)
+      
+      if http_method == :get
+        api_call = endpoint + "?" + options.collect{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+        rsp = Net::HTTP.get(URI.parse(api_call))
+      else
+        rsp = Net::HTTP.post_form(URI.parse(endpoint), options).body
+      end
+      
+      rsp = '<rsp stat="ok"></rsp>' if rsp == ""
+      xm = XmlMagic.new(rsp)
+      
+      if xm[:stat] == 'ok'
+        xm
+      else
+        raise "#{xm.err[:code]}: #{xm.err[:msg]}"
+      end
+    end
+    
+    # alters your api parameters to include a signiture and authorization token
+    # 
+    # Params
+    # * options (Required)
+    #     the hash of parameters to be passed to the send_request
+    # * authorize (Optional)
+    #     boolean value to determine if the call with include an auth_token (Defaults to true)
+    # 
+    def sign_request(options, authorize = true)
+      options.merge!(:auth_token => self.auth.token(false).to_s, :api_key => @api_key) if authorize and self.auth.token(false)
+      options.delete(:api_sig)
+      options.merge!(:api_sig => Digest::MD5.hexdigest(@api_secret + options.to_a.sort_by{|k| k[0].to_s}.flatten.join)) if @api_secret
+    end
+    
+    # creates and/or returns the Flickr::Test object
+    def test() @test ||= Flickr::Test.new(self) end
+
+    # creates and/or returns the Flickr::Photos object
+    def photos() @photos ||= Flickr::Photos.new(self) end
+      
+    # creates and/or returns the Flickr::People object
+    def people() @people ||= Flickr::People.new(self) end
+      
+    # creates and/or returns the Flickr::Auth object
+    def auth() @auth ||= Flickr::Auth.new(self) end
+      
+    # creates and/or returns the Flickr::Uploader object
+    def uploader() @uploader ||= Flickr::Uploader.new(self) end
+  end
+end

data/lib/flickr/comment.rb

@@ -0,0 +1,16 @@
+# wrapping class to hold a flickr comment
+# 
+class Flickr::Photos::Comment
+  attr_accessor :id, :comment, :author, :author_name, :created_at, :permalink
+  
+  # create a new instance of a flickr comment.
+  # 
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the comment object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+end

data/lib/flickr/license.rb

@@ -0,0 +1,14 @@
+class Flickr::Photos::License
+  attr_accessor :id, :name, :url
+
+  # create a new instance of a flickr photo license.
+  # 
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the license object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+end

data/lib/flickr/note.rb

@@ -0,0 +1,16 @@
+# wrapping class to hold a flickr note
+# 
+class Flickr::Photos::Note
+  attr_accessor :id, :note, :author, :author_name, :x, :y, :width, :height
+  
+  # create a new instance of a flickr note.
+  # 
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the note object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+end

data/lib/flickr/people.rb

@@ -0,0 +1,54 @@
+class Flickr::People < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+  
+  # Get information about a user.
+  # 
+  # Params
+  # * id (Required)
+  #     the nsid of the user to get information for
+  # 
+  def find_by_id(id)
+    rsp = @flickr.send_request('flickr.people.getInfo', {:user_id => id})
+        
+    Person.new(@flickr, :nsid => rsp.person[:nsid],
+                        :is_admin => (rsp.person[:isadmin] == "1" ? true : false),
+                        :is_pro => (rsp.person[:ispro] == "1" ? true : false),
+                        :icon_server => rsp.person[:iconserver],
+                        :icon_farm => rsp.person[:iconfarm],
+                        :username => rsp.person.username.to_s,
+                        :realname => rsp.person.realname.to_s,
+                        :mbox_sha1sum => rsp.person.mbox_sha1sum.to_s,
+                        :location => rsp.person.location.to_s,
+                        :photos_url => rsp.person.photosurl.to_s,
+                        :profile_url => rsp.person.profileurl.to_s,
+                        :photo_count => rsp.person.photos.count.to_s.to_i,
+                        :photo_first_upload => (Time.at(rsp.person.photos.firstdate.to_s.to_i) rescue nil),
+                        :photo_first_taken => (Time.parse(rsp.person.photos.firstdatetaken.to_s) rescue nil))
+  end
+  
+  # Get information about a user.
+  # 
+  # Params
+  # * username (Required)
+  #     the username of the user to get information for
+  #
+  def find_by_username(username)
+    rsp = @flickr.send_request('flickr.people.findByUsername', {:username => username})
+    
+    find_by_id(rsp.user[:nsid])
+  end
+  
+  # Get information about a user.
+  # 
+  # Params
+  # * email (Required)
+  #     the email of the user to get information for
+  #
+  def find_by_email(email)
+    rsp = @flickr.send_request('flickr.people.findByEmail', {:find_email => email})
+    
+    find_by_id(rsp.user[:nsid])
+  end
+end