rest-core 1.0.0 → 1.0.1

data/CHANGES.md

@@ -1,5 +1,11 @@
 # CHANGES
 
+## rest-core 1.0.1 -- 2012-05-14
+
+* [`Auto`] Check for eventmachine first instead of cool.io
+* [`EmHttpRequestFiber`] Also pass callback for errback
+* [`DefaultQuery`] Make default query to {} instead of nil
+
 ## rest-core 1.0.0 -- 2012-03-17
 
 This is a very significant release. The most important change is now we
@@ -7,7 +13,7 @@ support asynchronous requests, by either passing a callback block or using
 fibers in Ruby 1.9 to make the whole program still look synchronous.
 
 Please read [README.md](https://github.com/cardinalblue/rest-core/blob/master/README.md)
-or [example](https://github.com/cardinalblue/rest-core/blob/master/example)
+or [example](https://github.com/cardinalblue/rest-core/tree/master/example)
 for more detail.
 
 * [`Client`] Client#inspect is fixed for clients which do not have any

data/README.md

@@ -49,14 +49,16 @@ dedicated clients provided by [rest-more][].
 * Fibers only work on Ruby 1.9+
 * gem [em-http-request][] (if using eventmachine)
 * gem [cool.io-http][] (if using cool.io)
-* gem json or yajl-ruby (if using JsonDecode middleware)
+* gem json or yajl-ruby (if using `JsonDecode` middleware)
 
 [em-http-request]: https://github.com/igrigorik/em-http-request
 [cool.io-http]: https://github.com/godfat/cool.io-http
 
 ## INSTALLATION:
 
+``` shell
     gem install rest-core
+```
 
 Or if you want development version, put this in Gemfile:
 
@@ -106,14 +108,14 @@ for concepts.
 
 [example/rest-client.rb]: https://github.com/cardinalblue/rest-core/blob/master/example/rest-client.rb
 [rest-more]: https://github.com/cardinalblue/rest-more
-[rubyconf.tw]: http://rubyconf.tw/2011/#6
 [slides]: http://www.godfat.org/slide/2011-08-27-rest-core.html
+[rubyconf.tw]: http://rubyconf.tw/2011/#6
 
 ## Asynchronous HTTP Requests:
 
 I/O bound operations shouldn't be blocking the CPU! If you have a reactor,
 i.e. event loop, you should take the advantage of that to make HTTP requests
-non-blocking the whole process/thread. For now, we support eventmachine and
+not block the whole process/thread. For now, we support eventmachine and
 cool.io. Below is an example for eventmachine:
 
 ``` ruby
@@ -133,12 +135,13 @@ If you're passing a block, the block is called after the response is
 available. That is the block is the callback for the request.
 
 ``` ruby
-    client = AsynchronousClient.new(:cache => {})
+    client = AsynchronousClient.new
     EM.run{
       client.get('cardinalblue'){ |response|
         p response
         EM.stop
       }
+      puts "It's not blocking..."
     }
 ```
 
@@ -154,6 +157,7 @@ If you don't understand what does this mean, you can take a look at
         p client.get('cardinalblue')
         EM.stop
       }.resume
+      puts "It's not blocking..."
     }
 ```
 
@@ -178,6 +182,7 @@ You can also make multi-requests synchronously like this:
         p Fiber.yield
         EM.stop
       }.resume
+      puts "It's not blocking..."
     }
 ```
 

data/TODO.md

@@ -1,4 +1,22 @@
 # TODO
 
+* Auto should also pick RestClient if it's not inside a fiber
+* HTTP method in Requested log
 * middleware revisit (how to initialize?)
 * test utility
+
+# BUG
+
+* inheritance should work; assign builder?
+* no error handling in cool.io
+
+# FEATURE
+
+* middleware composer
+* RC::Payload which can handle Content-Type: application/json
+* how to pass a arbitrary payload generator?
+* RC::JsonRequest
+* RC::FakeGetWithPayload
+
+* ResponseThunk and EmHttpRequestThunk
+* options for apps

data/example/eventmachine.rb

@@ -10,12 +10,13 @@ AsynchronousClient = RestCore::Builder.client do
   run s::EmHttpRequest
 end
 
-client = AsynchronousClient.new(:cache => {})
+client = AsynchronousClient.new
 EM.run{
   client.get('cardinalblue'){ |response|
     p response
     EM.stop
   }
+  puts "It's not blocking..."
 }
 
 puts
@@ -25,4 +26,5 @@ EM.run{
     p client.get('cardinalblue')
     EM.stop
   }.resume
+  puts "It's not blocking..."
 }

data/example/multi.rb

@@ -23,6 +23,7 @@ EM.run{
       result[0] = response
       fiber.resume(result) if result.size == 2
     }
+    puts "It's not blocking..."
     client.get('cardinalblue'){ |response|
       result[1] = response
       fiber.resume(result) if result.size == 2
@@ -30,4 +31,5 @@ EM.run{
     p Fiber.yield
     EM.stop
   }.resume
+  puts "It's not blocking..."
 }

data/lib/rest-core/app/auto.rb

@@ -9,12 +9,13 @@ class RestCore::Auto
   end
 
   def http_client
-    if Object.const_defined?(:Coolio) && ::Coolio::Loop.default.
-                                           has_active_watchers?
-      @coolio        ||= RestCore::Coolio.new
-    elsif Object.const_defined?(:EventMachine) && ::EventMachine.
-                                                    reactor_running?
+    if Object.const_defined?(:EventMachine) && ::EventMachine.reactor_running?
       @emhttprequest ||= RestCore::EmHttpRequest.new
+
+    elsif Object.const_defined?(:Coolio) && ::Coolio::Loop.default.
+                                              has_active_watchers?
+      @coolio        ||= RestCore::Coolio.new
+
     else
       @restclient    ||= RestCore::RestClient.new
     end

data/lib/rest-core/app/em-http-request-async.rb

@@ -13,13 +13,8 @@ class RestCore::EmHttpRequestAsync
                  :body => payload.read,
                  :head => payload.headers.merge(env[REQUEST_HEADERS]))
 
-    client.callback{
-      env[TIMER].cancel if env[TIMER]
-      env[ASYNC].call(env.merge(
-        RESPONSE_BODY    => client.response,
-        RESPONSE_STATUS  => client.response_header.status,
-        RESPONSE_HEADERS => client.response_header)) if env[ASYNC]
-    }
+    client.callback{ respond(env, client) }
+    client. errback{ respond(env, client) }
 
     env[TIMER].on_timeout{
       client.close
@@ -31,4 +26,12 @@ class RestCore::EmHttpRequestAsync
 
     env
   end
+
+  def respond env, client
+    env[TIMER].cancel if env[TIMER]
+    env[ASYNC].call(env.merge(
+      RESPONSE_BODY    => client.response,
+      RESPONSE_STATUS  => client.response_header.status,
+      RESPONSE_HEADERS => client.response_header)) if env[ASYNC]
+  end
 end

data/lib/rest-core/app/em-http-request-fiber.rb

@@ -16,10 +16,8 @@ class RestCore::EmHttpRequestFiber
                  :body => payload.read,
                  :head => payload.headers.merge(env[REQUEST_HEADERS]))
 
-    client.callback{
-      env[TIMER].cancel if env[TIMER]
-      f.resume(process(env, client)) if f.alive?
-    }
+    client.callback{ respond(f, env, client) }
+    client. errback{ respond(f, env, client) }
 
     if (response = Fiber.yield).kind_of?(::Exception)
       client.close
@@ -29,6 +27,11 @@ class RestCore::EmHttpRequestFiber
     end
   end
 
+  def respond f, env, client
+    env[TIMER].cancel if env[TIMER]
+    f.resume(process(env, client)) if f.alive?
+  end
+
   def process env, client
     result = env.merge(RESPONSE_BODY    => client.response,
                        RESPONSE_STATUS  => client.response_header.status,

data/lib/rest-core/middleware/default_query.rb

@@ -4,6 +4,12 @@ require 'rest-core/middleware'
 class RestCore::DefaultQuery
   def self.members; [:query]; end
   include RestCore::Middleware
+
+  def initialize *args
+    super
+    @query ||= {}
+  end
+
   def call env
     app.call(env.merge(REQUEST_QUERY =>
       @query.merge(query(env)).merge(env[REQUEST_QUERY] || {})))

data/lib/rest-core/middleware/timeout.rb

@@ -8,7 +8,7 @@ class RestCore::Timeout
   include RestCore::Middleware
 
   def call env
-    return app.call(env) if env[DRY]
+    return app.call(env) if env[DRY] || timeout(env) == 0
     monitor(env){ |e| app.call(e) }
   end
 
@@ -21,7 +21,7 @@ class RestCore::Timeout
                  end
 
     case class_name
-    when /Coolio|EmHttpRequest/
+    when /EmHttpRequest|Coolio/
       if root_fiber? && env[ASYNC]
         yield(env.merge(TIMER => timeout_with_callback(env, class_name)))
       else
@@ -42,13 +42,13 @@ class RestCore::Timeout
 
   def timeout_with_callback env, class_name
     case class_name
+    when /EmHttpRequest/
+      EventMachineTimer.new(timeout(env), timeout_error)
     when /Coolio/
       timer = CoolioTimer.new(timeout(env))
       timer.error = timeout_error
       timer.attach(::Coolio::Loop.default)
       timer
-    when /EmHttpRequest/
-      EventMachineTimer.new(timeout(env), timeout_error)
     else
       raise "BUG: #{run} is not supported"
     end
@@ -56,6 +56,12 @@ class RestCore::Timeout
 
   def timeout_with_resume env, class_name
     case class_name
+    when /EmHttpRequest/
+      f = Fiber.current
+      EventMachineTimer.new(timeout(env), error = timeout_error){
+        f.resume(error) if f.alive?
+      }
+
     when /Coolio/
       f = Fiber.current
       timer = CoolioTimer.new(timeout(env))
@@ -64,11 +70,6 @@ class RestCore::Timeout
       timer.attach(::Coolio::Loop.default)
       timer
 
-    when /EmHttpRequest/
-      f = Fiber.current
-      EventMachineTimer.new(timeout(env), error = timeout_error){
-        f.resume(error) if f.alive?
-      }
     else
       raise "BUG: #{run} is not supported"
     end
@@ -78,8 +79,8 @@ class RestCore::Timeout
     ::Timeout::Error.new('execution expired')
   end
 
-  autoload       :CoolioTimer,
-    'rest-core/middleware/timeout/coolio_timer'
   autoload :EventMachineTimer,
     'rest-core/middleware/timeout/eventmachine_timer'
+  autoload       :CoolioTimer,
+    'rest-core/middleware/timeout/coolio_timer'
 end

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/rest-core.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   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-03-17"
+  s.date = "2012-05-14"
   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 = [
@@ -84,29 +84,33 @@ Gem::Specification.new do |s|
   "test/test_builder.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
+  "test/test_default_query.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_timeout.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.19"
+  s.rubygems_version = "1.8.24"
   s.summary = "Modular Ruby clients interface for REST APIs"
   s.test_files = [
   "test/test_auth_basic.rb",
   "test/test_builder.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
+  "test/test_default_query.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_timeout.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]
 

data/test/test_default_query.rb

@@ -0,0 +1,45 @@
+
+require 'rest-core/test'
+
+describe RC::DefaultQuery do
+  describe 'when given query' do
+    before do
+      @app = RC::DefaultQuery.new(RC::Dry.new, {})
+    end
+
+    def app
+      @app
+    end
+
+    should 'do nothing' do
+      app.call({})[RC::REQUEST_QUERY].should.eq({})
+    end
+
+    should 'merge query' do
+      app.instance_eval{@query = {'q' => 'uery'}}
+
+      app.call({}).should.eq({RC::REQUEST_QUERY =>
+        {'q' => 'uery'}})
+
+      format = {'format' => 'json'}
+      env    = {RC::REQUEST_QUERY => format}
+
+      app.call(env).should.eq({RC::REQUEST_QUERY =>
+        {'q' => 'uery'}.merge(format)})
+    end
+  end
+
+  describe 'when not given query' do
+    before do
+      @app = RC::DefaultQuery.new(RC::Dry.new)
+    end
+
+    def app
+      @app
+    end
+
+    should 'merge query with {}' do
+      app.call({}).should.eq({RC::REQUEST_QUERY => {}})
+    end
+  end
+end

data/test/test_timeout.rb

@@ -0,0 +1,19 @@
+
+require 'rest-core/test'
+
+describe RC::Timeout do
+  before do
+    @app = RC::Timeout.new(RC::Dry.new, 0)
+  end
+
+  should 'bypass timeout if timeout is 0' do
+    mock(@app).monitor.times(0)
+    @app.call({}).should.eq({})
+  end
+
+  should 'run the monitor to setup timeout' do
+    env = {'timeout' => 2}
+    mock.proxy(@app).monitor(env).times(1)
+    @app.call(env).should.eq(env)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-17 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -125,12 +125,14 @@ files:
 - test/test_builder.rb
 - test/test_client.rb
 - test/test_client_oauth1.rb
+- test/test_default_query.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_timeout.rb
 - test/test_universal.rb
 - test/test_wrapper.rb
 homepage: https://github.com/cardinalblue/rest-core
@@ -153,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Modular Ruby clients interface for REST APIs
@@ -162,12 +164,14 @@ test_files:
 - test/test_builder.rb
 - test/test_client.rb
 - test/test_client_oauth1.rb
+- test/test_default_query.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_timeout.rb
 - test/test_universal.rb
 - test/test_wrapper.rb
 has_rdoc: