rest-core 3.3.2 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 791ce9f1c9627673f6bb3c4708c6077948c2f049
-  data.tar.gz: 364ccb0bcdb0788c64e28221b333408c401395f2
+  metadata.gz: 07acac398a096c63464e9dca43b964dbe0d6359a
+  data.tar.gz: 887c818f4a83591b316511c709fbbf10e2d45c35
 SHA512:
-  metadata.gz: 2efd353f7e2c8058beeb5926427ffed27efdf3216b16bdf6c8fed1c7c57ba60636dc89be1b19db07aeac23c8ed954c4d106f179b755607589d6f63f93d2fdf7d
-  data.tar.gz: 0be08aada1f1a659d006a253809340e73d5590aa788be0d5d89780634f64be3c211715b5c8fd3c296e80db42cf66ed95d353deb1a51ad1d1f01b7922693b520a
+  metadata.gz: 24e9ebd41021150461013695d6e7cf4d2e6c628ea5156787c7dd957d4cd72e9df3452529518cfc9a48d1c837379aebee3cc6485bbe6422ba196fb3951f02da19
+  data.tar.gz: 6a0da34cf3b1221b9b791fb63eee8419c2ce93b6766e395019453f5dc65a8859f24a73a48ef46728ef7e9262186ff0d032334d82ddb777cfcad4b08ec920e4ad

data/.travis.yml

@@ -2,8 +2,8 @@ before_install: 'git submodule update --init'
 script: 'ruby -r bundler/setup -S rake test'
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - ruby
+  - 1.9
+  - 2.0
+  - 2.1
   - rbx-2
   - jruby

data/CHANGES.md

@@ -1,5 +1,27 @@
 # CHANGES
 
+## rest-core 3.3.3 -- 2014-11-07
+
+### Bugs fixed
+
+* `RC::EventSource` would now properly reconnect for SystemCallError such as
+  `Errno::ECONNRESET`.
+
+* It would now always emit a warning whenever there's an exception raised
+  asynchronously.
+
+* All exceptions raised from a thread or thread pool would now have a
+  proper backtrace. This was fixed by introducing `RC::Promise.backtrace`
+
+### Enhancements
+
+* Introduced `RC::Promise.backtrace`. Using this in a callback could give you
+  proper backtrace, comparing to `caller` would only give you the backtrace
+  for current thread.
+
+* Introduced `RC::Promise.set_backtrace`. Using this we could set exceptions
+  with proper backtrace.
+
 ## rest-core 3.3.2 -- 2014-10-11
 
 * Just use `File.join` for `RC::DefaultSite` as `File::SEPARATOR` is

data/README.md

