upflickr 0.1.6

data/CHANGELOG

@@ -0,0 +1,4 @@
+v0.1.6 - 06-06-2010
+  -new methods: list_photos, add_photo, remove_photo, delete_photo, license_photo, list_sets, create_set, delete_set
+  -improved error handling
+  -updated README

data/README

@@ -0,0 +1,94 @@
+#######################
+#   upflickr v0.1.6   #
+#######################
+#
+# Upflickr makes it easier to upload files to flickr using the flickr api.
+#
+# you will need the api_key and secret values for your flickr application.
+#
+#######################
+#     ATTRIBUTES      #
+#######################
+
+api_key
+
+secret
+
+token
+
+#######################
+#       METHODS       #
+#######################
+# (all methods return false on failure)
+
+add_photo
+	args:	 photo_id, set_id
+	returns: true
+
+	Add a photo to a set.
+
+check_token
+	args:	 none
+	returns: true
+
+	Check if the current authentication token is still valid.
+
+create_set
+	args:	 photo_id, title, description (optional)
+	returns: set_id
+
+	Create a new photoset.
+
+delete_photo
+	args:	 photo_id
+	returns: true
+
+	Delete a photo.
+
+delete_set
+	args:	 set_id
+	returns: true
+
+	Delete a photoset.
+
+get_auth_url
+	args: 	 none
+	returns: authorization_url
+
+	Gets the unique authentication URL for confirming read/write/delete access. You must load this URL in a web browser prior to attempting get_token.
+
+get_token
+	args: 	 none
+	returns: token
+
+	Get an authentication token after visiting the authentication URL and clicking confirm. This token may be used with the above 'token' method to set the token in a new instance without re-authenticating.
+
+license_photo
+	args:	 photo_id, license_id
+	returns: true
+
+	Specify a license for a photo. License IDs can be found at http://www.flickr.com/services/api/flickr.photos.licenses.getInfo.html
+
+list_photos
+	args:	 set_id (optional)
+	returns: hash {photo_id => title}
+
+	Without argument, lists all photos not assigned to a set. With set_id argument, lists all photos in the given set.
+
+list_sets
+	args:	 none
+	returns: hash {set_id => title}
+
+	List all the photosets for the current user.
+
+remove_photo
+	args:	 photo_id, set_id
+	returns: true
+
+	Remove a photo from a set.
+
+upload
+	args:	 hash {arg => value}
+	returns: photo_id
+
+	Upload a new image. Create a hash using any of the arguments from http://www.flickr.com/services/api/upload.api.html as keys. All arguments are optional except 'photo'. Therefore, the minimum required argument is: args{'photo' => "/path/to/image1.jpg"}

data/lib/multipartpost.rb

