rest-core 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 070bdd0392158ac265903b7e713245a18933aaa8
-  data.tar.gz: 015edd1a6221a2a0b55dc04958dbed0df1729ecf
+  metadata.gz: 530a9ed8d2e0b7cc07703113eaf17950cc611d12
+  data.tar.gz: ad5eb2846acf18bfacdd88fff480e91bccb4f89e
 SHA512:
-  metadata.gz: 30bcbb75a17c797b3ebf823d5e46837209bd628df0abc0190f9d67823f4367b1556a1f11461befb176400aba3863ec920561f503da32dd1edc00682e9e2b44a9
-  data.tar.gz: fd18d5ecd9cb318c9b8ce3616c3f7432bd55ea43b6c517ea0bbc21a8d33670b0fca238678b08faf25b6c80b95f3c9d6be449a69a6b74ecb929ea90995b49b4ce
+  metadata.gz: 4e43365d45547c82c1093963a677c34c2f38ab7c637e80c1219462b7a75313aa30ed8ce817ec94d55d9400a1d993b93bf2e4e203b7a6f4334818086dfa5e8ea9
+  data.tar.gz: a7c962c1876c5b67480708d2dda7e5df1299432cb16aea00afd7173efffc7e22c3596f9d06da640511d2de64df649cc4c927d9bd23e3e1492be502534543f287

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## rest-core 3.1.1 -- 2014-05-13
+
+### Enhancements
+
+* Introduced `RC::Client.wait` along with `RC::Client#wait`. It would collect
+  all the promises from all instances of the client, so we could wait on all
+  promises we're waiting. This would make writing graceful shutdown much
+  easier. For example, we could have: `at_exit{ RC::Universal.wait }` to
+  wait on all requests from the universal client before exiting the process.
+
 ## rest-core 3.1.0 -- 2014-05-09
 
 ### Incompatible changes
@@ -10,7 +20,7 @@
 * Now RC::EventSource#onmessage would receive the event in the first argument,
   and the data in the second argument instead of a hash in the first argument.
 
-### Enhancement
+### Enhancements
 
 * Added RC::REQUEST_URI in the env so that we could access the requesting
   URI easily.
@@ -59,7 +69,7 @@ Highlights:
 * `RC::Future` is renamed to `RC::Promise`, and `RC::Future::Proxy` is
   renamed to `RC::Promise::Future`.
 
-### Enhancement
+### Enhancements
 
 * HIJACK support, which is similar to Rack's HIJACK feature. If you're
   passing `{RC::HIJACK => true}` whenever making a request, rest-core would
@@ -107,7 +117,7 @@ Highlights:
 
 * Fixed em-http-request support.
 
-### Enhancement
+### Enhancements
 
 * [`Payload`] Now it is a class rather than a module.
 * [`Paylaod`] Introduced `Payload.generate_with_headers`.
@@ -132,7 +142,7 @@ Highlights:
 * [`Payload`] Now we could correctly support payload with "foo=1&foo=2".
 * [`Client`] Fix inspect spacing.
 
-### Enhancement
+### Enhancements
 
 * [`Payload`] With this class introduced, replacing rest-client's own
   payload implementation, we could pass StringIO or other sockets as the
@@ -172,7 +182,7 @@ Highlights:
 * Don't walk into parent's constants in `RC.eagerload`.
 * Also rescue `NameError` in `RC.eagerload`.
 
-### Enhancement
+### Enhancements
 
 * Remove unnecessary `future.wrap` in `EmHttpRequest`.
 * Introduce Future#callback_in_async.
@@ -269,7 +279,7 @@ It's a bit outdated, but you can also checkout my blog post.
 * You must provide a block to `app.call(env){ ... }`.
 * Rename Wrapper#default_app to Wrapper#default_engine
 
-### Enhancement
+### Enhancements
 
 * The default engine is changed from `RestClient` to `Auto`, which would
   be using `EmHttpRequest` under the context of a event loop, while
@@ -317,7 +327,7 @@ It's a bit outdated, but you can also checkout my blog post.
 
 ## rest-core 1.0.3 -- 2012-08-15
 
-### Enhancement
+### Enhancements
 
 * [Client] `client.head` now returns the headers instead of response body.
   It doesn't make sense to return the response body, because there's no
@@ -334,7 +344,7 @@ It's a bit outdated, but you can also checkout my blog post.
 
 ## rest-core 1.0.2 -- 2012-06-05
 
-### Enhancement
+### Enhancements
 
 * Some internal refactoring.
 
@@ -459,7 +469,7 @@ for more detail.
 
 ## rest-core 0.8.2 -- 2012-02-18
 
-### Enhancement
+### Enhancements
 
 * [`DefaultPayload`] This middleware allows you to have default payload for
   POST and PUT requests.
@@ -474,7 +484,7 @@ for more detail.
 
 ## rest-core 0.8.1 -- 2012-02-09
 
