rest-graph 1.4.5 → 1.4.6

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

@@ -111,7 +111,7 @@ class ApplicationControllerTest < ActionController::TestCase
     stub_request(:get, 'https://graph.facebook.com/me?access_token=wozilla').
       to_return(:body => '["fireball"]')
 
-    @request.session['rest_graph_session'] =
+    @request.session[RestGraph::RailsUtil.rest_graph_storage_key] =
       RestGraph.new(:access_token => 'wozilla').fbs
 
     get(:session_)
@@ -124,7 +124,7 @@ class ApplicationControllerTest < ActionController::TestCase
     stub_request(:get, 'https://graph.facebook.com/me?access_token=blizzard').
       to_return(:body => '["yeti"]')
 
-    @request.cookies['rest_graph_cookies'] =
+    @request.cookies[RestGraph::RailsUtil.rest_graph_storage_key] =
       RestGraph.new(:access_token => 'blizzard').fbs
 
     get(:cookies_)

data/lib/rest-graph.rb

@@ -13,15 +13,6 @@ begin
   require 'rack'
 rescue LoadError; end
 
-# pick a json gem if available
-%w[ yajl/json_gem json json_pure ].each{ |json|
-  begin
-    require json
-    break
-  rescue LoadError
-  end
-}
-
 # the data structure used in RestGraph
 RestGraphStruct = Struct.new(:auto_decode,
                              :graph_server, :old_server,
@@ -32,6 +23,73 @@ RestGraphStruct = Struct.new(:auto_decode,
                              :log_handler) unless defined?(RestGraphStruct)
 
 class RestGraph < RestGraphStruct
+
+  # begin json backend adapter
+  module YajlRuby
+    def self.extended mod
+      mod.const_set(:ParseError, Yajl::ParseError)
+    end
+    def json_encode hash
+      Yajl::Encoder.encode(hash)
+    end
+    def json_decode json
+      Yajl::Parser.parse(json)
+    end
+  end
+
+  module Json
+    def self.extended mod
+      mod.const_set(:ParseError, JSON::ParserError)
+    end
+    def json_encode hash
+      JSON.dump(hash)
+    end
+    def json_decode json
+      JSON.parse(json)
+    end
+  end
+
+  module Gsub
+    class ParseError < RuntimeError; end
+    def self.extended mod
+      mod.const_set(:ParseError, Gsub::ParseError)
+    end
+
+    # only works for flat hash
+    def json_encode hash
+      middle = hash.inject([]){ |r, (k, v)|
+                 r << "\"#{k}\":\"#{v.gsub('"','\\"')}\""
+               }.join(',')
+      "{#{middle}}"
+    end
+    def json_decode
+      raise NotImplementedError.new(
+        'You need to install either yajl-ruby, json, or json_pure gem')
+    end
+  end
+
+  def self.select_json! picked=false
+    if    defined?(::Yajl)
+      extend YajlRuby
+    elsif defined?(::JSON)
+      extend Json
+    elsif picked
+      extend Gsub
+    else
+      # pick a json gem if available
+      %w[yajl json].each{ |json|
+        begin
+          require json
+          break
+        rescue LoadError
+        end
+      }
+      select_json!(true)
+    end
+  end
+  select_json!
+  #   end json backend adapter
+
   class Error < RuntimeError; end
   class Event < Struct.new(:duration, :url); end
   class Event::Requested < Event; end
@@ -69,6 +127,12 @@ class RestGraph < RestGraphStruct
   end
   extend DefaultAttributes
 
+
+
+
+
+  # common methods
+
   def initialize o={}
     (Attributes + [:access_token]).each{ |name|
       send("#{name}=", o[name]) if o.key?(name)
@@ -87,6 +151,21 @@ class RestGraph < RestGraphStruct
     !!access_token
   end
 
+  def lighten!
+    [:cache, :error_handler, :log_handler].each{ |obj| send("#{obj}=", nil) }
+    self
+  end
+
+  def lighten
+    dup.lighten!
+  end
+
+
+
+
+
+  # graph api related methods
+
   def url path, query={}, server=graph_server
     "#{server}#{path}#{build_query_string(query)}"
   end
@@ -107,6 +186,10 @@ class RestGraph < RestGraphStruct
     request(:put   , url(path, query, graph_server), opts, payload)
   end
 
+
+
+
+
   # cookies, app_id, secrect related below
 
   def parse_rack_env! env
@@ -126,8 +209,8 @@ class RestGraph < RestGraphStruct
 
   def parse_json! json
     self.data = json &&
-      check_sig_and_return_data(JSON.parse(json))
-  rescue JSON::ParserError
+      check_sig_and_return_data(self.class.json_decode(json))
+  rescue ParseError
   end
 
   def fbs
@@ -141,11 +224,15 @@ class RestGraph < RestGraphStruct
     sig,  json = [sig_encoded, json_encoded].map{ |str|
       "#{str.tr('-_', '+/')}==".unpack('m').first
     }
-    self.data = JSON.parse(json) if
+    self.data = self.class.json_decode(json) if
       secret && OpenSSL::HMAC.digest('sha256', secret, json_encoded) == sig
-  rescue JSON::ParserError
+  rescue ParseError
   end
 
+
+
+
+
   # oauth related
 
   def authorize_url opts={}
@@ -160,6 +247,10 @@ class RestGraph < RestGraphStruct
                           :suppress_decode => true))
   end
 
