flickr-fu 0.1.3 → 0.1.4

data/lib/flickr/base.rb

@@ -79,12 +79,16 @@ module Flickr
     # 
     def sign_request(options, authorize = true)
       options.merge!(:auth_token => self.auth.token(false).to_s) if authorize and self.auth.token(false)
+      options.delete(:api_sig)
       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::People object
+    def people() @people ||= People.new(self) end
+      
     # creates and/or returns the Flickr::Auth object
     def auth() @auth ||= Auth.new(self) 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,74 @@
+# 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
+  
+  # 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 => 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,
+                      :media => photo[:media]}
+
+        photos << Flickr::Photos::Photo.new(@flickr, attributes)
+      end if rsp.photos.photo
+    end
+  end
+end

data/lib/flickr/photo.rb

@@ -2,7 +2,7 @@
 # 
 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 :license, :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

data/lib/flickr/photo_response.rb

@@ -22,12 +22,12 @@ class Flickr::Photos::PhotoResponse
 
   # 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
+    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.split('.').last, options.merge(:page => self.page.to_i - 1)) if self.page.to_i > 1
+    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

data/lib/flickr/photos.rb

@@ -113,7 +113,7 @@ class Flickr::Photos < Flickr::Base
   #     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"})
+    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)
 
@@ -121,8 +121,9 @@ class Flickr::Photos < Flickr::Base
                                 :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',
+                                :photos => [],
+                                :api => self,
+                                :method => 'search',
                                 :options => options) do |photos|
       rsp.photos.photo.each do |photo|
         attributes = {:id => photo[:id], 
@@ -145,7 +146,8 @@ class Flickr::Photos < Flickr::Base
                       :tags => photo[:tags],
                       :machine_tags => photo[:machine_tags],
                       :o_dims => photo[:o_dims],
-                      :views => photo[:views].to_i}
+                      :views => photo[:views].to_i,
+                      :media => photo[:media]}
 
         photos << Photo.new(@flickr, attributes)
       end if rsp.photos.photo
@@ -164,7 +166,7 @@ class Flickr::Photos < Flickr::Base
   #     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"})
+    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)
 
@@ -196,7 +198,8 @@ class Flickr::Photos < Flickr::Base
                       :tags => photo[:tags],
                       :machine_tags => photo[:machine_tags],
                       :o_dims => photo[:o_dims],
-                      :views => photo[:views].to_i}
+                      :views => photo[:views].to_i,
+                      :media => photo[:media]}
 
         photos << Photo.new(@flickr, attributes)
       end if rsp.photos.photo

data/lib/flickr/status.rb

@@ -0,0 +1,19 @@
+# wrapper class to hold a flickr upload status object.
+# 
+class Flickr::Uploader::Status
+  attr_accessor :nsid, :is_pro, :username, :max_bandwidth, :used_bandwidth, :remaining_bandwidth, :max_filesize, :max_videosize, :sets_created, :sets_remaining
+  
+  # create a new instance of a flickr upload status object.
+  # 
+  # Params
+  # * flickr (Required)
+  #     the flickr object
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the status object
+  def initialize(flickr, attributes)
+    @flickr = flickr
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+end

data/lib/flickr/uploader.rb

@@ -67,6 +67,27 @@ class Flickr::Uploader < Flickr::Base
       raise "#{xm.err[:code]}: #{xm.err[:msg]}"
     end
   end
+  
+  # Returns information for the calling user related to photo uploads.
+  # 
+  # * Bandwidth and filesize numbers are provided in bytes.
+  # * Bandwidth is specified in bytes per month.
+  # * Pro accounts display 99 for the number of remaining sets, since they have unlimited sets. Free accounts will display either 3, 2, 1, or 0.
+  # 
+  def status
+    rsp = @flickr.send_request('flickr.people.getUploadStatus')
+    
+    Flickr::Uploader::Status.new(@flickr, :nsid => rsp.user[:id],
+                                          :is_pro => (rsp.user[:ispro] == "1" ? true : false),
+                                          :username => rsp.user.username.to_s,
+                                          :max_bandwidth => rsp.user.bandwidth[:maxbytes],
+                                          :used_bandwidth => rsp.user.bandwidth[:usedbytes],
+                                          :remaining_bandwidth => rsp.user.bandwidth[:remainingbytes],
+                                          :max_filesize => rsp.user.filesize[:maxbytes],
+                                          :max_videosize => rsp.user.videosize[:maxbytes],
+                                          :sets_created => rsp.user.sets[:created].to_i,
+                                          :sets_remaining => (rsp.user[:ispro] == "1" ? 99 : rsp.user.sets[:remaining].to_i))
+  end
 end
 
 class Flickr::Uploader::FormPart

data/lib/flickr_fu.rb

@@ -6,9 +6,11 @@ require 'uri'
 require 'mime/types'
 require 'digest/md5'
 require 'yaml'
+require 'time'
+require 'date'
 
 # base must load first
-%w(base auth token photos photo photo_response comment note size uploader).each do |file|
+%w(base auth token photos photo photo_response comment note size uploader status people person).each do |file|
   require File.join(File.dirname(__FILE__), 'flickr', file)
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flickr-fu
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Ben Wyrosdick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-09 00:00:00 -05:00
+date: 2008-04-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,10 +35,13 @@ files:
 - lib/flickr/base.rb
 - lib/flickr/comment.rb
 - lib/flickr/note.rb
+- lib/flickr/people.rb
+- lib/flickr/person.rb
 - lib/flickr/photo.rb
 - lib/flickr/photo_response.rb
 - lib/flickr/photos.rb
 - lib/flickr/size.rb
+- lib/flickr/status.rb
 - lib/flickr/token.rb
 - lib/flickr/uploader.rb
 - lib/flickr_fu.rb