rest-core 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07acac398a096c63464e9dca43b964dbe0d6359a
-  data.tar.gz: 887c818f4a83591b316511c709fbbf10e2d45c35
+  metadata.gz: ab6a9f5e489329946784228471a7647aac66bbdd
+  data.tar.gz: 4b8d30e22074977305146a9a0cc875334c473599
 SHA512:
-  metadata.gz: 24e9ebd41021150461013695d6e7cf4d2e6c628ea5156787c7dd957d4cd72e9df3452529518cfc9a48d1c837379aebee3cc6485bbe6422ba196fb3951f02da19
-  data.tar.gz: 6a0da34cf3b1221b9b791fb63eee8419c2ce93b6766e395019453f5dc65a8859f24a73a48ef46728ef7e9262186ff0d032334d82ddb777cfcad4b08ec920e4ad
+  metadata.gz: 09378189003073e9e0fcde4b210c6ef3e5e7441388e006ba5f5e9bb916acd6b191ac7fd7e9649837dcd82e8e5d360a1efe41f3e6fa247fc9911e584b5dd074ce
+  data.tar.gz: cdf158fd0a2ca140d64792e7daa29575c9914ca5ede20b556ef04f64bc93792f053c3d2e49f59a6888823baa623fc467dbd41edac26544b9d97057e7b511b7e2

data/.gitignore

@@ -1 +1,2 @@
 /pkg/
+/coverage/

data/.travis.yml

@@ -1,9 +1,11 @@
-before_install: 'git submodule update --init'
-script: 'ruby -r bundler/setup -S rake test'
 
+language: ruby
 rvm:
   - 1.9
   - 2.0
   - 2.1
   - rbx-2
   - jruby
+
+install: 'bundle install --retry=3'
+script: 'ruby -r bundler/setup -S rake test'

data/CHANGES.md

@@ -1,5 +1,37 @@
 # CHANGES
 
+## rest-core 3.4.0 -- 2014-11-26
+
+### Incompatible changes
+
+* Removed rest-client support.
+* Removed net-http-persistent support.
+* Removed patch for old multi-json.
+
+### Bugs fixed
+
+* `RC::JsonRequest` can now POST, PUT, or PATCH with a single `false`.
+
+* Previously, we're not handling timeout correctly. We left all that to
+  httpclient, and which would raise `HTTPClient::ConnectTimeoutError` and
+  `HTTPClient::ReceiveTimeoutError`. The problem is that connecting and
+  receiving are counted separately. That means, if we have 30 seconds timeout,
+  we might be ending up with 58 seconds requesting time, for 29 seconds
+  connecting time and 29 seconds receiving time. Now it should probably
+  interrupt the request in 30 seconds by handling this by ourselves with a
+  timer thread in the background. The timer thread would be shut down
+  automatically if there's no jobs left, and it would recreate the thread
+  when there's a job comes in, keeping working until there's no jobs left.
+
+### Enhancements
+
+* Introduced `RC::Timer.interval` which is the interval to check if there's
+  a request timed out. The default interval is 1 second, which means it would
+  check if there's a request timed out for every 1 second. This also means
+  timeout with less than 1 second won't be accurate at all. You could
+  decrease the value if you need timeout less than 1 second, or increase it
+  if your timeout is far from 30 second by calling `RC::Timer.interval = 5`.
+
 ## rest-core 3.3.3 -- 2014-11-07
 
 ### Bugs fixed

data/Gemfile

@@ -16,6 +16,9 @@ gem 'multi_json'
 
 gem 'rack'
 
+gem 'simplecov', :require => false if ENV['COV']
+gem 'coveralls', :require => false if ENV['CI']
+
 platforms :ruby do
   gem 'yajl-ruby'
 end

data/README.md

