rest-core 3.6.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e2e3b27d9cdd63bf53ffecbe03691cd958f57da
-  data.tar.gz: 1c9a5d20dd052ee3ab3888d6a495ce13cfbc94ed
+  metadata.gz: 457863f961696936393b0a9cdfece4b4d2316b3c
+  data.tar.gz: 6c4c5f3ae1079f425fd463fb617fab97c3641237
 SHA512:
-  metadata.gz: fcc573e74f35f9f8baacc09ce81f76111ad91b35b8bccd2f344203efee0a27e589e9c67322252287d55f768b0465fadd0146256dec3a92213f1b951a621f0c8c
-  data.tar.gz: 12741fd1e4bff91d66226c86867be01ae0d9004cf85142fd28a38da12245bcb9a29840943c54b3d06c221e688c2ddd990574ecc92f28372fc2040a9e40718177
+  metadata.gz: 05f689fdc1a13a629fc2f82190bae7804533fd06cc2c3c5f625f666e695541a826717ead8f97de5a2fdb4834b2f1a55deec798a45ed407e00e13531c348ef1ca
+  data.tar.gz: 3906077d07d6ed8a64782ca78278adbd2a152b71420ad956248def24ed53554751d8e7e84231d8f36549f23cf8672463ba906bde39ba299b41bcc125badebfa8

data/.gitmodules

@@ -1,3 +1,6 @@
 [submodule "task"]
 	path = task
 	url = git://github.com/godfat/gemgem.git
+[submodule "rest-builder"]
+	path = rest-builder
+	url = git://github.com/godfat/rest-builder.git

data/.travis.yml

@@ -1,7 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1
   - 2.2
   - 2.3.0
   - rbx

data/CHANGES.md

@@ -1,5 +1,33 @@
 # CHANGES
 
+## rest-core 4.0.0 -- 2016-02-04
+
+Now the core functionality was extracted to a new gem, rest-builder.
+rest-core from now on would just bundle middleware and some utilities.
+Things like `RC::Builder` should still work for the sake of compatibility,
+but it's actually `RestBuilder::Builder` underneath. Note that the core
+concurrency facility was extracted to another new gem, promise_pool.
+Since some parts were also rewritten, things might change somehow.
+At least no public APIs were changed. It's completely compatible.
+
+### Incompatible changes
+
+* `RC::Simple` was removed. There's no point for that.
+* `RC.id` was removed, in favour of `:itself.to_proc`.
+* Include `RC::Middleware` would no longer include `RC` as well.
+
+### Enhancements
+
+* We no longer `autoload` a lot of stuffs, rather, we just load it.
+* Previously, only when you try to _peek_ the future, the callback would be
+  called. From now on, whenever the request is done, it would call the
+  callback regardless. However, if there's an exception, it won't be raised.
+  It would only raise whenever you _peek_ it. An obvious difference for this
+  is the `RC::CommonLogger`. Previously since callback would only be called
+  when you _peek_ it, the time would be the difference from request done to
+  you _peeked_ it. From now on, it would just be how much time the request
+  has been taken, regardless when you _peek_ it.
+
 ## rest-core 3.6.0 -- 2016-01-27
 
 ### Incompatible changes

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org/'
 
 gemspec
 
-gem 'rest-client'
-
 gem 'rake'
 gem 'pork'
 gem 'muack'

data/README.md

@@ -21,22 +21,18 @@ talk is in Mandarin. There's another talk about [The Promise of rest-core][]
 
 ## DESCRIPTION:
 
-Modular Ruby clients interface for REST APIs.
+Various [rest-builder](https://github.com/godfat/rest-builder) middleware
+for building REST clients.
 
-There has been an explosion in the number of REST APIs available today.
-To address the need for a way to access these APIs easily and elegantly,
-we have developed rest-core, which consists of composable middleware
-that allows you to build a REST client for any REST API. Or in the case of
-common APIs such as Facebook, Github, and Twitter, you can simply use the
-dedicated clients provided by [rest-more][].
-
-[rest-more]: https://github.com/godfat/rest-more
+Checkout [rest-more](https://github.com/godfat/rest-more) for pre-built
+clients.
 
 ## FEATURES:
 
-* Modular interface for REST clients similar to WSGI/Rack for servers.
+* Modular interface for REST clients similar to WSGI/Rack for servers
+  via [rest-builder][].
 * Concurrent requests with synchronous or asynchronous interfaces with
-  threads.
+  threads via [promise_pool][].
 
 ## WHY?
 
@@ -48,13 +44,17 @@ less memory, less conflicts, and run faster.
 ### Mandatory:
 
 * Tested with MRI (official CRuby), Rubinius and JRuby.
+* gem [rest-builder][]
+* gem [promise_pool][]
+* gem [timers][]
 * gem [httpclient][]
 * gem [mime-types][]
-* gem [timers][]
 
+[rest-builder]: https://github.com/godfat/rest-builder
+[promise_pool]: https://github.com/godfat/promise_pool
+[timers]: https://github.com/celluloid/timers
 [httpclient]: https://github.com/nahi/httpclient
 [mime-types]: https://github.com/halostatue/mime-types
-[timers]: https://github.com/celluloid/timers
 
 ### Optional:
 
@@ -553,88 +553,6 @@ simply ignore `:expires_in`.
 [RC::Timeout]: lib/rest-core/middleware/timeout.rb
 [moneta]: https://github.com/minad/moneta#expiration
 
-## Build Your Own Middleware:
-
-### How We Pick the Default Value:
-
-There are a number of ways to specify a default value, each with different
-priorities. Suppose we have a middleware which remembers an integer:
-
-``` ruby
-class HP
-  def self.members; [:hp]; end
-  include RC::Middleware
-  def call env, &k
-    puts "HP: #{hp(env)}"
-    app.call(env, &k)
-  end
-end
-Mage = RC::Builder.client do
-  use HP, 5 # the very last default
-end
-mage = Mage.new
-```
-
-1. The one passed to the request directly gets the first priority, e.g.
-
-``` ruby
-mage.get('http://example.com/', {}, :hp => 1) # prints HP: 1
-```
-
-2. The one saved as an instance variable in the client gets the 2nd place.
-
-``` ruby
-mage.hp = 2
-mage.get('http://example.com/')               # prints HP: 2
-mage.get('http://example.com/', {}, :hp => 1) # prints HP: 1
-mage.hp         # still 2
-mage.hp = false # disable hp
-mage.hp = nil   # reset to default
-```
-
-3. The method defined in the client instance named `default_hp` gets the 3rd.
-
-``` ruby
-class Mage
-  def default_hp
-    3
-  end
-end
-mage.get('http://example.com/')               # prints HP: 3
-mage.hp       # 3
-mage.hp = nil # reset default
-Mage.send(:remove_method, :default_hp)
-```
-
-4. The method defined in the client class named `default_hp` gets the 4rd.
-   P.S. In [rest-more][], with `RestCore::Config` it would generate a
-   `DefaultAttributes` module which defines this kind of default method and
-   then is extended into the client class. You could still define this method
-   to override the default though.
-
-``` ruby
-class Mage
-  def self.default_hp
-    4
-  end
-end
-mage.get('http://example.com/')               # prints HP: 4
-mage.hp       # 4
-mage.hp = nil # reset to default
-Mage.singleton_class.send(:remove_method, :default_hp)
-```
-
-5. The one defined in the middleware gets the last place.
-
-``` ruby
-mage.get('http://example.com/')               # prints HP: 5
-mage.hp       # 5
-mage.hp = nil # reset to default
-```
-
-You can find all the details in client.rb and middleware.rb. See the
-included method hooks.
-
 ## Advanced Concurrent HTTP Requests -- Embrace the Future
 
 ### The Interface
@@ -773,6 +691,7 @@ the priority here is:
 
 * [Codementor](https://www.codementor.io/)
 * [PicCollage](http://pic-collage.com/)
+* [GW2 Account Viewer](https://www.godfat.org/gw2)
 
 ## CHANGES:
 

data/Rakefile

@@ -2,14 +2,27 @@
 begin
   require "#{dir = File.dirname(__FILE__)}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
+$LOAD_PATH.unshift(File.expand_path("#{dir}/rest-builder/lib"))
+$LOAD_PATH.unshift(File.expand_path("#{dir}/rest-builder/promise_pool/lib"))
+
 Gemgem.init(dir) do |s|
   require 'rest-core/version'
   s.name    = 'rest-core'
   s.version = RestCore::VERSION
-  %w[httpclient mime-types].each{ |g| s.add_runtime_dependency(g) }
-  s.add_runtime_dependency('timers', '>=4.0.1')
+  %w[rest-builder].each do |g|
+    s.add_runtime_dependency(g)
+  end
+
+  # exclude rest-builder
+  s.files.reject!{ |f| f.start_with?('rest-builder/') }
+end
+
+desc 'Run console'
+task 'console' do
+  ARGV.shift
+  load `which rib`.chomp
 end

data/example/simple.rb

@@ -5,6 +5,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::Timeout     , 10
   use RC::Cache       , nil, 3600
 end
 

data/example/use-cases.rb

@@ -4,6 +4,16 @@ RC.eagerload
 
 RC::Universal.pool_size = 0 # default to no thread pool
 
+RC::Universal.module_eval do
+  def default_query
+    {:access_token => ENV['FACEBOOK_ACCESS_TOKEN']}
+  end
+
+  def default_timeout
+    10
+  end
+end
+
 def def_use_case name, &block
   singleton_class.send(:define_method, "#{name}_") do
     begin
@@ -23,8 +33,10 @@ def def_use_case name, &block
   end
 end
 
+@mutex = Mutex.new
+
 def q str
-  Thread.exclusive{ puts "\e[33m=> #{str.inspect}\e[0m" }
+  @mutex.synchronize{ puts "\e[33m=> #{str.inspect}\e[0m" }
 end
 
 # ----------------------------------------------------------------------
@@ -49,7 +61,7 @@ def_use_case 'pure_ruby_callback_requests' do
   RC::Universal.new(:json_response => true                                  ,
                     :site          => 'https://graph.facebook.com/'         ,
                     :log_method    => lambda{|str|
-                      Thread.exclusive{puts(str)}}).
+                      @mutex.synchronize{puts(str)}}).
     get('4'){ |res|
       if res.kind_of?(Exception)
         q "Encountering: #{res}"
@@ -70,7 +82,7 @@ def_use_case 'pure_ruby_nested_concurrent_requests' do
   c = RC::Universal.new(:json_response => true                              ,
                         :site          => 'https://graph.facebook.com/'     ,
                         :log_method => lambda{ |str|
-                          Thread.exclusive{puts(str)}})
+                          @mutex.synchronize{puts(str)}})
 
   %w[4 5].each{ |user|
     c.get(user, :fields => 'cover'){ |data|

data/lib/rest-core.rb

@@ -1,84 +1,52 @@
 
-module RestCore
-  REQUEST_METHOD   = 'REQUEST_METHOD'
-  REQUEST_PATH     = 'REQUEST_PATH'
-  REQUEST_QUERY    = 'REQUEST_QUERY'
-  REQUEST_PAYLOAD  = 'REQUEST_PAYLOAD'
-  REQUEST_HEADERS  = 'REQUEST_HEADERS'
-  REQUEST_URI      = 'REQUEST_URI'
-
-  RESPONSE_BODY    = 'RESPONSE_BODY'
-  RESPONSE_STATUS  = 'RESPONSE_STATUS'
-  RESPONSE_HEADERS = 'RESPONSE_HEADERS'
-  RESPONSE_SOCKET  = 'RESPONSE_SOCKET'
-  RESPONSE_KEY     = 'RESPONSE_KEY'
-
-  DRY              = 'core.dry'
-  FAIL             = 'core.fail'
-  LOG              = 'core.log'
-  CLIENT           = 'core.client'
+require 'rest-builder'
 
-  ASYNC            = 'async.callback'
-  TIMER            = 'async.timer'
-  PROMISE          = 'async.promise'
-  HIJACK           = 'async.hijack'
-
-  # core utilities
-  autoload :Builder       , 'rest-core/builder'
-  autoload :Client        , 'rest-core/client'
-  autoload :Error         , 'rest-core/error'
-  autoload :Event         , 'rest-core/event'
-  autoload :Middleware    , 'rest-core/middleware'
-  autoload :Promise       , 'rest-core/promise'
-  autoload :ThreadPool    , 'rest-core/thread_pool'
-  autoload :EventSource   , 'rest-core/event_source'
+module RestCore
+  # for backward compatibility
+  RestBuilder.constants.each do |const|
+    const_set(const, RestBuilder.const_get(const))
+  end
 
   # oauth1 utilities
-  autoload :ClientOauth1  , 'rest-core/client_oauth1'
+  autoload :ClientOauth1     , 'rest-core/client_oauth1'
 
   # misc utilities
-  autoload :Hmac          , 'rest-core/util/hmac'
-  autoload :Json          , 'rest-core/util/json'
-  autoload :ParseLink     , 'rest-core/util/parse_link'
-  autoload :ParseQuery    , 'rest-core/util/parse_query'
-  autoload :Payload       , 'rest-core/util/payload'
-  autoload :Config        , 'rest-core/util/config'
-  autoload :Clash         , 'rest-core/util/clash'
-  autoload :Smash         , 'rest-core/util/smash'
-  autoload :DalliExtension, 'rest-core/util/dalli_extension'
+  autoload :Hmac             , 'rest-core/util/hmac'
+  autoload :Json             , 'rest-core/util/json'
+  autoload :ParseLink        , 'rest-core/util/parse_link'
+  autoload :ParseQuery       , 'rest-core/util/parse_query'
+  autoload :Config           , 'rest-core/util/config'
+  autoload :Clash            , 'rest-core/util/clash'
+  autoload :Smash            , 'rest-core/util/smash'
+  autoload :DalliExtension   , 'rest-core/util/dalli_extension'
 
   # middlewares
-  autoload :AuthBasic     , 'rest-core/middleware/auth_basic'
-  autoload :Bypass        , 'rest-core/middleware/bypass'
-  autoload :Cache         , 'rest-core/middleware/cache'
-  autoload :ClashResponse , 'rest-core/middleware/clash_response'
-  autoload :SmashResponse , 'rest-core/middleware/smash_response'
-  autoload :CommonLogger  , 'rest-core/middleware/common_logger'
-  autoload :DefaultHeaders, 'rest-core/middleware/default_headers'
-  autoload :DefaultQuery  , 'rest-core/middleware/default_query'
-  autoload :DefaultPayload, 'rest-core/middleware/default_payload'
-  autoload :DefaultSite   , 'rest-core/middleware/default_site'
-  autoload :Defaults      , 'rest-core/middleware/defaults'
-  autoload :ErrorDetector , 'rest-core/middleware/error_detector'
+  autoload :AuthBasic        , 'rest-core/middleware/auth_basic'
+  autoload :Bypass           , 'rest-core/middleware/bypass'
+  autoload :Cache            , 'rest-core/middleware/cache'
+  autoload :ClashResponse    , 'rest-core/middleware/clash_response'
+  autoload :SmashResponse    , 'rest-core/middleware/smash_response'
+  autoload :CommonLogger     , 'rest-core/middleware/common_logger'
+  autoload :DefaultHeaders   , 'rest-core/middleware/default_headers'
+  autoload :DefaultQuery     , 'rest-core/middleware/default_query'
+  autoload :DefaultPayload   , 'rest-core/middleware/default_payload'
+  autoload :DefaultSite      , 'rest-core/middleware/default_site'
+  autoload :Defaults         , 'rest-core/middleware/defaults'
+  autoload :ErrorDetector    , 'rest-core/middleware/error_detector'
   autoload :ErrorDetectorHttp, 'rest-core/middleware/error_detector_http'
-  autoload :ErrorHandler  , 'rest-core/middleware/error_handler'
-  autoload :FollowRedirect, 'rest-core/middleware/follow_redirect'
-  autoload :JsonRequest   , 'rest-core/middleware/json_request'
-  autoload :JsonResponse  , 'rest-core/middleware/json_response'
-  autoload :QueryResponse , 'rest-core/middleware/query_response'
-  autoload :Oauth1Header  , 'rest-core/middleware/oauth1_header'
-  autoload :Oauth2Header  , 'rest-core/middleware/oauth2_header'
-  autoload :Oauth2Query   , 'rest-core/middleware/oauth2_query'
-  autoload :Retry         , 'rest-core/middleware/retry'
-  autoload :Timeout       , 'rest-core/middleware/timeout'
-
-  # engines
-  autoload :Dry           , 'rest-core/engine/dry'
-  autoload :HttpClient    , 'rest-core/engine/http-client'
+  autoload :ErrorHandler     , 'rest-core/middleware/error_handler'
+  autoload :FollowRedirect   , 'rest-core/middleware/follow_redirect'
+  autoload :JsonRequest      , 'rest-core/middleware/json_request'
+  autoload :JsonResponse     , 'rest-core/middleware/json_response'
+  autoload :QueryResponse    , 'rest-core/middleware/query_response'
+  autoload :Oauth1Header     , 'rest-core/middleware/oauth1_header'
+  autoload :Oauth2Header     , 'rest-core/middleware/oauth2_header'
+  autoload :Oauth2Query      , 'rest-core/middleware/oauth2_query'
+  autoload :Retry            , 'rest-core/middleware/retry'
+  autoload :Timeout          , 'rest-core/middleware/timeout'
 
   # clients
-  autoload :Simple        , 'rest-core/client/simple'
-  autoload :Universal     , 'rest-core/client/universal'
+  autoload :Universal        , 'rest-core/client/universal'
 
   # You might want to call this before launching your application in a
   # threaded environment to avoid thread-safety issue in autoload.
@@ -95,11 +63,6 @@ module RestCore
       eagerload(c, loaded) if c.respond_to?(:constants) && !loaded[n]
     }
   end
-
-  # identity function
-  def self.id
-    @id ||= lambda{ |a| a }
-  end
 end
 
 RC = RestCore unless Object.const_defined?(:RC)

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

@@ -1,6 +1,8 @@
 
+require 'rest-core'
+
 module RestCore
-  Universal = Builder.client do
+  Universal = RestBuilder::Builder.client do
     use DefaultSite   , nil
     use DefaultHeaders, {}
     use DefaultQuery  , {}