flickrrb 2.0 → 2.1

data/README.rdoc

@@ -1,8 +1,14 @@
 = Flickrrb
 
-Flickrrb is a library to access flickr[http://flickr.com] api in a simple way.
-It tries to map the methods described in {the official api documentation}[http://www.flickr.com/services/api].
+Flickrrb is a nice library to access the flickr[http://flickr.com] api in a simple way.
+It maps the methods described in {the official api documentation}[http://www.flickr.com/services/api] to ruby
+methods, eg.
 
+{flickr.people.findByUsername(:username => 'Henry Maddocks')}[http://www.flickr.com/services/api/flickr.people.findByUsername.html]
+
+{flickr.photos.getInfo(:photo_id => photo)}[http://www.flickr.com/services/api/flickr.photos.getInfo.html]
+
+You can copy from the documentation and paste into your ruby.
 
 = Installation
  gem install flickrrb
@@ -23,5 +29,4 @@ It tries to map the methods described in {the official api documentation}[http:/
   end
 
 == Todo
-*  Maybe use JSON instead of xml responses.
 *  OAuth.

data/Rakefile

@@ -1,6 +1,8 @@
 require 'rake/testtask'
 require 'rake/rdoctask'
 
+require 'flickrrb'
+
 
 Rake::TestTask.new do |t|
     t.pattern = 'test/*.rb'
@@ -11,3 +13,12 @@ RDoc::Task.new do |rd|
 end
 
 task 'default' => ['test']
+
+
+namespace "flickr" do
+
+  desc "Get an access token"
+  task "authorise" do
+    Flickr::OAuthCient.authorize
+  end  
+end

data/lib/flickrrb.rb

@@ -2,7 +2,6 @@ require 'json'
 
 require 'net/http'
 require 'cgi'
-require 'rexml/document'
 
 class APIException < StandardError; end
 
@@ -21,15 +20,15 @@ class Flickr
 
   def method_missing name, *args
     unless args.empty? || args.first.class == Hash
-       @method.clear
-       raise APIException, "Args must be a hash" 
+      @method.clear
+      fail APIException, "Args must be a hash" 
     end
     
     m = FlickrMethod.new(name, args.first)
     @method << m
     unless args.empty?
       p @method if @debug
-      begin
+      begin # FIXME
         command = build_command
         @method.clear
         @flickr_client.request(command)
@@ -141,7 +140,8 @@ class Flickr
      :location,
      :geoperms,
      :urls,
-     :media].each {|a| attr_accessor a}
+     :media,
+     :permissions].each {|a| attr_accessor a}
     
     def initialize data
       super
@@ -199,7 +199,7 @@ class Flickr
       p j if @debug
       m = j.match(/^jsonFlickrApi\((.+)\)$/)
       
-      raise APIException, "Invalid response from Flickr" if m.nil?
+      fail APIException, "Invalid response from Flickr" if m.nil?
       
       data = JSON.parse m[1]
 
@@ -210,7 +210,8 @@ class Flickr
           resp = self.send(k, data)
         end
       else
-        raise APIException, "#{data['code']}: #{data['message']}"
+        # FIXME Fail in send
+        fail APIException, "#{data['code']}: #{data['message']}"
       end
       
       resp
@@ -220,7 +221,7 @@ class Flickr
       # This is a bit ugly!
       code = xml.elements['rsp'].elements['err'].attributes['code']
       message = xml.elements['rsp'].elements['err'].attributes['msg']
-      raise APIException, "#{code}: #{message}"
+      fail APIException, "#{code}: #{message}"
     end
     
     def stat data
@@ -278,5 +279,62 @@ class Flickr
     end
   end
   
+  require 'oauth'
+  
+  class OAuthCient
+    def initialize params = {}
+      flickr_url = URI.parse "http://api.flickr.com/"
+
+      consumer = OAuth::Consumer.new(params[:consumer_key], params[:consumer_secret],
+                                     site:                  "http://api.flickr.com/",
+                                     request_token_path:    "/services/oauth/request_token",
+                                     access_token_path:     "/services/oauth/access_token",
+                                     authorize_path:        "/services/oauth/authorize")
+    
+      access_keys = {oauth_token:           params[:access_token], 
+                     oauth_token_secret:    params[:access_secret]}
+
+      @access = OAuth::AccessToken.from_hash(consumer, access_keys)
+    end
+    
+    def get path
+      @access.get path
+    end
+    
+#     def post path, params, headers = {}
+#       @access.post path, params, headers
+#     end
+
+    def self.authorize
+      print "Enter consumer key: "
+      consumer_key = $stdin.gets.chomp
+
+      print "Enter consumer secret: "
+      consumer_secret = $stdin.gets.chomp
+      
+      
+      consumer = OAuth::Consumer.new(consumer_key,          consumer_secret,
+                                     site:                  'http://www.flickr.com', # Note www
+                                     request_token_path:    "/services/oauth/request_token",
+                                     access_token_path:     "/services/oauth/access_token",
+                                     authorize_path:        "/services/oauth/authorize")
+      
+      request_token = consumer.get_request_token
+      p "\nGo to this url and click 'Authorize' to get the token:"
+      p request_token.authorize_url
+      print "\nEnter token: "
+      token = $stdin.gets.chomp
+  
+      access_token  = request_token.get_access_token(:oauth_verifier => token)
+  
+      p "\nAuthorisation complete! Use the following params to access Flickr:\n\n"
+      p "consumer_key     = '#{consumer.key}'"
+      p "consumer_secret  = '#{consumer.secret}'"
+      p "access_token     = '#{access_token.token}'"
+      p "access_secret    = '#{access_token.secret}'"
+    end
+
+  end
+  
 end
 

data/test/flickrrb_test.rb

@@ -3,8 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 class Test_Flickr < MiniTest::Unit::TestCase
   def setup
     @http_client = MiniTest::Mock.new
-    api_key = "9d96d3ae6145f12660896ae23b33f949"
-    @flickr = Flickr.new :api_key => api_key, :debug => false, :http => @http_client
+    @flickr = Flickr.new :api_key => "api_key", :debug => false, :http => @http_client
   end
   
   def test_api_key_exception

data/test/groups_test.rb

@@ -3,8 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 class GroupsTest < MiniTest::Unit::TestCase
   def setup
     @http_client = MiniTest::Mock.new
-    api_key = "9d96d3ae6145f12660896ae23b33f949"
-    @flickr = Flickr.new :api_key => api_key, :debug => false, :http => @http_client
+    @flickr = Flickr.new :api_key => "api_key", :debug => false, :http => @http_client
   end
   
   def test_group

data/test/people_test.rb

@@ -3,8 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 class PeopleTest < MiniTest::Unit::TestCase
   def setup
     @http_client = MiniTest::Mock.new
-    api_key = "9d96d3ae6145f12660896ae23b33f949"
-    @flickr = Flickr.new :api_key => api_key, :debug => false, :http => @http_client
+    @flickr = Flickr.new :api_key => "api_key", :debug => false, :http => @http_client
   end
   
   def test_get_info

data/test/photos_test.rb

@@ -3,8 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 class PhotosTest < MiniTest::Unit::TestCase
   def setup
     @http_client = MiniTest::Mock.new
-    api_key = "9d96d3ae6145f12660896ae23b33f949"
-    @flickr = Flickr.new :api_key => api_key, :debug => false, :http => @http_client
+    @flickr = Flickr.new :api_key => "api_key", :debug => false, :http => @http_client
   end
   
   def test_photo

data/test/test_helper.rb

@@ -20,16 +20,16 @@ class MiniTest::Unit::TestCase
   def flickr_commands
     {
       :bad_api_key => ["/services/rest/?method=flickr.photos.getInfo&api_key=bad_key&photo_id=1848466274&format=json"],
-      :bad_args => ["/services/rest/?method=flickr.people.getInfo&api_key=9d96d3ae6145f12660896ae23b33f949&xxxx=12656878%40N06&format=json"],
+      :bad_args => ["/services/rest/?method=flickr.people.getInfo&api_key=api_key&xxxx=12656878%40N06&format=json"],
 
-      :photos_get_info => ["/services/rest/?method=flickr.photos.getInfo&api_key=9d96d3ae6145f12660896ae23b33f949&photo_id=1848466274&format=json"],
-      :photos_get_sizes => ["/services/rest/?method=flickr.photos.getSizes&api_key=9d96d3ae6145f12660896ae23b33f949&photo_id=1848466274&format=json"],
+      :photos_get_info => ["/services/rest/?method=flickr.photos.getInfo&api_key=api_key&photo_id=1848466274&format=json"],
+      :photos_get_sizes => ["/services/rest/?method=flickr.photos.getSizes&api_key=api_key&photo_id=1848466274&format=json"],
       
-      :people_get_info => ["/services/rest/?method=flickr.people.getInfo&api_key=9d96d3ae6145f12660896ae23b33f949&user_id=12656878%40N06&format=json"],
-      :people_get_info_not_found => ["/services/rest/?method=flickr.people.getInfo&api_key=9d96d3ae6145f12660896ae23b33f949&user_id=xxxx&format=json"],
-      :people_by_user_name => ["/services/rest/?method=flickr.people.findByUsername&api_key=9d96d3ae6145f12660896ae23b33f949&username=Henry+Maddocks&format=json"],
+      :people_get_info => ["/services/rest/?method=flickr.people.getInfo&api_key=api_key&user_id=12656878%40N06&format=json"],
+      :people_get_info_not_found => ["/services/rest/?method=flickr.people.getInfo&api_key=api_key&user_id=xxxx&format=json"],
+      :people_by_user_name => ["/services/rest/?method=flickr.people.findByUsername&api_key=api_key&username=Henry+Maddocks&format=json"],
       
-      :groups_pools_get_photos => ["/services/rest/?method=flickr.groups.pools.getPhotos&api_key=9d96d3ae6145f12660896ae23b33f949&user_id=12656878%40N06&group_id=99404851%40N00&format=json"]
+      :groups_pools_get_photos => ["/services/rest/?method=flickr.groups.pools.getPhotos&api_key=api_key&user_id=12656878%40N06&group_id=99404851%40N00&format=json"]
     }
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrrb
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-22 00:00:00.000000000 +12:00
+date: 2011-09-04 00:00:00.000000000 +12:00
 default_executable: 
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &2161887080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161887080
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2161886520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161886520
 description: A simple interface to the Flickr public API.
-email: henry.maddocks@gmail.com
+email: hmaddocks@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -28,7 +50,7 @@ files:
 - test/photos_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: ''
+homepage: https://github.com/hmaddocks/flickrrb
 licenses: []
 post_install_message: 
 rdoc_options: []