rest-graph 0.9.0 → 1.0.0

data/CHANGES

@@ -1,5 +1,10 @@
 = rest-graph changes history
 
+== rest-graph 1.0.0 -- 2010-05-06
+* now access_token is saved in data attributes.
+* cookies related methods got renamed, and saved all data in RestGraph
+* parse failed would return nil, while data is always a hash
+
 == rest-graph 0.9.0 -- 2010-05-04
 * renamed :server option to :graph_server
 * added :fql_server option and fql support.

data/README

@@ -1,4 +1,4 @@
-= rest-graph 0.9.0
+= rest-graph 1.0.0
 by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
   godfat (XD) godfat.org
 
@@ -12,6 +12,12 @@ by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
 
  super simple facebook open graph api client
 
+== FEATURES:
+
+* simple graph api call
+* simple fql call
+* utility to extract access_token and check sig in cookies
+
 == SYNOPSIS:
 
  require 'rest-graph'
@@ -31,21 +37,27 @@ by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
  # for rack
  lambda{ |env|
    rg = RestGraph.new(:app_id => '123', :secret => '1829')
-   rg.parse_token_in_rack_env!(env)  # auto save access_token if sig checked
+   rg.parse_rack_env!(env)  # auto save access_token if sig checked
    rg.access_token # => ...
+   rg.data['uid']  # => facebook uid
  }
 
  # for fully blown cookies hash
  rg = RestGraph.new(:app_id => '123', :secret => '1829')
- rg.parse_token_in_cookies!(cookies) # auto save access_token if sig checked
+ rg.parse_cookies!(cookies) # auto save access_token if sig checked
  rg.access_token # => ...
+ rg.data['uid']  # => facebook uid
 
  # for fbs in cookies
  app_id = '456'
  rg = RestGraph.new(:app_id => '123', :secret => '1829')
  fbs = cookies["fbs_#{rg.app_id}"]
- rg.parse_token_in_fbs!(fbs)         # auto save access_token if sig checked
+ rg.parse_fbs!(fbs)         # auto save access_token if sig checked
  rg.access_token # => ...
+ rg.data['uid']  # => facebook uid
+
+ # fql query
+ rg.fql('SELECT name FROM page WHERE page_id="123"')
 
 == REQUIREMENTS:
 

data/lib/rest-graph.rb

@@ -3,10 +3,9 @@ require 'rest_client'
 
 require 'cgi'
 
