rest-core 0.0.1

data/test/test_page.rb

@@ -0,0 +1,110 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'get the next/prev page' do
+    rg = RestGraph.new(:site => '', :cache => false)
+    %w[next previous].each{ |type|
+      kind = "#{type}_page"
+      rg.send(kind, {})              .should == nil
+      rg.send(kind, {'paging' => []}).should == nil
+      rg.send(kind, {'paging' => {}}).should == nil
+
+      stub_request(:get, 'zzz').to_return(:body => '["ok"]')
+      rg.send(kind, {'paging' => {type => 'zzz'}}).should == ['ok']
+    }
+  end
+
+  should 'merge all pages into one' do
+    rg = RestGraph.new(:site => '', :cache => false)
+    %w[next previous].each{ |type|
+      kind = "#{type}_page"
+      data = {'paging' => {type => 'zzz'}, 'data' => ['z']}
+
+      # invalid pages or just the page itself
+      (-1..1).each{ |page|
+        rg.for_pages(data, page, {}, kind).should == data
+      }
+
+      (2..4).each{ |pages|
+        # merge data
+        stub_request(:get, 'zzz').to_return(:body => '{"data":["y"]}')
+        rg.for_pages(data, pages, {}, kind).should == {'data' => %w[z y]}
+
+        # this data cannot be merged
+        stub_request(:get, 'zzz').to_return(:body => '{"data":"y"}')
+        rg.for_pages(data, pages, {}, kind).should == {'data' => %w[z]}
+      }
+
+      stub_request(:get, 'zzz').to_return(:body =>
+        '{"paging":{"'+type+'":"yyy"},"data":["y"]}')
+      stub_request(:get, 'yyy').to_return(:body => '{"data":["x"]}')
+
+      rg.for_pages(data, 3, {}, kind).should == {'data' => %w[z y x]}
+    }
+  end
+
+  should 'for_pages with callback' do
+    rg = RestGraph.new(:site => '', :cache => false)
+    %w[next previous].each{ |type|
+      kind = "#{type}_page"
+      data = {'paging' => {type => 'zzz'}, 'data' => ['z']}
+
+      # invalid pages or just the page itself
+      nils = 0
+      ranges = -1..1
+      ranges.each{ |page|
+        rg.for_pages(data, page, {}, kind){ |r|
+          if r
+            r.should == data
+          else
+            nils += 1
+          end
+        }.should == data
+      }
+      nils.should == ranges.to_a.size
+
+      (2..4).each{ |pages|
+        # merge data
+        stub_request(:get, 'zzz').to_return(:body => '{"data":["y"]}')
+        expects = [{'data' => %w[y]}, nil]
+        rg.for_pages(data, pages, {}, kind){ |r|
+          r.should == expects.shift
+        }.should == {'data' => %w[z y]}
+        expects.empty?.should == true
+
+        # this data cannot be merged
+        stub_request(:get, 'zzz').to_return(:body => '{"data":"y"}')
+        expects = [{'data' => 'y'}, nil]
+        rg.for_pages(data, pages, {}, kind){ |r|
+          r.should == expects.shift
+        }.should == {'data' => %w[z]}
+        expects.empty?.should == true
+      }
+
+      stub_request(:get, 'zzz').to_return(:body =>
+        '{"paging":{"'+type+'":"yyy"},"data":["y"]}')
+      stub_request(:get, 'yyy').to_return(:body => '{"data":["x"]}')
+
+      expects = [{'data' => %w[y]}, {'data' => %w[x]}, nil]
+      rg.for_pages(data, 3, {}, kind){ |rr|
+        if rr
+          r = rr.dup
+          r.delete('paging')
+        else
+          r = rr
+        end
+        r.should == expects.shift
+      }.should == {'data' => %w[z y x]}
+    }
+  end
+end

data/test/test_parse.rb

@@ -0,0 +1,131 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+
+  should 'return nil if parse error, but not when call data directly' do
+    rg = RestGraph.new
+    rg.parse_cookies!({}).should == nil
+    rg.data              .should == {}
+  end
+
+  should 'parse if fbs contains json as well' do
+    algorithm = 'HMAC-SHA256'
+    user      = '{"country"=>"us", "age"=>{"min"=>21}}'
+    data      = {'algorithm' => algorithm, 'user' => user}
+    rg        = RestGraph.new(:data => data, :secret => 'secret')
+    sig       = rg.send(:calculate_sig, data)
+    rg.parse_fbs!("\"#{rg.fbs}\"").should == data.merge('sig' => sig)
+  end
+
+  should '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, fbs|
+      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)
+    check.call(access_token, "\"#{fbs}\"")
+    fbs << '&inject=evil"'
+    check.call(nil, fbs)
+    check.call(nil, "\"#{fbs}\"")
+  end
+
+  should 'not pass if there is no secret, prevent from forgery' do
+    rg = RestGraph.new
+    rg.parse_fbs!('"feed=me&sig=bddd192cf27f22c05f61c8bea24fa4b7"').
+      should == nil
+  end
+
+  should '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"}
+    rg.data.empty?.should == false
+    rg.parse_json!('bad json')
+    rg.data.empty?.should == true
+  end
+
+  should 'parse signed_request' do
+    secret = 'aloha'
+    json   = RestCore::JsonDecode.json_encode('ooh' => 'dir', 'moo' => 'bar')
+    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
+    rg.data                                 .should == {}
+  end
+
+  should 'fallback to ruby-hmac if Digest.new raise an runtime error' do
+    key, data = 'top', 'secret'
+    digest = OpenSSL::HMAC.digest('sha256', key, data)
+    mock(OpenSSL::HMAC).digest('sha256', key, data){ raise 'boom' }
+    RestCore::Hmac.sha256(key, data).should == digest
+  end
+
+  should 'generate correct fbs with correct sig' do
+    RestGraph.new(:access_token => 'fake', :secret => 's').fbs.should ==
+      "access_token=fake&sig=#{Digest::MD5.hexdigest('access_token=fakes')}"
+  end
+
+  should 'parse fbs from facebook response which lacks sig...' do
+    rg = RestGraph.new(:access_token => 'a', :secret => 'z')
+    rg.parse_fbs!(rg.fbs)                           .should.kind_of?(Hash)
+    rg.data.empty?.should == false
+    rg.parse_fbs!(rg.fbs.sub(/sig\=\w+/, 'sig=abc')).should == nil
+    rg.data.empty?.should == true
+  end
+
+  should 'generate correct fbs with additional parameters' do
+    rg = RestGraph.new(:access_token => 'a', :secret => 'z')
+    rg.data['expires'] = '1234'
+    rg.parse_fbs!(rg.fbs).should.kind_of?(Hash)
+    rg.access_token      .should == 'a'
+    rg.data['expires']   .should == '1234'
+  end
+
+end

data/test/test_rest-graph.rb

@@ -0,0 +1,10 @@
+
+$LOAD_PATH << File.dirname(__FILE__)
+$LOAD_PATH.uniq!
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].each{ |file|
+  next if file == __FILE__
+  next if ARGV.map{ |path| File.expand_path(path)
+                }.include?(File.expand_path(file))
+  require File.basename(file).sub(/\..+$/, '')
+}

data/test/test_serialize.rb

@@ -0,0 +1,44 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'be serialized with lighten' do
+    engines = if RUBY_VERSION >= '1.9.2'
+                begin
+                  require 'psych'
+                  YAML::ENGINE.yamler = 'psych' # TODO: probably a bug?
+                  [Marshal, YAML, Psych]
+                rescue LoadError
+                  [Marshal, YAML]
+                end
+              elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+                [Marshal]
+              else
+                [YAML]
+              end
+
+    engines.each{ |engine|
+      test = lambda{ |obj| engine.load(engine.dump(obj)) }
+        rg = RestGraph.new(:log_handler => lambda{})
+      lambda{ test[rg] }.should.raise(TypeError)
+      test[rg.lighten].should == rg.lighten
+      lambda{ test[rg] }.should.raise(TypeError)
+      rg.lighten!
+      test[rg.lighten].should == rg
+    }
+  end
+
+  should 'lighten takes options to change attributes' do
+    RestGraph.new.lighten(:timeout => 100    ).timeout.should == 100
+    RestGraph.new.lighten(:lang    => 'zh-TW').lang   .should == 'zh-TW'
+  end
+end

data/test/test_timeout.rb

