rest-core 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 457863f961696936393b0a9cdfece4b4d2316b3c
-  data.tar.gz: 6c4c5f3ae1079f425fd463fb617fab97c3641237
+  metadata.gz: 19136f5e04b26e2f6f630b4d73f4abef7bdc5b0b
+  data.tar.gz: 8b6e9b3ffd8ef15a3bcf5c41a7da9f6aa125546e
 SHA512:
-  metadata.gz: 05f689fdc1a13a629fc2f82190bae7804533fd06cc2c3c5f625f666e695541a826717ead8f97de5a2fdb4834b2f1a55deec798a45ed407e00e13531c348ef1ca
-  data.tar.gz: 3906077d07d6ed8a64782ca78278adbd2a152b71420ad956248def24ed53554751d8e7e84231d8f36549f23cf8672463ba906bde39ba299b41bcc125badebfa8
+  metadata.gz: 32f498cd18a1c646917abf8a909de19716db54b85ddeefaf917fb9c39d4cf6b186e7bfcf5e3cc1f8e62dc5c6e91244ca618f3b498b27b0b057054585ac22dbdf
+  data.tar.gz: eedebe88fe9065c313e292e988c8b502863062456e4dc763595f5f1975a77ffb96771ac1ce89a181cec1970c0c5f225eb1eac635aace59e50d066501efc58d6b

data/.travis.yml

@@ -1,14 +1,38 @@
 sudo: false
 language: ruby
-rvm:
-  - 2.2
-  - 2.3.0
-  - rbx
-  - jruby-9
 
 before_install:
   - rvm get head
   - rvm reload
   - rvm use --install $TRAVIS_RUBY_VERSION --binary --latest
-install: 'bundle install --retry=3'
+install: 'gem install bundler; bundle install --retry=3'
 script: 'ruby -vr bundler/setup -S rake test'
+
+matrix:
+  include:
+    - rvm: 2.2.5
+      env: json_lib=json
+    - rvm: 2.2.5
+      env: json_lib=yajl
+    - rvm: 2.3.2
+      env: json_lib=json
+    - rvm: 2.3.2
+      env: json_lib=yajl
+    - rvm: 2.4.1
+      env: json_lib=json
+    - rvm: 2.4.1
+      env: json_lib=yajl
+    - rvm: ruby-head
+      env: json_lib=json
+    - rvm: ruby-head
+      env: json_lib=yajl
+    - rvm: jruby-9
+      env: JRUBY_OPTS=--debug
+    - rvm: rbx
+
+  allow_failures:
+    - rvm: 2.4.1
+      env: json_lib=json
+    - rvm: 2.4.1
+      env: json_lib=yajl
+    - rvm: rbx

data/CHANGES.md

@@ -1,5 +1,14 @@
 # CHANGES
 
+## rest-core 4.0.1 -- 2017-05-15
+
+* [RC::Cache] Check against `Numeric` instead of `Fixnum` for Ruby 2.4
+  compatibility.
+* [RC::JsonResponse] Fix encoding issue when trying to remove BOM.
+  See https://github.com/godfat/rest-core/issues/24
+  and https://github.com/godfat/rest-core/commit/4123ca485ecc3b9d31749423f7039bfa1652a3a3
+  Thanks AshwiniDoddamaniFluke
+
 ## rest-core 4.0.0 -- 2016-02-04
 
 Now the core functionality was extracted to a new gem, rest-builder.

data/README.md

@@ -15,9 +15,7 @@ talk is in Mandarin. There's another talk about [The Promise of rest-core][]
 * [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)
+* [issues](https://github.com/godfat/rest-core/issues) (feel free to ask for support)
 
 ## DESCRIPTION:
 
@@ -720,9 +718,9 @@ the priority here is:
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2011-2016, Lin Jen-Shin (godfat)
+Copyright (c) 2011-2017, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,24 +1,23 @@
 
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
   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|
+Gemgem.init(__dir__, :submodules =>
+  %w[rest-builder
+     rest-builder/promise_pool]) do |s|
   require 'rest-core/version'
   s.name    = 'rest-core'
   s.version = RestCore::VERSION
-  %w[rest-builder].each do |g|
-    s.add_runtime_dependency(g)
-  end
 
-  # exclude rest-builder
-  s.files.reject!{ |f| f.start_with?('rest-builder/') }
+  %w[rest-builder].each(&s.method(:add_runtime_dependency))
+end
+
+task :test do
+  require ENV['json_lib'] if ENV['json_lib']
 end
 
 desc 'Run console'

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

@@ -68,7 +68,7 @@ module RestCore
       return res unless cache(res)
       return res unless cache_for?(res)
 
-      if expires_in(res).kind_of?(Fixnum) &&
+      if expires_in(res).kind_of?(Numeric) &&
          cache(res).respond_to?(:store)   &&
          cache(res).method(:store).arity == -3
 

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

@@ -28,11 +28,19 @@ module RestCore
     end
 
     def process response
-      # 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
+      body = response[RESPONSE_BODY]
+      json = if body.kind_of?(String)
+               Json.normalize(body)
+             else
+               # Yajl supports streaming, so let's pass it directly to make
+               # it possible to do streaming here. Although indeed we should
+               # use RESPONSE_SOCKET in this case, but doing that could
+               # introduce some incompatibility which I don't want to take
+               # care of for now.
+               body
+             end
+
+      response.merge(RESPONSE_BODY => Json.decode(json))
     rescue Json.const_get(:ParseError) => error
       fail(response, ParseError.new(error, body))
     end

data/lib/rest-core/test.rb

@@ -5,8 +5,6 @@ require 'pork/auto'
 require 'muack'
 require 'webmock'
 
-# for testing lighten (serialization)
-require 'yaml'
-
+WebMock.enable!
 WebMock.disable_net_connect!(:allow_localhost => true)
-Pork::Executor.include(Muack::API, WebMock::API)
+Pork::Suite.include(Muack::API, WebMock::API)

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

@@ -61,5 +61,34 @@ module RestCore
     end
 
     select_json!(self)
+
+    def self.normalize json
+      empty_to_null(strip_bom(json))
+    end
+
+    def self.strip_bom json
+      case json.encoding.name
+      when 'UTF-8'
+        # 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)
+        json.sub(/\A\xEF\xBB\xBF/u, '')
+      when 'ASCII-8BIT'
+        # In case if Content-Type doesn't have a charset for UTF-8,
+        # httpclient would set the response to ASCII-8BIT in this
+        # case.
+        json.sub(/\A\xEF\xBB\xBF/n, '')
+      else
+        json
+      end
+    end
+
+    def self.empty_to_null json
+      if json.empty?
+        'null'
+      else
+        json
+      end
+    end
   end
 end

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '4.0.0'
+  VERSION = '4.0.1'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 4.0.0 ruby lib
+# stub: rest-core 4.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core".freeze
-  s.version = "4.0.0"
+  s.version = "4.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Lin Jen-Shin (godfat)".freeze]
-  s.date = "2016-02-04"
+  s.date = "2017-05-15"
   s.description = "Various [rest-builder](https://github.com/godfat/rest-builder) middleware\nfor building REST clients.\n\nCheckout [rest-more](https://github.com/godfat/rest-more) for pre-built\nclients.".freeze
   s.email = ["godfat (XD) godfat.org".freeze]
   s.files = [
@@ -92,8 +92,8 @@ Gem::Specification.new do |s|
   "test/test_timeout.rb".freeze,
   "test/test_universal.rb".freeze]
   s.homepage = "https://github.com/godfat/rest-core".freeze
