rest-graph 1.8.0 → 1.9.0

data/lib/rest-graph/core.rb

@@ -14,7 +14,7 @@ require 'cgi'
 require 'timeout'
 
 # the data structure used in RestGraph
-RestGraphStruct = Struct.new(:auto_decode, :strict, :timeout,
+RestGraphStruct = Struct.new(:auto_decode, :timeout,
                              :graph_server, :old_server,
                              :accept, :lang,
                              :app_id, :secret,
@@ -82,7 +82,8 @@ class RestGraph < RestGraphStruct
   Attributes.each{ |name|
     module_eval <<-RUBY
       def #{name}
-        (r = super).nil? ? (self.#{name} = self.class.default_#{name}) : r
+        if (r = super).nil? then self.#{name} = self.class.default_#{name}
+                            else r end
       end
     RUBY
   }
@@ -211,23 +212,25 @@ class RestGraph < RestGraphStruct
     "#{app_id}|#{secret}"
   end
 
-  def lighten!
+  def lighten! o={}
     [:cache, :log_method, :log_handler, :error_handler].each{ |obj|
-      send("#{obj}=", nil) }
+      send("#{obj}=", false) }
+    send(:initialize, o)
     self
   end
 
-  def lighten
-    dup.lighten!
+  def lighten o={}
+    dup.lighten!(o)
   end
 
   def inspect
-    super.gsub(/(\w+)=([^,>]+)/){ |match|
-      value = $2 == 'nil' ? self.class.send("default_#{$1}").inspect : $2
-      "#{$1}=#{value}"
-    }
+    "#<struct RestGraph #{attributes.map{ |k, v|
+      "#{k}=#{v.inspect}" }.join(', ')}>"
   end
 
+  def attributes
+    Hash[each_pair.map{ |k, v| [k, send(k)] }]
+  end
 
 
 
@@ -239,17 +242,20 @@ class RestGraph < RestGraphStruct
   end
 
   # extra options:
-  #   auto_decode: Bool # decode with json or not in this method call
+  #   auto_decode: Bool # decode with json or not in this API request
   #                     # default: auto_decode in rest-graph instance
+  #       timeout: Int  # the timeout for this API request
+  #                     # default: timeout in rest-graph instance
   #        secret: Bool # use secret_acccess_token or not
   #                     # default: false
   #         cache: Bool # use cache or not; if it's false, update cache, too
   #                     # default: true
   #    expires_in: Int  # control when would the cache be expired
-  #                     # default: nothing
+  #                     # default: nil
   #         async: Bool # use eventmachine for http client or not
   #                     # default: false, but true in aget family
   #       headers: Hash # additional hash you want to pass
+  #                     # default: {}
   def get    path, query={}, opts={}, &cb
     request(opts, [:get   , url(path, query, graph_server, opts)], &cb)
   end
@@ -299,7 +305,7 @@ class RestGraph < RestGraphStruct
 
   def next_page hash, opts={}, &cb
     if hash['paging'].kind_of?(Hash) && hash['paging']['next']
-      request(opts, [:get, hash['paging']['next']], &cb)
+      request(opts, [:get, URI.encode(hash['paging']['next'])], &cb)
     else
       yield(nil) if block_given?
     end
@@ -307,7 +313,7 @@ class RestGraph < RestGraphStruct
 
   def prev_page hash, opts={}, &cb
     if hash['paging'].kind_of?(Hash) && hash['paging']['previous']
-      request(opts, [:get, hash['paging']['previous']], &cb)
+      request(opts, [:get, URI.encode(hash['paging']['previous'])], &cb)
     else
       yield(nil) if block_given?
     end
@@ -398,24 +404,23 @@ class RestGraph < RestGraphStruct
   # old rest facebook api, i will definitely love to remove them someday
 
   def old_rest path, query={}, opts={}, &cb
-    request(
-      opts,
-      [:get,
-       url("method/#{path}", {:format => 'json'}.merge(query),
-           old_server, opts)],
-      &cb)
+    uri = url("method/#{path}", {:format => 'json'}.merge(query),
+              old_server, opts)
+    if opts[:post]
+      request(
+        opts.merge(:uri => uri),
+        [:post,
+         url("method/#{path}", {:format => 'json'}, old_server, opts),
+         query],
+        &cb)
+    else
+      request(opts, [:get, uri], &cb)
+    end
   end
 
   def secret_old_rest path, query={}, opts={}, &cb
     old_rest(path, query, {:secret => true}.merge(opts), &cb)
   end
-  alias_method :broken_old_rest, :secret_old_rest
-
-  def exchange_sessions query={}, opts={}, &cb
-    q = {:client_id => app_id, :client_secret => secret,
-         :type => 'client_cred'}.merge(query)
-    request(opts, [:post, url('oauth/exchange_sessions', q)], &cb)
-  end
 
   def fql code, query={}, opts={}, &cb
     old_rest('fql.query', {:query => code}.merge(query), opts, &cb)
@@ -426,16 +431,22 @@ class RestGraph < RestGraphStruct
       {:queries => self.class.json_encode(codes)}.merge(query), opts, &cb)
   end
 
+  def exchange_sessions query={}, opts={}, &cb
+    q = {:client_id => app_id, :client_secret => secret,
+         :type => 'client_cred'}.merge(query)
+    request(opts, [:post, url('oauth/exchange_sessions', q)], &cb)
+  end
+
 
 
 
 
   def request opts, *reqs, &cb
