rest-graph 1.4.0 → 1.4.1

data/CHANGES

@@ -1,6 +1,26 @@
 = rest-graph changes history
 
-== rest-graph 1.4.0 -- ?
+== rest-graph 1.4.1 -- 2010-08-04
+
+* [RestGraph] Call error_handler when response contains error_code as well,
+  which came from FQL response. Thanks Florent.
+
+* [RestGraph] Added RestGraph#parse_signed_request!
+
+* [RestGraph] Added RestGraph#url to generate desired API request URL,
+  in case you'll want to use different HTTP client, such as em-http-request,
+  or pass the API request to different process of data fetcher.
+
+* [RestGraph] Added an :cache option that allow you to pass a cache
+  object, which should respond to [] and []= for reading and writing.
+  The cache key would be MD5 hexdigest from the URL being called.
+  pass :cache => Rails.cache to rest_graph_setup when using RailsUtil.
+
+* [RailsUtil] Pass :cache => Rails.cache to rest_graph_setup to enable caching.
+* [RailsUtil] Favor signed_request over session in rest_graph_setup
+* [RailsUtil] Now it's possible to setup all options in rest-graph.yaml.
+
+== rest-graph 1.4.0 -- 2010-07-15
 
 Changes only for RailsUtil, the core (rest-graph.rb) is pretty stable for now.
 

data/Gemfile

@@ -0,0 +1,12 @@
+
+source 'http://rubygems.org'
+
+gem 'rest-client'
+
+group :test do
+  gem 'yajl-ruby'
+  gem 'rack'
+  gem 'rr'
+  gem 'webmock'
+  gem 'bacon'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+--- 
+hash: 1abfe240bd774ad21e7a187351da9cabacb74d58
+sources: 
+- Rubygems: 
+    uri: http://rubygems.org
+specs: 
+- addressable: 
+    version: 2.1.2
+- bacon: 
+    version: 1.1.0
+- crack: 
+    version: 0.1.8
+- mime-types: 
+    version: "1.16"
+- rack: 
+    version: 1.2.1
+- rest-client: 
+    version: 1.6.0
+- rr: 
+    version: 0.10.11
+- webmock: 
+    version: 1.3.2
+- yajl-ruby: 
+    version: 0.7.7
+dependencies: 
+  rest-client: 
+    version: ">= 0"
+    group: 
+    - :default
+  yajl-ruby: 
+    version: ">= 0"
+    group: 
+    - :test
+  rack: 
+    version: ">= 0"
+    group: 
+    - :test
+  rr: 
+    version: ">= 0"
+    group: 
+    - :test
+  webmock: 
+    version: ">= 0"
+    group: 
+    - :test
+  bacon: 
+    version: ">= 0"
+    group: 
+    - :test

data/README

@@ -1,4 +1,4 @@
-= rest-graph 1.3.0
+= rest-graph 1.4.1
 by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
@@ -98,6 +98,7 @@ by Cardinal Blue ( http://cardinalblue.com )
                     :auto_decode  =>  true  , # decode by json
                     :app_id       => '123'  ,
                     :secret       => '1829' ,
+                    :cache        => {}     , # a cache for the same API call
 
  # This handler callback is only called if auto_decode is set to true,
  # otherwise, it's ignored.
@@ -215,13 +216,13 @@ by Cardinal Blue ( http://cardinalblue.com )
  # or (3) Load config automatically
  require 'rest-graph/auto_load'  # under Rails, load config/rest-graph.yaml
 
- # Please read:
+ # Please read: for an example of config file.
+ # Note that :auto_authorize_scope and friends is only for RailsUtil.
 {rest-graph.yaml}[http://github.com/cardinalblue/rest-graph/blob/master/test/config/rest-graph.yaml]
- # for an example of config file.
 
 == REQUIREMENTS:
 
-* Tested with MRI 1.8.7 and 1.9.1
+* Tested with MRI 1.8.7 and 1.9.1 and Rubinius HEAD
 * gem install rest-client
 * gem install json      (optional)
 * gem install json_pure (optional)

data/README.rdoc

@@ -1,4 +1,4 @@
-= rest-graph 1.3.0
+= rest-graph 1.4.1
 by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
@@ -98,6 +98,7 @@ by Cardinal Blue ( http://cardinalblue.com )
                     :auto_decode  =>  true  , # decode by json
                     :app_id       => '123'  ,
                     :secret       => '1829' ,
+                    :cache        => {}     , # a cache for the same API call
 
  # This handler callback is only called if auto_decode is set to true,
  # otherwise, it's ignored.
@@ -215,13 +216,13 @@ by Cardinal Blue ( http://cardinalblue.com )
  # or (3) Load config automatically
  require 'rest-graph/auto_load'  # under Rails, load config/rest-graph.yaml
 
- # Please read:
+ # Please read: for an example of config file.
+ # Note that :auto_authorize_scope and friends is only for RailsUtil.
 {rest-graph.yaml}[http://github.com/cardinalblue/rest-graph/blob/master/test/config/rest-graph.yaml]
- # for an example of config file.
 
 == REQUIREMENTS:
 
-* Tested with MRI 1.8.7 and 1.9.1
+* Tested with MRI 1.8.7 and 1.9.1 and Rubinius HEAD
 * gem install rest-client
 * gem install json      (optional)
 * gem install json_pure (optional)

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

@@ -16,6 +16,7 @@ class ApplicationController < ActionController::Base
   before_filter :filter_no_auto,     :only => [:no_auto]
   before_filter :filter_diff_app_id, :only => [:diff_app_id]
   before_filter :filter_diff_canvas, :only => [:diff_canvas]
+  before_filter :filter_cache,       :only => [:cache]
 
   def index
     render :text => rest_graph.get('me').to_json
@@ -34,9 +35,16 @@ class ApplicationController < ActionController::Base
     render :text => rest_graph.app_id
   end
 
+  def cache
+    url = rest_graph.url('cache')
+    rest_graph.get('cache')
+    rest_graph.get('cache')
+    render :text => Rails.cache.read(Digest::MD5.hexdigest(url))
+  end
+
   private
   def filter_common
-    rest_graph_setup(:auto_authorize => true)
+    rest_graph_setup(:auto_authorize => true, :canvas => '')
   end
 
   def filter_canvas
@@ -59,6 +67,11 @@ class ApplicationController < ActionController::Base
   end
 
   def filter_options
-    rest_graph_setup(:auto_authorize_options => {:scope => 'bogus'})
+    rest_graph_setup(:auto_authorize_options => {:scope => 'bogus'},
+                     :canvas => nil)
+  end
+
+  def filter_cache
+    rest_graph_setup(:cache => Rails.cache)
   end
 end

data/example/rails/config/environments/test.rb

@@ -26,3 +26,5 @@ config.action_mailer.delivery_method = :test
 # This is necessary if your schema can't be completely dumped by the schema dumper,
 # like if you have constraints or database-specific column types
 # config.active_record.schema_format = :sql
+
+config.logger = Logger.new($stdout, :debug)

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

@@ -71,4 +71,13 @@ class ApplicationControllerTest < ActionController::TestCase
     assert_response :success
     assert_equal 'zzz', @response.body
   end
+
+  def test_cache
+    stub_request(:get, 'https://graph.facebook.com/cache').
+      to_return(:body => '{"message":"ok"}')
+
+    get(:cache)
+    assert_response :success
+    assert_equal '{"message":"ok"}', @response.body
+  end
 end

data/lib/rest-graph.rb

@@ -4,6 +4,8 @@ require 'rest_client'
 
 # stdlib
 require 'digest/md5'
+require 'openssl'
+
 require 'cgi'
 
 # optional gem
@@ -21,15 +23,19 @@ rescue LoadError; end
 }
 
 # the data structure used in RestGraph
-RestGraphStruct = Struct.new(:data, :auto_decode,
+RestGraphStruct = Struct.new(:auto_decode,
                              :graph_server, :old_server,
                              :accept, :lang,
                              :app_id, :secret,
+                             :data, :cache,
                              :error_handler,
                              :log_handler) unless defined?(RestGraphStruct)
 
 class RestGraph < RestGraphStruct
   class Error < RuntimeError; end
+  class Event < Struct.new(:duration, :url); end
+  class Event::Requested < Event; end
+  class Event::CacheHit  < Event; end
 
   Attributes = RestGraphStruct.members.map(&:to_sym)
 
@@ -45,7 +51,6 @@ class RestGraph < RestGraphStruct
   # setup defaults
   module DefaultAttributes
     extend self
-    def default_data        ; {}                           ; end
     def default_auto_decode ; true                         ; end
     def default_graph_server; 'https://graph.facebook.com/'; end
     def default_old_server  ; 'https://api.facebook.com/'  ; end
@@ -53,11 +58,13 @@ class RestGraph < RestGraphStruct
     def default_lang        ; 'en-us'                      ; end
     def default_app_id      ; nil                          ; end
     def default_secret      ; nil                          ; end
+    def default_data        ; {}                           ; end
+    def default_cache       ; nil                          ; end
     def default_error_handler
       lambda{ |error| raise ::RestGraph::Error.new(error) }
     end
     def default_log_handler
-      lambda{ |duration, url| }
+      lambda{ |event| }
     end
   end
   extend DefaultAttributes
@@ -80,20 +87,24 @@ class RestGraph < RestGraphStruct
     !!access_token
   end
 
+  def url path, query={}, server=graph_server
+    "#{server}#{path}#{build_query_string(query)}"
+  end
+
   def get    path, query={}, opts={}
-    request(graph_server, path, query, :get,    nil,   opts[:suppress_decode])
+    request(:get   , url(path, query, graph_server), opts)
   end
 
   def delete path, query={}, opts={}
-    request(graph_server, path, query, :delete, nil,   opts[:suppress_decode])
+    request(:delete, url(path, query, graph_server), opts)
   end
 
   def post   path, payload, query={}, opts={}
-    request(graph_server, path, query, :post, payload, opts[:suppress_decode])
+    request(:post  , url(path, query, graph_server), opts, payload)
   end
 
   def put    path, payload, query={}, opts={}
-    request(graph_server, path, query, :put,  payload, opts[:suppress_decode])
+    request(:put   , url(path, query, graph_server), opts, payload)
   end
 
   # cookies, app_id, secrect related below
@@ -119,6 +130,18 @@ class RestGraph < RestGraphStruct
   rescue JSON::ParserError
   end
 
+  # facebook's new signed_request...
+
+  def parse_signed_request! request
+    sig_encoded, json_encoded = request.split('.')
+    sig,  json = [sig_encoded, json_encoded].map{ |str|
+      "#{str.tr('-_', '+/')}==".unpack('m').first
+    }
+    self.data = JSON.parse(json) if
+      secret && OpenSSL::HMAC.digest('sha256', secret, json_encoded) == sig
+  rescue JSON::ParserError
+  end
+
   # oauth related
 
   def authorize_url opts={}
@@ -129,20 +152,23 @@ class RestGraph < RestGraphStruct
   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))
+                  request(:get, url('oauth/access_token', query),
+                          :suppress_decode => 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])
+    request(
+      :get,
+      url("method/#{path}", {:format => 'json'}.merge(query), old_server),
+      opts)
   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)
+    request(:post, url('oauth/exchange_sessions', query))
   end
 
   def fql code, query={}, opts={}
@@ -162,15 +188,14 @@ class RestGraph < RestGraphStruct
   end
 
   private
-  def request server, path, opts, method, payload=nil, suppress_decode=nil
+  def request meth, uri, opts={}, payload=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)
+    post_request(cache_get(uri) || fetch(meth, uri, payload),
+                 opts[:suppress_decode])
   rescue RestClient::Exception => e
-    post_request(e.http_body, suppress_decode)
+    post_request(e.http_body, opts[:suppress_decode])
   ensure
-    log_handler.call(Time.now - start_time, res.url)
+    log_handler.call(Event::Requested.new(Time.now - start_time, uri))
   end
 
   def build_query_string query={}
@@ -200,7 +225,9 @@ class RestGraph < RestGraphStruct
   end
 
   def check_error hash
-    if error_handler && hash.kind_of?(Hash) && hash['error']
+    if error_handler && hash.kind_of?(Hash) &&
+       (hash['error'] ||    # from graph api
+        hash['error_code']) # from fql
       error_handler.call(hash)
     else
       hash
@@ -213,4 +240,26 @@ class RestGraph < RestGraphStruct
 
     Digest::MD5.hexdigest(args + secret)
   end
+
+  def cache_key uri
+    Digest::MD5.hexdigest(uri)
+  end
+
+  def cache_get uri
+    return unless cache
+    start_time = Time.now
+    cache[cache_key(uri)].tap{ |result|
+      log_handler.call(Event::CacheHit.new(Time.now - start_time, uri)) if
+        result
+    }
+  end
+
+  def fetch meth, uri, payload
+    RestClient::Request.execute(:method => meth, :url => uri,
+                                :headers => build_headers,
+                                :payload => payload).
+      tap{ |result|
+        cache[cache_key(uri)] = result if cache
+      }
+  end
 end

data/lib/rest-graph/rails_util.rb

@@ -1,12 +1,23 @@
 
 require 'rest-graph'
 
-module RestGraph::DefaultAttributes
-  def default_canvas
-    ''
+class RestGraph
+  module DefaultAttributes
+    def default_canvas                ; ''   ; end
+    def default_auto_authorize        ; false; end
+    def default_auto_authorize_options; {}   ; end
+    def default_auto_authorize_scope  ; ''   ; end
+    def default_write_session         ; false; end
+  end
+
+  module RailsCache
+    def []  key       ;  read(key)       ; end
+    def []= key, value; write(key, value); end
   end
 end
 
+::ActiveSupport::Cache::Store.send(:include, ::RestGraph::RailsCache)
+
 module RestGraph::RailsUtil
   module Helper
     def rest_graph
@@ -21,30 +32,16 @@ module RestGraph::RailsUtil
     controller.helper(::RestGraph::RailsUtil::Helper)
   end
 
-  def rest_graph_options
-    @rest_graph_options ||=
-      {:canvas                 => '',
-       :auto_authorize         => false,
-       :auto_authorize_options => {},
-       :auto_authorize_scope   => '',
-       :write_session          => false}
-  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_ctl.merge!(rest_graph_extract_options(options, :reject))
     rest_graph_options_new.merge!(rest_graph_extract_options(options, :select))
 
     rest_graph_check_cookie
+    rest_graph_check_params_signed_request
     rest_graph_check_params_session
     rest_graph_check_code
 
-    # there are above 3 ways to check the user identity!
+    # there are above 4 ways to check the user identity!
     # if nor of them passed, then we can suppose the user
     # didn't authorize for us, but we can check if user has authorized
     # before, in that case, the fbs would be inside session,
@@ -64,8 +61,8 @@ module RestGraph::RailsUtil
     if redirect || rest_graph_auto_authorize?
       @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]))
+         :scope        => rest_graph_oget(:auto_authorize_scope)}.
+        merge(rest_graph_oget(:auto_authorize_options)))
 
       logger.debug("DEBUG: RestGraph: redirect to #{@rest_graph_authorize_url}")
 
@@ -79,7 +76,6 @@ module RestGraph::RailsUtil
   def rest_graph_authorize_redirect
     if !rest_graph_in_canvas?
       redirect_to @rest_graph_authorize_url
-
     else
       render :inline => <<-HTML
       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
@@ -104,7 +100,27 @@ module RestGraph::RailsUtil
 
   module_function
 
-  # ==================== checking utility ====================
+  # ==================== options utility =======================
+
+  def rest_graph_oget key
+    if rest_graph_options_ctl.has_key?(key)
+      rest_graph_options_ctl[key]
+    else
+      RestGraph.send("default_#{key}")
+    end
+  end
+
+  def rest_graph_options_ctl
+    @rest_graph_options_ctl ||= {}
+  end
+
+  def rest_graph_options_new
+    @rest_graph_options_new ||=
+      {:error_handler => method(:rest_graph_authorize),
+         :log_handler => method(:rest_graph_log)}
+  end
+
+  # ==================== checking utility ======================
 
   # if we're not in canvas nor code passed,
   # we could check out cookies as well.
@@ -117,24 +133,37 @@ module RestGraph::RailsUtil
                  " #{rest_graph.data.inspect}")
   end
 
+  def rest_graph_check_params_signed_request
+    return if rest_graph.authorized? || !params[:signed_request]
+
+    rest_graph.parse_signed_request!(params[:signed_request])
+    logger.debug("DEBUG: RestGraph: detected signed_request, parsed:" \
+                 " #{rest_graph.data.inspect}")
+
+    if rest_graph.authorized?
+      rest_graph_write_session
+    else
+      logger.warn(
+        "WARN: RestGraph: bad signed_request: #{params[:signed_request]}")
+    end
+  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 canvas
   def rest_graph_check_params_session
-     return if rest_graph.authorized? || !params[:session]
+    return 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
+      rest_graph_write_session
     else
       logger.warn("WARN: RestGraph: bad session: #{params[:session]}")
     end
-
-    rest_graph_write_session
   end
 
   # exchange the code with access_token
@@ -148,7 +177,7 @@ module RestGraph::RailsUtil
       "#{rest_graph_normalized_request_uri}, " \
       "parsed: #{rest_graph.data.inspect}")
 
-    rest_graph_write_session
+    rest_graph_write_session if rest_graph.authorized?
   end
 
   def rest_graph_check_rails_session