-class RestGraph < Struct.new(:access_token, :graph_server, :fql_server,
+class RestGraph < Struct.new(:data, :graph_server, :fql_server,
                              :accept, :lang, :auto_decode, :app_id, :secret)
   def initialize o = {}
-    self.access_token = o[:access_token]
     self.graph_server = o[:graph_server] || 'https://graph.facebook.com/'
     self.fql_server   = o[:fql_server]   || 'https://api.facebook.com/'
     self.accept       = o[:accept] || 'text/javascript'
@@ -14,10 +13,27 @@ class RestGraph < Struct.new(:access_token, :graph_server, :fql_server,
     self.auto_decode  = o.key?(:auto_decode) ? o[:auto_decode] : true
     self.app_id       = o[:app_id]
     self.secret       = o[:secret]
+    self.access_token = o[:access_token]
 
     check_arguments!
   end
 
+  def access_token
+    data['access_token']
+  end
+
+  def access_token= token
+    data['access_token'] = token
+  end
+
+  def data
+    super || self.data = {}
+  end
+
+  def authorized?
+    !!access_token
+  end
+
   def get    path, opts = {}
     request(graph_server, path, opts, :get)
   end
@@ -41,18 +57,18 @@ class RestGraph < Struct.new(:access_token, :graph_server, :fql_server,
 
   # cookies, app_id, secrect related below
 
-  def parse_token_in_rack_env! env
-    self.access_token = env['HTTP_COOKIE'] =~ /fbs_#{app_id}="(.+?)"/ &&
-      extract_token_if_sig_ok(Rack::Utils.parse_query($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
 
-  def parse_token_in_cookies! cookies
-    self.access_token = parse_token_in_fbs!(cookies["fbs_#{app_id}"])
+  def parse_cookies! cookies
+    self.data = parse_fbs!(cookies["fbs_#{app_id}"])
   end
 
-  def parse_token_in_fbs! fbs
-    self.access_token = fbs &&
-      extract_token_if_sig_ok(Rack::Utils.parse_query(fbs[1..-2]))
+  def parse_fbs! fbs
+    self.data = fbs &&
+      check_sig_and_return_data(Rack::Utils.parse_query(fbs[1..-2]))
   end
 
   private
@@ -69,7 +85,7 @@ class RestGraph < Struct.new(:access_token, :graph_server, :fql_server,
       require 'digest/md5'
       require 'rack'
     elsif app_id || secret
-      raise ArgumentError.new("You may want pass both"         \
+      raise ArgumentError.new("You may want to pass both"      \
                               " app_id(#{app_id.inspect}) and" \
                               " secret(#{secret.inspect})")
     end
@@ -100,14 +116,14 @@ class RestGraph < Struct.new(:access_token, :graph_server, :fql_server,
     auto_decode ? JSON.parse(result) : result
   end
 
-  def extract_token_if_sig_ok cookies
-    cookies['access_token'] if calculate_sig(cookies) == cookies['sig']
+  def check_sig_and_return_data cookies
+    cookies if calculate_sig(cookies) == cookies['sig']
   end
 
   def calculate_sig cookies
-    payload = cookies.reject{ |(k, v)| k == 'sig' }.sort.
+    args = cookies.reject{ |(k, v)| k == 'sig' }.sort.
       map{ |a| a.join('=') }.join
 
-    Digest::MD5.hexdigest(payload + secret)
+    Digest::MD5.hexdigest(args + secret)
   end
 end

data/lib/rest-graph/version.rb

@@ -1,4 +1,4 @@
 
 class RestGraph
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end

data/test/test_rest-graph.rb

@@ -86,15 +86,9 @@ describe RestGraph do
     stub_request(:put, 'https://graph.facebook.com/feed/me').
       with(:body => 'message=hi%20there').to_return(:body => '[]')
 
-    begin
-      RestGraph.send(:public, :post_request) # TODO: rr, why??
-
-      mock.proxy(rg = RestGraph.new).post_request('[]')
-      rg.put('feed/me', :message => 'hi there').
-        should == []
-    ensure
-      RestGraph.send(:private, :post_request) # TODO: rr, why??
-    end
+    mock.proxy(rg = RestGraph.new).post_request('[]')
+    rg.put('feed/me', :message => 'hi there').
+      should == []
   end
 
   it 'would not raise exception when encountering 500' do
@@ -118,17 +112,17 @@ describe RestGraph do
         "fbs_#{app_id}=#{fbs}"
 
       rg  = RestGraph.new(:app_id => app_id, :secret => secret)
-      rg.parse_token_in_rack_env!('HTTP_COOKIE' => http_cookie).
-                      should == token
-      rg.access_token.should == token
+      rg.parse_rack_env!('HTTP_COOKIE' => http_cookie).
+                      should.kind_of?(token ? Hash : NilClass)
+      rg.access_token.should ==  token
 
-      rg.parse_token_in_cookies!({"fbs_#{app_id}" => fbs}).
-                      should == token
-      rg.access_token.should == token
+      rg.parse_cookies!({"fbs_#{app_id}" => fbs}).
+                      should.kind_of?(token ? Hash : NilClass)
+      rg.access_token.should ==  token
 
-      rg.parse_token_in_fbs!(fbs).
-                      should == token
-      rg.access_token.should == token
+      rg.parse_fbs!(fbs).
+                      should.kind_of?(token ? Hash : NilClass)
+      rg.access_token.should ==  token
     }
     check.call(access_token)
     fbs.chop!
@@ -136,6 +130,17 @@ describe RestGraph do
     check.call(nil)
   end
 
+  it 'would return true in authorized? if there is an access_token' do
+    RestGraph.new(:access_token => '1').authorized?.should == true
+    RestGraph.new(:access_token => nil).authorized?.should == false
+  end
+
+  it 'would return nil if parse error, but not when call data directly' do
+    rg = RestGraph.new
+    rg.parse_cookies!({}).should == nil
+    rg.data              .should == {}
+  end
+
   it 'would do fql query with/without access_token' do
     fql = 'SELECT name FROM likes where id="123"'
     query = "query=#{fql}&format=json"

metadata

@@ -3,10 +3,10 @@ name: rest-graph
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - "Lin Jen-Shin (aka godfat \xE7\x9C\x9F\xE5\xB8\xB8)"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-04 00:00:00 +08:00
+date: 2010-05-06 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,8 +41,8 @@ dependencies:
         segments: 
         - 1
         - 4
-        - 2
-        version: 1.4.2
+        - 3
+        version: 1.4.3
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency