maciej-flickr_fu 0.3.0

data/lib/flickr/photoset.rb

@@ -0,0 +1,36 @@
+class Flickr::Photosets::Photoset
+  attr_accessor :id,:num_photos,:title,:description
+  
+  def initialize(flickr, attributes)
+    @flickr = flickr
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+  
+  def get_photos(options={})
+    options = options.merge(:photoset_id=>id)
+    rsp = @flickr.send_request('flickr.photosets.getPhotos', options)
+    collect_photos(rsp)
+  end
+  
+  protected
+    def collect_photos(rsp)
+      photos = []
+      return photos unless rsp
+      if rsp.photoset.photo
+        rsp.photoset.photo.each do |photo|
+          attributes = create_attributes(photo)
+          photos << Flickr::Photos::Photo.new(@flickr,attributes)
+        end
+      end
+      return photos
+    end
+    
+    def create_attributes(photo)
+      {:id => photo[:id],
+       :secret => photo[:secret], 
+       :server => photo[:server], 
+       :title => photo[:title]}
+    end
+end

data/lib/flickr/photosets.rb

@@ -0,0 +1,36 @@
+class Flickr::Photosets < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+  
+  # Get the authorized user's contact list.
+  # 
+  def get_list(options={})
+    rsp = @flickr.send_request('flickr.photosets.getList', options)
+    collect_photosets(rsp)
+  end
+    
+  protected  
+    def collect_photosets(rsp)
+      photosets = []
+      return photosets unless rsp
+      if rsp.photosets.photoset
+        rsp.photosets.photoset.each do |photoset|
+          attributes = create_attributes(photoset)
+          photosets << Photoset.new(@flickr, attributes)
+        end
+      end
+      return photosets
+    end
+  
+    def create_attributes(photoset)
+
+      {
+        :id => photoset[:id], 
+        :num_photos => photoset[:photos],
+        :title => photoset.title,
+        :description => photoset.description
+       }
+    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/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/test.rb

@@ -0,0 +1,31 @@
+class Flickr::Test
+  def initialize(flickr)
+    @flickr = flickr
+  end
+  
+  # A testing method which checks if the caller is logged in then returns their username.
+  # 
+  def login
+    rsp = @flickr.send_request('flickr.test.login')
+    rsp.user.username.to_s
+  end
+  
+  # A testing method which echo's all parameters back in the response.
+  # 
+  # pass any number of options as a hash and it will be returned
+  # 
+  def echo(options = {})
+    rsp = @flickr.send_request('flickr.test.echo', options)
+    
+    options
+  end
+  
+  # Null test
+  # 
+  # Returns true unless there is an error
+  # 
+  def null
+     rsp = @flickr.send_request('flickr.test.null')
+     true
+  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) if respond_to?("#{k}=")
+    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,162 @@
+class Flickr::Uploader < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # upload a photo to flickr
+  #
+  # 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 = {})
+    upload_data(File.new(filename, 'rb').read, MIME::Types.of(filename), options.merge(:filename => filename))
+  end
+
+  # upload a photo to flickr
+  #
+  # Params
+  # * photo (Required)
+  #     image stored in a variable
+  # * mimetype (Required)
+  #     mime type of the image  
+  # * options (Optional)
+  #     see upload method
+  #
+  def upload_data(photo, mimetype, options = {})
+    filename = options.delete(:filename) || Time.now.to_s
+    options = upload_options(options)
+    @flickr.sign_request(options)
+
+    form = Flickr::Uploader::MultiPartForm.new
+
+    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
+
+  # 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
+
+  protected
+
+  def upload_options(options)
+    upload_options = { :api_key => @flickr.api_key }
+    upload_options.merge!({:title => options[:title], :description => options[:description], :tags => options[:tags]})
+    [ :is_public, :is_friend, :is_family, :async ].each { |key| upload_options[key] = options[key] ? '1' : '0' }
+
+    upload_options[:safety_level] = case options[:safety_level]
+      when :safe then '1'
+      when :moderate then '2'
+      when :restricted then '3'
+    end if options.has_key?(:safety_level)
+
+    upload_options[:content_type] = case options[:content_type]
+      when :photo then '1'
+      when :screenshot then '2'
+      when :other then '3'
+    end if options.has_key?(:content_type)
+
+    upload_options[:hidden] = options.has_key?(:hidden) ? '2' : '1'
+    upload_options
+  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
+    @attributes['filename'] = filename if filename
+    @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/urls.rb

@@ -0,0 +1,44 @@
+# Wrapping class that holds methods in the flickr.urls namespace
+class Flickr::Urls < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  def get_group group_id
+    rsp = @flickr.send_request('flickr.urls.getGroup', {:group_id => group_id})
+    rsp.group[:url]
+  end
+
+  def get_user_photos user_id
+    rsp = @flickr.send_request('flickr.urls.getUserPhotos', {:user_id => user_id})
+    rsp.user[:url]
+  end
+
+  def get_user_profile user_id
+    rsp = @flickr.send_request('flickr.urls.getUserProfile', {:user_id => user_id})
+    rsp.user[:url]
+  end
+
+  def lookup_group url #, options = {}
+    #options.symbolize_keys!
+    #options.reverse_merge!({:include_groupname => false})
+    rsp = @flickr.send_request('flickr.urls.lookupGroup', {:url => url})
+    #if options[:include_groupname]
+    #[rsp.group[:id], {:groupname => rsp.group.groupname}]
+    #else
+    rsp.group[:id]
+    #end
+  end
+
+  def lookup_user url
+    rsp = @flickr.send_request('flickr.urls.lookupUser', {:url => url})
+    user_id = UserLookupResult.new(rsp.user[:id])
+    user_id.username = rsp.user.username
+    user_id
+  end
+
+  class UserLookupResult < String
+    attr_accessor :username
+  end
+  
+end

data/lib/flickr_fu.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'xml_magic'
+require 'net/http'
+require 'cgi'
+require 'uri'
+require 'open-uri'
+require 'mime/types'
+require 'digest/md5'
+require 'yaml'
+require 'time'
+require 'date'
+
+# base must load first
+[ "base",
+  "test",
+  "auth",
+  "token",
+  "photos",
+  "photo",
+  "photo_response",
+  "photosets",
+  "photoset",
+  "comment",
+  "note",
+  "size",
+  "uploader",
+  "status",
+  "people",
+  "person",
+  "license",
+  "errors",
+  "contacts",
+  "contact",
+  "geo",
+  "location",
+  "urls" ].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

data/spec/fixtures/flickr/contacts/get_list-fail-99.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="99" msg="Insufficient permissions. Method requires read privileges; none granted."/>
+</rsp>

data/spec/fixtures/flickr/contacts/get_public_list-0.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<contacts page="1" pages="1" per_page="1000" perpage="1000" total="2">
+        <contact nsid="40718771@N00" username="kooop" iconserver="2" iconfarm="1" ignored="0" />
+        <contact nsid="20039881@N00" username="wayoutwest" iconserver="1" iconfarm="1" ignored="0" />
+</contacts>
+</rsp>

data/spec/fixtures/flickr/photos/geo/get_location-0.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<photo id="2984637736">
+		<location latitude="50.041376" longitude="21.999006" accuracy="16" context="0" place_id="X.5ul_ucAJtJcT0" woeid="517126">
+			<locality place_id="X.5ul_ucAJtJcT0" woeid="517126">Rzeszów</locality>
+			<county place_id="gUrbqNqYA5n4kv.erw" woeid="12591341">Rzeszów</county>
+			<region place_id="acDFruGYA5lyOpcIVg" woeid="12577943">Subcarpathia</region>
+			<country place_id="0kV97TybAphIxvm14g" woeid="23424923">Poland</country>
+		</location>
+	</photo>
+</rsp>