ruby-flickr 0.1.1 → 0.1.2

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 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.print self.token
+      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)
+      File.open(@flickr.token_cache, 'r').read
+    elsif pass_through
+      rsp = @flickr.send_request('flickr.auth.getToken', {:frob => self.frob})
+
+      rsp.auth.token.to_s
+    end
+  end
+end

data/lib/flickr/base.rb

@@ -4,24 +4,50 @@ module Flickr
   end
   
   class Base
-    ENDPOINT = 'http://api.flickr.com/services/rest/'
+    attr_reader :api_key, :api_secret, :token_cache
+    
+    REST_ENDPOINT = 'http://api.flickr.com/services/rest/'
+    AUTH_ENDPOINT = 'http://flickr.com/services/auth/'
     
     # create a new flickr object
     # 
     # Params
     # * api_key (Required)
+    #     The api key given to you by flickr.
     # * api_secret (Optional)
-    def initialize(api_key, api_secret = nil)
+    #     The api secret given to you by flickr. This is used to generate a signiture for signed request.
+    # * token_cache (Optional)
+    #     File path to a cache file that holds a flickr token.
+    # 
+    def initialize(api_key, api_secret = nil, token_cache = nil)
       @api_key = api_key
       @api_secret = api_secret
+      @token_cache = token_cache
     end
 
-    def send_request(method, options = {})
+    # 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
+    # 
+    def send_request(method, options = {}, http_method = :get)
       options.merge!(:api_key => @api_key, :method => method)
-      options.merge!(:api_sig => Digest::MD5.hexdigest(@api_secret + options.keys.sort_by{|k| k.to_s}.collect{|k| k.to_s + options[k]}.join)) if @api_secret
-
-      api_call = ENDPOINT + "?" + options.collect{|k,v| "#{k}=#{v}"}.join('&')
-      rsp = open(api_call).read
+      sign_request(options)
+      
+      if http_method == :get
+        api_call = REST_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'
@@ -30,7 +56,13 @@ module Flickr
         raise "#{xm.err[:code]}: #{xm.err[:msg]}"
       end
     end
+    
+    def sign_request(options, authorize = true)
+      options.merge!(:auth_token => self.auth.token(false)) 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
 
     def photos() @photos ||= Photos.new(self) end
+    def auth() @auth ||= Auth.new(self) end
   end
 end

data/lib/flickr/photos.rb

@@ -133,7 +133,13 @@ class Flickr::Photos < Flickr::Base
 
     rsp = @flickr.send_request('flickr.photos.search', options)
 
-    returning PhotoResponse.new(:page => rsp.photos[:page], :pages => rsp.photos[:pages], :per_page => rsp.photos[:perpage], :total => rsp.photos[:total], :photos => [], :api => self, :method => 'flickr.photos.search', :options => options) do |photos|
+    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|
         all_attributes = {:id => photo[:id], 
                           :owner => photo[:owner], 
@@ -155,7 +161,7 @@ class Flickr::Photos < Flickr::Base
                           :tags => photo[:tags],
                           :machine_tags => photo[:machine_tags],
                           :o_dims => photo[:o_dims],
-                          :views => photo[:views]}
+                          :views => photo[:views].to_i}
 
         used_attributes = {}
 
@@ -271,6 +277,18 @@ class Flickr::Photos < Flickr::Base
         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
 
     def description # :nodoc:
       attach_info

data/lib/ruby_flickr.rb

@@ -1,10 +1,14 @@
 require 'rubygems'
 require 'xml_magic'
-require 'open-uri'
+require 'net/http'
+require 'uri'
 require 'digest/md5'
-include CommonThread::XML
 
-Dir[File.join(File.dirname(__FILE__), 'flickr/**/*.rb')].sort.each { |lib| require lib }
+require File.join(File.dirname(__FILE__), 'flickr', 'base')
+require File.join(File.dirname(__FILE__), 'flickr', 'auth')
+require File.join(File.dirname(__FILE__), 'flickr', 'photos')
+
+include CommonThread::XML
 
 class Object
   # returning allows you to pass an object to a block that you can manipulate returning the manipulated object

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-flickr
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ben Wyrosdick
@@ -9,10 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-29 00:00:00 -05:00
+date: 2008-03-31 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+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: []
@@ -23,6 +31,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/flickr
+- lib/flickr/auth.rb
 - lib/flickr/base.rb
 - lib/flickr/photos.rb
 - lib/ruby_flickr.rb