flickr_fu 0.1.6 → 0.3.0

data/.gitignore

@@ -0,0 +1,13 @@
+rdoc
+.DS_Store
+*.gem
+demo*
+*~
+*.sw*
+.specification
+nbproject/
+doc/rspec_report.html
+doc/rspec_profile.txt
+spec/spec.local.opts
+coverage/
+pkg/

data/README

@@ -23,6 +23,12 @@
 
   http://www.commonthread.com/projects/flickr_fu/rdoc/
 
+== Example flickr.yml
+--- !map:HashWithIndifferentAccess
+key: "YOUR KEY"
+secret: "YOUR SECRET"
+token_cache: "token_cache.yml"
+
 == Authorization
 
   To authorise your application to access Flickr using your API key you will
@@ -32,6 +38,12 @@
   access it from your browser. Confirm the application has permission at 
   the level you have specified.
   
+  Note that flickr has different types of keys. If you use one for a webapplication,
+  which is most likely, you need to define a callback and somehow make sure that
+  you connect the parameter :frob that flickr send via the callback is assigned
+  to the right user account. The best way to do this is to loop over all the current
+  user's flickr accounts and try flickr.auth.token with the :frob.
+  
   Finally, cache the token (this will create the token cache file)
   
   If you have an invalid API key you will see errors such as:
@@ -44,7 +56,7 @@
   "98: Login failed / Invalid auth token" or 
   "99: User not logged in / Insufficient permissions"
   
-== Authorization Example
+== Authorization Example for non-webapplication
 
   require 'flickr_fu'
   
@@ -59,6 +71,28 @@
   
   flickr.auth.cache_token
 
+== Authorization Example for a webapplication
+
+  flickr.auth.token also contains the nsid and username, this
+  example only stores the token and no other userdata.
+
+  require 'flickr_fu'
+  class FlickrController < ActionController::Base
+    def create
+      flickr = Flickr.new('flickr.yml')
+      redirect_to flickr.auth.url(:write)
+    end
+    def flickr_callback
+      flickr = Flickr.new('flickr.yml')
+      flickr.auth.frob = params[:frob]
+      current_user.update_attribute :flickr_token, flickr.auth.token.token
+    end
+    def something_else_with_flickr
+      flickr = Flickr.new(YAML.load_file('flickr.yml').merge(:token => current_user.flickr_token))
+      # now you have full access on the user's data :)
+    end
+  end
+
 == Search Example
 
   require 'flickr_fu'
@@ -108,3 +142,6 @@
   Mike Perham
   Chris Anderton
   Luke Francl
+  Thomas R. Koll
+  P. Mark Anderson
+  Josh Nichols

data/Rakefile

@@ -1,22 +1,73 @@
 require 'rake'
-require 'rake/testtask'
 require 'rake/rdoctask'
- 
-desc 'Default: run unit tests.'
-task :default => :test
- 
-desc 'Test the contact_info plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+
+# Gem building
+begin
+  begin
+    require 'jeweler'
+  rescue LoadError
+    require 'rubygems'
+    require 'jeweler'
+  end
+  Jeweler::Tasks.new do |s|
+    s.name = "flickr_fu"
+    s.summary = "Provides a ruby interface to flickr via the REST api"
+    s.email = "ben@commonthread.com"
+    s.homepage = "http://github.com/commonthread/flickr_fu"
+    s.description = "Provides a ruby interface to flickr via the REST api"
+    s.authors = ["Ben Wyrosdick", "Maciej Bilas"]
+    s.rdoc_options = ["--main", "README"]
+    s.extra_rdoc_files = ["README"]
+    s.add_dependency("mime-types", ["> 0.0.0"])
+    s.add_dependency("xml-magic", ["> 0.0.0"])
+	s.files.exclude("spec/spec.local.opts")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
- 
-desc 'Generate documentation for the contact_info plugin.'
+
+desc 'Generate documentation for flickr_fu.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ruby-flickr'
+  rdoc.title    = 'flickr_fu'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+# RSpec support
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+	  To use rspec for testing you must install rspec gem:
+	  gem install rspec
+  EOS
+  exit(0)
+end
+
+task :default => :spec
+
+spec_common = Proc.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_opts << ['--options', "spec/spec.local.opts" ] if File.exist?(File.dirname(__FILE__) + "/spec/spec.local.opts")
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  spec_common.call(t)
+end
+
+desc "Analyze code coverage with tests"
+Spec::Rake::SpecTask.new("rcov") do |t|
+  spec_common.call(t)
+  t.rcov = true
+  t.rcov_opts = ["-x", "/var/lib", "-x", "spec/", "-T"]
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 3
+:patch: 0

data/flickr_fu.gemspec

@@ -1,35 +1,117 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
-  s.name     = "flickr_fu"
-  s.version  = "0.1.6"
-  s.date     = "2008-09-12"
-  s.summary  = "Provides a ruby interface to flickr via the REST api"
-  s.email    = "ben@commonthread.com"
-  s.homepage = "http://github.com/commonthread/flickr_fu"
-  s.description = "Provides a ruby interface to flickr via the REST api"
-  s.has_rdoc = true
-  s.authors  = ["Ben Wyrosdick"]
-  s.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"]
+  s.name = %q{flickr_fu}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Wyrosdick", "Maciej Bilas"]
+  s.date = %q{2009-05-19}
+  s.description = %q{Provides a ruby interface to flickr via the REST api}
+  s.email = %q{ben@commonthread.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "flickr_fu.gemspec",
+     "lib/flickr/auth.rb",
+     "lib/flickr/base.rb",
+     "lib/flickr/comment.rb",
+     "lib/flickr/contact.rb",
+     "lib/flickr/contacts.rb",
+     "lib/flickr/errors.rb",
+     "lib/flickr/geo.rb",
+     "lib/flickr/license.rb",
+     "lib/flickr/location.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/photoset.rb",
+     "lib/flickr/photosets.rb",
+     "lib/flickr/size.rb",
+     "lib/flickr/status.rb",
+     "lib/flickr/test.rb",
+     "lib/flickr/token.rb",
+     "lib/flickr/uploader.rb",
+     "lib/flickr/urls.rb",
+     "lib/flickr_fu.rb",
+     "spec/fixtures/flickr/contacts/get_list-fail-99.xml",
+     "spec/fixtures/flickr/contacts/get_public_list-0.xml",
+     "spec/fixtures/flickr/photos/geo/get_location-0.xml",
+     "spec/fixtures/flickr/photos/geo/get_location-fail-2.xml",
+     "spec/fixtures/flickr/photos/get_info-0.xml",
+     "spec/fixtures/flickr/photos/get_info-1.xml",
+     "spec/fixtures/flickr/photos/get_sizes-0.xml",
+     "spec/fixtures/flickr/photos/get_sizes-1.xml",
+     "spec/fixtures/flickr/photos/licenses/get_info.xml",
+     "spec/fixtures/flickr/photosets/get_list-0.xml",
+     "spec/fixtures/flickr/photosets/get_photos-0.xml",
+     "spec/fixtures/flickr/test/echo-0.xml",
+     "spec/fixtures/flickr/test/null-fail-99.xml",
+     "spec/fixtures/flickr/urls/get_group-0.xml",
+     "spec/fixtures/flickr/urls/get_group-fail-1.xml",
+     "spec/fixtures/flickr/urls/get_user_photos-0.xml",
+     "spec/fixtures/flickr/urls/get_user_photos-fail-1.xml",
+     "spec/fixtures/flickr/urls/get_user_photos-fail-2.xml",
+     "spec/fixtures/flickr/urls/get_user_profile-0.xml",
+     "spec/fixtures/flickr/urls/get_user_profile-fail-1.xml",
+     "spec/fixtures/flickr/urls/get_user_profile-fail-2.xml",
+     "spec/fixtures/flickr/urls/lookup_group-0.xml",
+     "spec/fixtures/flickr/urls/lookup_group-fail-1.xml",
+     "spec/fixtures/flickr/urls/lookup_user-0.xml",
+     "spec/fixtures/flickr/videos/get_info-0.xml",
+     "spec/fixtures/flickr/videos/get_sizes-0.xml",
+     "spec/flickr/base_spec.rb",
+     "spec/flickr/contacts_spec.rb",
+     "spec/flickr/errors_spec.rb",
+     "spec/flickr/geo_spec.rb",
+     "spec/flickr/photo_spec.rb",
+     "spec/flickr/photos_spec.rb",
+     "spec/flickr/photosets_spec.rb",
+     "spec/flickr/test_spec.rb",
+     "spec/flickr/urls_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/commonthread/flickr_fu}
   s.rdoc_options = ["--main", "README"]
-  s.extra_rdoc_files = ["README"]
-  s.add_dependency("mime-types", ["> 0.0.0"])
-  s.add_dependency("xml-magic", ["> 0.0.0"])
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Provides a ruby interface to flickr via the REST api}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/flickr/test_spec.rb",
+     "spec/flickr/geo_spec.rb",
+     "spec/flickr/contacts_spec.rb",
+     "spec/flickr/urls_spec.rb",
+     "spec/flickr/errors_spec.rb",
+     "spec/flickr/base_spec.rb",
+     "spec/flickr/photo_spec.rb",
+     "spec/flickr/photosets_spec.rb",
+     "spec/flickr/photos_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mime-types>, ["> 0.0.0"])
+      s.add_runtime_dependency(%q<xml-magic>, ["> 0.0.0"])
+    else
+      s.add_dependency(%q<mime-types>, ["> 0.0.0"])
+      s.add_dependency(%q<xml-magic>, ["> 0.0.0"])
+    end
+  else
+    s.add_dependency(%q<mime-types>, ["> 0.0.0"])
+    s.add_dependency(%q<xml-magic>, ["> 0.0.0"])
+  end
 end

data/lib/flickr/auth.rb

@@ -7,6 +7,11 @@ class Flickr::Auth < Flickr::Base
   def frob
     @frob ||= get_frob
   end
+  
+  # set the frob
+  def frob= frob
+    @frob=frob
+  end
 
   # generates the authorization url to allow access to a flickr account.
   # 
@@ -58,7 +63,9 @@ class Flickr::Auth < Flickr::Base
   end
 
   def get_token(pass_through)
-    if @flickr.token_cache and File.exists?(@flickr.token_cache)
+    if @flickr.token
+      @flickr.token
+    elsif @flickr.token_cache and File.exists?(@flickr.token_cache)
       YAML.load_file(@flickr.token_cache)
     elsif pass_through
       rsp = @flickr.send_request('flickr.auth.getToken', {:frob => self.frob})

data/lib/flickr/base.rb

@@ -4,7 +4,7 @@ module Flickr
   end
   
   class Base
-    attr_reader :api_key, :api_secret, :token_cache
+    attr_reader :api_key, :api_secret, :token_cache, :token
     
     REST_ENDPOINT = 'http://api.flickr.com/services/rest/'
     AUTH_ENDPOINT = 'http://flickr.com/services/auth/'
@@ -12,30 +12,62 @@ module Flickr
     
     # create a new flickr object
     # 
-    # Params
+    # You can either pass a hash with the following attributes:
+    # 
+    # * :key (Required)
+    #     the API key
+    # * :secret (Required)
+    #     the API secret
+    # * :token (Optional)
+    #     Flickr::Auth::Token object
+    #
+    # or:
+    # 
     # * config_file (Required)
     #     yaml file to load configuration from
-    # * token_cache (Optional)
-    #     location of the token cache file. This will override the setting in the config file
-    # 
+    # * options (Optional)
+    #     hash containing any of the two options
+    #     * token_cache
+    #       location of the token cache file. This will override the setting in the config file
+    #     * environment
+    #       section in the config file that flickr_fu should look for the API key and secret
+    #       Useful when using with Rails
+    #
     # Config Example (yaml file)
-    # 
     # ---
-    # key: YOUR_API_KEY
-    # secret: YOUR_API_SECRET
-    # token_cache: token.yml
-    # 
-    def initialize(config_file, token_cache = nil)
-      config = YAML.load_file(config_file)
-      
-      @api_key = config['key']
-      @api_secret = config['secret']
-      @token_cache = token_cache || config['token_cache']
-      
-      raise 'flickr config file must contain an api key and secret' unless @api_key and @api_secret
+    #   key: YOUR_API_KEY
+    #   secret: YOUR_API_SECRET
+    #   token_cache: token.yml
+    #
+    # Example config file with two environments:
+    # ---
+    #   development:
+    #     key: YOUR_DEVELOPMENT_API_KEY
+    #     secret: YOUR_DEVELOPMENT_API_SECRET
+    #   production:
+    #     key: YOUR_PRODUCTION_API_KEY
+    #     secret: YOUR_PRODUCTION_API_SECRET
+    def initialize(config_param, options_param = {})
+      if options_param.is_a? String
+        options = {:token_cache => options_param}
+      else
+        options = options_param
+      end
+      if config_param.is_a? String
+        config = YAML.load_file(config_param)
+        config = config[options[:environment]] if options.has_key? :environment
+      else
+        config = config_param
+      end
+      @api_key = config[:key] || config["key"]
+      @api_secret = config[:secret] || config["secret"]
+      @token_cache = options[:token_cache] || config["token_cache"]
+      @token = config[:token] || options[:token]
+      raise 'config file must contain an api key and secret' unless @api_key and @api_secret
+      raise 'you cannot specify both the token and token_cache' if @token and @token_cache
     end
 
-    # sends a request to the flcikr REST api
+    # sends a request to the flickr REST api
     # 
     # Params
     # * method (Required)
@@ -53,12 +85,7 @@ module Flickr
       options.merge!(:api_key => @api_key, :method => method)
       sign_request(options)
       
-      if http_method == :get
-        api_call = endpoint + "?" + options.collect{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
-        rsp = Net::HTTP.get(URI.parse(api_call))
-      else
-        rsp = Net::HTTP.post_form(URI.parse(endpoint), options).body
-      end
+      rsp = request_over_http(options, http_method, endpoint)
       
       rsp = '<rsp stat="ok"></rsp>' if rsp == ""
       xm = XmlMagic.new(rsp)
@@ -66,7 +93,7 @@ module Flickr
       if xm[:stat] == 'ok'
         xm
       else
-        raise "#{xm.err[:code]}: #{xm.err[:msg]}"
+        raise Flickr::Errors.error_for(xm.err[:code].to_i, xm.err[:msg])
       end
     end
     
@@ -90,6 +117,9 @@ module Flickr
     # creates and/or returns the Flickr::Photos object
     def photos() @photos ||= Flickr::Photos.new(self) end
       
+    # creates and/or returns the Flickr::Photos object
+    def photosets() @photosets ||= Flickr::Photosets.new(self) end
+      
     # creates and/or returns the Flickr::People object
     def people() @people ||= Flickr::People.new(self) end
       
@@ -98,5 +128,24 @@ module Flickr
       
     # creates and/or returns the Flickr::Uploader object
     def uploader() @uploader ||= Flickr::Uploader.new(self) end
+
+    # creates and/or returns the Flickr::Contacts object
+    def contacts() @contacts ||= Flickr::Contacts.new(self) end
+
+    # creates and/or returns the Flickr::Urls object
+    def urls() @urls ||= Flickr::Urls.new(self) end
+            
+    protected
+    
+    # For easier testing. You can mock this method with a XML file you're expecting to receive
+    def request_over_http(options, http_method, endpoint)
+      if http_method == :get
+        api_call = endpoint + "?" + options.collect{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+        Net::HTTP.get(URI.parse(api_call))
+      else
+        Net::HTTP.post_form(URI.parse(endpoint), options).body
+      end
+    end
+    
   end
 end