-  s.licenses = ["Apache License 2.0".freeze]
-  s.rubygems_version = "2.5.2".freeze
+  s.licenses = ["Apache-2.0".freeze]
+  s.rubygems_version = "2.6.12".freeze
   s.summary = "Various [rest-builder](https://github.com/godfat/rest-builder) middleware".freeze
   s.test_files = [
   "test/test_auth_basic.rb".freeze,

data/task/README.md

@@ -4,16 +4,16 @@
 
 Provided tasks:
 
-    rake clean        # Remove ignored files
+    rake clean        # Trash ignored files
     rake gem:build    # Build gem
     rake gem:install  # Install gem
     rake gem:release  # Release gem
     rake gem:spec     # Generate gemspec
-    rake test         # Run tests in memory
+    rake test         # Run tests
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+* Tested with MRI (official CRuby), Rubinius and JRuby.
 
 ## INSTALLATION:
 
@@ -23,13 +23,13 @@ And in Rakefile:
 
 ``` ruby
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__, :submodules => %w[your-dep]) do |s|
   s.name    = 'your-gem'
   s.version = '0.1.0'
 end
@@ -37,9 +37,9 @@ end
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2011-2013, Lin Jen-Shin (godfat)
+Copyright (c) 2011-2017, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/task/gemgem.rb

@@ -1,7 +1,7 @@
 
 module Gemgem
   class << self
-    attr_accessor :dir, :spec, :spec_create
+    attr_accessor :dir, :spec, :submodules, :spec_create
   end
 
   module_function
@@ -11,12 +11,14 @@ module Gemgem
   def pkg_dir    ; "#{dir}/pkg"                       ; end
   def escaped_dir; @escaped_dir ||= Regexp.escape(dir); end
 
-  def init dir, &block
+  def init dir, options={}, &block
     self.dir = dir
-    $LOAD_PATH.unshift("#{dir}/lib")
     ENV['RUBYLIB'] = "#{dir}/lib:#{ENV['RUBYLIB']}"
     ENV['PATH']    = "#{dir}/bin:#{ENV['PATH']}"
+    self.submodules  = options[:submodules] || []
     self.spec_create = block
+
+    $LOAD_PATH.unshift("#{dir}/lib", *submodules_libs)
   end
 
   def create
@@ -26,7 +28,7 @@ module Gemgem
 
       s.description = description.join
       s.summary     = description.first
-      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+      s.license     = license
 
       s.date        = Time.now.strftime('%Y-%m-%d')
       s.files       = gem_files
@@ -115,6 +117,7 @@ module Gemgem
       SimpleCov.start do
         add_filter('test/')
         add_filter('test.rb')
+        submodules_libs.each(&method(:add_filter))
       end
     end
 
@@ -159,11 +162,15 @@ module Gemgem
   end
 
   def strip_home_path path
-    path.sub(ENV['HOME'], '~')
+    path.sub(/\A#{Regexp.escape(ENV['HOME'])}\//, '~/')
   end
 
   def strip_cwd_path path
-    path.sub(Dir.pwd, '.')
+    path.sub(/\A#{Regexp.escape(Dir.pwd)}\//, '')
+  end
+
+  def submodules_libs
+    submodules.map{ |path| "#{dir}/#{path}/lib" }
   end
 
   def git *args
@@ -201,6 +208,11 @@ module Gemgem
     @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
   end
 
+  def license
+    readme['LICENSE'].sub(/.+\n\n/, '').lines.first.
+      split(/[()]/).map(&:strip).reject(&:empty?).last
+  end
+
   def all_files
     @all_files ||= fold_files(glob).sort
   end
@@ -221,7 +233,8 @@ module Gemgem
 
   def gem_files
     @gem_files ||= all_files.reject{ |f|
-      f =~ ignored_pattern && !git_files.include?(f)
+      f =~ submodules_pattern ||
+        (f =~ ignored_pattern && !git_files.include?(f))
     }
   end
 
@@ -253,6 +266,15 @@ module Gemgem
                          end
   end
 
+  def submodules_pattern
+    @submodules_pattern ||= if submodules.empty?
+                              /^$/
+                            else
+                              Regexp.new(submodules.map{ |path|
+                                "^#{Regexp.escape(path)}/" }.join('|'))
+                            end
+  end
+
   def expand_patterns pathes
     # http://git-scm.com/docs/gitignore
     pathes.flat_map{ |path|

data/test/test_json_response.rb

@@ -9,7 +9,9 @@ describe RC::JsonResponse do
     would 'do nothing' do
       expected = {RC::RESPONSE_BODY => nil,
                   RC::REQUEST_HEADERS => {'Accept' => 'application/json'}}
-      app.call({}){ |response| response.should.eq(expected) }
+      app.call(RC::RESPONSE_BODY => '') do |response|
+        response.should.eq(expected)
+      end
     end
 
     would 'decode' do
@@ -36,6 +38,22 @@ describe RC::JsonResponse do
         err.cause.class.should.eq(RC::Json.const_get(:ParseError))
       end
     end
+
+    would 'remove UTF-8 BOM' do
+      body = %Q{\xEF\xBB\xBF"UTF-8"}
+
+      app.call(RC::RESPONSE_BODY => body) do |response|
+        expect(response[RC::RESPONSE_BODY]).eq 'UTF-8'
+      end
+    end
+
+    would 'remove UTF-8 BOM for ASCII-8BIT' do
+      body = %Q{\xEF\xBB\xBF"UTF-8"}.force_encoding('ASCII-8BIT')
+
+      app.call(RC::RESPONSE_BODY => body) do |response|
+        expect(response[RC::RESPONSE_BODY]).eq 'UTF-8'
+      end
+    end
   end
 
   describe 'client' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2017-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-builder
@@ -117,7 +117,7 @@ files:
 - test/test_universal.rb
 homepage: https://github.com/godfat/rest-core
 licenses:
-- Apache License 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Various [rest-builder](https://github.com/godfat/rest-builder) middleware