@@ -14,6 +14,9 @@ talk is in Mandarin.
 * [github](https://github.com/godfat/rest-core)
 * [rubygems](https://rubygems.org/gems/rest-core)
 * [rdoc](http://rdoc.info/projects/godfat/rest-core)
+* [mailing list](http://www.freelists.org/list/rest-core)
+  Send your questions to: <rest-core@freelists.org> and you could read
+  through [archives](http://www.freelists.org/archives/rest-core)
 
 ## DESCRIPTION:
 
@@ -73,8 +76,6 @@ gem 'rest-core', :git => 'git://github.com/godfat/rest-core.git',
 If you just want to use Facebook or Twitter clients, please take a look at
 [rest-more][] which has a lot of clients built with rest-core.
 
-[rest-more]: http://github.com/godfat/rest-more
-
 ## Build Your Own Clients:
 
 You can use `RestCore::Builder` to build your own dedicated clients.
@@ -374,12 +375,10 @@ client.request_full(RC::REQUEST_PATH   => 'godfat',
 
 Runnable example is at: [example/simple.rb][]. Please see [rest-more][]
 for more complex examples to build clients, and [slides][] from
-[rubyconf.tw/2011][rubyconf.tw] for concepts.
+[rubyconf.tw/2011][talk] for concepts.
 
 [example/simple.rb]: example/simple.rb
-[rest-more]: https://github.com/godfat/rest-more
 [slides]: http://www.godfat.org/slide/2011-08-27-rest-core.html
-[rubyconf.tw]: http://rubyconf.tw/2011/#6
 
 ## Playing Around:
 
@@ -452,7 +451,6 @@ This is mostly for fun and experimenting, so it's only included in
 installed before trying this.
 
 [rib]: https://github.com/godfat/rib
-[rest-more]: https://github.com/godfat/rest-more
 
 ## List of built-in Middleware:
 
@@ -683,7 +681,6 @@ all the possible use cases, you can also see: [example/use-cases.rb][]. It's
 also served as a test for each possible combinations, so it's quite complex
 and complete.
 
-[example/simple.rb]: example/simple.rb
 [example/use-cases.rb]: example/use-cases.rb
 
 ## rest-core users:

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

@@ -16,8 +16,6 @@ class RestCore::HttpClient < RestCore::Engine
     else
       request_sync(client, payload, headers, promise, env)
     end
-  rescue Exception => e
-    promise.reject(e)
   end
 
   def request_sync client, payload, headers, promise, env

data/lib/rest-core/event_source.rb

@@ -103,7 +103,7 @@ class RestCore::EventSource < Struct.new(:client, :path, :query, :opts,
     end
     sock.close
     onerror(EOFError.new, sock)
-  rescue IOError => e
+  rescue IOError, SystemCallError => e
     onerror(e, sock)
   end
 

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

@@ -24,6 +24,6 @@ class RestCore::AuthBasic
 
   def auth_basic_header env
     {'Authorization' =>
-       "Basic #{["#{username(env)}:#{password(env)}"].pack('m').tr("\n",'')}"}
+       "Basic #{["#{username(env)}:#{password(env)}"].pack('m0')}"}
   end
 end

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

@@ -30,6 +30,7 @@ class RestCore::ErrorHandler
   end
 
   def process res, err
+    RC::Promise.set_backtrace(err)
     if res[ASYNC]
       res.merge(RESPONSE_BODY => err)
     else

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

@@ -47,7 +47,7 @@ class RestCore::Oauth1Header
 
   def signature env, params
     [Hmac.sha1("#{consumer_secret(env)}&#{oauth_token_secret(env)}",
-               base_string(env, params))].pack('m').tr("\n", '')
+               base_string(env, params))].pack('m0')
   end
 
   def base_string env, oauth_params
@@ -63,7 +63,7 @@ class RestCore::Oauth1Header
   end
 
   def nonce
-    [OpenSSL::Random.random_bytes(32)].pack('m').tr("+/=\n", '')
+    [OpenSSL::Random.random_bytes(32)].pack('m0').tr("+/=", '')
   end
 
   # according to OAuth 1.0a spec, only:

data/lib/rest-core/promise.rb

@@ -21,6 +21,14 @@ class RestCore::Promise
     promise
   end
 
+  def self.backtrace
+    Thread.current[:backtrace] || []
+  end
+
+  def self.set_backtrace e
+    e.set_backtrace((e.backtrace || caller) + backtrace)
+  end
+
   def initialize env, k=RC.id, immediate=false, &job
     self.env       = env
     self.k         = [k]
@@ -58,11 +66,13 @@ class RestCore::Promise
     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{ job.call }
+        synchronized_yield(backtrace){ job.call }
       end
     else
-      Thread.new{ synchronized_yield{ job.call } }
+      backtrace = caller + self.class.backtrace
+      Thread.new{ synchronized_yield(backtrace){ job.call } }
     end
     env[TIMER].on_timeout{ reject(env[TIMER].error) } if env[TIMER]
   end
@@ -85,7 +95,8 @@ class RestCore::Promise
     self.body, self.status, self.headers, self.socket =
       body, status, headers, socket
     # under ASYNC callback, should call immediately
-    callback_in_async if immediate
+    callback if immediate
+  ensure
     condv.broadcast # client or response might be waiting
   end
 
@@ -112,7 +123,7 @@ class RestCore::Promise
   # For synchronous mode, since we're waiting for the callback anyway,
   # we don't really have to check if it's called.
   def done?
-    !!status && !(immediate && !called)
+    !!status && (!immediate || called)
   end
 
   protected
@@ -124,14 +135,16 @@ class RestCore::Promise
   private
   # called in a new thread if pool_size == 0, otherwise from the pool
   # i.e. requesting thread
-  def synchronized_yield
+  def synchronized_yield backtrace
+    Thread.current[:backtrace] = backtrace
     mutex.synchronize{ 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)   # should never deadlock someone
+    reject(e) unless done?  # not done: i/o error; done: callback error
   end
 
   # called in client thread, when yield is called
@@ -144,18 +157,8 @@ class RestCore::Promise
                 RESPONSE_SOCKET  => socket,
                 FAIL             => ((env[FAIL]||[]) + [error]).compact,
                 LOG              =>   env[LOG] ||[])){ |r, i| i.call(r) }
+  ensure
     self.called = true
-    response
-  end
-
-  # called in requesting thread, whenever the request is done
-  def callback_in_async
-    callback
-  rescue Exception => 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}"
   end
 
   def client_class; env[CLIENT].class; end

data/lib/rest-core/version.rb

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

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.3.2 ruby lib
+# stub: rest-core 3.3.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.3.2"
+  s.version = "3.3.3"
 
   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-10-11"
+  s.date = "2014-11-07"
   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 = [

data/test/test_client.rb

@@ -49,6 +49,7 @@ describe RC::Simple do
     stub_request(:get, url).to_return do
       m.synchronize{ i += 1 }
       Thread.pass
+      {}
     end
 
     client = RC::Builder.client
@@ -131,4 +132,44 @@ describe RC::Simple do
     stub_request(:get, url).to_return(:body => '123')
     Class.new(RC::Simple).new.get(url).should.eq '123'
   end
+
+  would 'not deadlock when exception was raised in the callback' do
+    client = Class.new(RC::Simple).new
+    stub_request(:get, url).to_return(:body => 'nnf')
+
+    (0..1).each do |size|
+      mock(any_instance_of(RC::Promise)).warn(is_a(String)) do |msg|
+        msg.should.include?('nnf')
+      end
+      client.class.pool_size = size
+      client.get(url) do |body|
+        raise body
+      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
+    client = RC::Simple.new
+    stub_request(:get, url).to_return(:body => 'nnf')
+    client.get(url) do
+      current_file = /^#{__FILE__}/
+                     caller.grep(current_file).should.empty?
+      RC::Promise.backtrace.grep(current_file).should.not.empty?
+      client.get(url) do
+        RC::Promise.backtrace.last.should.not =~ /promise\.rb:\d+:in/
+        client = nil
+      end
+    end
+    client.wait
+    client.should.nil? # to make sure the inner most block did run
+  end
 end

data/test/test_error_handler.rb

@@ -41,4 +41,19 @@ describe RC::ErrorHandler do
     client.new(:error_handler => lambda{ |res| 1 }).
       request(RC::FAIL => [0], RC::RESPONSE_KEY => RC::FAIL).should.eq [0, 1]
   end
+
+  would 'set full backtrace' do
+    url = 'http://example.com/'
+    client = RC::Builder.client do
+      use RC::ErrorHandler, lambda{ |env|
+                              RuntimeError.new(env[RC::RESPONSE_BODY]) }
+      use RC::ErrorDetectorHttp
+    end.new
+    stub_request(:get, url).to_return(:status => 404, :body => 'nnf')
+    client.get(url) do |error|
+      error.message.should.eq 'nnf'
+      error.backtrace.grep(/^#{__FILE__}/).should.not.empty?
+    end
+    client.wait
+  end
 end

data/test/test_simple.rb

@@ -33,5 +33,6 @@ describe RC::Simple do
     stub_request(:get, "#{path}?a=b").to_return(:body => 'OK')
     RC::Simple.new.get(path, {:a => 'b'},
       RC::RESPONSE_KEY => RC::REQUEST_URI).should.eq "#{path}?a=b"
+    RC::Simple.wait
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.3.3
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient