userharmony-flickr_fu 0.3.6

data/lib/flickr/photo.rb

@@ -0,0 +1,303 @@
+# 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 :comments # comment attributes
+  
+  # create a new instance of a flickr photo.
+  # 
+  # Params
+  # * flickr (Required)
+  #     the flickr object
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the photo object
+  def initialize(flickr, attributes)
+    @flickr = flickr
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    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:
+  #       :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
+  #
+  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
+  # 
+  # == Params
+  # * filename (Required)
+  #     name of the new file omiting the extention (ex. photo_1)
+  # * size (Optional)
+  #     the size of the image to return. Optional sizes are:
+  #       :small - 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
+  # 
+  def save_as(filename, size = :medium)
+    format = size.to_sym == :original ? (self.original_format || 'jpg') : 'jpg'
+    filename = "#{filename}.#{format}"
+
+    if File.exists?(filename) or not self.url(size)
+      false
+    else
+      f = File.new(filename, 'w+')
+      f.puts open(self.url(size)).read
+      f.close
+      f
+    end
+  end
+  
+  # Add tags to a photo.
+  # 
+  # Params
+  # * tags (Required)
+  #     comma seperated list of tags
+  # 
+  def add_tags(tags)
+    @flickr.send_request('flickr.photos.addTags', {:photo_id => self.id, :tags => tags}, :post)
+    true
+  end
+  
+  # Add comment to a photo as the currently authenticated user.
+  #
+  # Params
+  # * message (Required)
+  #     text of the comment
+  #
+  def add_comment(message)
+    @flickr.send_request('flickr.photos.comments.addComment', {:photo_id => self.id, :comment_text => message}, :post)
+    true
+  end
+  
+  # Add a note to a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.
+  # 
+  # Params
+  # * message (Required)
+  #     The text of the note
+  # * x (Required)
+  #     The left coordinate of the note
+  # * y (Required)
+  #     The top coordinate of the note
+  # * w (Required)
+  #     The width of the note
+  # * h (Required)
+  #     The height of the note
+  #     
+  def add_note(message, x, y, w, h)
+    @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
+  
+  # Rotate a photo.
+  # 
+  # Params
+  # * degrees (Required)
+  #     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)
+    @flickr.send_request('flickr.photos.transform.rotate', {:photo_id => self.id, :degrees => degrees}, :post)
+    true
+  end
+  
+  # return the license associated with the 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.
+  # 
+  # Params
+  # * license_id (Required)
+  #     The license to apply, or 0 (zero) to remove the current license.
+  def set_license(license_id)
+    @flickr.send_request('flickr.photos.licenses.setLicense', {:photo_id => self.id, :license_id => license_id}, :post)
+    true
+  end
+  
+  def description # :nodoc:
+    attach_info
+    @description
+  end
+
+  def original_secret # :nodoc:
+    attach_info
+    @original_secret
+  end
+
+  def owner_username # :nodoc:
+    attach_info
+    @owner_username
+  end
+
+  def owner_realname # :nodoc:
+    attach_info
+    @owner_realname
+  end
+
+  def url_photopage # :nodoc:
+    attach_info
+    @url_photopage
+  end
+
+  def comments # :nodoc:
+    @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:
+    @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:
+    attach_info
+    @notes
+  end
+
+  protected
+  def size_hash
+    @size_hash ||= begin
+      hash = {}
+      sizes.each do |size|
+        hash[size.label.downcase] = size
+      end
+      hash
+    end
+  end
+
+  private
+  attr_accessor :comment_count
+  
+  # convert the size to the key used in the flickr url
+  def size_key(size)
+    case size.to_sym
+    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
+
+  # loads photo info when a field is requested that requires additional info
+  def attach_info
+    unless self.info_added
+      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.strip
+      self.original_secret = rsp.photo[:originalsecret]
+      self.owner_username = rsp.photo.owner[:username]
+      self.owner_realname = rsp.photo.owner[:realname]
+      self.url_photopage = rsp.photo.urls.url.to_s
+      self.comment_count = rsp.photo.comments.to_s.to_i
+
+      self.notes = []
+
+      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])
+      end if rsp.photo.notes.note
+    end
+  end
+end

data/lib/flickr/photo_response.rb

@@ -0,0 +1,37 @@
+# wrapping class to hold a photos response from the flickr api
+#
+class Flickr::Photos::PhotoResponse
+  attr_accessor :page, :pages, :per_page, :total, :photos, :api, :method, :options
+  
+  # creates an object to hold the search response.
+  # 
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the response object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+
+  # Add a Flickr::Photos::Photo object to the photos array.  It does nothing if you pass a non photo object
+  def <<(photo)
+    self.photos ||= []
+    self.photos << photo if photo.is_a?(Flickr::Photos::Photo)
+  end
+
+  # gets the next page from flickr if there are anymore pages in the current photos object
+  def next_page
+    api.send(self.method, options.merge(:page => self.page.to_i + 1)) if self.page.to_i < self.pages.to_i
+  end
+
+  # gets the previous page from flickr if there is a previous page in the current photos object
+  def previous_page
+    api.send(self.method, options.merge(:page => self.page.to_i - 1)) if self.page.to_i > 1
+  end
+  
+  # passes all unknown request to the photos array if it responds to the method
+  def method_missing(method, *args, &block)
+    self.photos.respond_to?(method) ? self.photos.send(method, *args, &block) : super
+  end
+end

