rest-core 1.0.3 → 2.0.0

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

@@ -5,7 +5,7 @@ class RestCore::Oauth2Header
   def self.members; [:access_token_type, :access_token]; end
   include RestCore::Middleware
 
-  def call env
+  def call env, &k
     start_time = Time.now
     headers = {'Authorization' =>
                  "#{access_token_type(env)} #{access_token(env)}"}.
@@ -14,11 +14,8 @@ class RestCore::Oauth2Header
     event = Event::WithHeader.new(Time.now - start_time,
               "Authorization: #{headers['Authorization']}") if headers
 
-    app.call(log(cache_key(
-      env.merge(REQUEST_HEADERS => headers || env[REQUEST_HEADERS])), event))
-  end
-
-  def cache_key env
-    env.merge('cache.key' => "#{request_uri(env)}&#{access_token(env)}")
+    app.call(log(env.merge(REQUEST_HEADERS => headers ||
+                                              env[REQUEST_HEADERS]), event),
+             &k)
   end
 end

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

@@ -5,7 +5,7 @@ class RestCore::Oauth2Query
   def self.members; [:access_token]; end
   include RestCore::Middleware
 
-  def call env
+  def call env, &k
     local = if access_token(env)
               env.merge(REQUEST_QUERY =>
                           {'access_token' => access_token(env)}.
@@ -14,6 +14,6 @@ class RestCore::Oauth2Query
               env
             end
 
-    app.call(local)
+    app.call(local, &k)
   end
 end

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

@@ -7,9 +7,18 @@ class RestCore::Timeout
   def self.members; [:timeout]; end
   include RestCore::Middleware
 
-  def call env
-    return app.call(env) if env[DRY] || timeout(env) == 0
-    monitor(env){ |e| app.call(e) }
+  def call env, &k
+    return app.call(env, &k) if env[DRY] || timeout(env) == 0
+    monitor(env){ |e|
+      app.call(e){ |r|
+        if r[ASYNC] ||
+           !(exp = (r[FAIL]||[]).find{ |f| f.kind_of?(::Timeout::Error) })
+          # we do nothing special for callback and rest-client
+          k.call(r)
+        else
+          # it would go to this branch only under response future
+          raise exp
+        end}}
   end
 
   def monitor env
@@ -20,73 +29,20 @@ class RestCore::Timeout
                    name
                  end
 
-    case class_name
-    when /EmHttpRequest|Coolio/
-      if root_fiber? && env[ASYNC]
-        yield(env.merge(TIMER => timeout_with_callback(env, class_name)))
-      else
-        timer = timeout_with_resume(env, class_name)
-        response = yield(env.merge(TIMER => timer))
-        timer.cancel unless timer.canceled?
-        response
-      end
-    else
-      ::Timeout.timeout(timeout(env)){ yield(env) }
-    end
-  end
-
-  def root_fiber?
-    if RestCore.const_defined?(:RootFiber)
-      RootFiber == Fiber.current
-    else
-      true
-    end
-  end
-
-  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
-    else
-      raise "BUG: #{run} is not supported"
-    end
-  end
-
-  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?
-        # no need to check if the fiber is already resumed or not,
-        # because monitor should have already handled this in the
-        # case of fibers
-      }
-
-    when /Coolio/
-      f = Fiber.current
-      timer = CoolioTimer.new(timeout(env))
-      error = timer.error = timeout_error
-      timer.on_timer{ f.resume(error) if f.alive? }
-      timer.attach(::Coolio::Loop.default)
-      timer
+    timer = case class_name
+            when /EmHttpRequest/
+              TimerEm
+            else
+              TimerThread
+            end.new(timeout(env), timeout_error)
 
-    else
-      raise "BUG: #{run} is not supported"
-    end
+    yield(env.merge(TIMER => timer))
   end
 
   def timeout_error
     ::Timeout::Error.new('execution expired')
   end
 
-  autoload :EventMachineTimer,
-    'rest-core/middleware/timeout/eventmachine_timer'
-  autoload       :CoolioTimer,
-    'rest-core/middleware/timeout/coolio_timer'
+  autoload :TimerEm    , 'rest-core/middleware/timeout/timer_em'
+  autoload :TimerThread, 'rest-core/middleware/timeout/timer_thread'
 end

data/lib/rest-core/middleware/timeout/{eventmachine_timer.rb → timer_em.rb}

@@ -1,5 +1,7 @@
 
-class RestCore::Timeout::EventMachineTimer < ::EventMachine::Timer
+require 'eventmachine'
+
+class RestCore::Timeout::TimerEm < ::EventMachine::Timer
   attr_accessor :timeout, :error
 
   def initialize timeout, error, &block

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

@@ -0,0 +1,36 @@
+
+class RestCore::Timeout::TimerThread
+  attr_accessor :timeout, :error
+
+  def initialize timeout, error, &block
+    t = Thread.current
+    self.timeout = timeout
+    self.error   = error
+    self.block   = block || lambda{ t.raise error }
+    @canceled    = false
+    start
+  end
+
+  def on_timeout &block
+    self.block = block
+  end
+
+  def cancel
+    @canceled = true
+  end
+
+  def canceled?
+    @canceled
+  end
+
+  def start
+    return if timeout.nil? || timeout.zero?
+    self.thread = Thread.new{
+      sleep(timeout)
+      block.call unless canceled?
+    }
+  end
+
+  protected
+  attr_accessor :block, :thread
+end

data/lib/rest-core/patch/multi_json.rb

@@ -0,0 +1,8 @@
+
+# encode and decode will be remove in multi_json 2.0
+module MultiJson
+  class << self
+    alias_method :dump, :encode if not respond_to?(:dump)
+    alias_method :load, :decode if not respond_to?(:load)
+  end
+end

data/lib/rest-core/test.rb

@@ -1,4 +1,6 @@
 
+require 'fiber'
+require 'em-http-request'
 require 'rest-core'
 
 require 'rr'
@@ -10,20 +12,9 @@ require 'yaml'
 
 include RR::Adapters::RRMethods
 include WebMock::API
-WebMock.disable_net_connect!
+WebMock.disable_net_connect!(:allow_localhost => true)
 Bacon.summary_on_exit
 
-module TestHelper
-  module_function
-  def normalize_query query
-    '?' + query[1..-1].split('&').sort.join('&')
-  end
-
-  def normalize_url url
-    url.sub(/\?.+/){ |query| TestHelper.normalize_query(query) }
-  end
-end
-
 module Kernel
   def eq? rhs
     self == rhs

data/lib/rest-core/util/json.rb

@@ -0,0 +1,65 @@
+
+module RestCore; end
+module RestCore::Json
+  module MultiJson
+    def self.extended mod
+      require 'rest-core/patch/multi_json'
+      mod.const_set(:ParseError, ::MultiJson::DecodeError)
+    end
+    def encode hash
+      ::MultiJson.dump(hash)
+    end
+    def decode json
+      ::MultiJson.load(json)
+    end
+  end
+
+  module YajlRuby
+    def self.extended mod
+      mod.const_set(:ParseError, Yajl::ParseError)
+    end
+    def encode hash
+      Yajl::Encoder.encode(hash)
+    end
+    def decode json
+      Yajl::Parser.parse(json)
+    end
+  end
+
+  module Json
+    def self.extended mod
+      mod.const_set(:ParseError, JSON::ParserError)
+    end
+    def encode hash
+      JSON.dump(hash)
+    end
+    def decode json
+      JSON.parse(json)
+    end
+  end
+
+  def self.select_json! mod, picked=false
+    if    Object.const_defined?(:MultiJson)
+      mod.send(:extend, MultiJson)
+    elsif Object.const_defined?(:Yajl)
+      mod.send(:extend, YajlRuby)
+    elsif Object.const_defined?(:JSON)
+      mod.send(:extend, Json)
+    elsif picked
+      raise LoadError.new(
+        'No JSON library found. Tried: multi_json, yajl-ruby, json.')
+    else
+      # pick a json gem if available
+      %w[multi_json yajl json].each{ |json|
+        begin
+          require json
+          break
+        rescue LoadError
+        end
+      }
+      select_json!(mod, true)
+    end
+  end
+
+  select_json!(self)
+end

data/lib/rest-core/util/parse_query.rb

@@ -12,8 +12,8 @@ module RestCore::ParseQuery
     def parse_query(qs, d = nil)
       params = {}
 
-      (qs || '').split(d ? /[#{d}] */n : DEFAULT_SEP).each do |p|
-        k, v = p.split('=', 2).map { |x| unescape(x) }
+      (qs || '').split(d ? /[#{d}] */n : /[&;] */n).each do |p|
+        k, v = p.split('=', 2).map { |x| URI.decode_www_form_component(x) }
         if cur = params[k]
           if cur.class == Array
             params[k] << v

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '1.0.3'
+  VERSION = '2.0.0'
 end

data/lib/rest-core/wrapper.rb

@@ -4,38 +4,38 @@ require 'rest-core'
 module RestCore::Wrapper
   include RestCore
 
-  module DefaultApp
-    def default_app
-      @default_app ||= RestCore::Dry
+  module DefaultEngine
+    def default_engine
+      @default_engine ||= RestCore::Dry
     end
   end
 
   def self.included mod
-    mod.send(:extend, DefaultApp)
+    mod.send(:extend, DefaultEngine)
     class << mod
-      attr_writer :default_app
+      attr_writer :default_engine
     end
   end
 
-  attr_reader :init, :middles, :wrapped
-  attr_writer :default_app
-  def default_app
-    @default_app ||= self.class.default_app
+  attr_reader :middles, :wrapped
+  attr_writer :default_engine
+  def default_engine
+    @default_engine ||= self.class.default_engine
   end
 
   def initialize &block
     @middles ||= []
     instance_eval(&block) if block_given?
     @wrapped ||= to_app
-    @init      = nil
+    @engine    = nil
   end
 
   def use middle, *args, &block
     middles << [middle, args, block]
   end
 
-  def run app
-    @init = app
+  def run engine
+    @engine = engine
   end
 
   def members
@@ -46,14 +46,14 @@ module RestCore::Wrapper
       else
         middle.members
       end if middle.respond_to?(:members)
-    }.flatten
+    }.flatten.compact
   end
 
-  def to_app app=init || default_app
+  def to_app engine=@engine || default_engine
     # === foldr m.new app middles
-    middles.reverse.inject(app.new){ |app_, (middle, args, block)|
+    middles.reverse.inject(engine.new){ |app, (middle, args, block)|
       begin
-        middle.new(app_, *partial_deep_copy(args), &block)
+        middle.new(app, *partial_deep_copy(args), &block)
       rescue ArgumentError => e
         raise ArgumentError.new("#{middle}: #{e}")
       end

data/rest-core.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "1.0.3"
+  s.version = "2.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-08-15"
-  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.date = "2012-10-31"
+  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-more]: https://github.com/cardinalblue/rest-more"
   s.email = ["dev (XD) cardinalblue.com"]
   s.files = [
   ".gitignore",
@@ -22,30 +22,22 @@ Gem::Specification.new do |s|
   "README.md",
   "Rakefile",
   "TODO.md",
-  "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",
+  "example/simple.rb",
+  "example/use-cases.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",
   "lib/rest-core/client/simple.rb",
   "lib/rest-core/client/universal.rb",
   "lib/rest-core/client_oauth1.rb",
+  "lib/rest-core/engine/auto.rb",
+  "lib/rest-core/engine/dry.rb",
+  "lib/rest-core/engine/em-http-request.rb",
+  "lib/rest-core/engine/future/future.rb",
+  "lib/rest-core/engine/future/future_fiber.rb",
+  "lib/rest-core/engine/future/future_thread.rb",
+  "lib/rest-core/engine/rest-client.rb",
   "lib/rest-core/error.rb",
   "lib/rest-core/event.rb",
   "lib/rest-core/middleware.rb",
@@ -62,21 +54,22 @@ Gem::Specification.new do |s|
   "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/json_request.rb",
+  "lib/rest-core/middleware/json_response.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/middleware/timeout/timer_em.rb",
+  "lib/rest-core/middleware/timeout/timer_thread.rb",
+  "lib/rest-core/patch/multi_json.rb",
   "lib/rest-core/patch/rest-client.rb",
   "lib/rest-core/test.rb",
   "lib/rest-core/util/hmac.rb",
+  "lib/rest-core/util/json.rb",
   "lib/rest-core/util/parse_query.rb",
   "lib/rest-core/version.rb",
   "lib/rest-core/wrapper.rb",
-  "pending/test_multi.rb",
-  "pending/test_test_util.rb",
   "rest-core.gemspec",
   "test/test_auth_basic.rb",
   "test/test_builder.rb",
@@ -84,12 +77,16 @@ Gem::Specification.new do |s|
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
   "test/test_default_query.rb",
+  "test/test_em_http_request.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
+  "test/test_error_handler.rb",
   "test/test_follow_redirect.rb",
-  "test/test_json_decode.rb",
+  "test/test_json_request.rb",
+  "test/test_json_response.rb",
   "test/test_oauth1_header.rb",
   "test/test_payload.rb",
+  "test/test_simple.rb",
   "test/test_timeout.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]
@@ -104,12 +101,16 @@ Gem::Specification.new do |s|
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
   "test/test_default_query.rb",
+  "test/test_em_http_request.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
+  "test/test_error_handler.rb",
   "test/test_follow_redirect.rb",
-  "test/test_json_decode.rb",
+  "test/test_json_request.rb",
+  "test/test_json_response.rb",
   "test/test_oauth1_header.rb",
   "test/test_payload.rb",
+  "test/test_simple.rb",
   "test/test_timeout.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]