@@ -159,24 +188,31 @@ module RestGraph::RailsUtil
                  " #{rest_graph.data.inspect}")
   end
 
-  # ==================== others ====================
+  # ==================== others ================================
 
   def rest_graph_write_session
-    return if !rest_graph.authorized? || !rest_graph_options[:write_session]
+    return if !rest_graph_oget(:write_session)
 
     fbs = rest_graph.data.to_a.map{ |k_v| k_v.join('=') }.join('&')
     session['fbs'] = fbs
     logger.debug("DEBUG: RestGraph: wrote session: fbs => #{fbs}")
   end
 
-  def rest_graph_log duration, url
-    logger.debug("DEBUG: RestGraph: spent #{duration} requesting #{url}")
+  def rest_graph_log event
+    message = "DEBUG: RestGraph: spent #{sprintf('%f', event.duration)} "
+    case event
+      when RestGraph::Event::Requested
+        logger.debug(message + "requesting #{event.url}")
+
+      when RestGraph::Event::CacheHit
+        logger.debug(message + "cache hit' #{event.url}")
+    end
   end
 
   def rest_graph_normalized_request_uri
     if rest_graph_in_canvas?
       "http://apps.facebook.com/" \
-      "#{rest_graph_canvas}#{request.request_uri}"
+      "#{rest_graph_oget(:canvas)}#{request.request_uri}"
     else
       request.url
     end.sub(/[\&\?]session=[^\&]+/, '').
@@ -184,21 +220,13 @@ module RestGraph::RailsUtil
   end
 
   def rest_graph_in_canvas?
-    !rest_graph_options[:canvas].empty?
-  end
-
-  def rest_graph_canvas
-    if rest_graph_options[:canvas].empty?
-      RestGraph.default_canvas
-    else
-      rest_graph_options[:canvas]
-    end
+    !rest_graph_oget(:canvas).blank?
   end
 
   def rest_graph_auto_authorize?
-    !rest_graph_options[:auto_authorize_scope  ].empty? ||
-    !rest_graph_options[:auto_authorize_options].empty? ||
-     rest_graph_options[:auto_authorize]
+    !rest_graph_oget(:auto_authorize_scope)  .blank? ||
+    !rest_graph_oget(:auto_authorize_options).blank? ||
+     rest_graph_oget(:auto_authorize)
   end
 
   def rest_graph_extract_options options, method

data/lib/rest-graph/version.rb

@@ -1,4 +1,4 @@
 
 require 'rest-graph'
 
-RestGraph::VERSION = '1.4.0'
+RestGraph::VERSION = '1.4.1'

data/rest-graph.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rest-graph}
-  s.version = "1.4.0"
+  s.version = "1.4.1"
 
   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-07-15}
+  s.date = %q{2010-07-26}
   s.description = %q{ A super simple Facebook Open Graph API client}
   s.email = %q{dev (XD) cardinalblue.com}
-  s.extra_rdoc_files = ["CHANGES", "LICENSE", "README", "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", "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/facebook_util.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.extra_rdoc_files = ["CHANGES", "Gemfile", "Gemfile.lock", "LICENSE", "README", "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", "Gemfile", "Gemfile.lock", "LICENSE", "README", "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/facebook_util.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"]
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<json>, [">= 1.4.3"])
       s.add_development_dependency(%q<rack>, [">= 1.2.1"])
       s.add_development_dependency(%q<rr>, [">= 0.10.11"])
-      s.add_development_dependency(%q<webmock>, [">= 1.3.1"])
+      s.add_development_dependency(%q<webmock>, [">= 1.3.2"])
       s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
       s.add_development_dependency(%q<bones>, [">= 3.4.7"])
     else
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<json>, [">= 1.4.3"])
       s.add_dependency(%q<rack>, [">= 1.2.1"])
       s.add_dependency(%q<rr>, [">= 0.10.11"])
-      s.add_dependency(%q<webmock>, [">= 1.3.1"])
+      s.add_dependency(%q<webmock>, [">= 1.3.2"])
       s.add_dependency(%q<bacon>, [">= 1.1.0"])
       s.add_dependency(%q<bones>, [">= 3.4.7"])
     end
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<json>, [">= 1.4.3"])
     s.add_dependency(%q<rack>, [">= 1.2.1"])
     s.add_dependency(%q<rr>, [">= 0.10.11"])
-    s.add_dependency(%q<webmock>, [">= 1.3.1"])
+    s.add_dependency(%q<webmock>, [">= 1.3.2"])
     s.add_dependency(%q<bacon>, [">= 1.1.0"])
     s.add_dependency(%q<bones>, [">= 3.4.7"])
   end

data/test/config/rest-graph.yaml

@@ -4,3 +4,4 @@ test:
   secret: <%= 'r41829'.reverse %>
   auto_decode: false
   lang: zh-tw
+  auto_authorize_scope: 'publish_stream'

data/test/test_handler.rb

@@ -8,49 +8,81 @@ end
 require 'json'
 
 describe RestGraph do
-  before do
-    @id    = lambda{ |obj| obj }
-    @error = '{"error":{"type":"Exception","message":"(#2500)"}}'
-    @error_hash = JSON.parse(@error)
-
+  after do
     reset_webmock
-    stub_request(:get, 'https://graph.facebook.com/me').
-      to_return(:body => @error)
+    RR.verify
   end
 
-  it 'would call error_handler if error occurred' do
-    RestGraph.new(:error_handler => @id).get('me').should == @error_hash
-  end
+  describe 'log handler' do
+    it 'would log whenever doing network request' do
+      stub_request(:get, 'https://graph.facebook.com/me').
+        to_return(:body => '{}')
+
+      mock(Time).now{ 666 }
+      mock(Time).now{ 999 }
+
+      logger = []
+      rg = RestGraph.new(:log_handler => lambda{ |e|
+                                           logger << [e.duration, e.url] })
+      rg.get('me')
 
-  it 'would raise ::RestGraph::Error in default error_handler' do
-    begin
-      RestGraph.new.get('me')
-    rescue ::RestGraph::Error => e
-      e.message.should == @error_hash
+      logger.last.should == [333, 'https://graph.facebook.com/me']
     end
   end
