rest-graph 1.2.1 → 1.3.0

data/CHANGES

@@ -1,5 +1,27 @@
 = rest-graph changes history
 
+== rest-graph 1.3.0 -- 2010-06-11
+* Now rest-graph is rescuing all exceptions from rest-client.
+* Added RestGraph#exchange_sessions to exchange old sessions to access tokens.
+
+* Added RestGraph#old_rest, see:
+  http://developers.facebook.com/docs/reference/rest/
+
+* Now all API request accept an additional options argument,
+  you may pass :suppress_decode => true to turn off auto-decode this time.
+  e.g. rg.get('bad/json', {:query => 'string'}, :suppress_decode => true)
+  This is for Facebook who didn't always return JSON in response.
+
+* Renamed fql_server to old_server.
+* Favor yaji/json_gem first, then falls back to json, and json_pure.
+* Fixed a bug that cookie format from Facebook varies. No idea why.
+
+for RailsUtil:
+
+* Big and fat refactoring in RailsUtil, see example for detail:
+  http://github.com/cardinalblue/rest-graph/tree/rest-graph-1.3.0/example
+* url_for and link_to would auto pass :host option if it's inside canvas.
+
 == rest-graph 1.2.1 -- 2010-06-02
 * Deprecated RailsController, use RailsUtil instead.
 * Fixed a bug that passing access_token in query string

data/README.rdoc

@@ -1,4 +1,4 @@
-= rest-graph 1.2.1
+= rest-graph 1.3.0
 by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
@@ -6,6 +6,7 @@ by Cardinal Blue ( http://cardinalblue.com )
 * {github}[http://github.com/cardinalblue/rest-graph]
 * {rubygems}[http://rubygems.org/gems/rest-graph]
 * {rdoc}[http://rdoc.info/projects/cardinalblue/rest-graph]
+* {mailing list}[http://groups.google.com/group/rest-graph/topics]
 
 == DESCRIPTION:
 
@@ -25,21 +26,21 @@ by Cardinal Blue ( http://cardinalblue.com )
  require 'rest-graph'
 
  # Every option is optional.
- rg = RestGraph.new(:access_token => '...',
+ rg = RestGraph.new(:access_token => 'tok',
                     :graph_server => 'https://graph.facebook.com/',
-                    :fql_server   => 'https://api.facebook.com/',
+                    :old_server   => 'https://api.facebook.com/',
                     :accept       => 'text/javascript',
                     :lang         => 'en-us', # this affect search
-                    :auto_decode  => true,    # decode by json
-                    :app_id       => '123',
-                    :secret       => '1829',
+                    :auto_decode  =>  true  , # decode by json
+                    :app_id       => '123'  ,
+                    :secret       => '1829' ,
 
   # This handler callback is only called if auto_decode is set to true,
   # otherwise, it's ignored.
                     :error_handler =>
                       lambda{ |hash| raise ::RestGraph::Error.new(hash) },
 
-  # You may want to do this in Rails to do debug logging:
+  # You might want to do this in Rails to do debug logging:
                     :log_handler =>
                       lambda{ |duration, url|
                         Rails.logger.debug("RestGraph "         \
@@ -47,34 +48,35 @@ by Cardinal Blue ( http://cardinalblue.com )
                                            "requesting #{url}")
                       })
 
- # You may want to do redirect instead of raising exception, for example,
- # in a Rails application, you might have this private controller method:
- def redirect_to_authorize error = nil
-   redirect_to @rg.authorize_url(:redirect_uri => request.url)
+ # You might want to do redirect instead of raising an exception,
+ # that is automatically redirect the user to authorization page
+ # if the access token is unavailable. This way, you don't have to
+ # check if the token is expired or not. If the token is expired,
+ # it will automatically do authorization again. For that purpose,
+ # you might want to include RestGraph::RailsUtil in your Rails'
+ # controller. For example:
+ class UserController < ApplicationController
+   include RestGraph::RailsUtil
+   before_filter :rest_graph_setup
  end
-
- # and you'll use that private method to do error handling:
- def setup_rest_graph
-   @rg = RestGraph.new(:error_handler => method(:redirect_to_authorize))
- end
-
- # This way, you don't have to check if the token is expired or not.
- # If the token is expired, it will automatically do authorization again.
+ # Please read:
+ # {examples}[http://github.com/cardinalblue/rest-graph/tree/master/example].
+ # for more detail, and other frameworks utils wanted!
 
  # Other simple API call:
- rg.get('me')       # GET https://graph.facebook.com/me?access_token=...
- rg.get('4/likes')  # GET https://graph.facebook.com/4/likes?access_token=...
+ rg.get('me')       # GET https://graph.facebook.com/me?access_token=tok
+ rg.get('4/likes')  # GET https://graph.facebook.com/4/likes?access_token=tok
 
- # GET https://graph.facebook.com/search?q=taiwan&access_token=...
+ # GET https://graph.facebook.com/search?q=taiwan&access_token=tok
  rg.get('search', :q => 'taiwan')
 
- # GET https://graph.facebook.com/me?metadata=1&access_token=...
+ # GET https://graph.facebook.com/me?metadata=1&access_token=tok
  rg.get('me', :metadata => '1')
 
- # POST https://graph.facebook.com/me/feed?message=bread%21&access_token=...
+ # POST https://graph.facebook.com/me/feed?message=bread%21&access_token=tok
  rg.post('me/feed', :message => 'bread!')
 
- # for fully blown cookies hash
+ # For fully blown cookies hash
  rg = RestGraph.new(:app_id => '123', :secret => '1829')
  rg.parse_cookies!(cookies) # auto save access_token if sig checked
  rg.data['uid']             # => facebook uid
@@ -93,40 +95,61 @@ by Cardinal Blue ( http://cardinalblue.com )
  rg.fql_multi(:q1 => 'SELECT name FROM page WHERE page_id="123"',
               :q2 => 'SELECT name FROM page WHERE page_id="456"')
 
- # default setting:
- class RestGraph
-   def self.default_app_id
+ # Setup default settings:
+ module MyDefaults
+   def default_app_id
      '456'
    end
 
-   def self.default_secret
+   def default_secret
      'category theory'
    end
  end
+ RestGraph.send(:extend, MyDefaults)
 
- # auto load config
- require 'rest-graph'
+ # Automatically load config:
  require 'rest-graph/auto_load'  # under Rails, load config/rest-graph.yaml
  RestGraph.new                   # all default options would honor config
  RestGraph.new(:app_id => '123') # default could be override as well
 
- # manually load config
+ # Manually load config:
  require 'rest-graph/load_config'
  RestGraph::LoadConfig.load_config!('path/to/rest-graph.yaml', 'env')
 
- # see test/config/rest-graph.yaml for an example for config
+ # 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 => '...')
+ # OAuth utilites:
+ # https://graph.facebook.com/oauth/authorize?client_id=123&
+ RestGraph.new.authorize_url(:redirect_uri => 'http://w3.org/')
 
- # get access token by:
- # https://graph.facebook.com/oauth/access_token?code=...&
+ # Get access token by:
+ # https://graph.facebook.com/oauth/access_token?code=edoc&
  rg = RestGraph.new
- rg.authorize!(:redirect_uri => '...', :code => 'zzz')
+ rg.authorize!(:redirect_uri => 'http://w3.org/', :code => 'edoc')
  rg.access_token    # your access_token is now available
  rg.data['expires'] # other values as well
 
+ # Exchange old session key for access token:
+ # https://graph.facebook.com/oauth/exchange_sessions?sessions=...
+ rg.exchange_sessions(:sessions => params[:fb_sig_session_key])
+
+ # Call Facebook's old REST API:
+ rg.old_rest(
+   'stream.publish',
+   { :message    => 'Greetings',
+     :attachment => {:name => 'Wikipedia',
+                     :href => 'http://wikipedia.org/',
+                     :caption => 'Wikipedia says hi.',
+                     :media => [{:type => 'image',
+                                 :src  => 'http://wikipedia.org/favicon.ico',
+                                 :href => 'http://wikipedia.org/'}]
+                    }.to_json,
+     :action_links => [{:text => 'Go to Wikipedia',
+                        :href => 'http://wikipedia.org/'}
+                      ].to_json
+   },
+   :suppress_decode => true)
+
 == REQUIREMENTS:
 
 * Tested with MRI 1.8.7 and 1.9.1

data/Rakefile

@@ -41,3 +41,11 @@ task :default do
   Rake.application.options.show_task_pattern = /./
   Rake.application.display_tasks_and_comments
 end
+
+desc 'Run example tests'
+task 'test:example' => ['gem:install'] do
+  sh "cd example/rails; #{Gem.ruby} -S rake test"
+end
+
+desc 'Run all tests'
+task 'test:all' => ['test', 'test:example']

data/TODO

@@ -1,5 +1,4 @@
 = rest-graph todo list
 
-= 1.2
 * more docs?
 * more examples?

data/example/rails/app/controllers/application_controller.rb

@@ -9,12 +9,70 @@ class ApplicationController < ActionController::Base
   # filter_parameter_logging :password
 
   include RestGraph::RailsUtil
-  before_filter :setup_iframe
-  before_filter :setup_rest_graph
+
+  before_filter :rest_graph_setup,   :only => [:index,  :url_for_standalone,
+                                                        :url_for_view_stand,
+                                                        :link_to_stand,
+                                                        :redirect_stand]
+  before_filter :filter_canvas,      :only => [:canvas, :url_for_canvas,
+                                                        :url_for_view_canvas,
+                                                        :link_to_canvas,
+                                                        :redirect_canvas]
+  before_filter :filter_options,     :only => [:options]
+  before_filter :filter_no_auto,     :only => [:no_auto]
+  before_filter :filter_diff_app_id, :only => [:app_id]
 
   def index
-    me = @rg.get('me')
-    return unless me
-    render :text => me.to_json
+    render :text => rest_graph.get('me').to_json
+  end
+  alias_method :canvas,  :index
+  alias_method :options, :index
+
+  def no_auto
+    rest_graph.get('me')
+  rescue RestGraph::Error
+    render :text => 'XD'
+  end
+
+  def app_id
+    render :text => rest_graph.app_id
+  end
+
+  def url_for_standalone
+    render :text => url_for(:action => 'index')
+  end
+  alias_method :url_for_canvas, :url_for_standalone
+
+  def url_for_view_stand
+    render :inline => '<%= url_for(:action => "index") %>'
+  end
+  alias_method :url_for_view_canvas, :url_for_view_stand
+
+  def link_to_stand
+    render :inline => '<%= link_to("test", :action => "index") %>'
+  end
+  alias_method :link_to_canvas, :link_to_stand
+
+  def redirect_stand
+    redirect_to :action => 'index'
+  end
+  alias_method :redirect_canvas, :redirect_stand
+
+  private
+  def filter_canvas
+    rest_graph_setup(:canvas => true,
+                     :auto_authorize_scope => 'publish_stream')
+  end
+
+  def filter_no_auto
+    rest_graph_setup(:auto_authorize => false)
+  end
+
+  def filter_diff_app_id
+    rest_graph_setup(:app_id => 'zzz')
+  end
+
+  def filter_options
+    rest_graph_setup(:auto_authorize_options => {:scope => 'bogus'})
   end
 end

data/example/rails/config/environment.rb

@@ -19,7 +19,6 @@ Rails::Initializer.run do |config|
   # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
   # config.gem "sqlite3-ruby", :lib => "sqlite3"
   # config.gem "aws-s3", :lib => "aws/s3"
-  config.gem 'rest-graph'
   config.gem 'rest-graph', :lib => 'rest-graph/auto_load'
 
   # Only load the plugins named here, in the order given (default is alphabetical).

data/example/rails/config/rest-graph.yaml

@@ -1,5 +1,11 @@
 
-development:
-  app_id: ''
-  secret: ''
-  canvas: ''
+development: &default
+  app_id: '123'
+  secret: '456'
+  canvas: 'can'
+
+production:
+  *default
+
+test:
+  *default

data/example/rails/config/routes.rb

@@ -31,7 +31,7 @@ ActionController::Routing::Routes.draw do |map|
   #   end
 
   # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
-  map.root :controller => 'application'
+  map.connect ':action', :controller => 'application'
 
   # See how all your routes lay out with "rake routes"
 

data/example/rails/test/functional/application_controller_test.rb

@@ -0,0 +1,114 @@
+
+require 'test_helper'
+require 'webmock'
+
+WebMock.disable_net_connect!
+
+class ApplicationControllerTest < ActionController::TestCase
+  include WebMock
+
+  def setup
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{"error":"not authorized"}')
+  end
+
+  def teardown
+    reset_webmock
+  end
+
+  def test_index
+    get(:index)
+    assert_response :redirect
+    assert_equal(
+      normalize_url(
+        'https://graph.facebook.com/oauth/authorize?client_id=123&' \
+        'scope=offline_access%2Cpublish_stream%2Cread_friendlists&' \
+        'redirect_uri=http%3A%2F%2Ftest.host%2F'),
+      normalize_url(assigns(:rest_graph_authorize_url)))
+  end
+
+  def test_canvas
+    get(:canvas)
+    assert_response :success
+    assert_equal(
+      normalize_url(
+        'https://graph.facebook.com/oauth/authorize?client_id=123&' \
+        'scope=publish_stream&'                                     \
+        'redirect_uri=http%3A%2F%2Fapps.facebook.com%2Fcan%2Fcanvas'),
+      normalize_url((assigns(:rest_graph_authorize_url))))
+  end
+
+  def test_options
+    get(:options)
+    assert_response :redirect
+    assert_equal(
+      normalize_url(
+        'https://graph.facebook.com/oauth/authorize?client_id=123&' \
+        'scope=bogus&'                                              \
+        'redirect_uri=http%3A%2F%2Ftest.host%2Foptions'),
+      normalize_url((assigns(:rest_graph_authorize_url))))
+  end
+
+  def test_no_auto
+    get(:no_auto)
+    assert_response :success
+    assert_equal 'XD', @response.body
+  end
+
+  def test_app_id
+    get(:app_id)
+    assert_response :success
+    assert_equal 'zzz', @response.body
+  end
+
+  def test_url_for_standalone
+    get(:url_for_standalone)
+    assert_response :success
+    assert_equal 'http://test.host/', @response.body
+  end
+
+  def test_url_for_canvas
+    get(:url_for_canvas)
+    assert_response :success
+    assert_equal 'http://apps.facebook.com/can/',
+      @response.body
+  end
+
+  def test_url_for_view_stand
+    get(:url_for_view_stand)
+    assert_response :success
+    assert_equal '/', @response.body
+  end
+
+  def test_url_for_view_canvas
+    get(:url_for_view_canvas)
+    assert_response :success
+    assert_equal 'http://apps.facebook.com/can/',
+      @response.body
+  end
+
+  def test_link_to_stand
+    get(:link_to_stand)
+    assert_response :success
+    assert_equal '<a href="/">test</a>', @response.body
+  end
+
+  def test_link_to_canvas
+    get(:link_to_canvas)
+    assert_response :success
+    assert_equal '<a href="http://apps.facebook.com/can/">test</a>',
+      @response.body
+  end
+
+  def test_redirect_stand
+    get(:redirect_stand)
+    assert_response :redirect
+    assert_redirected_to '/'
+  end
+
+  def test_redirect_canvas
+    get(:redirect_canvas)
+    assert_response :redirect
+    assert_redirected_to 'http://apps.facebook.com/can/'
+  end
+end

data/example/rails/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  def normalize_query query
+    '?' + query[1..-1].split('&').sort.join('&')
+  end
+
+  def normalize_url url
+    url.sub(/\?.+/){ |query| normalize_query(query) }
+  end
+end

data/init.rb

@@ -1,3 +1,2 @@
 
-require 'rest-graph'
 require 'rest-graph/auto_load'

data/lib/rest-graph/rails_util.rb

@@ -2,46 +2,77 @@
 require 'rest-graph'
 
 module RestGraph::RailsUtil
-  module_function
-  # filters for you
-  def setup_iframe
-    @fb_sig_in_iframe = true
+  module Helper
+    def url_for options
+      caller = respond_to?(:controller) ? controller : self
+      if caller.rest_graph_in_canvas? && options.kind_of?(Hash)
+        super({:host => "apps.facebook.com/#{RestGraph.default_canvas}"}.
+              merge(options))
+      else
+        super(options)
+      end
+    end
   end
 
-  def setup_rest_graph
-    rest_graph_create
+  def self.included controller
+    controller.rescue_from(::RestGraph::Error){ |exception|
+      logger.debug("DEBUG: RestGraph: action halt")
+    }
+    controller.send(:include, ::RestGraph::RailsUtil::Helper)
+    controller.helper(::RestGraph::RailsUtil::Helper)
+  end
+
+  def rest_graph_options
+    @rest_graph_options ||=
+      {:canvas                 => false,
+       :auto_authorize         => true,
+       :auto_authorize_options => {},
+       :auto_authorize_scope   =>
+         'offline_access,publish_stream,read_friendlists'}
+  end
+
+  def rest_graph_options_new
+    @rest_graph_options_new ||=
+      {:error_handler => method(:rest_graph_authorize),
+         :log_handler => method(:rest_graph_log)}
+  end
+
+  def rest_graph_setup options={}
+    rest_graph_options    .merge!(rest_graph_extract_options(options, :reject))
+    rest_graph_options_new.merge!(rest_graph_extract_options(options, :select))
 
     # exchange the code with access_token
     if params[:code]
-      @rg.authorize!(:code => params[:code],
-                     :redirect_uri => normalized_request_uri)
+      rest_graph.authorize!(:code => params[:code],
+                            :redirect_uri => rest_graph_normalized_request_uri)
       logger.debug(
-        "DEBUG: RestGraph: detected code with #{normalized_request_uri}, " \
-        "parsed: #{@rg.data.inspect}")
+        "DEBUG: RestGraph: detected code with "  \
+        "#{rest_graph_normalized_request_uri}, " \
+        "parsed: #{rest_graph.data.inspect}")
     end
 
     # if the code is bad or not existed,
     # check if there's one in session,
     # meanwhile, there the sig and access_token is correct,
-    # that means we're in the context of iframe
-    if !@rg.authorized? && params[:session]
-      @rg.parse_json!(params[:session])
-      logger.debug(
-        "DEBUG: RestGraph: detected session, parsed: #{@rg.data.inspect}")
-
-      if @rg.authorized?
-        @fb_sig_in_iframe = true
+    # that means we're in the context of canvas
+    if !rest_graph.authorized? && params[:session]
+      rest_graph.parse_json!(params[:session])
+      logger.debug("DEBUG: RestGraph: detected session, parsed:" \
+                   " #{rest_graph.data.inspect}")
+
+      if rest_graph.authorized?
+        @fb_sig_in_canvas = true
       else
         logger.warn("WARN: RestGraph: bad session: #{params[:session]}")
       end
     end
 
-    # if we're not in iframe nor code passed,
+    # if we're not in canvas nor code passed,
     # we could check out cookies as well.
-    if !@rg.authorized?
-      @rg.parse_cookies!(cookies)
-      logger.debug(
-        "DEBUG: RestGraph: detected cookies, parsed: #{@rg.data.inspect}")
+    if !rest_graph.authorized?
+      rest_graph.parse_cookies!(cookies)
+      logger.debug("DEBUG: RestGraph: detected cookies, parsed:" \
+                   " #{rest_graph.data.inspect}")
     end
 
     # there are above 3 ways to check the user identity!
@@ -50,46 +81,57 @@ module RestGraph::RailsUtil
   end
 
   # override this if you need different app_id and secret
-  def rest_graph_create
-    @rg ||= RestGraph.new(:error_handler => method(:rest_graph_authorize),
-                            :log_handler => method(:rest_graph_log))
+  def rest_graph
+    @rest_graph ||= RestGraph.new(rest_graph_options_new)
   end
 
-  def rest_graph_authorize error=nil
-    logger.warn("WARN: RestGraph: #{error.inspect}") if error
-
-    @authorize_url = @rg.authorize_url(
-      {:redirect_uri => normalized_request_uri,
-       :scope        => rest_graph_authorize_scope}.
-      merge(rest_graph_authorize_options))
+  def rest_graph_authorize error
+    logger.warn("WARN: RestGraph: #{error.inspect}")
 
-    logger.debug("DEBUG: RestGraph: redirect to #{@authorize_url}")
+    @rest_graph_authorize_url = rest_graph.authorize_url(
+      {:redirect_uri => rest_graph_normalized_request_uri,
+       :scope        => rest_graph_options[:auto_authorize_scope]}.
+      merge(            rest_graph_options[:auto_authorize_options]))
 
-    rest_graph_authorize_redirect
-    return false
-  end
+    logger.debug("DEBUG: RestGraph: redirect to #{@rest_graph_authorize_url}")
 
-  # override this if you need different access scope
-  def rest_graph_authorize_scope
-    @rest_graph_authorize_scope ||=
-      'offline_access,publish_stream,read_friendlists'
+    rest_graph_authorize_redirect if rest_graph_options[:auto_authorize]
+    raise ::RestGraph::Error.new(error)
   end
 
   # override this if you want the simple redirect_to
   def rest_graph_authorize_redirect
-    render :template => 'rest-graph/authorization'
-  end
+    if !rest_graph_in_canvas?
+      redirect_to @rest_graph_authorize_url
 
-  def rest_graph_authorize_options
-    @rest_graph_authorize_options ||= {}
+    else
+      render :inline => <<-HTML
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html>
+        <head>
+        <script type="text/javascript">
+          window.top.location.href = '<%= @rest_graph_authorize_url %>'
+        </script>
+        <noscript>
+          <meta http-equiv="refresh" content="0;url=<%= h @rest_graph_authorize_url %>" />
+          <meta http-equiv="window-target" content="_top" />
+        </noscript>
+        </head>
+        <body>
+          <div>Please <a href="<%= h @rest_graph_authorize_url %>" target="_top">authorize</a> if this page is not automatically redirected.</div>
+        </body>
+      </html>
+      HTML
+    end
   end
 
   def rest_graph_log duration, url
     logger.debug("DEBUG: RestGraph: spent #{duration} requesting #{url}")
   end
 
-  def normalized_request_uri
-    if @fb_sig_in_iframe
+  def rest_graph_normalized_request_uri
+    if rest_graph_in_canvas?
       "http://apps.facebook.com/" \
       "#{RestGraph.default_canvas}#{request.request_uri}"
     else
@@ -97,6 +139,14 @@ module RestGraph::RailsUtil
     end.sub(/[\&\?]session=[^\&]+/, '').
         sub(/[\&\?]code=[^\&]+/, '')
   end
-end
 
-RestGraph::RailsController = RestGraph::RailsUtil
+  def rest_graph_in_canvas?
+    rest_graph_options[:canvas] || @fb_sig_in_canvas
+  end
+
+  def rest_graph_extract_options options, method
+    result = options.send(method){ |(k, v)| RestGraph::Attributes.member?(k) }
+    return result if result.kind_of?(Hash) # RUBY_VERSION >= 1.9.1
+    result.inject({}){ |r, (k, v)| r[k] = v; r }
+  end
+end

data/lib/rest-graph/version.rb

@@ -1,4 +1,4 @@
 
 require 'rest-graph'
 
-RestGraph::VERSION = '1.2.1'
+RestGraph::VERSION = '1.3.0'

data/lib/rest-graph.rb

@@ -11,17 +11,18 @@ begin
   require 'rack'
 rescue LoadError; end
 
-begin
-  require 'json'
-rescue LoadError
+# pick a json gem if available
+%w[ yajl/json_gem json json_pure ].each{ |json|
   begin
-    require 'json_pure'
-  rescue LoadError; end
-end
+    require json
+    break
+  rescue LoadError
+  end
+}
 
 # the data structure used in RestGraph
 RestGraphStruct = Struct.new(:data, :auto_decode,
-                             :graph_server, :fql_server,
+                             :graph_server, :old_server,
                              :accept, :lang,
                              :app_id, :secret,
                              :error_handler,
@@ -47,7 +48,7 @@ class RestGraph < RestGraphStruct
     def default_data        ; {}                           ; end
     def default_auto_decode ; true                         ; end
     def default_graph_server; 'https://graph.facebook.com/'; end
-    def default_fql_server  ; 'https://api.facebook.com/'  ; end
+    def default_old_server  ; 'https://api.facebook.com/'  ; end
     def default_accept      ; 'text/javascript'            ; end
     def default_lang        ; 'en-us'                      ; end
     def default_app_id      ; nil                          ; end
@@ -79,52 +80,27 @@ class RestGraph < RestGraphStruct
     !!access_token
   end
 
-  def get    path, opts={}
-    request(graph_server, path, opts, :get)
-  end
-
-  def delete path, opts={}
-    request(graph_server, path, opts, :delete)
-  end
-
-  def post   path, payload, opts={}
-    request(graph_server, path, opts, :post, payload)
+  def get    path, query={}, opts={}
+    request(graph_server, path, query, :get,    nil,   opts[:suppress_decode])
   end
 
-  def put    path, payload, opts={}
-    request(graph_server, path, opts, :put,  payload)
+  def delete path, query={}, opts={}
+    request(graph_server, path, query, :delete, nil,   opts[:suppress_decode])
   end
 
-  def fql query, opts={}
-    request(fql_server, 'method/fql.query',
-      {:query  => query, :format => 'json'}.merge(opts), :get)
+  def post   path, payload, query={}, opts={}
+    request(graph_server, path, query, :post, payload, opts[:suppress_decode])
   end
 
-  def fql_multi queries, opts={}
-    q = if queries.respond_to?(:to_json)
-           queries.to_json
-        else
-          middle = queries.inject([]){ |r, (k, v)|
-                     r << "\"#{k}\":\"#{v.gsub('"','\\"')}\""
-                   }.join(',')
-          "{#{middle}}"
-        end
-    request(fql_server, 'method/fql.multiquery',
-      {:queries => q, :format => 'json'}.merge(opts), :get)
+  def put    path, payload, query={}, opts={}
+    request(graph_server, path, query, :put,  payload, opts[:suppress_decode])
   end
 
   # cookies, app_id, secrect related below
 
-  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
+  def parse_rack_env! env
+    env['HTTP_COOKIE'].to_s =~ /fbs_#{app_id}=([^\;]+)/
+    self.data = parse_fbs!($1)
   end
 
   def parse_cookies! cookies
@@ -132,13 +108,14 @@ class RestGraph < RestGraphStruct
   end
 
   def parse_fbs! fbs
-    self.data = fbs &&
-      check_sig_and_return_data(Rack::Utils.parse_query(fbs))
+    self.data = check_sig_and_return_data(
+      # take out facebook sometimes there but sometimes not quotes in cookies
+      Rack::Utils.parse_query(fbs.to_s.gsub('"', '')))
   end
 
   def parse_json! json
     self.data = json &&
-      check_sig_and_return_data(JSON.load(json))
+      check_sig_and_return_data(JSON.parse(json))
   rescue JSON::ParserError
   end
 
@@ -155,13 +132,42 @@ class RestGraph < RestGraphStruct
       request(graph_server, 'oauth/access_token', query, :get, nil, true))
   end
 
+  # old rest facebook api, i will definitely love to remove them someday
+
+  def old_rest path, query={}, opts={}
+    request(old_server, "method/#{path}",
+      {:format => 'json'}.merge(query), :get, nil, opts[:suppress_decode])
+  end
+
+  def exchange_sessions opts={}
+    query = {:client_id => app_id, :client_secret => secret,
+             :type => 'client_cred'}.merge(opts)
+    request(graph_server, 'oauth/exchange_sessions', query, :post)
+  end
+
+  def fql code, query={}, opts={}
+    old_rest('fql.query', {:query => code}.merge(query), opts)
+  end
+
+  def fql_multi codes, query={}, opts={}
+    c = if codes.respond_to?(:to_json)
+           codes.to_json
+        else
+          middle = codes.inject([]){ |r, (k, v)|
+                     r << "\"#{k}\":\"#{v.gsub('"','\\"')}\""
+                   }.join(',')
+          "{#{middle}}"
+        end
+    old_rest('fql.multiquery', {:queries => c}.merge(query), opts)
+  end
+
   private
-  def request server, path, opts, method, payload=nil, suppress_decode=false
+  def request server, path, opts, method, payload=nil, suppress_decode=nil
     start_time = Time.now
     res = RestClient::Resource.new(server)[path + build_query_string(opts)]
     post_request(
       res.send(method, *[payload, build_headers].compact), suppress_decode)
-  rescue RestClient::InternalServerError => e
+  rescue RestClient::Exception => e
     post_request(e.http_body, suppress_decode)
   ensure
     log_handler.call(Time.now - start_time, res.url)
@@ -181,7 +187,7 @@ class RestGraph < RestGraphStruct
     headers
   end
 
-  def post_request result, suppress_decode=false
+  def post_request result, suppress_decode=nil
     if auto_decode && !suppress_decode
       check_error(JSON.parse(result))
     else

data/rest-graph.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rest-graph}
-  s.version = "1.2.1"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cardinal Blue", "Lin Jen-Shin (aka godfat 真常)"]
-  s.date = %q{2010-06-02}
+  s.date = %q{2010-06-10}
   s.description = %q{ A super simple Facebook Open Graph API client}
   s.email = %q{dev (XD) cardinalblue.com}
-  s.extra_rdoc_files = ["CHANGES", "LICENSE", "TODO", "example/rails/README", "example/rails/app/views/rest-graph/authorization.erb", "example/rails/config/rest-graph.yaml", "example/rails/script/console", "example/rails/script/server", "rest-graph.gemspec"]
-  s.files = ["CHANGES", "LICENSE", "README.rdoc", "Rakefile", "TODO", "example/rails/README", "example/rails/Rakefile", "example/rails/app/controllers/application_controller.rb", "example/rails/app/views/rest-graph/authorization.erb", "example/rails/config/boot.rb", "example/rails/config/environment.rb", "example/rails/config/environments/development.rb", "example/rails/config/environments/production.rb", "example/rails/config/environments/test.rb", "example/rails/config/initializers/cookie_verification_secret.rb", "example/rails/config/initializers/new_rails_defaults.rb", "example/rails/config/initializers/session_store.rb", "example/rails/config/rest-graph.yaml", "example/rails/config/routes.rb", "example/rails/script/console", "example/rails/script/server", "init.rb", "lib/rest-graph.rb", "lib/rest-graph/auto_load.rb", "lib/rest-graph/load_config.rb", "lib/rest-graph/rails_util.rb", "lib/rest-graph/version.rb", "rest-graph.gemspec", "test/common.rb", "test/config/rest-graph.yaml", "test/test_default.rb", "test/test_fql.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_oauth.rb", "test/test_parse.rb", "test/test_rest-graph.rb"]
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "TODO", "example/rails/README", "example/rails/config/rest-graph.yaml", "example/rails/log", "example/rails/script/console", "example/rails/script/server", "rest-graph.gemspec"]
+  s.files = ["CHANGES", "LICENSE", "README.rdoc", "Rakefile", "TODO", "example/rails/README", "example/rails/Rakefile", "example/rails/app/controllers/application_controller.rb", "example/rails/config/boot.rb", "example/rails/config/environment.rb", "example/rails/config/environments/development.rb", "example/rails/config/environments/production.rb", "example/rails/config/environments/test.rb", "example/rails/config/initializers/cookie_verification_secret.rb", "example/rails/config/initializers/new_rails_defaults.rb", "example/rails/config/initializers/session_store.rb", "example/rails/config/rest-graph.yaml", "example/rails/config/routes.rb", "example/rails/log", "example/rails/script/console", "example/rails/script/server", "example/rails/test/functional/application_controller_test.rb", "example/rails/test/test_helper.rb", "init.rb", "lib/rest-graph.rb", "lib/rest-graph/auto_load.rb", "lib/rest-graph/load_config.rb", "lib/rest-graph/rails_util.rb", "lib/rest-graph/version.rb", "rest-graph.gemspec", "test/common.rb", "test/config/rest-graph.yaml", "test/test_default.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_oauth.rb", "test/test_old.rb", "test/test_parse.rb", "test/test_rest-graph.rb"]
   s.homepage = %q{http://github.com/cardinalblue/rest-graph}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{rest-graph}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A super simple Facebook Open Graph API client}
-  s.test_files = ["test/test_default.rb", "test/test_fql.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_oauth.rb", "test/test_parse.rb", "test/test_rest-graph.rb"]
+  s.test_files = ["test/test_default.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_oauth.rb", "test/test_old.rb", "test/test_parse.rb", "test/test_rest-graph.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rr>, [">= 0.10.11"])
       s.add_development_dependency(%q<webmock>, [">= 1.2.2"])
       s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
-      s.add_development_dependency(%q<bones>, [">= 3.4.3"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.6"])
     else
       s.add_dependency(%q<rest-client>, [">= 1.5.1"])
       s.add_dependency(%q<json>, [">= 1.4.3"])
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rr>, [">= 0.10.11"])
       s.add_dependency(%q<webmock>, [">= 1.2.2"])
       s.add_dependency(%q<bacon>, [">= 1.1.0"])
-      s.add_dependency(%q<bones>, [">= 3.4.3"])
+      s.add_dependency(%q<bones>, [">= 3.4.6"])
     end
   else
     s.add_dependency(%q<rest-client>, [">= 1.5.1"])
@@ -47,6 +47,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rr>, [">= 0.10.11"])
     s.add_dependency(%q<webmock>, [">= 1.2.2"])
     s.add_dependency(%q<bacon>, [">= 1.1.0"])
-    s.add_dependency(%q<bones>, [">= 3.4.3"])
+    s.add_dependency(%q<bones>, [">= 3.4.6"])
   end
 end

data/test/{test_fql.rb → test_old.rb}

@@ -35,11 +35,16 @@ describe RestGraph do
     f1 = 'SELECT display_name FROM application WHERE app_id="110225210740"'
     f0q, f1q = "\"#{f0.gsub('"', '\\"')}\"", "\"#{f1.gsub('"', '\\"')}\""
     q = "format=json&queries=#{CGI.escape("{\"f0\":#{f0q},\"f1\":#{f1q}}")}"
+    p = "format=json&queries=#{CGI.escape("{\"f1\":#{f1q},\"f0\":#{f0q}}")}"
 
     stub_multi = lambda{
       stub_request(:get,
         "https://api.facebook.com/method/fql.multiquery?#{q}").
         to_return(:body => '[]')
+
+      stub_request(:get,
+        "https://api.facebook.com/method/fql.multiquery?#{p}").
+        to_return(:body => '[]')
     }
 
     stub_multi.call
@@ -57,4 +62,27 @@ describe RestGraph do
     stub_multi.call
     RestGraph.new.fql_multi(queries).should == []
   end
+
+  it 'would do facebook old rest api' do
+    body = 'hate facebook inconsistent'
+    stub_request(:get,
+      'https://api.facebook.com/method/notes.create?format=json').
+      to_return(:body => body)
+
+    RestGraph.new.old_rest('notes.create', {}, :suppress_decode => true).
+      should == body
+  end
+
+  it 'would exchange sessions for access token' do
+    stub_request(:post,
+      'https://graph.facebook.com/oauth/exchange_sessions?'     \
+              'type=client_cred&client_id=id&client_secret=di&' \
+              'sessions=bad%20bed').
+      to_return(:body => '[{"access_token":"bogus"}]')
+
+    RestGraph.new(:app_id => 'id',
+                  :secret => 'di').
+      exchange_sessions(:sessions => 'bad bed').
+      first['access_token'].should == 'bogus'
+  end
 end

data/test/test_parse.rb

@@ -21,7 +21,7 @@ describe RestGraph do
     fbs          = "access_token=#{CGI.escape(access_token)}&expires=0&" \
                    "secret=abc&session_key=def-456&sig=#{sig}&uid=3"
 
-    check = lambda{ |token|
+    check = lambda{ |token, fbs|
       http_cookie =
         "__utma=123; __utmz=456.utmcsr=(d)|utmccn=(d)|utmcmd=(n); " \
         "fbs_#{app_id}=#{fbs}"
@@ -42,10 +42,11 @@ describe RestGraph do
                       should.kind_of?(token ? Hash : NilClass)
       rg.access_token.should ==  token
     }
-    check.call(access_token)
-    fbs.chop!
-    fbs += '&inject=evil"'
-    check.call(nil)
+    check.call(access_token, fbs)
+    check.call(access_token, "\"#{fbs}\"")
+    fbs << '&inject=evil"'
+    check.call(nil, fbs)
+    check.call(nil, "\"#{fbs}\"")
   end
 
   it 'would not pass if there is no secret, prevent from forgery' do

data/test/test_rest-graph.rb

@@ -75,20 +75,31 @@ describe RestGraph do
       should == '[]'
   end
 
+  it 'could suppress auto-decode in an api call' do
+    stub_request(:get, 'https://graph.facebook.com/woot').
+      to_return(:body => 'bad json')
+
+    rg = RestGraph.new(:auto_decode => true)
+    rg.get('woot', {}, :suppress_decode => true).should == 'bad json'
+    rg.auto_decode.should == true
+  end
+
   it 'would call post_request after request' 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('[]', false)
+    mock.proxy(rg = RestGraph.new).post_request('[]', nil)
     rg.put('feed/me', :message => 'hi there').
       should == []
   end
 
-  it 'would not raise exception when encountering 500' do
-    stub_request(:delete, 'https://graph.facebook.com/123').to_return(
-      :body => '[]', :status => 500)
+  it 'would not raise exception when encountering error' do
+    [500, 401, 402, 403].each{ |status|
+      stub_request(:delete, 'https://graph.facebook.com/123').to_return(
+        :body => '[]', :status => status)
 
-    RestGraph.new.delete('123').should == []
+      RestGraph.new.delete('123').should == []
+    }
   end
 
   it 'would return true in authorized? if there is an access_token' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rest-graph
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 1
-  version: 1.2.1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Cardinal Blue
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-02 00:00:00 +08:00
+date: 2010-06-11 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -123,12 +123,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 27
         segments: 
         - 3
         - 4
-        - 3
-        version: 3.4.3
+        - 6
+        version: 3.4.6
   type: :development
   version_requirements: *id007
 description: " A super simple Facebook Open Graph API client"
@@ -142,8 +142,8 @@ extra_rdoc_files:
 - LICENSE
 - TODO
 - example/rails/README
-- example/rails/app/views/rest-graph/authorization.erb
 - example/rails/config/rest-graph.yaml
+- example/rails/log
 - example/rails/script/console
 - example/rails/script/server
 - rest-graph.gemspec
@@ -156,7 +156,6 @@ files:
 - example/rails/README
 - example/rails/Rakefile
 - example/rails/app/controllers/application_controller.rb
-- example/rails/app/views/rest-graph/authorization.erb
 - example/rails/config/boot.rb
 - example/rails/config/environment.rb
 - example/rails/config/environments/development.rb
@@ -167,8 +166,11 @@ files:
 - example/rails/config/initializers/session_store.rb
 - example/rails/config/rest-graph.yaml
 - example/rails/config/routes.rb
+- example/rails/log
 - example/rails/script/console
 - example/rails/script/server
+- example/rails/test/functional/application_controller_test.rb
+- example/rails/test/test_helper.rb
 - init.rb
 - lib/rest-graph.rb
 - lib/rest-graph/auto_load.rb
@@ -179,10 +181,10 @@ files:
 - test/common.rb
 - test/config/rest-graph.yaml
 - test/test_default.rb
-- test/test_fql.rb
 - test/test_handler.rb
 - test/test_load_config.rb
 - test/test_oauth.rb
+- test/test_old.rb
 - test/test_parse.rb
 - test/test_rest-graph.rb
 has_rdoc: true
@@ -222,9 +224,9 @@ specification_version: 3
 summary: A super simple Facebook Open Graph API client
 test_files: 
 - test/test_default.rb
-- test/test_fql.rb
 - test/test_handler.rb
 - test/test_load_config.rb
 - test/test_oauth.rb
+- test/test_old.rb
 - test/test_parse.rb
 - test/test_rest-graph.rb

data/example/rails/app/views/rest-graph/authorization.erb

@@ -1,16 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-  <script type="text/javascript">
-    window.top.location.href = '<%= @authorize_url %>'
-  </script>
-  <noscript>
-    <meta http-equiv="refresh" content="0;url=<%= h @authorize_url %>" />
-    <meta http-equiv="window-target" content="_top" />
-  </noscript>
-  </head>
-  <body>
-    <div>Please <a href="<%= h @authorize_url %>" target="_top">authorize</a> if this page is not automatically redirected.</div>
-  </body>
-</html>