rest-core 0.8.2 → 1.0.0

data/lib/rest-core.rb

@@ -14,6 +14,9 @@ module RestCore
   FAIL             = 'core.fail'
   LOG              = 'core.log'
 
+  ASYNC            = 'async.callback'
+  TIMER            = 'async.timer'
+
   # core utilities
   autoload :Builder       , 'rest-core/builder'
   autoload :Client        , 'rest-core/client'
@@ -42,6 +45,7 @@ module RestCore
   autoload :ErrorDetector , 'rest-core/middleware/error_detector'
   autoload :ErrorDetectorHttp, 'rest-core/middleware/error_detector_http'
   autoload :ErrorHandler  , 'rest-core/middleware/error_handler'
+  autoload :FollowRedirect, 'rest-core/middleware/follow_redirect'
   autoload :JsonDecode    , 'rest-core/middleware/json_decode'
   autoload :Oauth1Header  , 'rest-core/middleware/oauth1_header'
   autoload :Oauth2Header  , 'rest-core/middleware/oauth2_header'
@@ -49,8 +53,15 @@ module RestCore
   autoload :Timeout       , 'rest-core/middleware/timeout'
 
   # apps
+  autoload :Auto          , 'rest-core/app/auto'
   autoload :Dry           , 'rest-core/app/dry'
   autoload :RestClient    , 'rest-core/app/rest-client'
+  autoload :Coolio        , 'rest-core/app/coolio'
+  autoload :CoolioAsync   , 'rest-core/app/coolio-async'
+  autoload :CoolioFiber   , 'rest-core/app/coolio-fiber'
+  autoload :EmHttpRequest     , 'rest-core/app/em-http-request'
+  autoload :EmHttpRequestAsync, 'rest-core/app/em-http-request-async'
+  autoload :EmHttpRequestFiber, 'rest-core/app/em-http-request-fiber'
 
   # clients
   autoload :Simple        , 'rest-core/client/simple'
@@ -58,3 +69,11 @@ module RestCore
 end
 
 RC = RestCore unless Object.const_defined?(:RC)
+
+begin
+  require 'fiber'
+rescue LoadError
+end
+# assume we would always require 'rest-core' in root fiber
+RestCore::RootFiber = Fiber.current if Object.const_defined?(:Fiber) &&
+                                       Fiber.respond_to?(:current)