@@ -0,0 +1,25 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'respect timeout' do
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{}')
+    mock.proxy(Timeout).timeout(numeric)
+    RestGraph.new.get('me').should == {}
+  end
+
+  should 'override timeout' do
+    mock(Timeout).timeout(99){ {RestCore::RESPONSE_BODY => true} }
+    RestGraph.new(:timeout => 1).get('me', {}, :timeout => 99).should == true
+  end
+end

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: rest-core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cardinal Blue
+- Lin Jen-Shin (godfat)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2153518960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153518960
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2153518480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153518480
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &2153518000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153518000
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2153517520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153517520
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: &2153517040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153517040
+- !ruby/object:Gem::Dependency
+  name: ruby-hmac
+  requirement: &2153516560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153516560
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2153516080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153516080
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &2153515600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153515600
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &2153515120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153515120
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153514640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153514640
+description: ! 'A modular Ruby REST client collection/infrastructure.
+
+
+  In this era of web services and mashups, we have seen a blooming of REST
+
+  APIs. One might wonder, how do we use these APIs easily and elegantly?
+
+  Since REST is very simple compared to SOAP, it is not hard to build a
+
+  dedicated client ourselves.
+
+
+  We have developed [rest-core][] with composable middlewares to build a
+
+  REST client, based on the effort from [rest-graph][]. In the cases of
+
+  common APIs such as Facebook, Github, and Twitter, developers can simply
+
+  use the built-in dedicated clients provided by rest-core, or do it yourself
+
+  for any other REST APIs.
+
+
+  [rest-core]: http://github.com/cardinalblue/rest-core
+
+  [rest-graph]: http://github.com/cardinalblue/rest-graph'
+email:
+- dev (XD) cardinalblue.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CONTRIBUTORS
+- LICENSE
+- TODO.md
+files:
+- .gitignore
+- .gitmodules
+- .travis.yml
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTE.md
+- README
+- README.md
+- Rakefile
+- TODO.md
+- example/facebook.rb
+- example/github.rb
+- lib/rest-core.rb
+- lib/rest-core/app/ask.rb
+- lib/rest-core/app/rest-client.rb
+- lib/rest-core/builder.rb
+- lib/rest-core/client.rb
+- lib/rest-core/client/github.rb
+- lib/rest-core/client/linkedin.rb
+- lib/rest-core/client/rest-graph.rb
+- lib/rest-core/client/twitter.rb
+- lib/rest-core/client_oauth1.rb
+- lib/rest-core/event.rb
+- lib/rest-core/middleware.rb
+- lib/rest-core/middleware/cache.rb
+- lib/rest-core/middleware/common_logger.rb
+- lib/rest-core/middleware/default_headers.rb
+- lib/rest-core/middleware/default_query.rb
+- lib/rest-core/middleware/default_site.rb
+- lib/rest-core/middleware/defaults.rb
+- lib/rest-core/middleware/error_detector.rb
+- lib/rest-core/middleware/error_detector_http.rb
+- lib/rest-core/middleware/error_handler.rb
+- lib/rest-core/middleware/json_decode.rb
+- lib/rest-core/middleware/oauth1_header.rb
+- lib/rest-core/middleware/oauth2_query.rb
+- lib/rest-core/middleware/timeout.rb
+- lib/rest-core/util/hmac.rb
+- lib/rest-core/version.rb
+- lib/rest-core/wrapper.rb
+- lib/rest-graph/config_util.rb
+- rest-core.gemspec
+- task/.gitignore
+- task/gemgem.rb
+- test/common.rb
+- test/config/rest-graph.yaml
+- test/pending/test_load_config.rb
+- test/pending/test_multi.rb
+- test/pending/test_test_util.rb
+- test/test_api.rb
+- test/test_cache.rb
+- test/test_default.rb
+- test/test_error.rb
+- test/test_handler.rb
+- test/test_misc.rb
+- test/test_oauth.rb
+- test/test_oauth1_header.rb
+- test/test_old.rb
+- test/test_page.rb
+- test/test_parse.rb
+- test/test_rest-graph.rb
+- test/test_serialize.rb
+- test/test_timeout.rb
+homepage: https://github.com/cardinalblue/rest-core
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: A modular Ruby REST client collection/infrastructure.
+test_files:
+- test/pending/test_load_config.rb
+- test/pending/test_multi.rb
+- test/pending/test_test_util.rb
+- test/test_api.rb
+- test/test_cache.rb
+- test/test_default.rb
+- test/test_error.rb
+- test/test_handler.rb
+- test/test_misc.rb
+- test/test_oauth.rb
+- test/test_oauth1_header.rb
+- test/test_old.rb
+- test/test_page.rb
+- test/test_parse.rb
+- test/test_rest-graph.rb
+- test/test_serialize.rb
+- test/test_timeout.rb