commonthread-flickr_fu 0.2.2 → 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/Rakefile

@@ -1,10 +1,35 @@
 require 'rake'
 require 'rake/rdoctask'
- 
-desc 'Generate documentation for the contact_info plugin.'
+
+# 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 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')
@@ -29,13 +54,20 @@ end
 
 task :default => :spec
 
-desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
+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 rcov"
-task :rcov do
-  system "rcov spec/**/*.rb -x /var/lib -x spec/"
+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,36 +1,117 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
-  s.name     = "flickr_fu"
-  s.version  = "0.2.2"
-  s.date     = "2008-12-30"
-  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/errors.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/base.rb

@@ -22,31 +22,49 @@ module Flickr
     #     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_hash_or_file, token_cache = nil)
-      if config_hash_or_file.is_a? Hash
-        @api_key = config_hash_or_file[:key]
-        @api_secret = config_hash_or_file[:secret]
-        @token = config_hash_or_file[:token]
-        raise 'config_hash must contain api key and secret' unless @api_key and @api_secret
-      else 
-        config = YAML.load_file(config_hash_or_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 flickr REST api
@@ -75,7 +93,7 @@ module Flickr
       if xm[:stat] == 'ok'
         xm
       else
-        raise Flickr::Errors.error_for(xm.err[:code], xm.err[:msg])
+        raise Flickr::Errors.error_for(xm.err[:code].to_i, xm.err[:msg])
       end
     end
     
@@ -99,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
       
@@ -107,7 +128,13 @@ 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

data/lib/flickr/contact.rb

@@ -0,0 +1,16 @@
+# wrapping class to hold a flickr contact
+# 
+class Flickr::Contacts::Contact
+  attr_accessor :nsid, :friend, :family, :iconfarm, :iconserver, :location, :username, :ignored, :realname, :path_alias
+  
+  # create a new instance of a flickr note.
+  # 
+  # Params
+  # * attributes (Required)
+  #     a hash of attributes used to set the initial values of the contact object
+  def initialize(attributes)
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+end

data/lib/flickr/contacts.rb

@@ -0,0 +1,55 @@
+class Flickr::Contacts < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # Get a user's public contact list.
+  # 
+  # Params
+  # * id (Required)
+  #     the nsid of the user to get information for
+  # 
+  def get_public_list(id, options={})
+    options.merge!({:user_id => id})
+    rsp = @flickr.send_request('flickr.contacts.getPublicList', options)
+    collect_contacts(rsp)
+  end
+    
+  
+  # Get the authorized user's contact list.
+  # 
+  def get_list(options={})
+    rsp = @flickr.send_request('flickr.contacts.getList', options)
+    collect_contacts(rsp)
+  end
+  
+  
+  protected
+  def collect_contacts(rsp)
+    contacts = []
+    return contacts unless rsp
+    if rsp.contacts.contact
+      rsp.contacts.contact.each do |contact|
+        attributes = create_attributes(contact)
+        contacts << Contact.new(attributes)
+      end
+    end
+    return contacts
+  end
+  
+  def create_attributes(contact)
+    {
+      :nsid => contact[:nsid], 
+      :path_alias => contact[:path_alias],
+      :username => contact[:username],
+      :iconfarm => contact[:iconfarm],
+      :iconserver => contact[:iconserver],
+      :ignored => contact[:ignored],
+      :friend => contact[:friend],
+      :family => contact[:family],
+      :realname => contact[:realname],
+      :location => contact[:location]
+     }
+  end
+  
+end

data/lib/flickr/geo.rb

@@ -0,0 +1,42 @@
+class Flickr::Photos::Geo < Flickr::Base
+
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  # Get the geo data (latitude and longitude and the accuracy level) of a photo.
+  #
+  # Params
+  # * photo_id (Required)
+  #
+  # Returns Flickr::Photos::Location object containing photo location
+  # or nil if photo is not geotagged.
+  def get_location(photo_id)
+    # begin
+    rsp = @flickr.send_request('flickr.photos.geo.getLocation', {:photo_id => photo_id})
+    Flickr::Photos::Location.new(:latitude => rsp.photo.location[:latitude].to_f,
+      :longitude => rsp.photo.location[:longitude].to_f, :accuracy => rsp.photo.location[:accuracy].to_i)
+  end
+
+  # Sets the geo data(latitude and longitude and the accuracy level) of a photo.
+  #
+  # Params
+  # * photo_id (Required)
+  # * latittude (Requried)
+  # * longitude (Required)
+  # * accuracy (Optional)
+  #
+  # Returns true if successful, raises an error otherwise.
+  def set_location(photo_id, lat, lon, accuracy = nil)
+    request_options = {:photo_id => photo_id, :lat => lat, :lon => lon}
+    request_options[:accuracy] = accuracy if !accuracy.nil?
+    @flickr.send_request('flickr.photos.geo.setLocation', request_options, :post)
+    true
+  end
+
+  def remove_location(photo_id)
+    request_options = {:photo_id => photo_id}
+    @flickr.send_request('flickr.photos.geo.removeLocation', request_options, :post)
+    true
+  end
+end