-    Timeout.timeout(timeout){
+    Timeout.timeout(opts[:timeout] || timeout){
       reqs.each{ |(meth, uri, payload)|
-        next if meth != :get
-        cache_assign(uri, nil)
-      } if opts[:cache] == false
+        next if meth != :get     # only get result would get cached
+        cache_assign(opts, uri, nil)
+      } if opts[:cache] == false # remove cache if we don't want it
 
       if opts[:async]
         request_em(opts, reqs, &cb)
@@ -449,8 +460,9 @@ class RestGraph < RestGraphStruct
   def request_em opts, reqs
     start_time = Time.now
     rs = reqs.map{ |(meth, uri, payload)|
-      r = EM::HttpRequest.new(uri).send(meth, :body => payload)
-      if cached = cache_get(uri)
+      r = EM::HttpRequest.new(uri).send(meth, :body => payload,
+                                              :head => build_headers(opts))
+      if cached = cache_get(opts, uri)
         # TODO: this is hack!!
         r.instance_variable_set('@response', cached)
         r.instance_variable_set('@state'   , :finish)
@@ -458,7 +470,7 @@ class RestGraph < RestGraphStruct
         r.succeed(r)
       else
         r.callback{
-          cache_for(uri, r.response, meth, opts)
+          cache_for(opts, uri, meth, r.response)
           log(Event::Requested.new(Time.now - start_time, uri))
         }
         r.error{
@@ -471,7 +483,7 @@ class RestGraph < RestGraphStruct
       # TODO: how to deal with the failed?
       clients = m.responses[:succeeded]
       results = clients.map{ |client|
-        post_request(client.response, client.uri, opts)
+        post_request(opts, client.uri, client.response)
       }
 
       if reqs.size == 1
@@ -486,10 +498,11 @@ class RestGraph < RestGraphStruct
 
   def request_rc opts, meth, uri, payload=nil, &cb
     start_time = Time.now
-    post_request(cache_get(uri) || fetch(meth, uri, payload, opts),
-                 uri, opts, &cb)
+    post_request(opts, uri,
+                 cache_get(opts, uri) || fetch(opts, uri, meth, payload),
+                 &cb)
   rescue RestClient::Exception => e
-    post_request(e.http_body, uri, opts, &cb)
+    post_request(opts, uri, e.http_body, &cb)
   ensure
     log(Event::Requested.new(Time.now - start_time, uri))
   end
@@ -509,11 +522,11 @@ class RestGraph < RestGraphStruct
     headers.merge(opts[:headers] || {})
   end
 
-  def post_request result, uri, opts, &cb
+  def post_request opts, uri, result, &cb
     if decode?(opts)
                                   # [this].first is not needed for yajl-ruby
       decoded = self.class.json_decode("[#{result}]").first
-      check_error(decoded, uri, &cb)
+      check_error(opts, uri, decoded, &cb)
     else
       block_given? ? yield(result) : result
     end
@@ -524,8 +537,6 @@ class RestGraph < RestGraphStruct
   def decode? opts
     if opts.has_key?(:auto_decode)
       opts[:auto_decode]
-    elsif opts.has_key?(:suppress_decode)
-      !opts[:suppress_decode]
     else
       auto_decode
     end
@@ -539,11 +550,11 @@ class RestGraph < RestGraphStruct
                          end == cookies['sig']
   end
 
-  def check_error hash, uri
+  def check_error opts, uri, hash
     if error_handler && hash.kind_of?(Hash) &&
        (hash['error'] ||    # from graph api
         hash['error_code']) # from fql
-      cache_assign(uri, nil)
+      cache_assign(opts, uri, nil)
       error_handler.call(hash, uri)
     else
       block_given? ? yield(hash) : hash
@@ -558,38 +569,41 @@ class RestGraph < RestGraphStruct
     cookies.reject{ |(k, v)| k == 'sig' }.sort.map{ |a| a.join('=') }
   end
 
-  def cache_assign uri, value
-    return unless cache
-    cache[cache_key(uri)] = value
+  def cache_key opts, uri
+    Digest::MD5.hexdigest(opts[:uri] || uri)
   end
 
-  def cache_key uri
-    Digest::MD5.hexdigest(uri)
+  def cache_assign opts, uri, value
+    return unless cache
+    cache[cache_key(opts, uri)] = value
   end
 
-  def cache_get uri
+  def cache_get opts, uri
     return unless cache
     start_time = Time.now
-    cache[cache_key(uri)].tap{ |result|
+    cache[cache_key(opts, uri)].tap{ |result|
       log(Event::CacheHit.new(Time.now - start_time, uri)) if result
     }
   end
 
-  def cache_for uri, result, meth, opts
-    return if !cache || meth != :get
+  def cache_for opts, uri, meth, value
+    return unless cache
+    # fake post (opts[:post] => true) is considered get and need cache
+    return if meth != :get unless opts[:post]
 
     if opts[:expires_in].kind_of?(Fixnum) && cache.method(:store).arity == -3
-      cache.store(cache_key(uri), result, :expires_in => opts[:expires_in])
+      cache.store(cache_key(opts, uri), value,
+                  :expires_in => opts[:expires_in])
     else
-      cache_assign(uri, result)
+      cache_assign(opts, uri, value)
     end
   end
 
-  def fetch meth, uri, payload, opts
+  def fetch opts, uri, meth, payload
     RestClient::Request.execute(:method => meth, :url => uri,
                                 :headers => build_headers(opts),
                                 :payload => payload).body.
-      tap{ |result| cache_for(uri, result, meth, opts) }
+      tap{ |result| cache_for(opts, uri, meth, result) }
   end
 
   def merge_data lhs, rhs

data/lib/rest-graph/rails_util.rb

@@ -59,7 +59,7 @@ module RestGraph::RailsUtil
     return if controller.respond_to?(:rest_graph, true)
 
     controller.rescue_from(RestGraph::Error::AccessToken,
-                           :with => :rest_graph_on_error)
+                           :with => :rest_graph_on_access_token_error)
     controller.helper(RestGraph::RailsUtil::Helper)
     controller.instance_methods.select{ |method|
       method.to_s =~ /^rest_graph/
@@ -103,9 +103,11 @@ module RestGraph::RailsUtil
     @rest_graph ||= RestGraph.new(rest_graph_options_new)
   end
 
-  def rest_graph_on_error error=nil
+  def rest_graph_on_access_token_error error=nil
     rest_graph_authorize(error, false)
   end
+  alias_method :rest_graph_on_error, # backward compatibility
+               :rest_graph_on_access_token_error
 
   def rest_graph_authorize error=nil, force_redirect=true
     logger.warn("WARN: RestGraph: #{error.inspect}")

data/lib/rest-graph/test_util.rb

@@ -14,19 +14,25 @@ module RestGraph::TestUtil
     any_instance_of(RestGraph){ |rg|
       stub(rg).data{default_data}
 
-      stub(rg).fetch{ |meth, uri, payload|
+      stub(rg).fetch{ |opts, uri, meth, payload|
         history << [meth, uri, payload]
         http     = 'https?://[\w\d]+(\.[\w\d]+)+/'
         response = case uri
                      when %r{#{http}method/fql.multiquery}
                        RestGraph.json_decode(
                          Rack::Utils.parse_query(
-                           URI.parse(uri).query)['queries']).keys.map{ |q|
-                             {'name' => q,
-                               'fql_result_set' => [default_response]}
-                           }
-                     when %r{#{http}method/\w+\.\w+}
-                       [default_response]
+                           URI.parse(opts[:uri] || uri).query)['queries']).
+                             keys.map{ |q|
+                               {'name' => q,
+                                'fql_result_set' => [default_response]}
+                             }
+                     when %r{#{http}method/(\w+\.\w+)}
+                       case $2
+                         when 'friends.getAppUsers'
+                           [5678]
+                         else
+                           [default_response]
+                       end
                      else
                        default_response
                    end

data/lib/rest-graph/version.rb

@@ -1,4 +1,4 @@
 
 require 'rest-graph/core'
 
-RestGraph::VERSION = '1.8.0'
+RestGraph::VERSION = '1.9.0'

data/rest-graph.gemspec

@@ -2,21 +2,132 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rest-graph}
-  s.version = "1.8.0"
+  s.version = "1.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Cardinal Blue", "Lin Jen-Shin (godfat)"]
-  s.date = %q{2011-03-08}
+  s.authors = [
+  %q{Cardinal Blue},
+  %q{Lin Jen-Shin (godfat)}]
+  s.date = %q{2011-05-26}
   s.description = %q{A lightweight Facebook Graph API client}
-  s.email = ["dev (XD) cardinalblue.com"]
-  s.extra_rdoc_files = ["CHANGES", "CONTRIBUTORS", "LICENSE", "TODO"]
-  s.files = [".gitignore", "CHANGES", "CONTRIBUTORS", "Gemfile", "LICENSE", "README", "README.md", "Rakefile", "TODO", "doc/ToC.md", "doc/dependency.md", "doc/design.md", "doc/rails.md", "doc/test.md", "doc/tutorial.md", "example/multi/config.ru", "example/multi/rainbows.rb", "example/rails2/Gemfile", "example/rails2/Gemfile.lock", "example/rails2/README", "example/rails2/Rakefile", "example/rails2/app/controllers/application_controller.rb", "example/rails2/app/views/application/helper.html.erb", "example/rails2/config/boot.rb", "example/rails2/config/environment.rb", "example/rails2/config/environments/development.rb", "example/rails2/config/environments/production.rb", "example/rails2/config/environments/test.rb", "example/rails2/config/initializers/cookie_verification_secret.rb", "example/rails2/config/initializers/new_rails_defaults.rb", "example/rails2/config/initializers/session_store.rb", "example/rails2/config/preinitializer.rb", "example/rails2/config/rest-graph.yaml", "example/rails2/config/routes.rb", "example/rails2/log", "example/rails2/test/functional/application_controller_test.rb", "example/rails2/test/test_helper.rb", "example/rails2/test/unit/rails_util_test.rb", "example/rails3/Gemfile", "example/rails3/Gemfile.lock", "example/rails3/Rakefile", "example/rails3/app/controllers/application_controller.rb", "example/rails3/app/views/application/helper.html.erb", "example/rails3/config.ru", "example/rails3/config/application.rb", "example/rails3/config/environment.rb", "example/rails3/config/environments/development.rb", "example/rails3/config/environments/production.rb", "example/rails3/config/environments/test.rb", "example/rails3/config/initializers/secret_token.rb", "example/rails3/config/initializers/session_store.rb", "example/rails3/config/rest-graph.yaml", "example/rails3/config/routes.rb", "example/rails3/test/functional/application_controller_test.rb", "example/rails3/test/test_helper.rb", "example/rails3/test/unit/rails_util_test.rb", "init.rb", "lib/rest-graph.rb", "lib/rest-graph/auto_load.rb", "lib/rest-graph/autoload.rb", "lib/rest-graph/config_util.rb", "lib/rest-graph/core.rb", "lib/rest-graph/facebook_util.rb", "lib/rest-graph/rails_util.rb", "lib/rest-graph/test_util.rb", "lib/rest-graph/version.rb", "rest-graph.gemspec", "task/gemgem.rb", "test/common.rb", "test/config/rest-graph.yaml", "test/test_api.rb", "test/test_cache.rb", "test/test_default.rb", "test/test_error.rb", "test/test_facebook.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_misc.rb", "test/test_multi.rb", "test/test_oauth.rb", "test/test_old.rb", "test/test_page.rb", "test/test_parse.rb", "test/test_rest-graph.rb", "test/test_serialize.rb", "test/test_test_util.rb", "test/test_timeout.rb"]
-  s.homepage = %q{http://github.com/godfat/}
-  s.rdoc_options = ["--main", "README"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.1}
+  s.email = [%q{dev (XD) cardinalblue.com}]
+  s.extra_rdoc_files = [
+  %q{CHANGES},
+  %q{CONTRIBUTORS},
+  %q{LICENSE},
+  %q{TODO}]
+  s.files = [
+  %q{.gitignore},
+  %q{.gitmodules},
+  %q{CHANGES},
+  %q{CONTRIBUTORS},
+  %q{Gemfile},
+  %q{LICENSE},
+  %q{README},
+  %q{README.md},
+  %q{Rakefile},
+  %q{TODO},
+  %q{doc/ToC.md},
+  %q{doc/dependency.md},
+  %q{doc/design.md},
+  %q{doc/heroku-facebook.md},
+  %q{doc/rails.md},
+  %q{doc/test.md},
+  %q{doc/tutorial.md},
+  %q{example/multi/config.ru},
+  %q{example/multi/rainbows.rb},
+  %q{example/rails2/Gemfile},
+  %q{example/rails2/README},
+  %q{example/rails2/Rakefile},
+  %q{example/rails2/app/controllers/application_controller.rb},
+  %q{example/rails2/app/views/application/helper.html.erb},
+  %q{example/rails2/config/boot.rb},
+  %q{example/rails2/config/environment.rb},
+  %q{example/rails2/config/environments/development.rb},
+  %q{example/rails2/config/environments/production.rb},
+  %q{example/rails2/config/environments/test.rb},
+  %q{example/rails2/config/initializers/cookie_verification_secret.rb},
+  %q{example/rails2/config/initializers/new_rails_defaults.rb},
+  %q{example/rails2/config/initializers/session_store.rb},
+  %q{example/rails2/config/preinitializer.rb},
+  %q{example/rails2/config/rest-graph.yaml},
+  %q{example/rails2/config/routes.rb},
+  %q{example/rails2/log},
+  %q{example/rails2/test/functional/application_controller_test.rb},
+  %q{example/rails2/test/test_helper.rb},
+  %q{example/rails2/test/unit/rails_util_test.rb},
+  %q{example/rails3/Gemfile},
+  %q{example/rails3/Rakefile},
+  %q{example/rails3/app/controllers/application_controller.rb},
+  %q{example/rails3/app/views/application/helper.html.erb},
+  %q{example/rails3/config.ru},
+  %q{example/rails3/config/application.rb},
+  %q{example/rails3/config/environment.rb},
+  %q{example/rails3/config/environments/development.rb},
+  %q{example/rails3/config/environments/production.rb},
+  %q{example/rails3/config/environments/test.rb},
+  %q{example/rails3/config/initializers/secret_token.rb},
+  %q{example/rails3/config/initializers/session_store.rb},
+  %q{example/rails3/config/rest-graph.yaml},
+  %q{example/rails3/config/routes.rb},
+  %q{example/rails3/test/functional/application_controller_test.rb},
+  %q{example/rails3/test/test_helper.rb},
+  %q{example/rails3/test/unit/rails_util_test.rb},
+  %q{example/sinatra/config.ru},
+  %q{init.rb},
+  %q{lib/rest-graph.rb},
+  %q{lib/rest-graph/config_util.rb},
+  %q{lib/rest-graph/core.rb},
+  %q{lib/rest-graph/facebook_util.rb},
+  %q{lib/rest-graph/rails_util.rb},
+  %q{lib/rest-graph/test_util.rb},
+  %q{lib/rest-graph/version.rb},
+  %q{rest-graph.gemspec},
+  %q{task/gemgem.rb},
+  %q{test/common.rb},
+  %q{test/config/rest-graph.yaml},
+  %q{test/test_api.rb},
+  %q{test/test_cache.rb},
+  %q{test/test_default.rb},
+  %q{test/test_error.rb},
+  %q{test/test_facebook.rb},
+  %q{test/test_handler.rb},
+  %q{test/test_load_config.rb},
+  %q{test/test_misc.rb},
+  %q{test/test_multi.rb},
+  %q{test/test_oauth.rb},
+  %q{test/test_old.rb},
+  %q{test/test_page.rb},
+  %q{test/test_parse.rb},
+  %q{test/test_rest-graph.rb},
+  %q{test/test_serialize.rb},
+  %q{test/test_test_util.rb},
+  %q{test/test_timeout.rb}]
+  s.homepage = %q{https://github.com/godfat/}
+  s.rdoc_options = [
+  %q{--main},
+  %q{README}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.4}
   s.summary = %q{A lightweight Facebook Graph API client}
-  s.test_files = ["test/test_api.rb", "test/test_cache.rb", "test/test_default.rb", "test/test_error.rb", "test/test_facebook.rb", "test/test_handler.rb", "test/test_load_config.rb", "test/test_misc.rb", "test/test_multi.rb", "test/test_oauth.rb", "test/test_old.rb", "test/test_page.rb", "test/test_parse.rb", "test/test_rest-graph.rb", "test/test_serialize.rb", "test/test_test_util.rb", "test/test_timeout.rb"]
+  s.test_files = [
+  %q{test/test_api.rb},
+  %q{test/test_cache.rb},
+  %q{test/test_default.rb},
+  %q{test/test_error.rb},
+  %q{test/test_facebook.rb},
+  %q{test/test_handler.rb},
+  %q{test/test_load_config.rb},
+  %q{test/test_misc.rb},
+  %q{test/test_multi.rb},
+  %q{test/test_oauth.rb},
+  %q{test/test_old.rb},
+  %q{test/test_page.rb},
+  %q{test/test_parse.rb},
+  %q{test/test_rest-graph.rb},
+  %q{test/test_serialize.rb},
+  %q{test/test_test_util.rb},
+  %q{test/test_timeout.rb}]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3