rest-core 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbe0fe23ff10ec39cf8a2b367616b1c332bd0d42
-  data.tar.gz: 0a7132a6620ecab1c35fd69fdff24733161aafad
+  metadata.gz: 2aa111679bf7c7b75c113cea9c30e4c52c709ed0
+  data.tar.gz: fe0dda1aea907ef4141f7125a7dfb9a881d42441
 SHA512:
-  metadata.gz: d59288134f72ed58c335e743e439479d93de99f6c4278d871733ec845790d65cede5986e276f0a8cd0f0aa39f1cf2ee38325ef468e74cbcb4a08bf3cb01ed2cc
-  data.tar.gz: 73a39d9b95793cc496d05e6c9370e0da5bd7c3ae22374e3ebe4ebc71d3dfd0d2778f885a9b8395fe1c8d38fd143b767df45d57ccbfcb6ae957116a8139ba2c41
+  metadata.gz: 4e634ba680b5cca9604ea54a5182e0afe161bf44e80b1f7748d8ffc922429023fb99fd009aea9a3c4b001b5531e9de315947de3db6229020de30c2bc88b8d9c7
+  data.tar.gz: 1a110e340a1f5e64e5ede750e6bca7a9ef38fa2137d27c53e900be9026b0d8d8f61664e7fc7032954bcb975ea45a6eea221e74ea7e01c9a62b3ca89c19f0b225

data/CHANGES.md

@@ -1,5 +1,28 @@
 # CHANGES
 
+## rest-core 3.3.0 -- 2014-08-25
+
+### Incompatible changes
+
+* Removed `RC::Wrapper`. Apparently it's introducing more troubles than the
+  benefit than it brings. Currently, only `RC::Cache` is really using it,
+  and now the old functionality is merged back to `RC::Builder`.
+
+* Therefore `RC::Cache` is no longer accepting a block.
+
+* `RC::Universal` is then updated accordingly to respect the new `RC::Cache`.
+
+### Enhancements
+
+* Now `RC::DefaultQuery`, `RC::DefaultPayload`, and `RC::DefaultHeaders`
+  work the same way. Previously they merge hashes slightly differently.
+
+* Introduced `RC::Middleware#member=` in addition to `RC::Middleware#member`.
+
+* RC::JsonResponse would now strip the problematic UTF-8 BOM before parsing.
+  This was introduced because Stackoverflow would return it. We also
+  try to not raise any encoding issues here.
+
 ## rest-core 3.2.0 -- 2014-06-27
 
 ### Enhancements

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 gem 'rest-client'
 
 gem 'rake'
-gem 'bacon'
+gem 'pork'
 gem 'muack'
 gem 'webmock'
 

data/README.md

@@ -409,18 +409,19 @@ module RestCore
     use DefaultPayload, {}
     use JsonRequest   , false
     use AuthBasic     , nil, nil
+    use CommonLogger  , method(:puts)
+    use ErrorHandler  , nil
+    use ErrorDetectorHttp
+
+    use SmashResponse , false
+    use ClashResponse , false
+    use  JsonResponse , false
+    use QueryResponse , false
+
+    use Cache         , {}, 600 # default :expires_in 600 but the default
+                                # cache {} didn't support it
 
     use FollowRedirect, 10