@@ -1,4 +1,4 @@
-# rest-core [![Build Status](https://secure.travis-ci.org/godfat/rest-core.png?branch=master)](http://travis-ci.org/godfat/rest-core)
+# rest-core [![Build Status](https://secure.travis-ci.org/godfat/rest-core.png?branch=master)](http://travis-ci.org/godfat/rest-core) [![Coverage Status](https://coveralls.io/repos/godfat/rest-core/badge.png)](https://coveralls.io/r/godfat/rest-core)
 
 by Lin Jen-Shin ([godfat](http://godfat.org))
 

data/example/use-cases.rb

@@ -23,13 +23,8 @@ def def_use_case name, &block
   end
 end
 
-def q str, m=nil
-  p = lambda{ puts "\e[33m=> #{str.inspect}\e[0m" }
-  if m
-    m.synchronize(&p)
-  else
-    p.call
-  end
+def q str
+  Thread.exclusive{ puts "\e[33m=> #{str.inspect}\e[0m" }
 end
 
 # ----------------------------------------------------------------------
@@ -51,36 +46,36 @@ def_use_case 'pure_ruby_cache_requests' do
 end
 
 def_use_case 'pure_ruby_callback_requests' do
-  m = Mutex.new
   RC::Universal.new(:json_response => true                                  ,
                     :site          => 'https://graph.facebook.com/'         ,
-                    :log_method    => lambda{|str| m.synchronize{puts(str)}}).
+                    :log_method    => lambda{|str|
+                      Thread.exclusive{puts(str)}}).
     get('4'){ |res|
       if res.kind_of?(Exception)
-        p "Encountering: #{res}"
+        q "Encountering: #{res}"
         next
       end
-      q res['name'], m
+      q res['name']
     }.
     get('5'){ |res|
       if res.kind_of?(Exception)
-        p "Encountering: #{res}"
+        q "Encountering: #{res}"
         next
       end
-      q res['name'], m
+      q res['name']
     }.wait
 end
 
 def_use_case 'pure_ruby_nested_concurrent_requests' do
-  m = Mutex.new
   c = RC::Universal.new(:json_response => true                              ,
                         :site          => 'https://graph.facebook.com/'     ,
-                        :log_method => lambda{|str| m.synchronize{puts(str)}})
+                        :log_method => lambda{ |str|
+                          Thread.exclusive{puts(str)}})
 
   %w[4 5].each{ |user|
     c.get(user, :fields => 'cover'){ |data|
       if data.kind_of?(Exception)
-        q "Encountering: #{data}", m
+        q "Encountering: #{data}"
         next
       end
 
@@ -89,11 +84,11 @@ def_use_case 'pure_ruby_nested_concurrent_requests' do
       likes    = c.get("#{cover['id']}/likes")
       most_liked_comment = comments['data'].max_by{|d|d['like_count']}
 
-      q "Author of most liked comment from #{user}'s cover photo:", m
-      q most_liked_comment['from']['name'], m
+      q "Author of most liked comment from #{user}'s cover photo:"
+      q most_liked_comment['from']['name']
 
       y = !!likes['data'].find{|d|d['id'] == most_liked_comment['from']['id']}
-      q "Did the user also like the cover?: #{y}", m
+      q "Did the user also like the cover?: #{y}"
     }
   }
 

data/lib/rest-core.rb

@@ -73,8 +73,6 @@ module RestCore
   # engines
   autoload :Dry           , 'rest-core/engine/dry'
   autoload :HttpClient    , 'rest-core/engine/http-client'
-  autoload :RestClient    , 'rest-core/engine/rest-client'
-  autoload :NetHttpPersistent, 'rest-core/engine/net-http-persistent'
 
   # clients
   autoload :Simple        , 'rest-core/client/simple'

data/lib/rest-core/engine.rb

@@ -17,11 +17,6 @@ class RestCore::Engine
     Payload.generate_with_headers(env[REQUEST_PAYLOAD], env[REQUEST_HEADERS])
   end
 