@@ -0,0 +1,55 @@
+#--
+# Helper class to prepare an HTTP POST request with a file upload
+# Mostly taken from http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/113774
+# Anything that's broken and wrong probably the fault of Bill Stilwell (bill@marginalia.org)
+#++
+
+  require 'rubygems'
+  require 'mime/types'
+  require 'net/http'
+  require 'cgi'
+  
+  class Param
+    attr_accessor :k, :v
+    def initialize( k, v )
+      @k = k
+      @v = v
+    end
+    
+    def to_multipart
+      return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
+    end
+  end
+  
+  class FileParam
+    attr_accessor :k, :filename, :content
+    def initialize( k, filename, content )
+      @k = k
+      @filename = filename
+      @content = content
+    end
+    
+    def to_multipart
+      return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{filename}\"\r\n" +
+	"Content-Transfer-Encoding: binary\r\n" +
+	"Content-Type: #{MIME::Types.type_for(@filename)}\r\n\r\n" + content + "\r\n"
+    end
+  end
+
+  class MultipartPost
+    BOUNDARY = 'flickrrocks-aaaaaabbbb0000'
+    HEADER = {"Content-type" => "multipart/form-data, boundary=" + BOUNDARY + " "}
+    
+    def prepare_query ( params )
+      fp = []
+      params.each do |k,v|
+	if v.respond_to?(:read)
+	  fp.push(FileParam.new(k,v.path,v.read))
+	else
+	  fp.push(Param.new(k,v))
+	end
+      end
+      query = fp.collect {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("") + "--" + BOUNDARY + "--"
+      return query, HEADER
+    end
+  end

data/lib/upflickr.rb

@@ -0,0 +1,295 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'open-uri'
+require 'digest/md5'
+require 'rexml/document'
+require 'multipartpost'
+
+class Upflickr
+  API_URL = 'http://api.flickr.com/services/rest/?'
+  attr_accessor :api_key
+  attr_accessor :secret
+  attr_accessor :token
+
+  def check_attr(token=false)
+    if token == false
+      if @api_key != nil && @secret != nil
+        return true
+      else
+        puts "UPFLICKR: api_key and/or secret not set"
+        return false
+      end
+    else
+      if @api_key != nil && @secret != nil && @token != nil
+        return true
+      else
+        puts "UPFLICKR: api_key, secret, and/or token not set"
+        return false
+      end
+    end
+  end
+
+  def sign(s)
+    return Digest::MD5.hexdigest(s)
+  end
+
+  def remove_white(s)
+    return s.gsub(" ","+")
+  end
+
+  def get_auth_url
+    if self.check_attr == true
+      sig = self.sign("#{@secret}api_key#{@api_key}methodflickr.auth.getFrob")
+      data = open("#{API_URL}method=flickr.auth.getFrob&api_key=#{@api_key}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        @frob = doc.elements["//frob"].text.strip
+        sig = self.sign("#{@secret}api_key#{@api_key}frob#{@frob}permsdelete")
+        url = "http://flickr.com/services/auth/?api_key=#{@api_key}&frob=#{@frob}&perms=delete&api_sig=#{sig}"
+        return url
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def get_token
+    if self.check_attr == true
+      sig = self.sign("#{@secret}api_key#{@api_key}frob#{@frob}methodflickr.auth.getToken")
+      data = open("#{API_URL}method=flickr.auth.getToken&api_key=#{@api_key}&frob=#{@frob}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        self.token = doc.elements["//token"].text.strip
+        return @token
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def check_token
+    if self.check_attr(true) == true
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.auth.checkToken")
+      data = open("#{API_URL}method=flickr.auth.checkToken&api_key=#{@api_key}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        perms = doc.elements["//perms"].text.strip
+        if perms == "delete"
+          return true
+        else
+	  puts "UPFLICKR: Full permissions not enabled."
+          return false
+        end
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def list_photos(set_id=false)
+    if self.check_attr(true) == true
+      if set_id == false
+        sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photos.getNotInSet")
+        data = open("#{API_URL}method=flickr.photos.getNotInSet&api_key=#{@api_key}&auth_token=#{@token}&api_sig=#{sig}")
+        doc = REXML::Document.new(data)
+      else
+        sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photosets.getPhotosphotoset_id#{set_id}")
+        data = open("#{API_URL}method=flickr.photosets.getPhotos&api_key=#{@api_key}&photoset_id=#{set_id}&auth_token=#{@token}&api_sig=#{sig}")
+        doc = REXML::Document.new(data)
+      end
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+	photos = {}
+        doc.elements.each("*/*/photo") do |e|
+          id = e.attributes['id']
+          name = e.attributes['title']
+          photos[id] = name
+        end
+        return photos
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def add_photo(photo_id, set_id)
+    if self.check_attr(true) == true
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photosets.addPhotophoto_id#{photo_id}photoset_id#{set_id}")
+      data = open("#{API_URL}method=flickr.photosets.addPhoto&api_key=#{@api_key}&photo_id=#{photo_id}&photoset_id=#{set_id}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return true
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def remove_photo(photo_id, set_id)
+    if self.check_attr(true) == true  
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photosets.removePhotophoto_id#{photo_id}photoset_id#{set_id}")
+      data = open("#{API_URL}method=flickr.photosets.removePhoto&api_key=#{@api_key}&photo_id=#{photo_id}&photoset_id=#{set_id}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return true
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def delete_photo(photo_id)
+    if self.check_attr(true) == true
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photos.deletephoto_id#{photo_id}")
+      data = open("#{API_URL}method=flickr.photos.delete&api_key=#{@api_key}&photo_id=#{photo_id}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return true
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+	return false
+      end
+    else
+      return false
+    end
+  end
+
+  def license_photo(photo_id,license_id)
+    if self.check_attr(true) == true
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}license_id#{license_id}methodflickr.photos.licenses.setLicensephoto_id#{photo_id}")
+      data = open("#{API_URL}method=flickr.photos.licenses.setLicense&api_key=#{@api_key}&photo_id=#{photo_id}&license_id=#{license_id}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return true
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    end
+  end
+
+  def list_sets
+    if self.check_attr(true) == true
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photosets.getList")
+      data = open("#{API_URL}method=flickr.photosets.getList&api_key=#{@api_key}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        photosetids = {}
+        doc.elements.each("*/photosets/photoset") do |e|
+          id = e.attributes['id']
+          name = e.elements['title'].text.strip
+          photosetids[id] = name
+        end
+        return photosetids
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def create_set(photo_id, title, description=false)
+    if self.check_attr(true) == true
+      if description != false
+        sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}description#{description}methodflickr.photosets.createprimary_photo_id#{photo_id}title#{title}")
+        title = self.remove_white(title)
+        description = self.remove_white(description)
+        data = open("#{API_URL}method=flickr.photosets.create&api_key=#{@api_key}&title=#{title}&description=#{description}&primary_photo_id=#{photo_id}&auth_token=#{@token}&api_sig=#{sig}")
+      else
+        sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photosets.createprimary_photo_id#{photo_id}title#{title}")
+        title = self.remove_white(title)
+        data = open("#{API_URL}method=flickr.photosets.create&api_key=#{@api_key}&title=#{title}&primary_photo_id=#{photo_id}&auth_token=#{@token}&api_sig=#{sig}")
+      end
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return doc.elements['//photoset'].attributes['id']
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def delete_set(set_id)
+    if self.check_attr(true) == true
+      sig = self.sign("#{@secret}api_key#{@api_key}auth_token#{@token}methodflickr.photosets.deletephotoset_id#{set_id}")
+      data = open("#{API_URL}method=flickr.photosets.delete&api_key=#{@api_key}&photoset_id=#{set_id}&auth_token=#{@token}&api_sig=#{sig}")
+      doc = REXML::Document.new(data)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return true
+      else
+	puts "UPFLICKR: #{doc.elements["//err"].attributes['msg']}"
+        return false
+      end
+    end
+  end
+
+  def post_form(url, query, headers)
+    Net::HTTP.start(url.host, url.port) {|con|
+      con.read_timeout = 10
+      begin
+        return con.post(url.path, query, headers)
+      rescue => e
+        puts "UPFLICKR: POSTING Failed #{e}... #{Time.now}"
+      end
+    }
+  end 
+
+  def upload(params)
+    if self.check_attr(true) == true
+      params['api_key'] = @api_key
+      params['auth_token'] = @token
+      p2s = {}
+      params.each do |k,v|
+        if k == 'photo'
+          params['photo'] = File.open(v, 'r')
+        else
+          p2s[k] = v
+        end
+      end
+      p2s = p2s.sort.to_s
+      sig = self.sign("#{@secret}#{p2s}")
+      params['api_sig'] = sig
+
+      mp = MultipartPost.new
+
+      # Get both the headers and the query ready,
+      # given the new MultipartPost and the params
+      # Hash
+      query, headers = mp.prepare_query(params)
+
+      # Make sure the URL is useable
+      url = URI.parse('http://flickr.com/services/upload/')
+
+      # Do the actual POST, given the right inputs
+      data = self.post_form(url, query, headers)
+      doc = REXML::Document.new(data.read_body)
+      if doc.elements["//rsp"].attributes['stat'] == "ok"
+        return doc.elements["//photoid"].text.strip
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: upflickr
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
+platform: ruby
+authors: 
+- Ben Baker-Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/multipartpost.rb
+- lib/upflickr.rb
+- README
+- CHANGELOG
+has_rdoc: true
+homepage: http://bitsynthesis.com/upflickr/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a simple flickr uploader
+test_files: []
+