-    use CommonLogger  , method(:puts)
-    use Cache         ,  {}, 600 do # default :expires_in 600 but the default
-                                    # cache {} didn't support it
-      use ErrorHandler, nil
-      use ErrorDetectorHttp
-      use SmashResponse, false
-      use ClashResponse, false
-      use  JsonResponse, false
-      use QueryResponse, false
-    end
   end
 end
 ```

data/Rakefile

@@ -11,5 +11,6 @@ Gemgem.init(dir) do |s|
   s.name     = 'rest-core'
   s.version  = RestCore::VERSION
   s.homepage = 'https://github.com/godfat/rest-core'
-  %w[httpclient mime-types timers].each{ |g| s.add_runtime_dependency(g) }
+  %w[httpclient mime-types].each{ |g| s.add_runtime_dependency(g) }
+  s.add_runtime_dependency('timers', '<4')
 end

data/lib/rest-core.rb

@@ -29,7 +29,6 @@ module RestCore
   autoload :Error         , 'rest-core/error'
   autoload :Event         , 'rest-core/event'
   autoload :Middleware    , 'rest-core/middleware'
-  autoload :Wrapper       , 'rest-core/wrapper'
   autoload :Promise       , 'rest-core/promise'
   autoload :ThreadPool    , 'rest-core/thread_pool'
   autoload :EventSource   , 'rest-core/event_source'

data/lib/rest-core/builder.rb

@@ -1,18 +1,61 @@
 
 require 'thread'
 require 'rest-core/client'
-require 'rest-core/wrapper'
 
 class RestCore::Builder
   include RestCore
-  include Wrapper
 
-  def self.default_engine
-    @default_engine ||= RestCore::HttpClient
+  singleton_class.module_eval do
+    attr_writer :default_engine
+    def default_engine
+      @default_engine ||= RestCore::HttpClient
+    end
+
+    def client *attrs, &block
+      new(&block).to_client(*attrs)
+    end
+  end
+
+  def initialize &block
+    @engine    = nil
+    @middles ||= []
+    instance_eval(&block) if block_given?
+  end
+
+  attr_reader :middles
+  attr_writer :default_engine
+  def default_engine
+    @default_engine ||= self.class.default_engine
   end
 
-  def self.client *attrs, &block
-    new(&block).to_client(*attrs)
+  def use middle, *args, &block
+    middles << [middle, args, block]
+  end
+
+  def run engine
+    @engine = engine
+  end
+
+  def members
+    middles.map{ |(middle, args, block)|
+      if middle.public_method_defined?(:wrapped)
+        # TODO: this is hacky... try to avoid calling new!
+        middle.members + middle.new(Dry.new, *args, &block).members
+      else
+        middle.members
+      end if middle.respond_to?(:members)
+    }.flatten.compact
+  end
+
+  def to_app engine=@engine || default_engine
+    # === foldr m.new app middles
+    middles.reverse.inject(engine.new){ |app, (middle, args, block)|
+      begin
+        middle.new(app, *partial_deep_copy(args), &block)
+      rescue ArgumentError => e
+        raise ArgumentError.new("#{middle}: #{e}")
+      end
+    }
   end
 
   def to_client *attrs
@@ -33,6 +76,16 @@ class RestCore::Builder
     client
   end
 
+  private
+  def partial_deep_copy obj
+    case obj
+      when Array; obj.map{ |o| partial_deep_copy(o) }
+      when Hash ; obj.inject({}){ |r, (k, v)| r[k] = partial_deep_copy(v); r }
+      when Numeric, Symbol, TrueClass, FalseClass, NilClass; obj
+      else begin obj.dup; rescue TypeError; obj; end
+    end
+  end
+
   def build_struct fields
     if fields.empty?
       Struct.new(nil)
@@ -89,10 +142,4 @@ class RestCore::Builder
       end
     end
   end
-
-  def initialize &block
-    @engine    = nil
-    @middles ||= []
-    instance_eval(&block) if block_given?
-  end
 end

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

@@ -9,17 +9,18 @@ module RestCore
     use DefaultPayload, {}
     use JsonRequest   , false
     use AuthBasic     , nil, nil
+    use CommonLogger  , method(:puts)
+    use ErrorHandler  , nil
+    use ErrorDetectorHttp
+
+    use SmashResponse , false
+    use ClashResponse , false
+    use  JsonResponse , false
+    use QueryResponse , false
+
+    use Cache         , {}, 600 # default :expires_in 600 but the default
+                                # cache {} didn't support it
 
     use FollowRedirect, 10
-    use CommonLogger  , method(:puts)
-    use Cache         ,  {}, 600 do # default :expires_in 600 but the default
-                                    # cache {} didn't support it
-      use ErrorHandler, nil
-      use ErrorDetectorHttp
-      use SmashResponse, false
-      use ClashResponse, false
-      use  JsonResponse, false
-      use QueryResponse, false
-    end
   end
 end

data/lib/rest-core/middleware.rb

@@ -10,6 +10,7 @@ module RestCore::Middleware
     mod.send(:attr_reader, :app)
     mem = if mod.respond_to?(:members) then mod.members else [] end
     src = mem.map{ |member| <<-RUBY }
+      attr_writer :#{member}
       def #{member} env
         if    env.key?('#{member}')
           env['#{member}']
@@ -113,4 +114,23 @@ module RestCore::Middleware
     }
   end
   public :string_keys
+
+  # this method is intended to merge payloads if they are non-empty hashes,
+  # but prefer the right most one if they are not hashes.
+  def merge_hash *hashes
+    hashes.reverse_each.inject do |r, i|
+      if r.kind_of?(Hash)
+        if i.kind_of?(Hash)
+          Middleware.string_keys(i).merge(Middleware.string_keys(r))
+        elsif r.empty?
+          i # prefer non-empty ones
+        else
+          r # don't try to merge non-hashes
+        end
+      else
+        r
+      end
+    end
+  end
+  public :merge_hash
 end

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

@@ -1,14 +1,12 @@
 
 require 'rest-core/event'
 require 'rest-core/middleware'
-require 'rest-core/wrapper'
 
 require 'digest/md5'
 
 class RestCore::Cache
   def self.members; [:cache, :expires_in]; end
   include RestCore::Middleware
-  include RestCore::Wrapper
 
   def initialize app, cache, expires_in, &block
     super(&block)
@@ -24,14 +22,18 @@ class RestCore::Cache
 
     cache_get(e){ |cached|
       e[TIMER].cancel if e[TIMER]
-      wrapped.call(cached, &k)
-    } || app.call(e){ |res|
-           wrapped.call(res){ |res_wrapped|
-             k.call(if (res_wrapped[FAIL] || []).empty?
-                      cache_for(res).merge(res_wrapped)
-                    else
-                      res_wrapped
-                    end)}}
+      k.call(cached)
+    } || app_call(e, &k)
+  end
+
+  def app_call env
+    app.call(env) do |res|
+      yield(if (res[FAIL] || []).empty?
+              cache_for(res)
+            else
+              res
+            end)
+    end
   end
 
   def cache_key env

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

@@ -5,7 +5,7 @@ class RestCore::DefaultHeaders
   def self.members; [:headers]; end
   include RestCore::Middleware
   def call env, &k
-    app.call(env.merge(REQUEST_HEADERS =>
-      @headers.merge(headers(env)).merge(env[REQUEST_HEADERS])), &k)
+    h = merge_hash(@headers, headers(env), env[REQUEST_HEADERS])
+    app.call(env.merge(REQUEST_HEADERS => h), &k)
   end
 end

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

@@ -4,32 +4,8 @@ require 'rest-core/middleware'
 class RestCore::DefaultPayload
   def self.members; [:payload]; end
   include RestCore::Middleware
-
-  def initialize *args
-    super
-    @payload ||= {}
-  end
-
   def call env, &k
-    defaults = merge(@payload, payload(env))
-
-    app.call(env.merge(REQUEST_PAYLOAD =>
-      merge(defaults, env[REQUEST_PAYLOAD])), &k)
-  end
-
-  # this method is intended to merge payloads if they are non-empty hashes,
-  # but prefer the right most one if they are not hashes.
-  def merge lhs, rhs
-    if rhs.respond_to?(:empty?) && rhs.empty?
-      lhs
-    elsif lhs.respond_to?(:merge)
-      if rhs.respond_to?(:merge)
-        string_keys(lhs).merge(string_keys(rhs))
-      else
-        rhs
-      end
-    else
-      rhs
-    end
+    p = merge_hash(@payload, payload(env), env[REQUEST_PAYLOAD])
+    app.call(env.merge(REQUEST_PAYLOAD => p), &k)
   end
 end

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

@@ -4,16 +4,8 @@ require 'rest-core/middleware'
 class RestCore::DefaultQuery
   def self.members; [:query]; end
   include RestCore::Middleware
-
-  def initialize *args
-    super
-    @query ||= {}
-  end
-
   def call env, &k
-    defaults = string_keys(@query).merge(string_keys(query(env)))
-
-    app.call(env.merge(REQUEST_QUERY =>
-      defaults.merge(env[REQUEST_QUERY])), &k)
+    q = merge_hash(@query, query(env), env[REQUEST_QUERY])
+    app.call(env.merge(REQUEST_QUERY => q), &k)
   end
 end

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

@@ -10,7 +10,8 @@ class RestCore::JsonRequest
 
   def call env, &k
     return app.call(env, &k) unless json_request(env)
-    return app.call(env, &k) unless env[REQUEST_PAYLOAD]
+    return app.call(env, &k) unless env[REQUEST_PAYLOAD] &&
+                                    !env[REQUEST_PAYLOAD].empty?
 
     app.call(env.merge(
       REQUEST_HEADERS => JSON_REQUEST_HEADER.merge(env[REQUEST_HEADERS]||{}),

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

@@ -9,7 +9,8 @@ class RestCore::JsonResponse
   class ParseError < Json.const_get(:ParseError)
     attr_reader :cause, :body
     def initialize cause, body
-      super("#{cause.message}\nOriginal text: #{body}")
+      msg = cause.message.force_encoding('utf-8')
+      super("#{msg}\nOriginal text: #{body}")
       @cause, @body = cause, body
     end
   end
@@ -27,7 +28,9 @@ class RestCore::JsonResponse
   end
 
   def process response
-    body = response[RESPONSE_BODY]
+    # StackExchange returns the problematic BOM! in UTF-8, so we need to
+    # strip it or it would break JSON parsers (i.e. yajl-ruby and json)
+    body = response[RESPONSE_BODY].to_s.sub(/\A\xEF\xBB\xBF/, '')
     response.merge(RESPONSE_BODY => Json.decode("[#{body}]").first)
     # [this].first is not needed for yajl-ruby
   rescue Json.const_get(:ParseError) => error

data/lib/rest-core/test.rb

@@ -1,26 +1,17 @@
 
 require 'rest-core'
 
-require 'webmock'
+require 'pork/auto'
 require 'muack'
-require 'bacon'
+require 'webmock'
 
 # for testing lighten (serialization)
 require 'yaml'
 
 WebMock.disable_net_connect!(:allow_localhost => true)
-Bacon.summary_on_exit
-Bacon::Context.send(:include, Muack::API, WebMock::API)
+Pork::Executor.__send__(:include, Muack::API, WebMock::API)
 
 module Kernel
-  def eq? rhs
-    self == rhs
-  end
-
-  def lt? rhs
-    self < rhs
-  end
-
   def with_img
     f = Tempfile.new(['img', '.jpg'])
     n = File.basename(f.path)

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.2.0 ruby lib
+# stub: rest-core 3.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.2.0"
+  s.version = "3.3.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-06-27"
+  s.date = "2014-08-25"
   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 = [
@@ -76,7 +76,6 @@ Gem::Specification.new do |s|
   "lib/rest-core/util/payload.rb",
   "lib/rest-core/util/smash.rb",
   "lib/rest-core/version.rb",
-  "lib/rest-core/wrapper.rb",
   "rest-core.gemspec",
   "task/README.md",
   "task/gemgem.rb",
@@ -89,6 +88,7 @@ Gem::Specification.new do |s|
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
   "test/test_config.rb",
+  "test/test_default_headers.rb",
   "test/test_default_payload.rb",
   "test/test_default_query.rb",
   "test/test_error_detector.rb",
@@ -111,11 +111,10 @@ Gem::Specification.new do |s|
   "test/test_smash_response.rb",
   "test/test_thread_pool.rb",
   "test/test_timeout.rb",
-  "test/test_universal.rb",
-  "test/test_wrapper.rb"]
+  "test/test_universal.rb"]
   s.homepage = "https://github.com/godfat/rest-core"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.1"
   s.summary = "Modular Ruby clients interface for REST APIs."
   s.test_files = [
   "test/test_auth_basic.rb",
@@ -126,6 +125,7 @@ Gem::Specification.new do |s|
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
   "test/test_config.rb",
+  "test/test_default_headers.rb",
   "test/test_default_payload.rb",
   "test/test_default_query.rb",
   "test/test_error_detector.rb",
@@ -148,8 +148,7 @@ Gem::Specification.new do |s|
   "test/test_smash_response.rb",
   "test/test_thread_pool.rb",
   "test/test_timeout.rb",
-  "test/test_universal.rb",
-  "test/test_wrapper.rb"]
+  "test/test_universal.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
@@ -157,15 +156,15 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httpclient>, [">= 0"])
       s.add_runtime_dependency(%q<mime-types>, [">= 0"])
-      s.add_runtime_dependency(%q<timers>, [">= 0"])
+      s.add_runtime_dependency(%q<timers>, ["< 4"])
     else
       s.add_dependency(%q<httpclient>, [">= 0"])
       s.add_dependency(%q<mime-types>, [">= 0"])
-      s.add_dependency(%q<timers>, [">= 0"])
+      s.add_dependency(%q<timers>, ["< 4"])
     end
   else
     s.add_dependency(%q<httpclient>, [">= 0"])
     s.add_dependency(%q<mime-types>, [">= 0"])
-    s.add_dependency(%q<timers>, [">= 0"])
+    s.add_dependency(%q<timers>, ["< 4"])
   end
 end