data/lib/flickr/photos.rb

@@ -0,0 +1,246 @@
+class Flickr::Photos < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # Return a list of photos matching some criteria. Only photos visible to the calling user will be returned. To return private or semi-private photos, 
+  # the caller must be authenticated with 'read' permissions, and have permission to view the photos. Unauthenticated calls will only return public photos.
+  # 
+  # == Authentication
+  # This method does not require authentication.
+  # 
+  # == Options
+  # * user_id (Optional)
+  #     The NSID of the user who's photo to search. If this parameter isn't passed then everybody's public photos will be searched. A value of "me" will 
+  #     search against the calling user's photos for authenticated calls.
+  # * tags (Optional)
+  #     A comma-delimited list of tags. Photos with one or more of the tags listed will be returned.
+  # * tag_mode (Optional)
+  #     Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.
+  # * text (Optional)
+  #     A free text search. Photos who's title, description or tags contain the text will be returned.
+  # * min_upload_date (Optional)
+  #     Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.
+  # * max_upload_date (Optional)
+  #     Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.
+  # * min_taken_date (Optional)
+  #     Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.
+  # * max_taken_date (Optional)
+  #     Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.
+  # * license (Optional)
+  #     The license id for photos (for possible values see the flickr.photos.licenses.getInfo method). Multiple licenses may be comma-separated.
+  # * sort (Optional)
+  #     The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, date-taken-asc, 
+  #     date-taken-desc, interestingness-desc, interestingness-asc, and relevance.
+  # * privacy_filter (Optional)
+  #     Return photos only matching a certain privacy level. This only applies when making an authenticated call to view photos you own. Valid values are:
+  #       1 public photos
+  #       2 private photos visible to friends
+  #       3 private photos visible to family
+  #       4 private photos visible to friends & family
+  #       5 completely private photos
+  # * bbox (Optional)
+  #     A comma-delimited list of 4 values defining the Bounding Box of the area that will be searched. 
+  # 
+  #     The 4 values represent the bottom-left corner of the box and the top-right corner, minimum_longitude, minimum_latitude, maximum_longitude, maximum_latitude. 
+  # 
+  #     Longitude has a range of -180 to 180 , latitude of -90 to 90. Defaults to -180, -90, 180, 90 if not specified. 
+  # 
+  #     Unlike standard photo queries, geo (or bounding box) queries will only return 250 results per page. 
+  # 
+  #     Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" 
+  #     for queries without a geo component. 
+  # 
+  #     A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we 
+  #     return only photos added in the last 12 hours (though we may extend the limit in the future).
+  # * accuracy (Optional)
+  #     Recorded accuracy level of the location information. Current range is 1-16 :
+  #       World level is 1
+  #       Country is ~3
+  #       Region is ~6
+  #       City is ~11
+  #       Street is ~16
+  #     Defaults to maximum value if not specified.
+  # * safe_search (Optional)
+  #     Safe search setting:
+  #       1 for safe.
+  #       2 for moderate.
+  #       3 for restricted.
+  #     (Please note: Un-authed calls can only see Safe content.)
+  # * content_type (Optional)
+  #     Content Type setting:
+  #       1 for photos only.
+  #       2 for screenshots only.
+  #       3 for 'other' only.
+  #       4 for photos and screenshots.
+  #       5 for screenshots and 'other'.
+  #       6 for photos and 'other'.
+  #       7 for photos, screenshots, and 'other' (all).
+  # * machine_tags (Optional)
+  #     Aside from passing in a fully formed machine tag, there is a special syntax for searching on specific properties :
+  #       Find photos using the 'dc' namespace : "machine_tags" => "dc:"
+  #       Find photos with a title in the 'dc' namespace : "machine_tags" => "dc:title="
+  #       Find photos titled "mr. camera" in the 'dc' namespace : "machine_tags" => "dc:title=\"mr. camera\"
+  #       Find photos whose value is "mr. camera" : "machine_tags" => "*:*=\"mr. camera\""
+  #       Find photos that have a title, in any namespace : "machine_tags" => "*:title="
+  #       Find photos that have a title, in any namespace, whose value is "mr. camera" : "machine_tags" => "*:title=\"mr. camera\""
+  #       Find photos, in the 'dc' namespace whose value is "mr. camera" : "machine_tags" => "dc:*=\"mr. camera\""
+  #     Multiple machine tags may be queried by passing a comma-separated list. The number of machine tags you can pass in a single query depends on 
+  #     the tag mode (AND or OR) that you are querying with. "AND" queries are limited to (16) machine tags. "OR" queries are limited to (8).
+  # * machine_tag_mode (Required)
+  #     Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.
+  # * group_id (Optional)
+  #     The id of a group who's pool to search. If specified, only matching photos posted to the group's pool will be returned.
+  # * woe_id (Optional)
+  #     A 32-bit identifier that uniquely represents spatial entities. (not used if bbox argument is present). Experimental. 
+  # 
+  #     Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" 
+  #     for queries without a geo component. 
+  # 
+  #     A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters &emdash; If no limiting factor is passed 
+  #     we return only photos added in the last 12 hours (though we may extend the limit in the future).
+  # * place_id (Optional)
+  #     A Flickr place id. (not used if bbox argument is present). Experimental. 
+  # 
+  #     Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" 
+  #     for queries without a geo component. 
+  # 
+  #     A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters &emdash; If no limiting factor is passed 
+  #     we return only photos added in the last 12 hours (though we may extend the limit in the future).
+  # * per_page (Optional)
+  #     Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
+  # * page (Optional)
+  #     The page of results to return. If this argument is omitted, it defaults to 1.
+  # * media (Optional)
+  #     The type of media to search for. 'photo', 'video', or 'both' are allowed arguments, with 'both' being the default.
+  # 
+  def search(options)
+    options.merge!({:extras => "license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media"})
+
+    rsp = @flickr.send_request('flickr.photos.search', options)
+
+    returning PhotoResponse.new(:page => rsp.photos[:page].to_i,
+                                :pages => rsp.photos[:pages].to_i,
+                                :per_page => rsp.photos[:perpage].to_i,
+                                :total => rsp.photos[:total].to_i,
+                                :photos => [],
+                                :api => self,
+                                :method => 'search',
+                                :options => options) do |photos|
+      rsp.photos.photo.each do |photo|
+        attributes = create_attributes(photo)
+
+        photos << Photo.new(@flickr, attributes)
+      end if rsp.photos.photo
+    end
+  end
+    
+  # Returns a list of the latest public photos uploaded to flickr.
+  # 
+  # == Authentication
+  # This method does not require authentication.
+  # 
+  # == Options
+  # * per_page (Optional)
+  #     Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
+  # * page (Optional)
+  #     The page of results to return. If this argument is omitted, it defaults to 1.
+  # * media (Optional)
+  #     The type of media to search for. 'photo', 'video', or 'both' are allowed arguments, with 'both' being the default.
+  # 
+  def get_recent(options = {})
+    options.merge!({:extras => "license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media"})
+
+    rsp = @flickr.send_request('flickr.photos.getRecent', options)
+
+    returning PhotoResponse.new(:page => rsp.photos[:page].to_i,
+                                :pages => rsp.photos[:pages].to_i,
+                                :per_page => rsp.photos[:perpage].to_i,
+                                :total => rsp.photos[:total].to_i,
+                                :photos => [], :api => self,
+                                :method => 'flickr.photos.getRecent',
+                                :options => options) do |photos|
+      rsp.photos.photo.each do |photo|
+        attributes = create_attributes(photo)
+
+        photos << Photo.new(@flickr, attributes)
+      end if rsp.photos.photo
+    end
+  end
+  
+  def interesting(options)
+    options.merge!({:extras => "license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media"})
+
+    rsp = @flickr.send_request('flickr.interestingness.getList', options)
+
+    returning PhotoResponse.new(:page => rsp.photos[:page].to_i,
+                                :pages => rsp.photos[:pages].to_i,
+                                :per_page => rsp.photos[:perpage].to_i,
+                                :total => rsp.photos[:total].to_i,
+                                :photos => [],
+                                :api => self,
+                                :method => 'flickr.interestingness.getList',
+                                :options => options) do |photos|
+      rsp.photos.photo.each do |photo|
+        attributes = create_attributes(photo)
+
+
+        photos << Photo.new(@flickr, attributes)
+      end if rsp.photos.photo
+    end
+  end
+  
+  def 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
+
+  # creates and/or returns the Flickr::Photos::Geo object
+  def geo
+    @geo ||= Flickr::Photos::Geo.new(@flickr)
+  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
+  def create_attributes(photo)
+    {:id => photo[:id], 
+     :owner => photo[:owner], 
+     :secret => photo[:secret], 
+     :server => photo[:server], 
+     :farm => photo[:farm], 
+     :title => photo[:title], 
+     :is_public => photo[:ispublic], 
+     :is_friend => photo[:isfriend], 
+     :is_family => photo[:isfamily],
+     :license_id => photo[:license].to_i,
+     :uploaded_at => (Time.at(photo[:dateupload].to_i) rescue nil),
+     :taken_at => (Time.parse(photo[:datetaken]) rescue nil),
+     :owner_name => photo[:ownername],
+     :icon_server => photo[:icon_server],
+     :original_format => photo[:originalformat],
+     :updated_at => (Time.at(photo[:lastupdate].to_i) rescue nil),
+     :geo => photo[:geo],
+     :tags => photo[:tags],
+     :machine_tags => photo[:machine_tags],
+     :o_dims => photo[:o_dims],
+     :views => photo[:views].to_i,
+     :media => photo[:media]}
+  end
+  
+end