data/rest-core.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "0.8.2"
+  s.version = "1.0.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 = "2012-02-18"
-  s.description = "Modular Ruby clients interface for REST APIs\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed [rest-core][], which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-core]: http://github.com/cardinalblue/rest-core\n[rest-more]: http://github.com/cardinalblue/rest-more"
+  s.date = "2012-03-17"
+  s.description = "Modular Ruby clients interface for REST APIs\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed [rest-core][], which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-core]: https://github.com/cardinalblue/rest-core\n[rest-more]: https://github.com/cardinalblue/rest-more"
   s.email = ["dev (XD) cardinalblue.com"]
   s.files = [
   ".gitignore",
@@ -22,12 +22,24 @@ Gem::Specification.new do |s|
   "README.md",
   "Rakefile",
   "TODO.md",
-  "example/facebook.rb",
-  "example/github.rb",
-  "example/linkedin.rb",
-  "example/twitter.rb",
+  "doc/ToC.md",
+  "doc/dependency.md",
+  "doc/design.md",
+  "example/auto.rb",
+  "example/coolio.rb",
+  "example/eventmachine.rb",
+  "example/multi.rb",
+  "example/rest-client.rb",
   "lib/rest-core.rb",
+  "lib/rest-core/app/abstract/async_fiber.rb",
+  "lib/rest-core/app/auto.rb",
+  "lib/rest-core/app/coolio-async.rb",
+  "lib/rest-core/app/coolio-fiber.rb",
+  "lib/rest-core/app/coolio.rb",
   "lib/rest-core/app/dry.rb",
+  "lib/rest-core/app/em-http-request-async.rb",
+  "lib/rest-core/app/em-http-request-fiber.rb",
+  "lib/rest-core/app/em-http-request.rb",
   "lib/rest-core/app/rest-client.rb",
   "lib/rest-core/builder.rb",
   "lib/rest-core/client.rb",
@@ -49,11 +61,15 @@ Gem::Specification.new do |s|
   "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/follow_redirect.rb",
   "lib/rest-core/middleware/json_decode.rb",
   "lib/rest-core/middleware/oauth1_header.rb",
   "lib/rest-core/middleware/oauth2_header.rb",
   "lib/rest-core/middleware/oauth2_query.rb",
   "lib/rest-core/middleware/timeout.rb",
+  "lib/rest-core/middleware/timeout/coolio_timer.rb",
+  "lib/rest-core/middleware/timeout/eventmachine_timer.rb",
+  "lib/rest-core/patch/rest-client.rb",
   "lib/rest-core/test.rb",
   "lib/rest-core/util/hmac.rb",
   "lib/rest-core/util/parse_query.rb",
@@ -70,13 +86,15 @@ Gem::Specification.new do |s|
   "test/test_client_oauth1.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
+  "test/test_follow_redirect.rb",
+  "test/test_json_decode.rb",
   "test/test_oauth1_header.rb",
   "test/test_payload.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]
   s.homepage = "https://github.com/cardinalblue/rest-core"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.16"
+  s.rubygems_version = "1.8.19"
   s.summary = "Modular Ruby clients interface for REST APIs"
   s.test_files = [
   "test/test_auth_basic.rb",
@@ -85,6 +103,8 @@ Gem::Specification.new do |s|
   "test/test_client_oauth1.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
+  "test/test_follow_redirect.rb",
+  "test/test_json_decode.rb",
   "test/test_oauth1_header.rb",
   "test/test_payload.rb",
   "test/test_universal.rb",

data/test/test_client.rb

@@ -1,15 +1,32 @@
 
 require 'rest-core/test'
 
-describe RestCore::Simple do
+describe RC::Simple do
   after do
     WebMock.reset!
     RR.verify
   end
 
   should 'do simple request' do
-    stub_request(:get, 'http://localhost/').to_return(:body => '[]')
-    RestCore::Simple.new.get('http://localhost/').should.eq '[]'
+    [:get, :post, :delete, :put,
+     :head, :patch, :options].each do |method|
+      stub_request(method, 'http://localhost/').to_return(:body => '[]')
+      RC::Simple.new.send(method, 'http://localhost/').should.eq '[]'
+    end
+  end
+
+  should 'call the callback' do
+    [:get, :post, :delete, :put,
+     :head, :patch, :options].each do |method|
+      stub_request(method, 'http://localhost/').to_return(:body => '123')
+      (client = RC::Simple.new).send(method, 'http://localhost/'){ |res|
+        res.should.eq '123' }.should.eq client
+    end
+  end
+
+  should 'have correct to_i' do
+    stub_request(:get, 'http://localhost/').to_return(:body => '123')
+    RC::Simple.new.get('http://localhost/').to_i.should.eq 123
   end
 
   should 'use defaults' do

data/test/test_follow_redirect.rb

@@ -0,0 +1,47 @@
+
+require 'rest-core/test'
+
+describe RC::FollowRedirect do
+  before do
+    @dry = RC::Dry.new
+    @app = RC::FollowRedirect.new(dry, 1)
+  end
+  after do
+    RR.verify
+  end
+  def dry; @dry; end
+  def app; @app; end
+
+  [301, 302, 303, 307].each do |status|
+    should "not follow redirect if reached max_redirects: #{status}" do
+      mock(dry).call(anything){ |env|
+        env.merge(RC::RESPONSE_STATUS => status,
+                  RC::RESPONSE_HEADERS => {'LOCATION' => 'location'})
+      }
+      app.call(RC::REQUEST_METHOD => :get,
+               'max_redirects' => 0)[RC::RESPONSE_HEADERS]['LOCATION'].
+                                                 should.eq 'location'
+    end
+
+    should "follow once: #{status}" do
+      mock(dry).call(anything){ |env|
+        env.merge(RC::RESPONSE_STATUS => status,
+                  RC::RESPONSE_HEADERS => {'LOCATION' => 'location'})
+      }.times(2)
+      app.call(RC::REQUEST_METHOD => :get)[RC::RESPONSE_HEADERS]['LOCATION'].
+                                                       should.eq 'location'
+    end
+  end
+
+  [200, 201, 404, 500].each do |status|
+    should "not follow redirect if it's not a redirect status: #{status}" do
+      mock(dry).call(anything){ |env|
+        env.merge(RC::RESPONSE_STATUS => status,
+                  RC::RESPONSE_HEADERS => {'LOCATION' => 'location'})
+      }
+      app.call(RC::REQUEST_METHOD => :get,
+               'max_redirects' => 9)[RC::RESPONSE_HEADERS]['LOCATION'].
+                                                 should.eq 'location'
+    end
+  end
+end

data/test/test_json_decode.rb

@@ -0,0 +1,24 @@
+
+require 'rest-core/test'
+
+describe RC::JsonDecode do
+  before do
+    @app = RC::JsonDecode.new(RC::Dry.new, true)
+  end
+
+  should 'do nothing' do
+    @app.call({}).should.eq(RC::RESPONSE_BODY => nil)
+  end
+
+  should 'decode sync' do
+    @app.call(RC::RESPONSE_BODY => '{}').should.eq(
+              RC::RESPONSE_BODY =>  {} )
+  end
+
+  should 'decode async' do
+    @app.call(RC::RESPONSE_BODY => '{}',
+              RC::ASYNC => lambda{ |response|
+                             response[RC::RESPONSE_BODY].should.eq({})}
+             )[RC::RESPONSE_BODY].should.eq '{}'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-18 00:00:00.000000000 Z
+date: 2012-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2157113980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157113980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'Modular Ruby clients interface for REST APIs
 
 
@@ -39,9 +44,9 @@ description: ! 'Modular Ruby clients interface for REST APIs
   dedicated clients provided by [rest-more][].
 
 
-  [rest-core]: http://github.com/cardinalblue/rest-core
+  [rest-core]: https://github.com/cardinalblue/rest-core
 
-  [rest-more]: http://github.com/cardinalblue/rest-more'
+  [rest-more]: https://github.com/cardinalblue/rest-more'
 email:
 - dev (XD) cardinalblue.com
 executables: []
@@ -58,12 +63,24 @@ files:
 - README.md
 - Rakefile
 - TODO.md
-- example/facebook.rb
-- example/github.rb
-- example/linkedin.rb
-- example/twitter.rb
+- doc/ToC.md
+- doc/dependency.md
+- doc/design.md
+- example/auto.rb
+- example/coolio.rb
+- example/eventmachine.rb
+- example/multi.rb
+- example/rest-client.rb
 - lib/rest-core.rb
+- lib/rest-core/app/abstract/async_fiber.rb
+- lib/rest-core/app/auto.rb
+- lib/rest-core/app/coolio-async.rb
+- lib/rest-core/app/coolio-fiber.rb
+- lib/rest-core/app/coolio.rb
 - lib/rest-core/app/dry.rb
+- lib/rest-core/app/em-http-request-async.rb
+- lib/rest-core/app/em-http-request-fiber.rb
+- lib/rest-core/app/em-http-request.rb
 - lib/rest-core/app/rest-client.rb
 - lib/rest-core/builder.rb
 - lib/rest-core/client.rb
@@ -85,11 +102,15 @@ files:
 - 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/follow_redirect.rb
 - lib/rest-core/middleware/json_decode.rb
 - lib/rest-core/middleware/oauth1_header.rb
 - lib/rest-core/middleware/oauth2_header.rb
 - lib/rest-core/middleware/oauth2_query.rb
 - lib/rest-core/middleware/timeout.rb
+- lib/rest-core/middleware/timeout/coolio_timer.rb
+- lib/rest-core/middleware/timeout/eventmachine_timer.rb
+- lib/rest-core/patch/rest-client.rb
 - lib/rest-core/test.rb
 - lib/rest-core/util/hmac.rb
 - lib/rest-core/util/parse_query.rb
@@ -106,6 +127,8 @@ files:
 - test/test_client_oauth1.rb
 - test/test_error_detector.rb
 - test/test_error_detector_http.rb
+- test/test_follow_redirect.rb
+- test/test_json_decode.rb
 - test/test_oauth1_header.rb
 - test/test_payload.rb
 - test/test_universal.rb
@@ -130,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Modular Ruby clients interface for REST APIs
@@ -141,6 +164,8 @@ test_files:
 - test/test_client_oauth1.rb
 - test/test_error_detector.rb
 - test/test_error_detector_http.rb
+- test/test_follow_redirect.rb
+- test/test_json_decode.rb
 - test/test_oauth1_header.rb
 - test/test_payload.rb
 - test/test_universal.rb

data/example/facebook.rb

@@ -1,9 +0,0 @@
-
-require 'rest-core/client/rest-graph'
-
-p RestGraph.new.get('4') # get user info
-
-facebook = RestGraph.new(:app_id => '...', :secret => '...')
-facebook.authorize_url # copy and paste the URL in browser to authorize
-facebook.authorize!(:redirect_uri => '...', :code => '...')
-p facebook.get('me')

data/example/github.rb

@@ -1,4 +0,0 @@
-
-require 'rest-core'
-
-p RestCore::Github.new.get('users/cardinalblue') # get user info

data/example/linkedin.rb

@@ -1,8 +0,0 @@
-
-require 'rest-core'
-
-linkedin = RestCore::Linkedin.new(:consumer_key    => '...',
-                                  :consumer_secret => '...')
-linkedin.authorize_url!   # copy and paste the URL in browser to authorize
-linkedin.authorize!('..') # paste your code from browser
-p linkedin.me             # get current user info

data/example/twitter.rb

@@ -1,11 +0,0 @@
-
-require 'rest-core'
-RestCore::Twitter.new.statuses('_cardinalblue') # get user tweets
-
-twitter = RestCore::Twitter.new(:consumer_key    => '...',
-                                :consumer_secret => '...')
-twitter.authorize_url!   # copy and paste the URL in browser to authorize
-twitter.authorize!('..') # paste your code from browser
-p twitter.tweet('hi!')   # tweet for the current user
-
-p twitter.tweet('hi with pic!', File.open('...'))