fotonauts-flickr_fu 0.3.2

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

@@ -0,0 +1,24 @@
+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
+  
+  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/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

data/lib/flickr/person.rb

@@ -0,0 +1,82 @@
+# wrapping class to hold an flickr photo
+# 
+class Flickr::People::Person
+  attr_accessor :username, :nsid, :is_admin, :is_pro, :icon_server, :icon_farm, :realname, :mbox_sha1sum, :location, :photos_url, :profile_url, :photo_count, :photo_first_upload, :photo_first_taken
+    
+  # create a new instance of a flickr person.
+  # 
+  # Params
+  # * flickr (Required)
+  #     the flickr object
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the person object
+  def initialize(flickr, attributes)
+    @flickr = flickr
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+  
+  def buddy_icon
+    @buddy_icon ||= if icon_server.to_i > 0
+                      "http://farm#{icon_farm}.static.flickr.com/#{icon_server}/buddyicons/#{nsid}.jpg"
+                    else
+                      'http://www.flickr.com/images/buddyicon.jpg'
+                    end
+  end
+  
+  # Get a list of public photos for the given user.
+  # 
+  # Options
+  # * 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.)
+  # * 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.
+  def public_photos(options = {})
+    options.merge!({:user_id => self.nsid, :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.people.getPublicPhotos', options)
+
+    returning Flickr::Photos::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 => 'public_photos',
+                                :options => options) do |photos|
+      rsp.photos.photo.each do |photo|
+        attributes = {: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]}
+
+        photos << Flickr::Photos::Photo.new(@flickr, attributes)
+      end if rsp.photos.photo
+    end
+  end
+end

data/lib/flickr/photo.rb

@@ -0,0 +1,321 @@
+# 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_height, :o_width, :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
+
+  # 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:
+  #       :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