rest-graph 1.1.1 → 1.2.0

data/lib/rest-graph/version.rb

@@ -1,6 +1,4 @@
 
 require 'rest-graph'
 
-class RestGraph < RestGraphStruct
-  VERSION = '1.1.1'
-end
+RestGraph::VERSION = '1.2.0'

data/rest-graph.gemspec

@@ -2,51 +2,53 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rest-graph}
-  s.version = "1.1.0"
+  s.version = "1.2.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-05-11}
-  s.description = %q{ super simple facebook open graph api client}
-  s.email = %q{godfat (XD) cardinalblue.com}
-  s.extra_rdoc_files = ["CHANGES", "LICENSE", "README", "TODO", "bench/config.ru"]
-  s.files = ["CHANGES", "LICENSE", "README", "Rakefile", "TODO", "bench/config.ru", "init.rb", "lib/rest-graph.rb", "lib/rest-graph/load_config.rb", "lib/rest-graph/version.rb", "test/common.rb", "test/config/rest-graph.yaml", "test/test_load_config.rb", "test/test_rest-graph.rb"]
+  s.date = %q{2010-05-28}
+  s.description = %q{ A super simple Facebook Open Graph API client
+ If you feel SYNOPSIS is so hard to understand, please read
+ {examples}[http://github.com/cardinalblue/rest-graph/tree/master/example].}
+  s.email = %q{dev (XD) cardinalblue.com}
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "TODO", "example/rails/README", "example/rails/app/views/rest-graph.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.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_controller.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.homepage = %q{http://github.com/cardinalblue/rest-graph}
-  s.rdoc_options = ["--main", "README"]
+  s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{rest-graph}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{super simple facebook open graph api client}
-  s.test_files = ["test/test_load_config.rb", "test/test_rest-graph.rb"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A super simple Facebook Open Graph API client If you feel SYNOPSIS is so hard to understand, please read {examples}[http://github}
+  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"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rest-client>, [">= 1.5.0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.5.1"])
       s.add_development_dependency(%q<json>, [">= 1.4.3"])
       s.add_development_dependency(%q<rack>, [">= 1.1.0"])
       s.add_development_dependency(%q<rr>, [">= 0.10.11"])
-      s.add_development_dependency(%q<webmock>, [">= 1.1.0"])
+      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.1"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.3"])
     else
-      s.add_dependency(%q<rest-client>, [">= 1.5.0"])
+      s.add_dependency(%q<rest-client>, [">= 1.5.1"])
       s.add_dependency(%q<json>, [">= 1.4.3"])
       s.add_dependency(%q<rack>, [">= 1.1.0"])
       s.add_dependency(%q<rr>, [">= 0.10.11"])
-      s.add_dependency(%q<webmock>, [">= 1.1.0"])
+      s.add_dependency(%q<webmock>, [">= 1.2.2"])
       s.add_dependency(%q<bacon>, [">= 1.1.0"])
-      s.add_dependency(%q<bones>, [">= 3.4.1"])
+      s.add_dependency(%q<bones>, [">= 3.4.3"])
     end
   else
-    s.add_dependency(%q<rest-client>, [">= 1.5.0"])
+    s.add_dependency(%q<rest-client>, [">= 1.5.1"])
     s.add_dependency(%q<json>, [">= 1.4.3"])
     s.add_dependency(%q<rack>, [">= 1.1.0"])
     s.add_dependency(%q<rr>, [">= 0.10.11"])
-    s.add_dependency(%q<webmock>, [">= 1.1.0"])
+    s.add_dependency(%q<webmock>, [">= 1.2.2"])
     s.add_dependency(%q<bacon>, [">= 1.1.0"])
-    s.add_dependency(%q<bones>, [">= 3.4.1"])
+    s.add_dependency(%q<bones>, [">= 3.4.3"])
   end
 end

data/test/common.rb

@@ -20,7 +20,7 @@ module TestHelper
   ensure # the defaults should remain the same!
     RestGraph.send(:extend, RestGraph::DefaultAttributes.dup)
 
-    RestGraph::Attributes.each{ |name|
+    TestHelper.attrs_no_callback.each{ |name|
       RestGraph.new.send(name).should ==
         RestGraph::DefaultAttributes.send("default_#{name}")
     }
@@ -33,4 +33,10 @@ module TestHelper
   def normalize_url url
     url.sub(/\?.+/){ |query| TestHelper.normalize_query(query) }
   end
+
+  def attrs_no_callback
+    RestGraph::Attributes.reject{ |attr|
+      attr.to_s =~ /_handler/
+    }
+  end
 end

data/test/test_default.rb

@@ -0,0 +1,31 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  it 'would honor default attributes' do
+    TestHelper.attrs_no_callback.each{ |name|
+      RestGraph.new.send(name).should ==
+        RestGraph.send("default_#{name}")
+
+      RestGraph.new.send(name).should ==
+        RestGraph::DefaultAttributes.send("default_#{name}")
+    }
+  end
+
+  it 'could use module to override default attributes' do
+    module BlahAttributes
+      def default_app_id
+        '1829'
+      end
+    end
+
+    TestHelper.ensure_rollback{
+      RestGraph.send(:extend, BlahAttributes)
+      RestGraph.default_app_id.should == '1829'
+    }
+  end
+end

data/test/test_fql.rb

@@ -0,0 +1,60 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  before do
+    reset_webmock
+  end
+
+  after do
+    RR.verify
+  end
+
+  it 'would do fql query with/without access_token' do
+    fql = 'SELECT name FROM likes where id="123"'
+    query = "format=json&query=#{CGI.escape(fql)}"
+    stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}").
+      to_return(:body => '[]')
+
+    RestGraph.new.fql(fql).should == []
+
+    token = 'token'.reverse
+    stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}" \
+      "&access_token=#{token}").
+      to_return(:body => '[]')
+
+    RestGraph.new(:access_token => token).fql(fql).should == []
+  end
+
+  it 'would do fql.mutilquery correctly' do
+    f0 = 'SELECT display_name FROM application WHERE app_id="233082465238"'
+    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}}")}"
+
+    stub_multi = lambda{
+      stub_request(:get,
+        "https://api.facebook.com/method/fql.multiquery?#{q}").
+        to_return(:body => '[]')
+    }
+
+    stub_multi.call
+
+    queries = {:f0 => f0, :f1 => f1}
+    RestGraph.new.fql_multi(queries).should == []
+
+    # FIXME: didn't work
+    # mock(queries).respond_to?(:json){ false }
+    # mock.proxy(queries).inject
+    def queries.respond_to? msg
+      msg == :to_json ? false : super(msg)
+    end
+
+    stub_multi.call
+    RestGraph.new.fql_multi(queries).should == []
+  end
+end

data/test/test_handler.rb

@@ -0,0 +1,56 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+require 'json'
+
+describe RestGraph do
+  before do
+    @id    = lambda{ |obj| obj }
+    @error = '{"error":{"type":"Exception","message":"(#2500)"}}'
+    @error_hash = JSON.parse(@error)
+
+    reset_webmock
+    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
+
+describe RestGraph do
+  before do
+    reset_webmock
+  end
+
+  after do
+    RR.verify
+  end
+
+  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{ |d, u| logger << [d, u] })
+    rg.get('me')
+
+    logger.last.should == [333, 'https://graph.facebook.com/me']
+  end
+end

data/test/test_load_config.rb

@@ -9,6 +9,10 @@ require 'rest-graph/load_config'
 
 describe RestGraph::LoadConfig do
 
+  after do
+    RR.verify
+  end
+
   it 'would honor rails config' do
     ::Rails = Object.new
     mock(Rails).env { 'test' }

data/test/test_parse.rb

@@ -0,0 +1,70 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+
+  it 'would return nil if parse error, but not when call data directly' do
+    rg = RestGraph.new
+    rg.parse_cookies!({}).should == nil
+    rg.data              .should == {}
+  end
+
+  it 'would extract correct access_token or fail checking sig' do
+    access_token = '1|2-5|f.'
+    app_id       = '1829'
+    secret       = app_id.reverse
+    sig          = '398262caea8442bd8801e8fba7c55c8a'
+    fbs          = "\"access_token=#{CGI.escape(access_token)}&expires=0&" \
+                   "secret=abc&session_key=def-456&sig=#{sig}&uid=3\""
+
+    check = lambda{ |token|
+      http_cookie =
+        "__utma=123; __utmz=456.utmcsr=(d)|utmccn=(d)|utmcmd=(n); " \
+        "fbs_#{app_id}=#{fbs}"
+
+      rg  = RestGraph.new(:app_id => app_id, :secret => secret)
+      rg.parse_rack_env!('HTTP_COOKIE' => http_cookie).
+                      should.kind_of?(token ? Hash : NilClass)
+      rg.access_token.should ==  token
+
+      rg.parse_rack_env!('HTTP_COOKIE' => nil).should == nil
+      rg.data.should == {}
+
+      rg.parse_cookies!({"fbs_#{app_id}" => fbs}).
+                      should.kind_of?(token ? Hash : NilClass)
+      rg.access_token.should ==  token
+
+      rg.parse_fbs!(fbs).
+                      should.kind_of?(token ? Hash : NilClass)
+      rg.access_token.should ==  token
+    }
+    check.call(access_token)
+    fbs.chop!
+    fbs += '&inject=evil"'
+    check.call(nil)
+  end
+
+  it 'would not pass if there is no secret, prevent from forgery' do
+    rg = RestGraph.new
+    rg.parse_fbs!('"feed=me&sig=bddd192cf27f22c05f61c8bea24fa4b7"').
+      should == nil
+  end
+
+  it 'would parse json correctly' do
+    rg = RestGraph.new
+
+    rg.parse_json!('bad json').should == nil
+    rg.parse_json!('{"no":"sig"}').should == nil
+    rg.parse_json!('{"feed":"me","sig":"bddd192cf27f22c05f61c8bea24fa4b7"}').
+      should == nil
+
+    rg = RestGraph.new(:secret => 'bread')
+    rg.parse_json!('{"feed":"me","sig":"20393e7823730308938a86ecf1c88b14"}').
+      should == {'feed' => 'me', 'sig' => "20393e7823730308938a86ecf1c88b14"}
+  end
+
+end