-  def calculate_timeout timer
-    return [] unless timer
-    [timer.timeout, timer.timeout]
-  end
-
   def normalize_headers headers
     headers.inject({}){ |r, (k, v)|
       r[k.to_s.upcase.tr('-', '_')] = if v.kind_of?(Array) && v.size == 1

data/lib/rest-core/engine/http-client.rb

@@ -19,9 +19,6 @@ class RestCore::HttpClient < RestCore::Engine
   end
 
   def request_sync client, payload, headers, promise, env
-    client.connect_timeout, client.receive_timeout =
-      calculate_timeout(env[TIMER])
-
     res = client.request(env[REQUEST_METHOD], env[REQUEST_URI], nil,
             payload, {'User-Agent' => 'Ruby'}.merge(headers))
 

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

@@ -7,11 +7,12 @@ class RestCore::JsonRequest
   include RestCore::Middleware
 
   JSON_REQUEST_HEADER = {'Content-Type' => 'application/json'}.freeze
+  JSON_REQUEST_METHOD = [:post, :put, :patch]
 
   def call env, &k
     return app.call(env, &k) unless json_request(env)
-    return app.call(env, &k) unless env[REQUEST_PAYLOAD] &&
-                                    !env[REQUEST_PAYLOAD].empty?
+    return app.call(env, &k) unless
+      JSON_REQUEST_METHOD.include?(env[REQUEST_METHOD])
 
     app.call(env.merge(
       REQUEST_HEADERS => JSON_REQUEST_HEADER.merge(env[REQUEST_HEADERS]||{}),

data/lib/rest-core/promise.rb

@@ -62,19 +62,28 @@ class RestCore::Promise
   end
 
   # called in client thread
-  def defer &job
+  def defer
     if pool_size < 0 # negative number for blocking call
-      job.call
-    elsif pool_size > 0
-      backtrace = caller + self.class.backtrace
-      self.task = client_class.thread_pool.defer do
-        synchronized_yield(backtrace){ job.call }
-      end
+      self.thread = Thread.current
+      # set timeout after thread set, before yield (because yield is blocking)
+      env[TIMER].on_timeout{ cancel_task } if env[TIMER]
+      protected_yield{ yield }
     else
       backtrace = caller + self.class.backtrace
-      Thread.new{ synchronized_yield(backtrace){ job.call } }
+      if pool_size > 0
+        self.task = client_class.thread_pool.defer(mutex) do
+          Thread.current[:backtrace] = backtrace
+          protected_yield{ yield }
+        end
+      else
+        self.thread = Thread.new do
+          Thread.current[:backtrace] = backtrace
+          protected_yield{ yield }
+        end
+      end
+      # set timeout after thread/task set
+      env[TIMER].on_timeout{ cancel_task } if env[TIMER]
     end
-    env[TIMER].on_timeout{ reject(env[TIMER].error) } if env[TIMER]
   end
 
   # called in client thread (client.wait)
@@ -92,24 +101,13 @@ class RestCore::Promise
   # called in requesting thread after the request is done
   def fulfill body, status, headers, socket=nil
     env[TIMER].cancel if env[TIMER]
-    self.body, self.status, self.headers, self.socket =
-      body, status, headers, socket
-    # under ASYNC callback, should call immediately
-    callback if immediate
-  ensure
-    condv.broadcast # client or response might be waiting
+    mutex.synchronize{ fulfilling(body, status, headers, socket) }
   end
 
   # called in requesting thread if something goes wrong or timed out
   def reject error
-    task.cancel if task
-
-    self.error = if error.kind_of?(Exception)
-                   error
-                 else
-                   Error.new(error || 'unknown')
-                 end
-    fulfill('', 0, {})
+    env[TIMER].cancel if env[TIMER]
+    mutex.synchronize{ rejecting(error) }
   end
 
   # append your actions, which would be called when we're calling back
@@ -130,21 +128,42 @@ class RestCore::Promise
   attr_accessor :env, :k, :immediate,
                 :body, :status, :headers, :socket,
                 :response, :error, :called,
-                :condv, :mutex, :task
+                :condv, :mutex, :task, :thread
 
   private
+  def fulfilling body, status, headers, socket=nil
+    self.body, self.status, self.headers, self.socket =
+      body, status, headers, socket
+    # under ASYNC callback, should call immediately
+    callback if immediate
+  ensure
+    condv.broadcast # client or response might be waiting
+  end
+
+  def rejecting error
+    self.error = if error.kind_of?(Exception)
+                   error
+                 else
+                   Error.new(error || 'unknown')
+                 end
+    fulfilling('', 0, {})
+  end
+
   # called in a new thread if pool_size == 0, otherwise from the pool
   # i.e. requesting thread
-  def synchronized_yield backtrace
-    Thread.current[:backtrace] = backtrace
-    mutex.synchronize{ yield }
+  def protected_yield
+    yield
   rescue Exception => e
-    self.class.set_backtrace(e)
-    # nothing we can do here for an asynchronous exception,
-    # so we just log the error
-    # TODO: add error_log_method
-    warn "RestCore: ERROR: #{e}\n  from #{e.backtrace.inspect}"
-    reject(e) unless done?  # not done: i/o error; done: callback error
+    # pray if timeout won't trigger here!
+    env[TIMER].cancel if env[TIMER]
+    mutex.synchronize do
+      self.class.set_backtrace(e)
+      # nothing we can do here for an asynchronous exception,
+      # so we just log the error
+      # TODO: add error_log_method
+      warn "RestCore: ERROR: #{e}\n  from #{e.backtrace.inspect}"
+      rejecting(e) unless done?  # not done: i/o error; done: callback error
+    end
   end
 
   # called in client thread, when yield is called
@@ -161,6 +180,18 @@ class RestCore::Promise
     self.called = true
   end
 
+  def cancel_task
+    mutex.synchronize do
+      next if done?
+      if t = thread || task.thread
+        t.raise(env[TIMER].error)
+      else
+        task.cancel
+        rejecting(env[TIMER].error)
+      end
+    end
+  end
+
   def client_class; env[CLIENT].class; end
   def pool_size
     @pool_size ||= if client_class.respond_to?(:pool_size)

data/lib/rest-core/thread_pool.rb

@@ -26,7 +26,7 @@ class RestCore::ThreadPool
       mutex.synchronize do
         if queue.empty?
           condv.wait(mutex, timeout)
-          queue.shift || lambda{ false } # shutdown idle workers
+          queue.shift || lambda{ |_| false } # shutdown idle workers
         else
           queue.shift
         end
@@ -41,19 +41,20 @@ class RestCore::ThreadPool
     attr_reader :queue, :mutex, :condv
   end
 
-  class Task < Struct.new(:job)
+  class Task < Struct.new(:job, :mutex, :thread, :cancelled)
     # this should never fail
-    def call
-      job.call unless cancelled
+    def call working_thread
+      mutex.synchronize do
+        return if cancelled
+        self.thread = working_thread
+      end
+      job.call
       true
     end
 
-    # called from the other thread telling us it's timed out
     def cancel
-      @cancelled = true
+      self.cancelled = true
     end
-    protected
-    attr_reader :thread, :mutex, :cancelled
   end
 
   def self.[] client_class
@@ -86,9 +87,9 @@ class RestCore::ThreadPool
     client_class.pool_idle_time
   end
 
-  def defer &job
+  def defer mutex=nil, &job
     mutex.synchronize do
-      task = Task.new(job)
+      task = Task.new(job, mutex)
       queue << task
       spawn_worker if waiting == 0 && workers.size < max_size
       task
@@ -96,7 +97,7 @@ class RestCore::ThreadPool
   end
 
   def trim force=false
-    queue << lambda{ false } if force || waiting > 0
+    queue << lambda{ |_| false } if force || waiting > 0
   end
 
   # Block on shutting down, and should not add more jobs while shutting down
@@ -119,7 +120,7 @@ class RestCore::ThreadPool
         mutex.synchronize{ @waiting += 1 }
         task = queue.pop(idle_time)
         mutex.synchronize{ @waiting -= 1 }
-      end while task.call
+      end while task.call(Thread.current)
 
       mutex.synchronize{ workers.delete(Thread.current) }
     }

data/lib/rest-core/timer.rb

@@ -1,12 +1,33 @@
 
+require 'thread'
 require 'timers'
 
 class RestCore::Timer
-  TimerGen = if Timers.respond_to?(:new)
-               Timers.new
-             else
-               Timers::Group.new
-             end
+  @mutex = Mutex.new
+  @interval = 1
+
+  singleton_class.module_eval do
+    attr_accessor :interval
+
+    def group
+      @group ||= @mutex.synchronize{ @group || group_new }
+    end
+
+    private
+    def group_new
+      g = Timers::Group.new
+      g.every(interval){}
+      @thread = Thread.new do
+        begin
+          g.wait
+        rescue => e
+          warn "RestCore::Timer: ERROR: #{e}\n  from #{e.backtrace.inspect}"
+        end while g.count > 1
+        @group = nil
+      end
+      g
+    end
+  end
 
   attr_accessor :timeout, :error
   def initialize timeout, error, &block
@@ -22,11 +43,12 @@ class RestCore::Timer
 
   def cancel
     timer.cancel
+    self.block = nil
   end
 
   def start
     return if timeout.nil? || timeout.zero?
-    self.timer = TimerGen.after(timeout){ block.call }
+    self.timer = self.class.group.after(timeout){ block.call if block }
   end
 
   protected

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

@@ -3,7 +3,6 @@ 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

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '3.3.3'
+  VERSION = '3.4.0'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.3.3 ruby lib
+# stub: rest-core 3.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.3.3"
+  s.version = "3.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-11-07"
+  s.date = "2014-11-26"
   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/godfat/rest-more"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -33,8 +33,6 @@ Gem::Specification.new do |s|
   "lib/rest-core/engine.rb",
   "lib/rest-core/engine/dry.rb",
   "lib/rest-core/engine/http-client.rb",
-  "lib/rest-core/engine/net-http-persistent.rb",
-  "lib/rest-core/engine/rest-client.rb",
   "lib/rest-core/error.rb",
   "lib/rest-core/event.rb",
   "lib/rest-core/event_source.rb",
@@ -61,8 +59,6 @@ Gem::Specification.new do |s|
   "lib/rest-core/middleware/query_response.rb",
   "lib/rest-core/middleware/smash_response.rb",
   "lib/rest-core/middleware/timeout.rb",
-  "lib/rest-core/patch/multi_json.rb",
-  "lib/rest-core/patch/rest-client.rb",
   "lib/rest-core/promise.rb",
   "lib/rest-core/test.rb",
   "lib/rest-core/thread_pool.rb",
@@ -98,6 +94,7 @@ Gem::Specification.new do |s|
   "test/test_event_source.rb",
   "test/test_follow_redirect.rb",
   "test/test_future.rb",
+  "test/test_httpclient.rb",
   "test/test_json_request.rb",
   "test/test_json_response.rb",
   "test/test_oauth1_header.rb",
@@ -106,7 +103,6 @@ Gem::Specification.new do |s|
   "test/test_payload.rb",
   "test/test_promise.rb",
   "test/test_query_response.rb",
-  "test/test_rest-client.rb",
   "test/test_simple.rb",
   "test/test_smash.rb",
   "test/test_smash_response.rb",
@@ -115,7 +111,7 @@ Gem::Specification.new do |s|
   "test/test_universal.rb"]
   s.homepage = "https://github.com/godfat/rest-core"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.4.2"
+  s.rubygems_version = "2.4.4"
   s.summary = "Modular Ruby clients interface for REST APIs."
   s.test_files = [
   "test/test_auth_basic.rb",
@@ -136,6 +132,7 @@ Gem::Specification.new do |s|
   "test/test_event_source.rb",
   "test/test_follow_redirect.rb",
   "test/test_future.rb",
+  "test/test_httpclient.rb",
   "test/test_json_request.rb",
   "test/test_json_response.rb",
   "test/test_oauth1_header.rb",
@@ -144,7 +141,6 @@ Gem::Specification.new do |s|
   "test/test_payload.rb",
   "test/test_promise.rb",
   "test/test_query_response.rb",
-  "test/test_rest-client.rb",
   "test/test_simple.rb",
   "test/test_smash.rb",
   "test/test_smash_response.rb",

data/task/gemgem.rb

@@ -38,6 +38,99 @@ module Gemgem
     self.spec = spec
   end
 
+  def gem_install
+    require 'rubygems/commands/install_command'
+    # read ~/.gemrc
+    Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
+    Gem::Command.extra_args = Gem.configuration[:gem]
+
+    # setup install options
+    cmd = Gem::Commands::InstallCommand.new
+    cmd.handle_options([])
+
+    # install
+    install = Gem::Installer.new(gem_path, cmd.options)
+    install.install
+    puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
+  end
+
+  def gem_spec
+    create
+    write
+  end
+
+  def gem_build
+    require 'fileutils'
+    require 'rubygems/package'
+    gem = nil
+    Dir.chdir(dir) do
+      gem = Gem::Package.build(Gem::Specification.load(spec_path))
+      FileUtils.mkdir_p(pkg_dir)
+      FileUtils.mv(gem, pkg_dir) # gem is relative path, but might be ok
+    end
+    puts "\e[35mGem built: \e[33m#{strip_path("#{pkg_dir}/#{gem}")}\e[0m"
+  end
+
+  def gem_release
+    sh_git('tag', gem_tag)
+    sh_git('push')
+    sh_git('push', '--tags')
+    sh_gem('push', gem_path)
+  end
+
+  def gem_check
+    ver = spec.version.to_s
+
+    if ENV['VERSION'].nil?
+      puts("\e[35mExpected "                                  \
+           "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
+      exit(1)
+
+    elsif ENV['VERSION'] != ver
+      puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+           "\e[35mbut got\n         "                         \
+           "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
+      exit(2)
+    end
+  end
+
+  def test
+    return if test_files.empty?
+
+    if ENV['COV'] || ENV['CI']
+      require 'simplecov'
+      if ENV['CI']
+        require 'coveralls'
+        SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+      end
+      SimpleCov.start do
+        add_filter('test/')
+        add_filter('test.rb')
+      end
+    end
+
+    test_files.each{ |file| require "#{dir}/#{file[0..-4]}" }
+  end
+
+  def clean
+    return if ignored_files.empty?
+
+    require 'fileutils'
+    trash = File.expand_path("~/.Trash/#{spec.name}")
+    puts "Move the following files into: \e[35m#{strip_path(trash)}\e[33m"
+
+    ignored_files.each do |file|
+      from = "#{dir}/#{file}"
+      to   = "#{trash}/#{File.dirname(file)}"
+      puts strip_path(from)
+
+      FileUtils.mkdir_p(to)
+      FileUtils.mv(from, to)
+    end
+
+    print "\e[0m"
+  end
+
   def write
     File.open(spec_path, 'w'){ |f| f << split_lines(spec.to_ruby) }
   end
@@ -173,82 +266,38 @@ namespace :gem do
 
 desc 'Install gem'
 task :install => [:build] do
-  Gemgem.sh_gem('install', Gemgem.gem_path)
+  Gemgem.gem_install
 end
 
 desc 'Build gem'
 task :build => [:spec] do
-  require 'fileutils'
-  require 'rubygems/package'
-  gem = nil
-  Dir.chdir(Gemgem.dir) do
-    gem = Gem::Package.build(Gem::Specification.load(Gemgem.spec_path))
-    FileUtils.mkdir_p(Gemgem.pkg_dir)
-    FileUtils.mv(gem, Gemgem.pkg_dir) # gem is relative path, but might be ok
-  end
-  puts "\e[35mGem built: \e[33m" \
-       "#{Gemgem.strip_path("#{Gemgem.pkg_dir}/#{gem}")}\e[0m"
+  Gemgem.gem_build
 end
 
 desc 'Generate gemspec'
 task :spec do
-  Gemgem.create
-  Gemgem.write
+  Gemgem.gem_spec
 end
 
 desc 'Release gem'
 task :release => [:spec, :check, :build] do
-  Gemgem.module_eval do
-    sh_git('tag', Gemgem.gem_tag)
-    sh_git('push')
-    sh_git('push', '--tags')
-    sh_gem('push', Gemgem.gem_path)
-  end
+  Gemgem.gem_release
 end
 
 task :check do
-  ver = Gemgem.spec.version.to_s
-
-  if ENV['VERSION'].nil?
-    puts("\e[35mExpected "                                  \
-         "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
-    exit(1)
-
-  elsif ENV['VERSION'] != ver
-    puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
-         "\e[35mbut got\n         "                         \
-         "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
-    exit(2)
-  end
+  Gemgem.gem_check
 end
 
 end # of gem namespace
 
 desc 'Run tests'
 task :test do
-  next if Gemgem.test_files.empty?
-  Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
+  Gemgem.test
 end
 
 desc 'Trash ignored files'
 task :clean => ['gem:spec'] do
-  next if Gemgem.ignored_files.empty?
-
-  require 'fileutils'
-  trash = File.expand_path("~/.Trash/#{Gemgem.spec.name}")
-  puts "Move the following files into:" \
-       " \e[35m#{Gemgem.strip_path(trash)}\e[33m"
-
-  Gemgem.ignored_files.each do |file|
-    from = "#{Gemgem.dir}/#{file}"
-    to   = "#{trash}/#{File.dirname(file)}"
-    puts Gemgem.strip_path(from)
-
-    FileUtils.mkdir_p(to)
-    FileUtils.mv(from, to)
-  end
-
-  print "\e[0m"
+  Gemgem.clean
 end
 
 task :default do

data/test/test_builder.rb

@@ -10,13 +10,13 @@ describe RC::Builder do
     RC::Builder.new.to_app.should.kind_of? RC::Engine
   end
 
-  would 'switch default_engine to RestCore::RestClient' do
+  would 'switch default_engine to RestCore::Dry a' do
     builder = Class.new(RC::Builder)
-    builder.default_engine = RC::RestClient
-    builder.new.to_app.class.should.eq RC::RestClient
+    builder.default_engine = RC::Dry
+    builder.new.to_app.class.should.eq RC::Dry
   end
 
-  would 'switch default_engine to RestCore::Dry' do
+  would 'switch default_engine to RestCore::Dry b' do
     builder = RC::Builder.dup
     builder.default_engine = RC::Dry
     builder.client.new.app.class.should.eq RC::Dry

data/test/test_client.rb

@@ -137,7 +137,7 @@ describe RC::Simple do
     client = Class.new(RC::Simple).new
     stub_request(:get, url).to_return(:body => 'nnf')
 
-    (0..1).each do |size|
+    (-1..1).each do |size|
       mock(any_instance_of(RC::Promise)).warn(is_a(String)) do |msg|
         msg.should.include?('nnf')
       end
@@ -147,14 +147,6 @@ describe RC::Simple do
       end
       client.class.shutdown
     end
-
-    client.class.pool_size = -1
-    should.raise do
-      client.get(url) do |body|
-        raise body
-      end
-    end.message.should.eq 'nnf'
-    client.class.shutdown
   end
 
   would 'be able to access caller outside the callback' do

data/test/{test_rest-client.rb → test_httpclient.rb}

@@ -1,14 +1,14 @@
 
 require 'rest-core/test'
 
-describe RC::RestClient do
+describe RC::HttpClient do
   describe 'POST Payload' do
     after do
       WebMock.reset!
     end
 
     client = RC::Builder.client
-    client.builder.run(RC::RestClient)
+    client.builder.run(RC::HttpClient)
     path = 'http://example.com'
     ok   = 'OK'
     c    = client.new
@@ -39,24 +39,11 @@ describe RC::RestClient do
     end
 
     would 'not kill the thread if error was coming from the task' do
-      mock(RestClient::Request).execute{ raise 'boom' }.with_any_args
-      c.request(RC::RESPONSE_KEY => RC::FAIL).first.message.should.eq 'boom'
-      Muack.verify
-    end
-
-    would 'cancel the task if timing out' do
-      timer = Object.new.instance_eval do
-        def on_timeout; yield ; end
-        def error     ; 'boom'; end
-        def cancel    ;       ; end
-        self
+      mock(any_instance_of(RC::Promise)).warn(is_a(String)) do |msg|
+        msg.should.include?('boom')
       end
-      stub(c.class).pool_size{ 1 }
-      stub(c.class.thread_pool).queue{ [] } # don't queue the task
-      mock(RC::ThreadPool::Task).new.with_any_args.
-        peek_return{ |t| mock(t).cancel; t } # the task should be cancelled
-      c.request(RC::RESPONSE_KEY => RC::FAIL, RC::TIMER => timer).
-        first.message.should.eq 'boom'
+      mock(HTTPClient).new{ raise 'boom' }.with_any_args
+      c.request(RC::RESPONSE_KEY => RC::FAIL).first.message.should.eq 'boom'
       Muack.verify
     end
   end

data/test/test_json_request.rb

@@ -3,7 +3,7 @@ require 'rest-core/test'
 
 describe RC::JsonRequest do
   app = RC::JsonRequest.new(RC::Dry.new, true)
-  env = {RC::REQUEST_HEADERS => {}}
+  env = {RC::REQUEST_HEADERS => {}, RC::REQUEST_METHOD => :post}
   request_params = {
     'key' => 'value',
     'array' => [1, 2, 3],
@@ -21,9 +21,21 @@ describe RC::JsonRequest do
         RC::REQUEST_PAYLOAD => RC::Json.encode(request_params))}
   end
 
-  would 'do nothing if payload is empty' do
-    e = env.merge(RC::REQUEST_PAYLOAD => {})
-    app.call(e){ |res| res.should.eq e }
+  would 'encode false and nil' do
+    [[nil, 'null'], [false, 'false'], [true, 'true']].each do |(value, exp)|
+      [:post, :put, :patch].each do |meth|
+        e = env.merge(RC::REQUEST_METHOD  => meth,
+                      RC::REQUEST_PAYLOAD => value)
+        app.call(e){ |res| res[RC::REQUEST_PAYLOAD].should.eq(exp) }
+      end
+    end
+  end
+
+  would 'do nothing for get, delete, head, options' do
+    [:get, :delete, :head, :options].each do |meth|
+      e = env.merge(RC::REQUEST_PAYLOAD => {}, RC::REQUEST_METHOD => meth)
+      app.call(e){ |res| res.should.eq e }
+    end
   end
 
   would 'do nothing if json_request is false' do

data/test/test_timeout.rb

@@ -1,5 +1,6 @@
 
 require 'rest-core/test'
+require 'rest-core/engine'
 
 describe RC::Timeout do
   app = RC::Timeout.new(RC::Dry.new, 0)
@@ -26,4 +27,57 @@ describe RC::Timeout do
     lambda{ app.call(env){} }.should    .raise(RuntimeError)
     lambda{ sleep 0.01      }.should.not.raise(Timeout::Error)
   end
+
+  would 'cancel the task if timing out' do
+    timer = Object.new.instance_eval do
+      def on_timeout; yield ; end
+      def error     ; 'boom'; end
+      def cancel    ;       ; end
+      self
+    end
+    app = RC::Builder.client do
+      run Class.new(RC::Engine){
+        def request _, _
+          sleep
+        end
+      }
+    end
+    app.pool_size = 1
+    app.new.request(RC::RESPONSE_KEY => RC::FAIL, RC::TIMER => timer).
+      first.message.should.eq 'boom'
+    Muack.verify
+  end
+
+  would 'interrupt the task if timing out' do
+    rd, wr = IO.pipe
+    timer = Object.new.instance_eval do
+      define_singleton_method :on_timeout do |&block|
+        Thread.new do
+          rd.gets
+          block.call
+        end
+      end
+      def error     ; 'boom'; end
+      def cancel    ;       ; end
+      self
+    end
+    app = RC::Builder.client do
+      run Class.new(RC::Engine){
+        def request _, env
+          env['pipe'].puts
+          sleep
+        end
+      }
+    end
+    (-1..1).each do |size|
+      mock(any_instance_of(RC::Promise)).warn(is_a(String)) do |msg|
+        msg.should.include?('boom')
+      end
+      app.pool_size = size
+      app.new.request(RC::RESPONSE_KEY => RC::FAIL, RC::TIMER => timer,
+                      'pipe' => wr).
+        first.message.should.eq 'boom'
+      Muack.verify
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -90,8 +90,6 @@ files:
 - lib/rest-core/engine.rb
 - lib/rest-core/engine/dry.rb
 - lib/rest-core/engine/http-client.rb
-- lib/rest-core/engine/net-http-persistent.rb
-- lib/rest-core/engine/rest-client.rb
 - lib/rest-core/error.rb
 - lib/rest-core/event.rb
 - lib/rest-core/event_source.rb
@@ -118,8 +116,6 @@ files:
 - lib/rest-core/middleware/query_response.rb
 - lib/rest-core/middleware/smash_response.rb
 - lib/rest-core/middleware/timeout.rb
-- lib/rest-core/patch/multi_json.rb
-- lib/rest-core/patch/rest-client.rb
 - lib/rest-core/promise.rb
 - lib/rest-core/test.rb
 - lib/rest-core/thread_pool.rb
@@ -155,6 +151,7 @@ files:
 - test/test_event_source.rb
 - test/test_follow_redirect.rb
 - test/test_future.rb
+- test/test_httpclient.rb
 - test/test_json_request.rb
 - test/test_json_response.rb
 - test/test_oauth1_header.rb
@@ -163,7 +160,6 @@ files:
 - test/test_payload.rb
 - test/test_promise.rb
 - test/test_query_response.rb
-- test/test_rest-client.rb
 - test/test_simple.rb
 - test/test_smash.rb
 - test/test_smash_response.rb
@@ -190,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Modular Ruby clients interface for REST APIs.
@@ -213,6 +209,7 @@ test_files:
 - test/test_event_source.rb
 - test/test_follow_redirect.rb
 - test/test_future.rb
+- test/test_httpclient.rb
 - test/test_json_request.rb
 - test/test_json_response.rb
 - test/test_oauth1_header.rb
@@ -221,7 +218,6 @@ test_files:
 - test/test_payload.rb
 - test/test_promise.rb
 - test/test_query_response.rb
-- test/test_rest-client.rb
 - test/test_simple.rb
 - test/test_smash.rb
 - test/test_smash_response.rb

data/lib/rest-core/engine/net-http-persistent.rb

@@ -1,21 +0,0 @@
-
-require 'net/http/persistent'
-require 'rest-core/engine'
-
-class RestCore::NetHttpPersistent < RestCore::Engine
-  def request promise, env
-    http = ::Net::HTTP::Persistent.new
-    http.open_timeout, http.read_timeout = calculate_timeout(env[TIMER])
-    payload, headers = payload_and_headers(env)
-
-    uri = ::URI.parse(env[REQUEST_URI])
-    req = ::Net::HTTP.const_get(env[REQUEST_METHOD].to_s.capitalize).
-            new(uri, headers)
-    req.body_stream = payload
-    res = http.request(uri, req)
-
-    promise.fulfill(res.body, res.code.to_i, normalize_headers(res.to_hash))
-  rescue Exception => e
-    promise.reject(e)
-  end
-end

data/lib/rest-core/engine/rest-client.rb

@@ -1,29 +0,0 @@
-
-require 'restclient'
-require 'rest-core/patch/rest-client'
-require 'rest-core/engine'
-
-class RestCore::RestClient < RestCore::Engine
-  def request promise, env
-    open_timeout, read_timeout = calculate_timeout(env[TIMER])
-    payload, headers = payload_and_headers(env)
-    res = ::RestClient::Request.execute(:method   => env[REQUEST_METHOD],
-                                        :url      => env[REQUEST_URI]   ,
-                                        :payload  => payload            ,
-                                        :headers  => headers            ,
-                                        :max_redirects => 0             ,
-                                        :open_timeout => open_timeout   ,
-                                             :timeout => read_timeout   )
-    promise.fulfill(res.body, res.code, normalize_headers(res.raw_headers))
-  rescue ::RestClient::Exception => e
-    if res = e.response
-      # we don't want to raise an exception for 404 requests
-      promise.fulfill(res.body, res.code, normalize_headers(res.raw_headers))
-    else
-      promise.reject(e)
-    end
-
-  rescue Exception => e
-    promise.reject(e)
-  end
-end

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

@@ -1,8 +0,0 @@
-
-# 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/patch/rest-client.rb

@@ -1,35 +0,0 @@
-
-module RestClient
-  module AbstractResponse
-    # begin patch
-    # https://github.com/archiloque/rest-client/pull/103
-    remove_method :to_i if method_defined?(:to_i)
-    # end patch
-
-    # Follow a redirection
-    def follow_redirection request = nil, result = nil, & block
-      url = headers[:location]
-      if url !~ /^http/u
-        url = URI.parse(args[:url]).merge(url).to_s
-      end
-      args[:url] = url
-      if request
-        if request.max_redirects == 0
-          # begin patch
-          # https://github.com/archiloque/rest-client/pull/118
-          raise MaxRedirectsReached.new(self, code)
-          # end patch
-        end
-        args[:password] = request.password
-        args[:user] = request.user
-        args[:headers] = request.headers
-        args[:max_redirects] = request.max_redirects - 1
-        # pass any cookie set in the result
-        if result && result['set-cookie']
-          args[:headers][:cookies] = (args[:headers][:cookies] || {}).merge(parse_cookie(result['set-cookie']))
-        end
-      end
-      Request.execute args, &block
-    end
-  end
-end