rest-graph 1.1.0 → 1.1.1

data/CHANGES

@@ -1,5 +1,10 @@
 = rest-graph changes history
 
+== rest-graph 1.1.1 -- 2010-05-21
+* Add oauth realted utilites -- authorize_url and authorize!
+* Fixed a bug that in Ruby 1.8.7-, nil =~ /regexp/ equals to false.
+  It is nil as expected in Ruby 1.9.1+
+
 == rest-graph 1.1.0 -- 2010-05-13
 * Main repository was moved to http://github.com/cardinalblue/rest-graph
   Sorry for the inconvenience. I'll keep pushing to both repositories until
@@ -12,8 +17,8 @@
   if you're using rails plugin, we do require 'rest-graph/auto_load'
   for you.
 
-* Config could be load manually as well. require 'rest-graph/load_config' and
-  RestGraph::LoadConfig.load_config!('path/to/rest-graph.yaml', 'env')
+* Config could be loaded manually as well. require 'rest-graph/load_config'
+  and RestGraph::LoadConfig.load_config!('path/to/rest-graph.yaml', 'env')
 
 == rest-graph 1.0.0 -- 2010-05-06
 * now access_token is saved in data attributes.

data/README.rdoc

@@ -1,4 +1,4 @@
-= rest-graph 1.1.0
+= rest-graph 1.1.1
 by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
@@ -77,6 +77,17 @@ by Cardinal Blue ( http://cardinalblue.com )
 
  # see test/config/rest-graph.yaml for an example for config
 
+ # oauth utilites:
+ # https://graph.facebook.com/oauth/authorize?client_id=...&
+ RestGraph.new.authorize_url(:redirect_uri => '...')
+
+ # get access token by:
+ # https://graph.facebook.com/oauth/access_token?code=...&
+ rg = RestGraph.new
+ rg.authorize!(:redirect_uri => '...', :code => 'zzz')
+ rg.access_token    # your access_token is now available
+ rg.data['expires'] # other values as well
+
 == REQUIREMENTS:
 
 * tested with MRI 1.8.7 and 1.9.1

data/TODO

@@ -1,4 +1,17 @@
 = rest-graph todo list
 
-= 1.0
-* oauth support?
+= 1.1
+* auto authorization?
+
+class AuthError < RuntimeError; end
+
+rg = RestGraph.new(:scope => 'publish_stream,read_friendlists',
+                   :error_callback => lambda{ |json| raise AuthError } )
+
+begin
+  rg.get('me')
+rescue AuthError
+  # ...
+end
+
+rg.error_callback = lambda{ |json| redirect request.url }

data/lib/rest-graph/version.rb

@@ -2,5 +2,5 @@
 require 'rest-graph'
 
 class RestGraph < RestGraphStruct
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/rest-graph.rb

@@ -77,9 +77,16 @@ class RestGraph < RestGraphStruct
 
   # cookies, app_id, secrect related below
 
-  def parse_rack_env! env
-    self.data = env['HTTP_COOKIE'] =~ /fbs_#{app_id}="(.+?)"/ &&
-      check_sig_and_return_data(Rack::Utils.parse_query($1))
+  if RUBY_VERSION >= '1.9.1'
+    def parse_rack_env! env
+      self.data = env['HTTP_COOKIE'] =~ /fbs_#{app_id}="(.+?)"/ &&
+        check_sig_and_return_data(Rack::Utils.parse_query($1))
+    end
+  else
+    def parse_rack_env! env
+      self.data = (env['HTTP_COOKIE'] || '') =~ /fbs_#{app_id}="(.+?)"/ &&
+        check_sig_and_return_data(Rack::Utils.parse_query($1))
+    end
   end
 
   def parse_cookies! cookies
@@ -91,6 +98,19 @@ class RestGraph < RestGraphStruct
       check_sig_and_return_data(Rack::Utils.parse_query(fbs[1..-2]))
   end
 
+  # oauth related
+
+  def authorize_url opts={}
+    query = {:client_id => app_id}.merge(opts)
+    "#{graph_server}oauth/authorize#{build_query_string(query)}"
+  end
+
+  def authorize! opts={}
+    query = {:client_id => app_id, :client_secret => secret}.merge(opts)
+    self.data = Rack::Utils.parse_query(
+      request(graph_server, 'oauth/access_token', query, :get, nil, true))
+  end
+
   private
   def check_arguments!
     if auto_decode
@@ -111,15 +131,15 @@ class RestGraph < RestGraphStruct
     end
   end
 
-  def request server, path, opts, method, payload = nil
+  def request server, path, opts, method, payload=nil, suppress_decode=false
     post_request(
       RestClient::Resource.new(server)[path + build_query_string(opts)].
-      send(method, *[payload, build_headers].compact))
+      send(method, *[payload, build_headers].compact), suppress_decode)
   rescue RestClient::InternalServerError => e
-    post_request(e.http_body)
+    post_request(e.http_body, suppress_decode)
   end
 
-  def build_query_string q = {}
+  def build_query_string q={}
     query = q.merge(access_token ? {:access_token => access_token} : {})
     return '' if query.empty?
     return '?' + query.map{ |(k, v)| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
@@ -132,8 +152,8 @@ class RestGraph < RestGraphStruct
     headers
   end
 
-  def post_request result
-    auto_decode ? JSON.parse(result) : result
+  def post_request result, suppress_decode=false
+    (auto_decode && !suppress_decode) ? JSON.parse(result) : result
   end
 
   def check_sig_and_return_data cookies

data/test/common.rb

@@ -25,4 +25,12 @@ module TestHelper
         RestGraph::DefaultAttributes.send("default_#{name}")
     }
   end
+
+  def normalize_query query
+    '?' + query[1..-1].split('&').sort.join('&')
+  end
+
+  def normalize_url url
+    url.sub(/\?.+/){ |query| TestHelper.normalize_query(query) }
+  end
 end

data/test/test_oauth.rb

@@ -0,0 +1,34 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  before do
+    reset_webmock
+    @rg  = RestGraph.new(:app_id => '29', :secret => '18')
+    @uri = 'http://zzz.tw'
+  end
+
+  it 'would return correct oauth url' do
+    TestHelper.normalize_url(@rg.authorize_url(:redirect_uri => @uri)).
+    should == 'https://graph.facebook.com/oauth/authorize?' \
+              'client_id=29&redirect_uri=http%3A%2F%2Fzzz.tw'
+  end
+
+  it 'would do authorizing and parse result and save it in data' do
+    stub_request(:get, 'https://graph.facebook.com/oauth/access_token?' \
+                       'client_id=29&client_secret=18&code=zzz&'        \
+                       'redirect_uri=http%3A%2F%2Fzzz.tw').
+      to_return(:body => 'access_token=baken&expires=2918')
+
+    result = {'access_token' => 'baken', 'expires' => '2918'}
+
+    @rg.authorize!(:redirect_uri => @uri, :code => 'zzz').
+             should == result
+    @rg.data.should == result
+  end
+
+end

data/test/test_rest-graph.rb

@@ -10,10 +10,6 @@ describe RestGraph do
     reset_webmock
   end
 
-  def normalize_query query
-    '?' + query[1..-1].split('&').sort.join('&')
-  end
-
   it 'would build correct headers' do
     rg = RestGraph.new(:accept => 'text/html',
                        :lang   => 'zh-tw')
@@ -31,12 +27,12 @@ describe RestGraph do
   end
 
   it 'would build correct query string' do
-    normalize_query(
+    TestHelper.normalize_query(
     RestGraph.new(:access_token => 'token').send(:build_query_string,
                                                  :message => 'hi!!')).
       should == '?access_token=token&message=hi%21%21'
 
-    normalize_query(
+    TestHelper.normalize_query(
     RestGraph.new.send(:build_query_string, :message => 'hi!!',
                                             :subject => '(&oh&)')).
       should == '?message=hi%21%21&subject=%28%26oh%26%29'
@@ -79,7 +75,7 @@ describe RestGraph do
     stub_request(:put, 'https://graph.facebook.com/feed/me').
       with(:body => 'message=hi%20there').to_return(:body => '[]')
 
-    mock.proxy(rg = RestGraph.new).post_request('[]')
+    mock.proxy(rg = RestGraph.new).post_request('[]', false)
     rg.put('feed/me', :message => 'hi there').
       should == []
   end
@@ -109,6 +105,9 @@ describe RestGraph do
                       should.kind_of?(token ? Hash : NilClass)
       rg.access_token.should ==  token
 
+      rg.parse_rack_env!('HTTP_COOKIE' => nil).should == nil
+      rg.data.should == {}
+
       rg.parse_cookies!({"fbs_#{app_id}" => fbs}).
                       should.kind_of?(token ? Hash : NilClass)
       rg.access_token.should ==  token
@@ -136,7 +135,7 @@ describe RestGraph do
 
   it 'would do fql query with/without access_token' do
     fql = 'SELECT name FROM likes where id="123"'
-    query = "query=#{fql}&format=json"
+    query = "format=json&query=#{CGI.escape(fql)}"
     stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}").
       to_return(:body => '[]')
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rest-graph
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Cardinal Blue
@@ -15,30 +16,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 +08:00
+date: 2010-05-21 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 1
         - 5
-        - 0
-        version: 1.5.0
+        - 1
+        version: 1.5.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 1
         - 4
@@ -50,9 +55,11 @@ dependencies:
   name: rack
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 1
         - 1
@@ -64,9 +71,11 @@ dependencies:
   name: rr
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 33
         segments: 
         - 0
         - 10
@@ -78,23 +87,27 @@ dependencies:
   name: webmock
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 1
-        - 1
+        - 2
         - 0
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: bacon
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 1
         - 1
@@ -106,14 +119,16 @@ dependencies:
   name: bones
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 3
         - 4
-        - 1
-        version: 3.4.1
+        - 3
+        version: 3.4.3
   type: :development
   version_requirements: *id007
 description: " super simple facebook open graph api client"
@@ -142,6 +157,7 @@ files:
 - test/common.rb
 - test/config/rest-graph.yaml
 - test/test_load_config.rb
+- test/test_oauth.rb
 - test/test_rest-graph.rb
 has_rdoc: true
 homepage: http://github.com/cardinalblue/rest-graph
@@ -154,26 +170,31 @@ 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: rest-graph
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: super simple facebook open graph api client
 test_files: 
 - test/test_load_config.rb
+- test/test_oauth.rb
 - test/test_rest-graph.rb