-end
 
-describe RestGraph do
-  before do
-    reset_webmock
-  end
+  describe 'with Graph API' do
+    before do
+      @id    = lambda{ |obj| obj }
+      @error = '{"error":{"type":"Exception","message":"(#2500)"}}'
+      @error_hash = JSON.parse(@error)
 
-  after do
-    RR.verify
+      stub_request(:get, 'https://graph.facebook.com/me').
+        to_return(:body => @error)
+    end
+
+    it 'would call error_handler if error occurred' do
+      RestGraph.new(:error_handler => @id).get('me').should == @error_hash
+    end
+
+    it 'would raise ::RestGraph::Error in default error_handler' do
+      begin
+        RestGraph.new.get('me')
+      rescue ::RestGraph::Error => e
+        e.message.should == @error_hash
+      end
+    end
   end
 
-  it 'would log whenever doing network request' do
-    stub_request(:get, 'https://graph.facebook.com/me').
-      to_return(:body => '{}')
+  describe 'with FQL API' do
+    # Example of an actual response (without newline)
+    # {"error_code":603,"error_msg":"Unknown table: bad_table",
+    #  "request_args":[{"key":"method","value":"fql.query"},
+    #                  {"key":"format","value":"json"},
+    #                  {"key":"query","value":
+    #                     "SELECT name FROM bad_table WHERE uid=12345"}]}
+    before do
+      @id             = lambda{ |obj| obj }
+      @fql_error      = '{"error_code":603,"error_msg":"Unknown table: bad"}'
+      @fql_error_hash = JSON.parse(@fql_error)
 
-    mock(Time).now{ 666 }
-    mock(Time).now{ 999 }
+      @bad_fql_query  = 'SELECT name FROM bad_table WHERE uid="12345"'
+      bad_fql_request = "https://api.facebook.com/method/fql.query?" \
+                        "format=json&query=#{CGI.escape(@bad_fql_query)}"
 
-    logger = []
-    rg = RestGraph.new(:log_handler => lambda{ |d, u| logger << [d, u] })
-    rg.get('me')
+      stub_request(:get, bad_fql_request).to_return(:body => @fql_error)
+    end
 
-    logger.last.should == [333, 'https://graph.facebook.com/me']
+    it 'would call error_handler if error occurred' do
+      RestGraph.new(:error_handler => @id).fql(@bad_fql_query).
+        should == @fql_error_hash
+    end
+
+    it 'would raise ::RestGraph::Error in default error_handler' do
+      begin
+        RestGraph.new.fql(@bad_fql_query)
+      rescue ::RestGraph::Error => e
+        e.message.should == @fql_error_hash
+      end
+    end
   end
 end

data/test/test_oauth.rb

@@ -7,11 +7,14 @@ end
 
 describe RestGraph do
   before do
-    reset_webmock
     @rg  = RestGraph.new(:app_id => '29', :secret => '18')
     @uri = 'http://zzz.tw'
   end
 
+  after do
+    reset_webmock
+  end
+
   it 'would return correct oauth url' do
     TestHelper.normalize_url(@rg.authorize_url(:redirect_uri => @uri)).
     should == 'https://graph.facebook.com/oauth/authorize?' \

data/test/test_old.rb

@@ -6,11 +6,8 @@ else
 end
 
 describe RestGraph do
-  before do
-    reset_webmock
-  end
-
   after do
+    reset_webmock
     RR.verify
   end
 

data/test/test_parse.rb

@@ -68,4 +68,23 @@ describe RestGraph do
       should == {'feed' => 'me', 'sig' => "20393e7823730308938a86ecf1c88b14"}
   end
 