+
+
+
+
   # old rest facebook api, i will definitely love to remove them someday
 
   def old_rest path, query={}, opts={}
@@ -180,17 +271,14 @@ class RestGraph < RestGraphStruct
   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)
+    old_rest('fql.multiquery',
+      {:queries => self.class.json_encode(codes)}.merge(query), opts)
   end
 
+
+
+
+
   private
   def request meth, uri, opts={}, payload=nil
     start_time = Time.now
@@ -218,7 +306,7 @@ class RestGraph < RestGraphStruct
 
   def post_request result, suppress_decode=nil
     if auto_decode && !suppress_decode
-      check_error(JSON.parse(result))
+      check_error(self.class.json_decode(result))
     else
       result
     end
@@ -262,9 +350,9 @@ class RestGraph < RestGraphStruct
   def fetch meth, uri, payload
     RestClient::Request.execute(:method => meth, :url => uri,
                                 :headers => build_headers,
-                                :payload => payload).
+                                :payload => payload).body.
       tap{ |result|
-        cache[cache_key(uri)] = result if cache
+        cache[cache_key(uri)] = result if cache && meth == :get
       }
   end
 end

data/lib/rest-graph/rails_util.rb

@@ -8,6 +8,7 @@ class RestGraph
     def default_auto_authorize        ; false; end
     def default_auto_authorize_options; {}   ; end
     def default_auto_authorize_scope  ; ''   ; end
+    def default_ensure_authorized     ; false; end
     def default_write_session         ; false; end
     def default_write_cookies         ; false; end
     def default_write_handler         ;   nil; end
@@ -30,9 +31,7 @@ module RestGraph::RailsUtil
   end
 
   def self.included controller
-    controller.rescue_from(::RestGraph::Error){ |exception|
-      logger.debug("DEBUG: RestGraph: action halt")
-    }
+    controller.rescue_from(::RestGraph::Error, :with => :rest_graph_on_error)
     controller.helper(::RestGraph::RailsUtil::Helper)
   end
 
@@ -51,7 +50,15 @@ module RestGraph::RailsUtil
     # before, in that case, the fbs would be inside session,
     # as we just saved it there
 
-    rest_graph_check_rg_fbs
+    rest_graph_check_rg_fbs # check rest-graph storage
+
+    if rest_graph_oget(:ensure_authorized) && !rest_graph.authorized?
+      rest_graph_authorize('ensure authorized')
+      false # action halt, redirect to do authorize,
+            # eagerly, as opposed to auto_authorize
+    else
+      true  # keep going
+    end
   end
 
   # override this if you need different app_id and secret
@@ -59,10 +66,14 @@ module RestGraph::RailsUtil
     @rest_graph ||= RestGraph.new(rest_graph_options_new)
   end
 
