flickr_fu 0.1.6 → 0.3.0

data/lib/flickr/contact.rb

@@ -0,0 +1,16 @@
+# wrapping class to hold a flickr contact
+# 
+class Flickr::Contacts::Contact
+  attr_accessor :nsid, :friend, :family, :iconfarm, :iconserver, :location, :username, :ignored, :realname, :path_alias
+  
+  # create a new instance of a flickr note.
+  # 
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the contact object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+end

data/lib/flickr/contacts.rb

@@ -0,0 +1,55 @@
+class Flickr::Contacts < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # Get a user's public contact list.
+  # 
+  # Params
+  # * id (Required)
+  #     the nsid of the user to get information for
+  # 
+  def get_public_list(id, options={})
+    options.merge!({:user_id => id})
+    rsp = @flickr.send_request('flickr.contacts.getPublicList', options)
+    collect_contacts(rsp)
+  end
+    
+  
+  # Get the authorized user's contact list.
+  # 
+  def get_list(options={})
+    rsp = @flickr.send_request('flickr.contacts.getList', options)
+    collect_contacts(rsp)
+  end
+  
+  
+  protected
+  def collect_contacts(rsp)
+    contacts = []
+    return contacts unless rsp
+    if rsp.contacts.contact
+      rsp.contacts.contact.each do |contact|
+        attributes = create_attributes(contact)
+        contacts << Contact.new(attributes)
+      end
+    end
+    return contacts
+  end
+  
+  def create_attributes(contact)
+    {
+      :nsid => contact[:nsid], 
+      :path_alias => contact[:path_alias],
+      :username => contact[:username],
+      :iconfarm => contact[:iconfarm],
+      :iconserver => contact[:iconserver],
+      :ignored => contact[:ignored],
+      :friend => contact[:friend],
+      :family => contact[:family],
+      :realname => contact[:realname],
+      :location => contact[:location]
+     }
+  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/geo.rb

@@ -0,0 +1,42 @@
+class Flickr::Photos::Geo < Flickr::Base
+
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # Get the geo data (latitude and longitude and the accuracy level) of a photo.
+  #
+  # Params
+  # * photo_id (Required)
+  #
+  # Returns Flickr::Photos::Location object containing photo location
+  # or nil if photo is not geotagged.
+  def get_location(photo_id)
+    # begin
+    rsp = @flickr.send_request('flickr.photos.geo.getLocation', {:photo_id => photo_id})
+    Flickr::Photos::Location.new(:latitude => rsp.photo.location[:latitude].to_f,
+      :longitude => rsp.photo.location[:longitude].to_f, :accuracy => rsp.photo.location[:accuracy].to_i)
+  end
+
+  # Sets the geo data(latitude and longitude and the accuracy level) of a photo.
+  #
+  # Params
+  # * photo_id (Required)
+  # * latittude (Requried)
+  # * longitude (Required)
+  # * accuracy (Optional)
+  #
+  # Returns true if successful, raises an error otherwise.
+  def set_location(photo_id, lat, lon, accuracy = nil)
+    request_options = {:photo_id => photo_id, :lat => lat, :lon => lon}
+    request_options[:accuracy] = accuracy if !accuracy.nil?
+    @flickr.send_request('flickr.photos.geo.setLocation', request_options, :post)
+    true
+  end
+
+  def remove_location(photo_id)
+    request_options = {:photo_id => photo_id}
+    @flickr.send_request('flickr.photos.geo.removeLocation', request_options, :post)
+    true
+  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/location.rb

@@ -0,0 +1,15 @@
+class Flickr::Photos::Location
+
+  attr_accessor :latitude, :longitude, :accuracy
+
+  # Create an instance of Flickr::Photos::Location
+  #
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the Location object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  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,31 @@ class Flickr::Photos::Photo
     end
   end
 
+  # Alias to image_url method
+  def url(size = :medium)
+    image_url(size)
+  end
+
+  # returns an instance of Flickr::Photos::Size for the required size
+  #
+  # Params
+  #  * size (Optional)
+  #    the size of the size instance to return.  Optional sizes are:
+  #       :square - square 75x75
+  #       :thumbnail - 100 on longest side
+  #       :small - 240 on longest side
+  #       :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
+  # Examples
+  #       Photo.photo_size(:square).source
+  #       Photo.photo_size(:large).width
+  def photo_size(size = :medium)
+    size_hash.fetch(size.to_s, size_hash['medium'])
+  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 +53,30 @@ 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
+
+  def video_url
+    if size_hash['video player']
+      size_hash['video player'].source
+    end
   end
 
   # save the current photo to the local computer
@@ -53,7 +94,7 @@ class Flickr::Photos::Photo
   #       :original - original image, either a jpg, gif or png, depending on source format
   # 
   def save_as(filename, size = :medium)
-    format = size.to_sym == :original ? self.original_format : 'jpg'
+    format = size.to_sym == :original ? (self.original_format || 'jpg') : 'jpg'
     filename = "#{filename}.#{format}"
 
     if File.exists?(filename) or not self.url(size)
@@ -73,7 +114,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 +125,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 +144,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 +155,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
   
@@ -123,6 +164,29 @@ class Flickr::Photos::Photo
   def license
     @flickr.photos.licenses[self.license_id]
   end
+
+  # Returns the location of the photo (if available)
+  # or nil if photo is not geo-tagged.
+  def location
+    begin
+      @location ||= @flickr.photos.geo.get_location(self.id)
+    rescue Flickr::Error => e
+      if e.code == 2 # 2: Photo has no location information.
+        return nil
+      else
+        raise e
+      end
+    end
+  end
+
+  def location= location
+    if !location.nil?
+      @flickr.photos.geo.set_location(self.id, location.latitude, location.longitude, location.accuracy)
+    else
+      @flickr.photos.geo.remove_location(self.id)
+    end
+    @location = location
+  end
   
   # Sets the license for a photo.
   # 
@@ -130,7 +194,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 +224,39 @@ class Flickr::Photos::Photo
   end
 
   def comments # :nodoc:
-    attach_comments
-    @comments
+    @comments ||= begin
+      if @comment_count == 0
+        self.comments = []
+      else
+        rsp = @flickr.send_request('flickr.photos.comments.getList', :photo_id => self.id)
+        
+        self.comments = []
+        
+        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
+
+      self.comments
+    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 +265,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 +281,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 +297,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 +308,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