-### Enhancement
+### Enhancements
 
 * [`Wrapper`] Introducing `Wrapper.default_app` (also `Builder.default_app`)
   which you can change the default app from `RestClient` to other HTTP
@@ -513,7 +523,7 @@ Changes are mostly related to OAuth.
 
 [OAuth 2.0 spec]: http://tools.ietf.org/html/draft-ietf-oauth-v2-22
 
-### Enhancement
+### Enhancements
 
 * [`AuthBasic`] Added a new middleware which could do
   [basic authentication][].

data/README.md

@@ -87,7 +87,7 @@ YourClient = RC::Builder.client do
   use RC::DefaultSite , 'https://api.github.com/users/'
   use RC::JsonResponse, true
   use RC::CommonLogger, method(:puts)
-  use RC::Cache       , nil, 3600
+  use RC::Cache       , nil, 3600 # :expires_in if cache store supports
 end
 ```
 
@@ -392,7 +392,8 @@ module RestCore
 
     use FollowRedirect, 10
     use CommonLogger  , method(:puts)
-    use Cache         ,  {}, 600 do
+    use Cache         ,  {}, 600 do # default :expires_in 600 but the default
+                                    # cache {} didn't support it
       use ErrorHandler, nil
       use ErrorDetectorHttp
       use JsonResponse, false
@@ -432,25 +433,62 @@ installed before trying this.
 
 ## List of built-in Middleware:
 
-* [RC::AuthBasic][]
-* [RC::Bypass][]
-* [RC::Cache][]
-* [RC::CommonLogger][]
-* [RC::DefaultHeaders][]
-* [RC::DefaultPayload][]
-* [RC::DefaultQuery][]
-* [RC::DefaultSite][]
-* [RC::Defaults][]
-* [RC::ErrorDetector][]
-* [RC::ErrorDetectorHttp][]
-* [RC::ErrorHandler][]
-* [RC::FollowRedirect][]
-* [RC::JsonRequest][]
-* [RC::JsonResponse][]
-* [RC::Oauth1Header][]
-* [RC::Oauth2Header][]
-* [RC::Oauth2Query][]
-* [RC::Timeout][]
+### [RC::AuthBasic][]
+
+### [RC::Bypass][]
+
+### [RC::Cache][]
+
+    use RC::Cache, cache, expires_in
+
+where `cache` is the cache store which the cache data would be storing to.
+`expires_in` would be passed to
+`cache.store(key, value :expires_in => expires_in)` if `store` method is
+available and its arity should be at least 3. The interface to the cache
+could be referenced from [moneta][], namely:
+
+* (required) `[](key)`
+* (required) `[]=(key, value)`
+* (optional, required if :expires_in is needed) `store(key, value, options)`
+
+Note that `{:expires_in => seconds}` would be passed as the options in
+`store(key, value, options)`, and a plain old Ruby hash `{}` satisfies
+the mandatory requirements: `[](key)` and `[]=(key, value)`, but not the
+last one for `:expires_in` because the `store` method for Hash did not take
+the third argument. That means we could use `{}` as the cache but it would
+simply ignore `:expires_in`.
+
+### [RC::CommonLogger][]
+
+### [RC::DefaultHeaders][]
+
+### [RC::DefaultPayload][]
+
+### [RC::DefaultQuery][]
+
+### [RC::DefaultSite][]
+
+### [RC::Defaults][]
+
+### [RC::ErrorDetector][]
+
+### [RC::ErrorDetectorHttp][]
+
+### [RC::ErrorHandler][]
+
+### [RC::FollowRedirect][]
+
+### [RC::JsonRequest][]
+
+### [RC::JsonResponse][]
+
+### [RC::Oauth1Header][]
+
+### [RC::Oauth2Header][]
+
+### [RC::Oauth2Query][]
+
+### [RC::Timeout][]
 
 [RC::AuthBasic]: lib/rest-core/middleware/auth_basic.rb
 [RC::Bypass]: lib/rest-core/middleware/bypass.rb
@@ -471,6 +509,7 @@ installed before trying this.
 [RC::Oauth2Header]: lib/rest-core/middleware/oauth2_header.rb
 [RC::Oauth2Query]: lib/rest-core/middleware/oauth2_query.rb
 [RC::Timeout]: lib/rest-core/middleware/timeout.rb
+[moneta]: https://github.com/minad/moneta#expiration
 
 ## Build Your Own Middleware:
 

data/lib/rest-core/builder.rb

@@ -1,4 +1,5 @@
 
+require 'thread'
 require 'rest-core/client'
 require 'rest-core/wrapper'
 
@@ -16,27 +17,60 @@ class RestCore::Builder
 
   def to_client *attrs
     fields = members + attrs
-    struct = if fields.empty?
-               Struct.new(nil)
-             else
-               Struct.new(*fields.uniq)
-             end
+    struct = build_struct(fields)
     client = Class.new(struct)
     client.const_set('Struct', struct)
+    class_methods = build_class_methods
+    client.const_set('ClassMethods', class_methods)
+    client.singleton_class.send(:include, class_methods)
     client.send(:include, Client)
-    class << client
-      attr_reader   :builder
-      attr_accessor :pool_size, :pool_idle_time, :event_source_class
+    client.builder            = self
+    client.pool_size          =  0 # default to no pool
+    client.pool_idle_time     = 60 # default to 60 seconds
+    client.event_source_class = EventSource
+    client.promises           = []
+    client.mutex              = Mutex.new
+    client
+  end
+
+  def build_struct fields
+    if fields.empty?
+      Struct.new(nil)
+    else
+      Struct.new(*fields.uniq)
+    end
+  end
 
-      def thread_pool
-        RestCore::ThreadPool[self]
+  def build_class_methods
+    Module.new do
+      attr_accessor :builder, :pool_size, :pool_idle_time,
+                    :event_source_class, :promises, :mutex
+      def thread_pool; RestCore::ThreadPool[self]; end
+
+      def give_promise weak_promise, ps=promises, m=mutex
+        m.synchronize do
+          ps << weak_promise
+          ps.keep_if(&:weakref_alive?)
+        end
+      end
+
+      def wait ps=promises, m=mutex
+        return self if ps.empty?
+        current_promises = nil
+        m.synchronize do
+          current_promises = ps.dup
+          ps.clear
+        end
+        current_promises.each do |p|
+          next unless p.weakref_alive?
+          begin
+            p.wait
+          rescue WeakRef::RefError # it's gc'ed after we think it's alive
+          end
+        end
+        wait(ps, m)
       end
     end
-    client.instance_variable_set(:@builder, self)
-    client.instance_variable_set(:@pool_size, 0) # default to no pool
-    client.instance_variable_set(:@pool_idle_time, 60) # default to 60 seconds
-    client.instance_variable_set(:@event_source_class, EventSource)
-    client
   end
 
   def initialize &block

data/lib/rest-core/client.rb

@@ -1,4 +1,5 @@
 
+require 'thread'
 require 'weakref'
 require 'rest-core'
 
@@ -85,19 +86,8 @@ module RestCore::Client
   end
 
   def wait
-    return self if promises.empty?
-    current_promises = nil
-    mutex.synchronize{
-      current_promises = promises.dup
-      promises.clear
-    }
-    current_promises.each{ |f|
-      begin
-        f.wait
-      rescue WeakRef::RefError # it's gc'ed after we think it's alive
-      end if f.weakref_alive?
-    }
-    wait
+    self.class.wait(promises, mutex)
+    self
   end
 
   def url path, query={}, opts={}
@@ -181,7 +171,9 @@ module RestCore::Client
     # in that case (maybe in a user created engine), Client#wait
     # won't work because we have no way to track the promise.
     if response.kind_of?(Hash) && response[PROMISE].kind_of?(Promise)
-      mutex.synchronize{ promises << WeakRef.new(response[PROMISE]) }
+      weak_promise = WeakRef.new(response[PROMISE])
+      self.class.give_promise(weak_promise)
+      self.class.give_promise(weak_promise, promises, mutex)
     end
 
     if block_given?

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.1.0 ruby lib
+# stub: rest-core 3.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.1.0"
+  s.version = "3.1.1"
 
   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-05-09"
+  s.date = "2014-05-13"
   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

@@ -7,9 +7,10 @@ describe RC::Simple do
     Muack.verify
   end
 
+  url = 'http://localhost/'
+
   should 'do simple request' do
     c = RC::Simple.new
-    url = 'http://localhost/'
     [:get, :post, :delete, :put, :patch].each do |method|
       stub_request(method, url).to_return(:body => '[]')
       c.send(method, url).should.eq '[]'
@@ -23,7 +24,6 @@ describe RC::Simple do
   end
 
   should 'call the callback' do
-    url = 'http://localhost/'
     [:get, :post, :delete, :put, :patch].each do |method|
       stub_request(method, url).to_return(:body => '123')
       (client = RC::Simple.new).send(method, url){ |res|
@@ -44,6 +44,33 @@ describe RC::Simple do
     client.wait
   end
 
+  should 'wait for all the requests' do
+    t, i, m = 5, 0, Mutex.new
+    stub_request(:get, url).to_return do
+      m.synchronize{ i += 1 }
+      Thread.pass
+    end
+
+    client = RC::Builder.client
+    t.times{ client.new.get(url) }
+    client.wait
+    client.promises.should.empty
+    i.should.eq t
+  end
+
+  should 'cleanup promises' do
+    stub_request(:get, url)
+    client = RC::Builder.client
+    5.times{ client.new.get(url) }
+    Thread.pass
+    GC.start # can only force GC run on MRI, so we mock for jruby and rubinius
+    stub(any_instance_of(WeakRef)).weakref_alive?{false}
+    client.new.get(url)
+    client.promises.size.should < 6
+    client.wait
+    client.promises.should.empty
+  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

metadata

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