data/test/test_rest-graph.rb

@@ -10,6 +10,10 @@ describe RestGraph do
     reset_webmock
   end
 
+  after do
+    RR.verify
+  end
+
   it 'would build correct headers' do
     rg = RestGraph.new(:accept => 'text/html',
                        :lang   => 'zh-tw')
@@ -87,95 +91,15 @@ describe RestGraph do
     RestGraph.new.delete('123').should == []
   end
 
-  it 'would extract correct access_token or fail checking sig' do
-    access_token = '1|2-5|f.'
-    app_id       = '1829'
-    secret       = app_id.reverse
-    sig          = '398262caea8442bd8801e8fba7c55c8a'
-    fbs          = "\"access_token=#{CGI.escape(access_token)}&expires=0&" \
-                   "secret=abc&session_key=def-456&sig=#{sig}&uid=3\""
-
-    check = lambda{ |token|
-      http_cookie =
-        "__utma=123; __utmz=456.utmcsr=(d)|utmccn=(d)|utmcmd=(n); " \
-        "fbs_#{app_id}=#{fbs}"
-
-      rg  = RestGraph.new(:app_id => app_id, :secret => secret)
-      rg.parse_rack_env!('HTTP_COOKIE' => http_cookie).
-                      should.kind_of?(token ? Hash : NilClass)
-      rg.access_token.should ==  token
-
-      rg.parse_rack_env!('HTTP_COOKIE' => nil).should == nil
-      rg.data.should == {}
-
-      rg.parse_cookies!({"fbs_#{app_id}" => fbs}).
-                      should.kind_of?(token ? Hash : NilClass)
-      rg.access_token.should ==  token
-
-      rg.parse_fbs!(fbs).
-                      should.kind_of?(token ? Hash : NilClass)
-      rg.access_token.should ==  token
-    }
-    check.call(access_token)
-    fbs.chop!
-    fbs += '&inject=evil"'
-    check.call(nil)
-  end
-
   it 'would return true in authorized? if there is an access_token' do
     RestGraph.new(:access_token => '1').authorized?.should == true
     RestGraph.new(:access_token => nil).authorized?.should == false
   end
 
