flickr-fu 0.1.3

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,94 @@
+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}=#{v}"}.join('&')
+        rsp = Net::HTTP.get(URI.parse(api_call))
+      else
+        rsp = Net::HTTP.post_form(URI.parse(REST_ENDPOINT), options).body
+      end
+      
+      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) if authorize and self.auth.token(false)
+      options.merge!(:api_sig => Digest::MD5.hexdigest(@api_secret + options.keys.sort_by{|k| k.to_s}.collect{|k| k.to_s + options[k].to_s}.join)) if @api_secret
+    end
+
+    # creates and/or returns the Flickr::Photos object
+    def photos() @photos ||= Photos.new(self) end
+      
+    # creates and/or returns the Flickr::Auth object
+    def auth() @auth ||= Auth.new(self) end
+      
+    # creates and/or returns the Flickr::Uploader object
+    def uploader() @uploader ||= 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/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/photo.rb

@@ -0,0 +1,266 @@
+# 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, :uploaded_at, :taken_at, :owner_name, :icon_server, :original_format, :updated_at, :geo, :tags, :machine_tags, :o_dims, :views # 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
+  
+  # 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
+
+  # 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 url(size = :medium)
+    attach_sizes
+    send("url_#{size}")
+  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'
+    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
+      true
+    end
+  end
+  
+  # Add tags to a photo.
+  # 
+  # Params
+  # * tags (Required)
+  #     comma seperated list of tags
+  # 
+  def add_tags(tags)
+    rsp = @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)
+    rsp = @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)
+    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)
+    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:
+    attach_comments
+    @comments
+  end
+  
+  def sizes # :nodoc:
+    attach_sizes
+    @sizes
+  end
+
+  def notes # :nodoc:
+    attach_info
+    @notes
+  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
+  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 : 's'
+    when :thumb, :thumbnail : 't'
+    when :small : 'm'
+    when :medium : '-'
+    when :large : 'b'
+    when :original : '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
+      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
+
+  # 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 = []
+
+      rsp.sizes.size.each do |size|
+        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/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.split('.').last, 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.split('.').last, 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,205 @@
+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.
+  # 
+  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"})
+
+    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 => 'flickr.photos.search',
+                                :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 => photo[:license],
+                      :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}
+
+        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.
+  # 
+  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"})
+
+    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 = {: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 => photo[:license],
+                      :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}
+
+        photos << Photo.new(@flickr, attributes)
+      end if rsp.photos.photo
+    end
+  end
+end

data/lib/flickr/size.rb

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

data/lib/flickr/token.rb

@@ -0,0 +1,22 @@
+# wrapping class to hold a flickr size
+# 
+class Flickr::Auth::Token
+  attr_accessor :token, :permisions, :user_id, :username, :user_real_name
+
+  # create a new instance of a flickr auth token.
+  # 
+  # Params
+  # * attributes (Required)
+  #     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)
+    end
+  end
+
+  # overide the default to_s to output the text of the token
+  # 
+  def to_s
+    self.token.to_s
+  end
+end

data/lib/flickr/uploader.rb

@@ -0,0 +1,106 @@
+class Flickr::Uploader < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # upload a photo to flickr
+  # 
+  # NOT WORKING ... FILE UPLOADS IN NET::HTTP SUX
+  # 
+  # Params
+  # * filename (Required)
+  #     path to the file to upload
+  # * options (Optional)
+  #     options to attach to the photo (See Below)
+  # 
+  # Options
+  # * title (Optional)
+  #     The title of the photo.
+  # * description (Optional)
+  #     A description of the photo. May contain some limited HTML.
+  # * tags (Optional)
+  #     A space-seperated list of tags to apply to the photo.
+  # * privacy (Optional)
+  #     Specifies who can view the photo. valid valus are:
+  #       :public
+  #       :private
+  #       :friends
+  #       :family
+  #       :friends_and_family
+  # * safety_level (Optional)
+  #     sets the safety level of the photo. valid values are:
+  #       :safe
+  #       :moderate
+  #       :restricted
+  # * content_type (Optional)
+  #     tells what type of image you are uploading. valid values are:
+  #       :photo
+  #       :screenshot
+  #       :other
+  # * hidden (Optional)
+  #     boolean that determines if the photo shows up in global searches
+  # 
+  def upload(filename, options = {})
+    photo = File.new(filename, 'r').read
+    mimetype = MIME::Types.of(filename)
+
+    upload_options = {}
+    @flickr.sign_request(upload_options)
+    
+    form = Flickr::Uploader::MultiPartForm.new
+        
+    upload_options.each do |k,v|
+      form.parts << Flickr::Uploader::FormPart.new(k.to_s, v.to_s)
+    end
+    
+    form.parts << Flickr::Uploader::FormPart.new('photo', photo, mimetype, filename)
+    
+    headers = {"Content-Type" => "multipart/form-data; boundary=" + form.boundary}
+		        
+    rsp = Net::HTTP.start('api.flickr.com').post("/services/upload/", form.to_s, headers).body
+        
+    xm = XmlMagic.new(rsp)
+    
+    if xm[:stat] == 'ok'
+      xm
+    else
+      raise "#{xm.err[:code]}: #{xm.err[:msg]}"
+    end
+  end
+end
+
+class Flickr::Uploader::FormPart
+	attr_reader :data, :mime_type, :attributes, :filename
+
+	def initialize(name, data, mime_type = nil, filename = nil)
+		@attributes = {}
+		@attributes['name'] = name
+		@data = data
+		@mime_type = mime_type
+		@filename = filename
+	end
+
+	def to_s
+		([ "Content-Disposition: form-data" ] +
+		attributes.map{|k,v| "#{k}=\"#{v}\""}).
+		join('; ') + "\r\n"+
+		(@mime_type ? "Content-Type: #{@mime_type}\r\n" : '')+
+		"\r\n#{data}"
+	end
+end
+
+class Flickr::Uploader::MultiPartForm
+	attr_accessor :boundary, :parts
+
+	def initialize(boundary=nil)
+		@boundary = boundary ||
+		    "----------------------------Ruby#{rand(1000000000000)}"
+		@parts = []
+	end
+
+	def to_s
+		"--#@boundary\r\n"+
+		parts.map{|p| p.to_s}.join("\r\n--#@boundary\r\n")+
+		"\r\n--#@boundary--\r\n"
+	end
+end

data/lib/flickr_fu.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'xml_magic'
+require 'net/http'
+require 'cgi'
+require 'uri'
+require 'mime/types'
+require 'digest/md5'
+require 'yaml'
+
+# base must load first
+%w(base auth token photos photo photo_response comment note size uploader).each do |file|
+  require File.join(File.dirname(__FILE__), 'flickr', file)
+end
+
+include CommonThread::XML
+
+class Object
+  # returning allows you to pass an object to a block that you can manipulate returning the manipulated object
+  def returning(value)
+    yield(value)
+    value
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: flickr-fu
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Ben Wyrosdick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xml-magic
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: ben@commonthread.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flickr
+- lib/flickr/auth.rb
+- lib/flickr/base.rb
+- lib/flickr/comment.rb
+- lib/flickr/note.rb
+- lib/flickr/photo.rb
+- lib/flickr/photo_response.rb
+- lib/flickr/photos.rb
+- lib/flickr/size.rb
+- lib/flickr/token.rb
+- lib/flickr/uploader.rb
+- lib/flickr_fu.rb
+has_rdoc: true
+homepage: http://www.commonthread.com/projects/flickr-fu/rdoc
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: flickr-fu
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Provides a ruby interface to flickr via the REST api
+test_files: []
+