commonthread-flickr_fu 0.1.6 → 0.2.0

data/README

@@ -23,6 +23,12 @@
 
   http://www.commonthread.com/projects/flickr_fu/rdoc/
 
+== Example flickr.yml
+--- !map:HashWithIndifferentAccess
+key: "YOUR KEY"
+secret: "YOUR SECRET"
+token_cache: "token_cache.yml"
+
 == Authorization
 
   To authorise your application to access Flickr using your API key you will
@@ -32,6 +38,12 @@
   access it from your browser. Confirm the application has permission at 
   the level you have specified.
   
+  Note that flickr has different types of keys. If you use one for a webapplication,
+  which is most likely, you need to define a callback and somehow make sure that
+  you connect the parameter :frob that flickr send via the callback is assigned
+  to the right user account. The best way to do this is to loop over all the current
+  user's flickr accounts and try flickr.auth.token with the :frob.
+  
   Finally, cache the token (this will create the token cache file)
   
   If you have an invalid API key you will see errors such as:
@@ -44,7 +56,7 @@
   "98: Login failed / Invalid auth token" or 
   "99: User not logged in / Insufficient permissions"
   
-== Authorization Example
+== Authorization Example for non-webapplication
 
   require 'flickr_fu'
   
@@ -59,6 +71,28 @@
   
   flickr.auth.cache_token
 
+== Authorization Example for a webapplication
+
+  flickr.auth.token also contains the nsid and username, this
+  example only stores the token and no other userdata.
+
+  require 'flickr_fu'
+  class FlickrController < ActionController::Base
+    def create
+      flickr = Flickr.new('flickr.yml')
+      redirect_to flickr.auth.url(:write)
+    end
+    def flickr_callback
+      flickr = Flickr.new('flickr.yml')
+      flickr.auth.frob = params[:frob]
+      current_user.update_attribute :flickr_token, flickr.auth.token.token
+    end
+    def something_else_with_flickr
+      flickr = Flickr.new(YAML.load_file('flickr.yml').merge(:token => current_user.flickr_token))
+      # now you have full access on the user's data :)
+    end
+  end
+
 == Search Example
 
   require 'flickr_fu'
@@ -108,3 +142,5 @@
   Mike Perham
   Chris Anderton
   Luke Francl
+  Thomas R. Koll
+  P. Mark Anderson

data/Rakefile

@@ -1,17 +1,6 @@
 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'
@@ -20,3 +9,33 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+# RSpec support
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+	  To use rspec for testing you must install rspec gem:
+	  gem install rspec
+  EOS
+  exit(0)
+end
+
+task :default => :spec
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run rcov"
+task :rcov do
+  system "rcov spec/**/*.rb -x /var/lib -x spec/"
+end

data/flickr_fu.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "flickr_fu"
-  s.version  = "0.1.6"
-  s.date     = "2008-09-12"
+  s.version  = "0.2.0"
+  s.date     = "2008-12-30"
   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"
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 		"lib/flickr/auth.rb",
 		"lib/flickr/base.rb",
 		"lib/flickr/comment.rb",
+		"lib/flickr/errors.rb",
 		"lib/flickr/license.rb",
 		"lib/flickr/note.rb",
 		"lib/flickr/people.rb",

data/lib/flickr/auth.rb

@@ -7,6 +7,11 @@ class Flickr::Auth < Flickr::Base
   def frob
     @frob ||= get_frob
   end
+  
+  # set the frob
+  def frob= frob
+    @frob=frob
+  end
 
   # generates the authorization url to allow access to a flickr account.
   # 
@@ -58,7 +63,9 @@ class Flickr::Auth < Flickr::Base
   end
 
   def get_token(pass_through)
-    if @flickr.token_cache and File.exists?(@flickr.token_cache)
+    if @flickr.token
+      @flickr.token
+    elsif @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})

data/lib/flickr/base.rb

@@ -4,7 +4,7 @@ module Flickr
   end
   
   class Base
-    attr_reader :api_key, :api_secret, :token_cache
+    attr_reader :api_key, :api_secret, :token_cache, :token
     
     REST_ENDPOINT = 'http://api.flickr.com/services/rest/'
     AUTH_ENDPOINT = 'http://flickr.com/services/auth/'