-  def rest_graph_authorize error=nil, redirect=false
+  def rest_graph_on_error error=nil
+    rest_graph_authorize(error, false)
+  end
+
+  def rest_graph_authorize error=nil, force_redirect=true
     logger.warn("WARN: RestGraph: #{error.inspect}")
 
-    if redirect || rest_graph_auto_authorize?
+    if force_redirect || rest_graph_auto_authorize?
       @rest_graph_authorize_url = rest_graph.authorize_url(
         {:redirect_uri => rest_graph_normalized_request_uri,
          :scope        => rest_graph_oget(:auto_authorize_scope)}.
@@ -72,8 +83,6 @@ module RestGraph::RailsUtil
 
       rest_graph_authorize_redirect
     end
-
-    raise ::RestGraph::Error.new(error)
   end
 
   # override this if you want the simple redirect_to
@@ -125,9 +134,7 @@ module RestGraph::RailsUtil
   end
 
   def rest_graph_options_new
-    @rest_graph_options_new ||=
-      {:error_handler => method(:rest_graph_authorize),
-         :log_handler => method(:rest_graph_log)}
+    @rest_graph_options_new ||= {:log_handler => method(:rest_graph_log)}
   end
   # ==================== end options utility =======================
 
@@ -196,29 +203,35 @@ module RestGraph::RailsUtil
 
 
   # ==================== begin check ================================
+  def rest_graph_storage_key
+    "rest_graph_fbs_#{rest_graph_oget(:app_id)}"
+  end
+
   def rest_graph_check_rg_fbs
     rest_graph_check_rg_handler # custom method to store fbs
     rest_graph_check_rg_session # prefered way to store fbs
     rest_graph_check_rg_cookies # in canvas, session might not work..
   end
 
-  def rest_graph_check_rg_handler
-    return if rest_graph.authorized? || !rest_graph_oget(:check_handler)
-    rest_graph.parse_fbs!(rest_graph_oget(:check_handler).call)
+  def rest_graph_check_rg_handler handler=rest_graph_oget(:check_handler)
+    return if rest_graph.authorized? || !handler
+    rest_graph.parse_fbs!(handler.call)
     logger.debug("DEBUG: RestGraph: called check_handler, parsed:" \
                  " #{rest_graph.data.inspect}")
   end
 
   def rest_graph_check_rg_session
-    return if rest_graph.authorized? || !session[:rest_graph_session]
-    rest_graph.parse_fbs!(session[:rest_graph_session])
+    return if rest_graph.authorized? ||
+              !(fbs = session[rest_graph_storage_key])
+    rest_graph.parse_fbs!(fbs)
     logger.debug("DEBUG: RestGraph: detected rest-graph session, parsed:" \
                  " #{rest_graph.data.inspect}")
   end
 
   def rest_graph_check_rg_cookies
-    return if rest_graph.authorized? || !cookies[:rest_graph_cookies]
-    rest_graph.parse_fbs!(cookies[:rest_graph_cookies])
+    return if rest_graph.authorized? ||
+              !(fbs = cookies[rest_graph_storage_key])
+    rest_graph.parse_fbs!(fbs)
     logger.debug("DEBUG: RestGraph: detected rest-graph cookies, parsed:" \
                  " #{rest_graph.data.inspect}")
   end
@@ -230,24 +243,21 @@ module RestGraph::RailsUtil
     rest_graph_write_rg_cookies
   end
 
-  def rest_graph_write_rg_handler
-    return if !rest_graph_oget(:write_handler)
-    fbs = rest_graph.fbs
-    rest_graph_oget(:write_handler).call(fbs)
+  def rest_graph_write_rg_handler handler=rest_graph_oget(:write_handler)
+    return if !handler
+    handler.call(fbs = rest_graph.fbs)
     logger.debug("DEBUG: RestGraph: called write_handler: fbs => #{fbs}")
   end
 
   def rest_graph_write_rg_session
     return if !rest_graph_oget(:write_session)
-    fbs = rest_graph.fbs
-    session[:rest_graph_session] = fbs
+    session[rest_graph_storage_key] = fbs = rest_graph.fbs
     logger.debug("DEBUG: RestGraph: wrote session: fbs => #{fbs}")
   end
 
   def rest_graph_write_rg_cookies
     return if !rest_graph_oget(:write_cookies)
-    fbs = rest_graph.fbs
-    cookies[:rest_graph_cookies] = fbs
+    cookies[rest_graph_storage_key] = fbs = rest_graph.fbs
     logger.debug("DEBUG: RestGraph: wrote cookies: fbs => #{fbs}")
   end
   # ==================== end write ================================

data/lib/rest-graph/version.rb

@@ -1,4 +1,4 @@
 
 require 'rest-graph'
 
-RestGraph::VERSION = '1.4.5'
+RestGraph::VERSION = '1.4.6'

data/rest-graph.gemspec

@@ -2,50 +2,56 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rest-graph}
-  s.version = "1.4.1"
+  s.version = "1.4.6"
 
   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-26}
-  s.description = %q{ A super simple Facebook Open Graph API client}
+  s.date = %q{2010-09-01}
+  s.description = %q{A super simple Facebook Open Graph API client}
   s.email = %q{dev (XD) cardinalblue.com}
-  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.extra_rdoc_files = ["CHANGES", "CONTRIBUTORS", "Gemfile", "Gemfile.lock", "LICENSE", "README", "TODO", "rest-graph.gemspec"]
+  s.files = ["CHANGES", "CONTRIBUTORS", "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", "example/rails/test/unit/rails_util_test.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_access_token.rb", "test/test_api.rb", "test/test_cache.rb", "test/test_default.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_misc.rb", "test/test_oauth.rb", "test/test_old.rb", "test/test_parse.rb", "test/test_serialize.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_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.test_files = ["test/test_access_token.rb", "test/test_api.rb", "test/test_cache.rb", "test/test_default.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_misc.rb", "test/test_oauth.rb", "test/test_old.rb", "test/test_parse.rb", "test/test_serialize.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.0"])
-      s.add_development_dependency(%q<json>, [">= 1.4.3"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.1"])
+      s.add_development_dependency(%q<yajl-ruby>, [">= 0.7.7"])
+      s.add_development_dependency(%q<json>, [">= 1.4.6"])
+      s.add_development_dependency(%q<json_pure>, [">= 1.4.6"])
       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.2"])
+      s.add_development_dependency(%q<rr>, [">= 1.0.0"])
+      s.add_development_dependency(%q<webmock>, [">= 1.3.4"])
       s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
       s.add_development_dependency(%q<bones>, [">= 3.4.7"])
     else
-      s.add_dependency(%q<rest-client>, [">= 1.6.0"])
-      s.add_dependency(%q<json>, [">= 1.4.3"])
+      s.add_dependency(%q<rest-client>, [">= 1.6.1"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0.7.7"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+      s.add_dependency(%q<json_pure>, [">= 1.4.6"])
       s.add_dependency(%q<rack>, [">= 1.2.1"])
-      s.add_dependency(%q<rr>, [">= 0.10.11"])
-      s.add_dependency(%q<webmock>, [">= 1.3.2"])
+      s.add_dependency(%q<rr>, [">= 1.0.0"])
+      s.add_dependency(%q<webmock>, [">= 1.3.4"])
       s.add_dependency(%q<bacon>, [">= 1.1.0"])
       s.add_dependency(%q<bones>, [">= 3.4.7"])
     end
   else
-    s.add_dependency(%q<rest-client>, [">= 1.6.0"])
-    s.add_dependency(%q<json>, [">= 1.4.3"])
+    s.add_dependency(%q<rest-client>, [">= 1.6.1"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0.7.7"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+    s.add_dependency(%q<json_pure>, [">= 1.4.6"])
     s.add_dependency(%q<rack>, [">= 1.2.1"])
-    s.add_dependency(%q<rr>, [">= 0.10.11"])
-    s.add_dependency(%q<webmock>, [">= 1.3.2"])
+    s.add_dependency(%q<rr>, [">= 1.0.0"])
+    s.add_dependency(%q<webmock>, [">= 1.3.4"])
     s.add_dependency(%q<bacon>, [">= 1.1.0"])
     s.add_dependency(%q<bones>, [">= 3.4.7"])
   end