-  it 'would return nil if parse error, but not when call data directly' do
-    rg = RestGraph.new
-    rg.parse_cookies!({}).should == nil
-    rg.data              .should == {}
-  end
-
-  it 'would do fql query with/without access_token' do
-    fql = 'SELECT name FROM likes where id="123"'
-    query = "format=json&query=#{CGI.escape(fql)}"
-    stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}").
-      to_return(:body => '[]')
-
-    RestGraph.new.fql(fql).should == []
-
-    token = 'token'.reverse
-    stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}" \
-      "&access_token=#{token}").
-      to_return(:body => '[]')
-
-    RestGraph.new(:access_token => token).fql(fql).should == []
-  end
-
-  it 'would honor default attributes' do
-    RestGraph::Attributes.each{ |name|
-      RestGraph.new.send(name).should ==
-        RestGraph.send("default_#{name}")
-
-      RestGraph.new.send(name).should ==
-        RestGraph::DefaultAttributes.send("default_#{name}")
-    }
-  end
-
   it 'would convert query to string' do
     mock(o = Object.new).to_s{ 'i am mock' }
     stub_request(:get, "https://graph.facebook.com/search?q=i%20am%20mock").
       to_return(:body => 'ok')
     RestGraph.new(:auto_decode => false).get('search', :q => o).should == 'ok'
   end
-
-  it 'could use module to override default attributes' do
-    module BlahAttributes
-      def default_app_id
-        '1829'
-      end
-    end
-
-    TestHelper.ensure_rollback{
-      RestGraph.send(:extend, BlahAttributes)
-      RestGraph.default_app_id.should == '1829'
-    }
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rest-graph
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Cardinal Blue
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 +08:00
+date: 2010-05-28 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,12 +91,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 27
         segments: 
         - 1
         - 2
-        - 0
-        version: 1.2.0
+        - 2
+        version: 1.2.2
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -131,7 +131,7 @@ dependencies:
         version: 3.4.3
   type: :development
   version_requirements: *id007
-description: " super simple facebook open graph api client"
+description: " A super simple Facebook Open Graph API client"
 email: dev (XD) cardinalblue.com
 executables: []
 
@@ -141,6 +141,11 @@ extra_rdoc_files:
 - CHANGES
 - LICENSE
 - TODO
+- example/rails/README
+- example/rails/app/views/rest-graph.erb
+- example/rails/config/rest-graph.yaml
+- example/rails/script/console
+- example/rails/script/server
 - rest-graph.gemspec
 files: 
 - CHANGES
@@ -148,16 +153,37 @@ files:
 - README.rdoc
 - Rakefile
 - TODO
+- example/rails/README
+- example/rails/Rakefile
+- example/rails/app/controllers/application_controller.rb
+- example/rails/app/views/rest-graph.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_controller.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
 has_rdoc: true
 homepage: http://github.com/cardinalblue/rest-graph
@@ -193,8 +219,12 @@ rubyforge_project: rest-graph
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: super simple facebook open graph api client
+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_parse.rb
 - test/test_rest-graph.rb