+  it 'would parse signed_request' do
+    secret = 'aloha'
+    json   = {'ooh' => 'dir', 'moo' => 'bar'}.to_json
+    encode = lambda{ |str|
+      [str].pack('m').tr("\n=", '').tr('+/', '-_')
+    }
+    json_encoded = encode[json]
+    sig = OpenSSL::HMAC.digest('sha256', secret, json_encoded)
+    signed_request = "#{encode[sig]}.#{json_encoded}"
+
+    rg = RestGraph.new(:secret => secret)
+    rg.parse_signed_request!(signed_request)
+    rg.data['ooh'].should == 'dir'
+    rg.data['moo'].should == 'bar'
+
+    signed_request = "#{encode[sig[0..-4]+'bad']}.#{json_encoded}"
+    rg.parse_signed_request!(signed_request).should == nil
+  end
+
 end

data/test/test_rest-graph.rb

@@ -6,11 +6,8 @@ else
 end
 
 describe RestGraph do
-  before do
-    reset_webmock
-  end
-
   after do
+    reset_webmock
     RR.verify
   end
 
@@ -42,6 +39,13 @@ describe RestGraph do
       should == '?message=hi%21%21&subject=%28%26oh%26%29'
   end
 
+  it 'would generate correct url' do
+    TestHelper.normalize_url(
+    RestGraph.new(:access_token => 'awesome').url('path', :query => 'string')).
+      should ==
+        'https://graph.facebook.com/path?access_token=awesome&query=string'
+  end
+
   it 'would request to correct server' do
     stub_request(:get, 'http://nothing.godfat.org/me').with(
       :headers => {'Accept'          => 'text/plain',
@@ -113,4 +117,17 @@ describe RestGraph do
       to_return(:body => 'ok')
     RestGraph.new(:auto_decode => false).get('search', :q => o).should == 'ok'
   end
+
+  it 'would enable cache if passing cache' do
+    url, body = "https://graph.facebook.com/cache", '{"message":"ok"}'
+    stub_request(:get, url).to_return(:body => body)
+
+    cache = {}
+    rg = RestGraph.new(:cache => cache, :auto_decode => false)
+    3.times{
+      rg.get('cache').should == body
+      reset_webmock
+    }
+    cache.should == {rg.send(:cache_key, url) => body}
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rest-graph
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 1
+  version: 1.4.1
 platform: ruby
 authors: 
 - Cardinal Blue
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 +08:00
+date: 2010-08-04 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,12 +91,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 31
         segments: 
         - 1
         - 3
-        - 1
-        version: 1.3.1
+        - 2
+        version: 1.3.2
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -139,6 +139,8 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGES
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README
 - TODO
@@ -150,6 +152,8 @@ extra_rdoc_files:
 - rest-graph.gemspec
 files: 
 - CHANGES
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README
 - README.rdoc
@@ -176,7 +180,6 @@ files:
 - init.rb
 - lib/rest-graph.rb
 - lib/rest-graph/auto_load.rb
-- lib/rest-graph/facebook_util.rb
 - lib/rest-graph/load_config.rb
 - lib/rest-graph/rails_util.rb
 - lib/rest-graph/version.rb

data/lib/rest-graph/facebook_util.rb

@@ -1,27 +0,0 @@
-
-require 'rest-graph'
-
-module RestGraph::FacebookUtil
-  module_function
-  def ext_perm
-    %w[publish_stream create_event rsvp_event sms offline_access manage_pages
-       email read_insights read_stream read_mailbox ads_management xmpp_login
-       user_about_me user_activities user_birthday user_education_history
-       user_events user_groups user_hometown user_interests user_likes
-       user_location user_notes user_online_presence user_photo_video_tags
-       user_photos user_relationships user_religion_politics user_status
-       user_videos user_videos user_work_history read_friendlists read_requests
-       friends_about_me friends_activities friends_birthday
-       friends_education_history friends_events friends_groups friends_hometown
-       friends_interests friends_likes friends_location friends_notes
-       friends_online_presence friends_photo_video_tags friends_photos
-       friends_relationships friends_religion_politics friends_status
-       friends_videos friends_website friends_work_history]
-  end
-
-  def method_name
-
-  end
-end
-
-RestGraph.send(:include, RestGraph::FacebookUtil)