flickr_fu 0.1.6

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)
+    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_fu.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'xml_magic'
+require 'net/http'
+require 'cgi'
+require 'uri'
+require 'mime/types'
+require 'digest/md5'
+require 'yaml'
+require 'time'
+require 'date'
+
+# base must load first
+%w(base test auth token photos photo photo_response comment note size uploader status people person license).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,92 @@
+--- !ruby/object:Gem::Specification 
+name: flickr_fu
+version: !ruby/object:Gem::Version 
+  version: 0.1.6
+platform: ruby
+authors: 
+- Ben Wyrosdick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xml-magic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Provides a ruby interface to flickr via the REST api
+email: ben@commonthread.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- LICENSE
+- Rakefile
+- flickr_fu.gemspec
+- lib/flickr/auth.rb
+- lib/flickr/base.rb
+- lib/flickr/comment.rb
+- lib/flickr/license.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/test.rb
+- lib/flickr/token.rb
+- lib/flickr/uploader.rb
+- lib/flickr_fu.rb
+has_rdoc: true
+homepage: http://github.com/commonthread/flickr_fu
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Provides a ruby interface to flickr via the REST api
+test_files: []
+