@@ -12,30 +12,44 @@ module Flickr
     
     # create a new flickr object
     # 
-    # Params
+    # You can either pass a hash with the following attributes:
+    # 
+    # * :key (Required)
+    #     the API key
+    # * :secret (Required)
+    #     the API secret
+    # * :token (Optional)
+    #     Flickr::Auth::Token object
+    #
+    # or:
     # * 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)
+    def initialize(config_hash_or_file, token_cache = nil)
+      if config_hash_or_file.is_a? Hash
+        @api_key = config_hash_or_file[:key]
+        @api_secret = config_hash_or_file[:secret]
+        @token = config_hash_or_file[:token]
+        raise 'config_hash must contain api key and secret' unless @api_key and @api_secret
+      else 
+        config = YAML.load_file(config_hash_or_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
+        @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
     end
 
-    # sends a request to the flcikr REST api
+    # sends a request to the flickr REST api
     # 
     # Params
     # * method (Required)
@@ -53,12 +67,7 @@ module Flickr
       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 = request_over_http(options, http_method, endpoint)
       
       rsp = '<rsp stat="ok"></rsp>' if rsp == ""
       xm = XmlMagic.new(rsp)
@@ -66,7 +75,7 @@ module Flickr
       if xm[:stat] == 'ok'
         xm
       else
-        raise "#{xm.err[:code]}: #{xm.err[:msg]}"
+        raise Flickr::Errors.error_for(xm.err[:code], xm.err[:msg])
       end
     end
     
@@ -98,5 +107,18 @@ module Flickr
       
     # creates and/or returns the Flickr::Uploader object
     def uploader() @uploader ||= Flickr::Uploader.new(self) end
+    
+    protected
+    
+    # For easier testing. You can mock this method with a XML file you're expecting to receive
+    def request_over_http(options, http_method, endpoint)
+      if http_method == :get
+        api_call = endpoint + "?" + options.collect{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+        Net::HTTP.get(URI.parse(api_call))
+      else
+        Net::HTTP.post_form(URI.parse(endpoint), options).body
+      end
+    end
+    
   end
 end

data/lib/flickr/errors.rb

@@ -0,0 +1,20 @@
+module Flickr
+    class Error < RuntimeError
+      attr_accessor :code
+    end
+    
+    
+    class Errors
+      
+      # Method used for raising the appropriate error class for a given error code.
+      # Currently raises only Flickr::Error
+      def self.error_for(code, message)
+        raise RuntimeError.new("Internal error. Flickr API error not identified or unknown error.") if (code.nil? || message.nil? || message.empty?)
+        raise RuntimeError.new("Internal error. Unknown error.") if code.to_i == 0 # We assume that error code 0 is never returned
+        e = Flickr::Error.new("#{code}: #{message}")
+        e.code = code
+        raise e
+      end
+    end
+
+end

data/lib/flickr/license.rb

@@ -11,4 +11,14 @@ class Flickr::Photos::License
       send("#{k}=", v)
     end
   end
+  
+  def == o
+    return false unless o.respond_to?(:id) && o.respond_to?(:name) && o.respond_to?(:url)
+    return true if id == o.id && name == o.name && url == o.url
+    false
+  end
+  
+  def eql? o
+    return self == o
+  end
 end

data/lib/flickr/photo.rb

@@ -1,11 +1,9 @@
 # wrapping class to hold an flickr photo
-# 
 class Flickr::Photos::Photo
   attr_accessor :id, :owner, :secret, :server, :farm, :title, :is_public, :is_friend, :is_family # standard attributes
   attr_accessor :license_id, :uploaded_at, :taken_at, :owner_name, :icon_server, :original_format, :updated_at, :geo, :tags, :machine_tags, :o_dims, :views, :media # extra attributes
   attr_accessor :info_added, :description, :original_secret, :owner_username, :owner_realname, :url_photopage, :notes # info attributes
-  attr_accessor :sizes_added, :sizes, :url_square, :url_thumbnail, :url_small, :url_medium, :url_large, :url_original # size attributes
-  attr_accessor :comments_added, :comments # comment attributes
+  attr_accessor :comments # comment attributes
   
   # create a new instance of a flickr photo.
   # 
@@ -21,8 +19,13 @@ class Flickr::Photos::Photo
     end
   end
 
+  # Alias to image_url method
+  def url(size = :medium)
+    image_url(size)
+  end
+
   # retreive the url to the image stored on flickr
-  # 
+  #
   # == Params
   # * size (Optional)
   #     the size of the image to return. Optional sizes are:
@@ -32,10 +35,24 @@ class Flickr::Photos::Photo
   #       :medium - 500 on longest side
   #       :large - 1024 on longest side (only exists for very large original images)
   #       :original - original image, either a jpg, gif or png, depending on source format
-  # 
-  def url(size = :medium)
-    attach_sizes
-    send("url_#{size}")
+  #
+  def image_url(size = :medium)
+	# It turns out that flickr always stores all the sizes of the picture even when getSizes call returns otherwise.
+	# Not calling getSizes is also very important for performance reasons.
+	# Retrieving 30 search results means calling the API 31 times if you call getSizes every time.
+	# Mind that you still need to call getSizes if you go out for the original image.
+	if size == :original
+	  size_hash[size.to_s].source if size_hash.has_key? size.to_s
+	else
+	  key = "_#{size_key(size.to_sym)}"
+	  key = "" if key == "_"
+	  "http://farm#{farm}.static.flickr.com/#{server}/#{id}_#{secret}#{key}.jpg"
+	end
+  end
+
+  def photopage_url
+	# Keeping the same convention as image_url (foo_url)
+	url_photopage
   end
 
   # save the current photo to the local computer
@@ -73,7 +90,7 @@ class Flickr::Photos::Photo
   #     comma seperated list of tags
   # 
   def add_tags(tags)
-    rsp = @flickr.send_request('flickr.photos.addTags', {:photo_id => self.id, :tags => tags}, :post)
+    @flickr.send_request('flickr.photos.addTags', {:photo_id => self.id, :tags => tags}, :post)
     true
   end
   
@@ -84,7 +101,7 @@ class Flickr::Photos::Photo
   #     text of the comment
   #
   def add_comment(message)
-    rsp = @flickr.send_request('flickr.photos.comments.addComment', {:photo_id => self.id, :comment_text => message}, :post)
+    @flickr.send_request('flickr.photos.comments.addComment', {:photo_id => self.id, :comment_text => message}, :post)
     true
   end
   
@@ -103,7 +120,7 @@ class Flickr::Photos::Photo
   #     The height of the note
   #     
   def add_note(message, x, y, w, h)
-    rsp = @flickr.send_request('flickr.photos.notes.add', {:photo_id => self.id, :note_x => x, :note_y => y, :note_w => w, :note_h => h, :note_text => message}, :post)
+    @flickr.send_request('flickr.photos.notes.add', {:photo_id => self.id, :note_x => x, :note_y => y, :note_w => w, :note_h => h, :note_text => message}, :post)
     true
   end
   
@@ -114,7 +131,7 @@ class Flickr::Photos::Photo
   #     The amount of degrees by which to rotate the photo (clockwise) from it's current orientation. Valid values are 90, 180 and 270.
   # 
   def rotate(degrees)
-    rsp = @flickr.send_request('flickr.photos.transform.rotate', {:photo_id => self.id, :degrees => degrees}, :post)
+    @flickr.send_request('flickr.photos.transform.rotate', {:photo_id => self.id, :degrees => degrees}, :post)
     true
   end
   
@@ -130,7 +147,7 @@ class Flickr::Photos::Photo
   # * license_id (Required)
   #     The license to apply, or 0 (zero) to remove the current license.
   def set_license(license_id)
-    rsp = @flickr.send_request('flickr.photos.licenses.setLicense', {:photo_id => self.id, :license_id => license_id}, :post)
+    @flickr.send_request('flickr.photos.licenses.setLicense', {:photo_id => self.id, :license_id => license_id}, :post)
     true
   end
   
@@ -160,13 +177,39 @@ class Flickr::Photos::Photo
   end
 
   def comments # :nodoc:
-    attach_comments
-    @comments
+    @comments ||= begin
+      if @comment_count == 0
+        self.comments = []
+        self.comments_added = true
+      elsif not self.comments_added
+        rsp = @flickr.send_request('flickr.photos.comments.getList', :photo_id => self.id)
+        
+        self.comments = []
+        self.comments_added = true
+        
+        rsp.comments.comment.each do |comment|
+          self.comments << Flickr::Photos::Comment.new(:id => comment[:id],
+            :comment => comment.to_s,
+            :author => comment[:author],
+            :author_name => comment[:authorname],
+            :permalink => comment[:permalink],
+            :created_at => (Time.at(comment[:datecreate].to_i) rescue nil))
+        end
+      end        
+    end
   end
   
   def sizes # :nodoc:
-    attach_sizes
-    @sizes
+    @sizes ||= begin
+      rsp = @flickr.send_request('flickr.photos.getSizes', :photo_id => self.id)
+      
+      _sizes = []
+      rsp.sizes.size.each do |size|
+        _sizes << Flickr::Photos::Size.new(:label => size[:label], :width => size[:width],
+          :height => size[:height], :source => size[:source], :url => size[:url])
+      end
+      _sizes
+    end
   end
 
   def notes # :nodoc:
@@ -175,34 +218,14 @@ class Flickr::Photos::Photo
   end
 
   protected
-  def url_square # :nodoc:
-    attach_sizes
-    @url_square
-  end
-
-  def url_thumbnail # :nodoc:
-    attach_sizes
-    @url_thumbnail
-  end
-
-  def url_small # :nodoc:
-    attach_sizes
-    @url_small
-  end
-
-  def url_medium # :nodoc:
-    attach_sizes
-    @url_medium
-  end
-
-  def url_large # :nodoc:
-    attach_sizes
-    @url_large
-  end
-
-  def url_original # :nodoc:
-    attach_sizes
-    @url_original
+  def size_hash
+    @size_hash ||= begin
+      hash = {}
+      sizes.each do |size|
+        hash[size.label.downcase] = size
+      end
+      hash
+    end
   end
 
   private
@@ -211,12 +234,12 @@ class Flickr::Photos::Photo
   # convert the size to the key used in the flickr url
   def size_key(size)
     case size.to_sym
-    when :square : 's'
-    when :thumb, :thumbnail : 't'
-    when :small : 'm'
-    when :medium : '-'
-    when :large : 'b'
-    when :original : 'o'
+    when :square then 's'
+    when :thumb, :thumbnail then 't'
+    when :small then 'm'
+    when :medium then ''
+    when :large then 'b'
+    when :original then 'o'
     else ''
     end
   end
@@ -227,7 +250,7 @@ class Flickr::Photos::Photo
       rsp = @flickr.send_request('flickr.photos.getInfo', :photo_id => self.id, :secret => self.secret)
 
       self.info_added = true
-      self.description = rsp.photo.description.to_s
+      self.description = rsp.photo.description.to_s.strip
       self.original_secret = rsp.photo[:originalsecret]
       self.owner_username = rsp.photo.owner[:username]
       self.owner_realname = rsp.photo.owner[:realname]
@@ -238,61 +261,14 @@ class Flickr::Photos::Photo
 
       rsp.photo.notes.note.each do |note|
         self.notes << Flickr::Photos::Note.new(:id => note[:id],
-                               :note => note.to_s,
-                               :author => note[:author],
-                               :author_name => note[:authorname],
-                               :x => note[:x],
-                               :y => note[:y],
-                               :width => note[:w],
-                               :height => note[:h])
+		  :note => note.to_s,
+		  :author => note[:author],
+		  :author_name => note[:authorname],
+		  :x => note[:x],
+		  :y => note[:y],
+		  :width => note[:w],
+		  :height => note[:h])
       end if rsp.photo.notes.note
     end
   end
-
-  # loads picture sizes only after one has been requested
-  def attach_sizes
-    unless self.sizes_added
-      rsp = @flickr.send_request('flickr.photos.getSizes', :photo_id => self.id)
-
-      self.sizes_added = true
-      self.sizes = []
-
-      # TODO: investigate the new video features and integrate better
-      rsp.sizes.size.each do |size|
-        method = "url_#{size[:label].downcase}="
-        next unless respond_to? method
-        send(method, size[:source])
-        
-        # send("url_#{size[:label].downcase}=", size[:source])
-
-        self.sizes << Flickr::Photos::Size.new(:label => size[:label],
-                               :width => size[:width],
-                               :height => size[:height],
-                               :source => size[:source],
-                               :url => size[:url])
-      end
-    end
-  end
-
-  # loads comments once they have been requested
-  def attach_comments
-    if @comment_count == 0
-      self.comments = []
-      self.comments_added = true
-    elsif not self.comments_added
-      rsp = @flickr.send_request('flickr.photos.comments.getList', :photo_id => self.id)
-
-      self.comments = []
-      self.comments_added = true
-
-      rsp.comments.comment.each do |comment|
-        self.comments << Flickr::Photos::Comment.new(:id => comment[:id],
-                                     :comment => comment.to_s,
-                                     :author => comment[:author],
-                                     :author_name => comment[:authorname],
-                                     :permalink => comment[:permalink],
-                                     :created_at => (Time.at(comment[:datecreate].to_i) rescue nil))
-      end
-    end        
-  end
 end

data/lib/flickr/photos.rb

@@ -187,7 +187,25 @@ class Flickr::Photos < Flickr::Base
   end
   
   def licenses
-    @licenses ||= get_licenses
+    @licenses ||= begin
+      rsp = @flickr.send_request('flickr.photos.licenses.getInfo')
+      
+      returning Hash.new do |licenses|
+        rsp.licenses.license.each do |license|
+          licenses[license[:id].to_i] = Flickr::Photos::License.new(:id => license[:id].to_i, :name => license[:name], :url => license[:url])
+        end
+      end
+    end
+  end
+  
+  # Returns a Flickr::Photos::Photo object of the given id.
+  # Raises an error if photo not found
+  def find_by_id(photo_id)
+    rsp = @flickr.send_request('flickr.photos.getInfo', :photo_id => photo_id)
+    Photo.new(@flickr, :id => rsp.photo[:id].to_i, :owner => rsp.photo.owner,
+      :secret => rsp.photo[:secret], :server => rsp.photo[:server].to_i, :farm => rsp.photo[:farm], 
+      :title => rsp.photo.title,
+      :is_public => rsp.photo.visibility[:public], :is_friend => rsp.photo.visibility[:is_friend], :is_family => rsp.photo.visibility[:is_family])
   end
   
   protected
@@ -216,13 +234,4 @@ class Flickr::Photos < Flickr::Base
      :media => photo[:media]}
   end
   
-  def get_licenses
-    rsp = @flickr.send_request('flickr.photos.licenses.getInfo')
-    
-    returning Hash.new do |licenses|
-      rsp.licenses.license.each do |license|
-        licenses[license[:id].to_i] = Flickr::Photos::License.new(:id => license[:id].to_i, :name => license[:name], :url => license[:url])
-      end
-    end
-  end
 end

data/lib/flickr/token.rb

@@ -10,7 +10,7 @@ class Flickr::Auth::Token
   #     a hash of attributes used to set the initial values of the token object
   def initialize(attributes)
     attributes.each do |k,v|
-      send("#{k}=", v)
+      send("#{k}=", v) if respond_to?("#{k}=")
     end
   end
 

data/lib/flickr_fu.rb

@@ -10,7 +10,7 @@ require 'time'
 require 'date'
 
 # base must load first
-%w(base test auth token photos photo photo_response comment note size uploader status people person license).each do |file|
+%w(base test auth token photos photo photo_response comment note size uploader status people person license errors).each do |file|
   require File.join(File.dirname(__FILE__), 'flickr', file)
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: commonthread-flickr_fu
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ben Wyrosdick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-12 00:00:00 -07:00
+date: 2008-12-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ files:
 - lib/flickr/auth.rb
 - lib/flickr/base.rb
 - lib/flickr/comment.rb
+- lib/flickr/errors.rb
 - lib/flickr/license.rb
 - lib/flickr/note.rb
 - lib/flickr/people.rb