http 2.1.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ce75d295d182290642aa569b754914f89ed797f
-  data.tar.gz: 353078321cc4c0e9134a5b10d655186474288770
+  metadata.gz: 66bda3b695b673507461ef5f59bc3d14a145fc78
+  data.tar.gz: 69c82f1484defda8becec34ef76caf0a59e2d378
 SHA512:
-  metadata.gz: d4717d7e9b0a3d841fa31e533e69e35728943218c68455550ccacb845712c1a24e657385c7c4d228c6d3af5a5c68105a674647bef64fba1af33439041153db6a
-  data.tar.gz: 6dd93161b0a552b4f7484ee2e935e54f57de0f0f6f3f1415250f35073ea90be854baa00322cc59a078a2f3f0a84732289de5ad44e63f782874df44a347770bb8
+  metadata.gz: c1149d111a7b16ea0d02c30a5a5126c393ea86cda749341a2056c17cf5c5004ee1bb3faf416c9bc483d28771c7c0ad9af349a866bd209a394460b579561142be
+  data.tar.gz: 7e3a46cf89a76a1ff557f40740f3aa851a8dd3e9bc44f64146f62db7db4839f21fb5efce9aaf88826945c85d97820bfa7574bc8aea21a0e6551d7195120d5e51

data/.rubocop.yml

@@ -20,7 +20,7 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   CountComments: false
-  Max: 22 # TODO: Lower to 15
+  Max: 25 # TODO: Lower to 15
 
 Metrics/ModuleLength:
   CountComments: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -1,28 +1,29 @@
 language: ruby
 sudo: false
 
-bundler_args: --without development doc
+before_install:
+  - gem update --system 2.6.10
+  - gem --version
+  - gem install bundler --version 1.14.3 --no-rdoc --no-ri
+  - bundle --version
+
+install: bundle _1.14.3_ install --without development doc
+
+script: bundle _1.14.3_ exec rake
 
 env:
   global:
     - JRUBY_OPTS="$JRUBY_OPTS --debug"
 
 rvm:
+  - jruby-9.1.7.0
   - 2.0.0
   - 2.1
   - 2.2
-  - 2.3.0
-  - 2.3.1
-  - jruby-9.1.0.0
-  - jruby-head
-  - ruby-head
-  - rbx-2
+  - 2.3.3
+  - 2.4.0
 
 matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head
-    - rvm: rbx-2
   fast_finish: true
 
 branches:

data/CHANGES.md

@@ -1,3 +1,29 @@
+## 2.2.2 (2017-04-27)
+
+* [#404](https://github.com/httprb/http/issues/404),
+  [#405](https://github.com/httprb/http/pull/405)
+  Make keepalive timeout configurable.
+  ([@nestegg])
+
+
+## 2.2.1 (2017-02-06)
+
+* [#395](https://github.com/httprb/http/issues/395)
+  Fix regression of API, that broke webmock integration.
+  ([@ixti])
+
+
+## 2.2.0 (2017-02-03)
+
+* [#375](https://github.com/httprb/http/pull/375)
+  Add support for automatic Gzip/Inflate
+  ([@Bonias])
+
+* [#390](https://github.com/httprb/http/pull/390)
+  Add REPORT to the list of valid HTTP verbs
+  ([@ixti])
+
+
 ## 2.1.0 (2016-11-08)
 
 * [#370](https://github.com/httprb/http/issues/370)
@@ -566,3 +592,5 @@ end
 [@jhbabon]: https://github.com/jhbabon
 [@britishtea]: https://github.com/britishtea
 [@janko-m]: https://github.com/janko-m
+[@Bonias]: https://github.com/Bonias
+[@nestegg]: https://github.com/nestegg

data/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
+ruby RUBY_VERSION
 
 gem "rake"
 
@@ -17,13 +18,12 @@ group :test do
   gem "backports"
   gem "coveralls", :require => false
   gem "simplecov", ">= 0.9"
-  gem "json",      ">= 1.8.1"
   gem "rubocop",   "=  0.40.0"
   gem "rspec",     "~> 3.0"
   gem "rspec-its"
   gem "yardstick"
   gem "certificate_authority", :require => false
-  gem "activemodel", "~> 4", :require => false # Used by certificate_authority
+  gem "activemodel",           :require => false # Used by certificate_authority
 end
 
 group :doc do

data/README.md

@@ -6,6 +6,10 @@
 [![Coverage Status](https://coveralls.io/repos/httprb/http/badge.svg?branch=master)](https://coveralls.io/r/httprb/http)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/httprb/http/blob/master/LICENSE.txt)
 
+_NOTE: This is the 2.x **stable** branch.  For the 3.x **development** branch, please see:_
+
+https://github.com/httprb/http/
+
 ## About
 
 HTTP (The Gem! a.k.a. http.rb) is an easy-to-use client library for making requests
@@ -160,7 +164,7 @@ versions:
 * Ruby 2.1.x
 * Ruby 2.2.x
 * Ruby 2.3.x
-* JRuby 9.1.0.0
+* JRuby 9.1.x.x
 
 If something doesn't work on one of these versions, it's a bug.
 

data/lib/http/chainable.rb

@@ -75,10 +75,12 @@ module HTTP
       branch(options).request verb, uri
     end
 
-    # @overload(options = {})
+    # @overload timeout(options = {})
     #   Syntax sugar for `timeout(:per_operation, options)`
-    # @overload(klass, options = {})
+    # @overload timeout(klass, options = {})
+    #   Adds a timeout to the request.
     #   @param [#to_sym] klass
+    #     either :null, :global, or :per_operation
     #   @param [Hash] options
     #   @option options [Float] :read Read timeout
     #   @option options [Float] :write Write timeout
@@ -107,12 +109,13 @@ module HTTP
       )
     end
 
-    # @overload persistent(host)
+    # @overload persistent(host, timeout: 5)
     #   Flags as persistent
-    #   @param [String] host
-    #   @raise [Request::Error] if Host is invalid
+    #   @param  [String] host
+    #   @option [Integer] timeout Keep alive timeout
+    #   @raise  [Request::Error] if Host is invalid
     #   @return [HTTP::Client] Persistent client
-    # @overload persistent(host, &block)
+    # @overload persistent(host, timeout: 5, &block)
     #   Executes given block with persistent client and automatically closes
     #   connection at the end of execution.
     #
@@ -136,8 +139,9 @@ module HTTP
     #
     #   @yieldparam [HTTP::Client] client Persistent client
     #   @return [Object] result of last expression in the block
-    def persistent(host)
-      p_client = branch default_options.with_persistent host
+    def persistent(host, timeout: 5)
+      options  = {:keep_alive_timeout => timeout}
+      p_client = branch default_options.merge(options).with_persistent host
       return p_client unless block_given?
       yield p_client
     ensure
@@ -228,6 +232,14 @@ module HTTP
       branch default_options.with_nodelay(true)
     end
 
+    # Turn on given features. Available features are:
+    # * auto_inflate
+    # * auto_deflate
+    # @param features
+    def use(*features)
+      branch default_options.with_features(features)
+    end
+
     private
 
     # :nodoc:

data/lib/http/client.rb

@@ -71,6 +71,7 @@ module HTTP
         :proxy_headers => @connection.proxy_response_headers,
         :connection    => @connection,
         :encoding      => options.encoding,
+        :auto_inflate  => options.feature(:auto_inflate),
         :uri           => req.uri
       )
 
@@ -150,18 +151,24 @@ module HTTP
 
     # Create the request body object to send
     def make_request_body(opts, headers)
-      case
-      when opts.body
-        opts.body
-      when opts.form
-        form = HTTP::FormData.create opts.form
-        headers[Headers::CONTENT_TYPE]   ||= form.content_type
-        headers[Headers::CONTENT_LENGTH] ||= form.content_length
-        form.to_s
-      when opts.json
-        body = MimeType[:json].encode opts.json
-        headers[Headers::CONTENT_TYPE] ||= "application/json; charset=#{body.encoding.name}"
-        body
+      request_body =
+        case
+        when opts.body
+          opts.body
+        when opts.form
+          form = HTTP::FormData.create opts.form
+          headers[Headers::CONTENT_TYPE]   ||= form.content_type
+          headers[Headers::CONTENT_LENGTH] ||= form.content_length
+          form.to_s
+        when opts.json
+          body = MimeType[:json].encode opts.json
+          headers[Headers::CONTENT_TYPE] ||= "application/json; charset=#{body.encoding.name}"
+          body
+        end
+      if (auto_deflate = opts.feature(:auto_deflate))
+        auto_deflate.deflate(headers, request_body)
+      else
+        request_body
       end
     end
   end

data/lib/http/feature.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module HTTP
+  class Feature
+    def initialize(opts = {})
+      @opts = opts
+    end
+  end
+end

data/lib/http/features/auto_deflate.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+module HTTP
+  module Features
+    class AutoDeflate < Feature
+      attr_reader :method
+
+      def initialize(*)
+        super
+
+        @method = @opts.key?(:method) ? @opts[:method].to_s : "gzip"
+
+        raise Error, "Only gzip and deflate methods are supported" unless %w(gzip deflate).include?(@method)
+      end
+
+      def deflate(headers, body)
+        return body unless body
+        return body unless body.is_a?(String)
+
+        # We need to delete Content-Length header. It will be set automatically
+        # by HTTP::Request::Writer
+        headers.delete(Headers::CONTENT_LENGTH)
+
+        headers[Headers::CONTENT_ENCODING] = method
+
+        case method
+        when "gzip" then
+          StringIO.open do |out|
+            Zlib::GzipWriter.wrap(out) do |gz|
+              gz.write body
+              gz.finish
+              out.tap(&:rewind).read
+            end
+          end
+        when "deflate" then
+          Zlib::Deflate.deflate(body)
+        else
+          raise ArgumentError, "Unsupported deflate method: #{method}"
+        end
+      end
+    end
+  end
+end

data/lib/http/features/auto_inflate.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module HTTP
+  module Features
+    class AutoInflate < Feature
+      def stream_for(connection, response)
+        if %w(deflate gzip x-gzip).include?(response.headers[:content_encoding])
+          Response::Inflater.new(connection)
+        else
+          connection
+        end
+      end
+    end
+  end
+end

data/lib/http/headers/known.rb

@@ -68,6 +68,10 @@ module HTTP
     # Currently defined methods are: chunked, compress, deflate, gzip, identity.
     TRANSFER_ENCODING = "Transfer-Encoding".freeze
 
+    # Indicates what additional content codings have been applied to the
+    # entity-body.
+    CONTENT_ENCODING = "Content-Encoding".freeze
+
     # The user agent string of the user agent.
     USER_AGENT = "User-Agent".freeze
 

data/lib/http/options.rb

@@ -3,15 +3,24 @@ require "http/headers"
 require "openssl"
 require "socket"
 require "http/uri"
+require "http/feature"
+require "http/features/auto_inflate"
+require "http/features/auto_deflate"
 
 module HTTP
+  # rubocop:disable Metrics/ClassLength
   class Options
     @default_socket_class     = TCPSocket
     @default_ssl_socket_class = OpenSSL::SSL::SSLSocket
     @default_timeout_class    = HTTP::Timeout::Null
+    @available_features       = {
+      :auto_inflate => Features::AutoInflate,
+      :auto_deflate => Features::AutoDeflate
+    }
 
     class << self
       attr_accessor :default_socket_class, :default_ssl_socket_class, :default_timeout_class
+      attr_reader :available_features
 
       def new(options = {})
         return options if options.is_a?(self)
@@ -50,7 +59,8 @@ module HTTP
         :keep_alive_timeout => 5,
         :headers            => {},
         :cookies            => {},
-        :encoding           => nil
+        :encoding           => nil,
+        :features           => {}
       }
 
       opts_w_defaults = defaults.merge(options)
@@ -73,6 +83,38 @@ module HTTP
       self.encoding = Encoding.find(encoding)
     end
 
+    def_option :features do |features|
+      # Normalize features from:
+      #
+      #     [{feature_one: {opt: 'val'}}, :feature_two]
+      #
+      # into:
+      #
+      #     {feature_one: {opt: 'val'}, feature_two: {}}
+      features = features.each_with_object({}) do |feature, h|
+        if feature.is_a?(Hash)
+          h.merge!(feature)
+        else
+          h[feature] = {}
+        end
+      end
+
+      self.features.merge(features)
+    end
+
+    def features=(features)
+      @features = features.each_with_object({}) do |(name, opts_or_feature), h|
+        h[name] = if opts_or_feature.is_a?(Feature)
+                    opts_or_feature
+                  else
+                    unless (feature = self.class.available_features[name])
+                      argument_error! "Unsupported feature: #{name}"
+                    end
+                    feature.new(opts_or_feature)
+                  end
+      end
+    end
+
     %w(
       proxy params form json body follow response
       socket_class nodelay ssl_socket_class ssl_context ssl
@@ -127,6 +169,10 @@ module HTTP
       dupped
     end
 
+    def feature(name)
+      features[name]
+    end
+
     protected
 
     def []=(option, val)

data/lib/http/request.rb

@@ -37,7 +37,10 @@ module HTTP
       # RFC 3744: WebDAV Access Control Protocol
       :acl,
 
-      # draft-dusseault-http-patch: PATCH Method for HTTP
+      # RFC 6352: vCard Extensions to WebDAV -- CardDAV
+      :report,
+
+      # RFC 5789: PATCH Method for HTTP
       :patch,
 
       # draft-reschke-webdav-search: WebDAV Search

data/lib/http/response/body.rb

@@ -15,8 +15,9 @@ module HTTP
       # @return [HTTP::Connection]
       attr_reader :connection
 
-      def initialize(connection, encoding = Encoding::BINARY)
-        @connection = connection
+      def initialize(stream, encoding = Encoding::BINARY)
+        @stream     = stream
+        @connection = stream.is_a?(Inflater) ? stream.connection : stream
         @streaming  = nil
         @contents   = nil
         @encoding   = encoding
@@ -25,7 +26,7 @@ module HTTP
       # (see HTTP::Client#readpartial)
       def readpartial(*args)
         stream!
-        @connection.readpartial(*args)
+        @stream.readpartial(*args)
       end
 
       # Iterate over the body, allowing it to be enumerable
@@ -52,7 +53,7 @@ module HTTP
           @streaming  = false
           @contents   = String.new("").force_encoding(encoding)
 
-          while (chunk = @connection.readpartial)
+          while (chunk = @stream.readpartial)
             @contents << chunk.force_encoding(encoding)
           end
         rescue

data/lib/http/response/inflater.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+module HTTP
+  class Response
+    class Inflater
+      attr_reader :connection
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def readpartial(*args)
+        chunk = @connection.readpartial(*args)
+        if chunk
+          chunk = zstream.inflate(chunk)
+        elsif !zstream.closed?
+          zstream.finish
+          zstream.close
+        end
+        chunk
+      end
+
+      private
+
+      def zstream
+        @zstream ||= Zlib::Inflate.new(32 + Zlib::MAX_WBITS)
+      end
+    end
+  end
+end

data/lib/http/response.rb

@@ -5,6 +5,7 @@ require "http/headers"
 require "http/content_type"
 require "http/mime_type"
 require "http/response/status"
+require "http/response/inflater"
 require "http/uri"
 require "http/cookie_jar"
 require "time"
@@ -47,8 +48,9 @@ module HTTP
       if opts.include?(:connection)
         connection = opts.fetch(:connection)
         encoding   = opts[:encoding] || charset || Encoding::BINARY
+        stream     = body_stream_for(connection, opts)
 
-        @body = Response::Body.new(connection, encoding)
+        @body = Response::Body.new(stream, encoding)
       else
         @body = opts.fetch(:body)
       end
@@ -143,5 +145,15 @@ module HTTP
     def inspect
       "#<#{self.class}/#{@version} #{code} #{reason} #{headers.to_h.inspect}>"
     end
+
+    private
+
+    def body_stream_for(connection, opts)
+      if opts[:auto_inflate]
+        opts[:auto_inflate].stream_for(connection, self)
+      else
+        connection
+      end
+    end
   end
 end

data/lib/http/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTP
-  VERSION = "2.1.0".freeze
+  VERSION = "2.2.2".freeze
 end

data/spec/lib/http/features/auto_deflate_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+RSpec.describe HTTP::Features::AutoDeflate do
+  subject { HTTP::Features::AutoDeflate.new }
+
+  it "raises error for wrong type" do
+    expect { HTTP::Features::AutoDeflate.new(:method => :wrong) }.
+      to raise_error(HTTP::Error) { |error|
+        expect(error.message).to eq("Only gzip and deflate methods are supported")
+      }
+  end
+
+  it "accepts gzip method" do
+    expect(HTTP::Features::AutoDeflate.new(:method => :gzip).method).to eq "gzip"
+  end
+
+  it "accepts deflate method" do
+    expect(HTTP::Features::AutoDeflate.new(:method => :deflate).method).to eq "deflate"
+  end
+
+  it "accepts string as method" do
+    expect(HTTP::Features::AutoDeflate.new(:method => "gzip").method).to eq "gzip"
+  end
+
+  it "uses gzip by default" do
+    expect(subject.method).to eq("gzip")
+  end
+
+  describe "#deflate" do
+    let(:headers) { HTTP::Headers.coerce("Content-Length" => "10") }
+
+    context "when body is nil" do
+      let(:body) { nil }
+
+      it "returns nil" do
+        expect(subject.deflate(headers, body)).to be_nil
+      end
+
+      it "does not remove Content-Length header" do
+        subject.deflate(headers, body)
+        expect(headers["Content-Length"]).to eq "10"
+      end
+
+      it "does not set Content-Encoding header" do
+        subject.deflate(headers, body)
+        expect(headers.include?("Content-Encoding")).to eq false
+      end
+    end
+
+    context "when body is not a string" do
+      let(:body) { {} }
+
+      it "returns given body" do
+        expect(subject.deflate(headers, body).object_id).to eq(body.object_id)
+      end
+
+      it "does not remove Content-Length header" do
+        subject.deflate(headers, body)
+        expect(headers["Content-Length"]).to eq "10"
+      end
+
+      it "does not set Content-Encoding header" do
+        subject.deflate(headers, body)
+        expect(headers.include?("Content-Encoding")).to eq false
+      end
+    end
+
+    context "when body is a string" do
+      let(:body) { "Hello HTTP!" }
+
+      it "encodes body" do
+        encoded = subject.deflate(headers, body)
+        decoded = Zlib::GzipReader.new(StringIO.new(encoded)).read
+
+        expect(decoded).to eq(body)
+      end
+
+      it "removes Content-Length header" do
+        subject.deflate(headers, body)
+        expect(headers.include?("Content-Length")).to eq false
+      end
+
+      it "sets Content-Encoding header" do
+        subject.deflate(headers, body)
+        expect(headers["Content-Encoding"]).to eq "gzip"
+      end
+
+      context "as deflate method" do
+        subject { HTTP::Features::AutoDeflate.new(:method => :deflate) }
+
+        it "encodes body" do
+          encoded = subject.deflate(headers, body)
+          decoded = Zlib::Inflate.inflate(encoded)
+
+          expect(decoded).to eq(body)
+        end
+
+        it "removes Content-Length header" do
+          subject.deflate(headers, body)
+          expect(headers.include?("Content-Length")).to eq false
+        end
+
+        it "sets Content-Encoding header" do
+          subject.deflate(headers, body)
+          expect(headers["Content-Encoding"]).to eq "deflate"
+        end
+      end
+    end
+  end
+end

data/spec/lib/http/features/auto_inflate_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+RSpec.describe HTTP::Features::AutoInflate do
+  subject { HTTP::Features::AutoInflate.new }
+  let(:connection) { double }
+  let(:headers) { {} }
+  let(:response) do
+    HTTP::Response.new(
+      :version    => "1.1",
+      :status     => 200,
+      :headers    => headers,
+      :connection => connection
+    )
+  end
+
+  describe "stream_for" do
+    context "when there is no Content-Encoding header" do
+      it "returns connection" do
+        stream = subject.stream_for(connection, response)
+        expect(stream).to eq(connection)
+      end
+    end
+
+    context "for identity Content-Encoding header" do
+      let(:headers) { {:content_encoding => "not-supported"} }
+
+      it "returns connection" do
+        stream = subject.stream_for(connection, response)
+        expect(stream).to eq(connection)
+      end
+    end
+
+    context "for unknown Content-Encoding header" do
+      let(:headers) { {:content_encoding => "not-supported"} }
+
+      it "returns connection" do
+        stream = subject.stream_for(connection, response)
+        expect(stream).to eq(connection)
+      end
+    end
+
+    context "for deflate Content-Encoding header" do
+      let(:headers) { {:content_encoding => "deflate"} }
+
+      it "returns HTTP::Response::Inflater instance - connection wrapper" do
+        stream = subject.stream_for(connection, response)
+        expect(stream).to be_instance_of HTTP::Response::Inflater
+      end
+    end
+
+    context "for gzip Content-Encoding header" do
+      let(:headers) { {:content_encoding => "gzip"} }
+
+      it "returns HTTP::Response::Inflater instance - connection wrapper" do
+        stream = subject.stream_for(connection, response)
+        expect(stream).to be_instance_of HTTP::Response::Inflater
+      end
+    end
+
+    context "for x-gzip Content-Encoding header" do
+      let(:headers) { {:content_encoding => "x-gzip"} }
+
+      it "returns HTTP::Response::Inflater instance - connection wrapper" do
+        stream = subject.stream_for(connection, response)
+        expect(stream).to be_instance_of HTTP::Response::Inflater
+      end
+    end
+  end
+end

data/spec/lib/http/options/features_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+RSpec.describe HTTP::Options, "features" do
+  let(:opts) { HTTP::Options.new }
+
+  it "defaults to be empty" do
+    expect(opts.features).to be_empty
+  end
+
+  it "accepts plain symbols in array" do
+    opts2 = opts.with_features([:auto_inflate])
+    expect(opts.features).to be_empty
+    expect(opts2.features.keys).to eq([:auto_inflate])
+    expect(opts2.features[:auto_inflate]).
+      to be_instance_of(HTTP::Features::AutoInflate)
+  end
+
+  it "accepts feature name with its options in array" do
+    opts2 = opts.with_features([{:auto_deflate => {:method => :deflate}}])
+    expect(opts.features).to be_empty
+    expect(opts2.features.keys).to eq([:auto_deflate])
+    expect(opts2.features[:auto_deflate]).
+      to be_instance_of(HTTP::Features::AutoDeflate)
+    expect(opts2.features[:auto_deflate].method).to eq("deflate")
+  end
+
+  it "raises error for not supported features" do
+    expect { opts.with_features([:wrong_feature]) }.
+      to raise_error(HTTP::Error) { |error|
+        expect(error.message).to eq("Unsupported feature: wrong_feature")
+      }
+  end
+end

data/spec/lib/http/options/merge_spec.rb

@@ -24,7 +24,8 @@ RSpec.describe HTTP::Options, "merge" do
       :body      => "body-foo",
       :json      => {:foo => "foo"},
       :headers   => {:accept => "json", :foo => "foo"},
-      :proxy     => {}
+      :proxy     => {},
+      :features  => {}
     )
 
     bar = HTTP::Options.new(
@@ -60,7 +61,8 @@ RSpec.describe HTTP::Options, "merge" do
       :ssl_socket_class   => described_class.default_ssl_socket_class,
       :ssl_context        => nil,
       :cookies            => {},
-      :encoding           => nil
+      :encoding           => nil,
+      :features           => {}
     )
   end
 end

data/spec/lib/http/response/body_spec.rb

@@ -38,4 +38,32 @@ RSpec.describe HTTP::Response::Body do
       end
     end
   end
+
+  context "when body is gzipped" do
+    let(:chunks) do
+      body = Zlib::Deflate.deflate("Hi, HTTP here ☺")
+      len  = body.length
+      [String.new(body[0, len / 2]), String.new(body[(len / 2)..-1])]
+    end
+    subject(:body) do
+      inflater = HTTP::Response::Inflater.new(connection)
+      described_class.new(inflater, Encoding::UTF_8)
+    end
+
+    it "decodes body" do
+      expect(subject.to_s).to eq("Hi, HTTP here ☺")
+    end
+
+    describe "#readpartial" do
+      it "streams decoded body" do
+        [
+          "Hi, HTTP ",
+          String.new("here ☺").force_encoding("ASCII-8BIT"),
+          nil
+        ].each do |part|
+          expect(subject.readpartial).to eq(part)
+        end
+      end
+    end
+  end
 end

data/spec/lib/http_spec.rb

@@ -288,6 +288,14 @@ RSpec.describe HTTP do
         end
       end
     end
+
+    context "with timeout specified" do
+      subject(:client) { HTTP.persistent host, :timeout => 100 }
+      it "sets keep_alive_timeout" do
+        options = client.default_options
+        expect(options.keep_alive_timeout).to eq(100)
+      end
+    end
   end
 
   describe ".timeout" do
@@ -410,4 +418,47 @@ RSpec.describe HTTP do
       expect(socket_spy_class.setsockopt_calls).to eq([[Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1]])
     end
   end
+
+  describe ".use" do
+    it "turns on given feature" do
+      client = HTTP.use :auto_deflate
+      expect(client.default_options.features.keys).to eq [:auto_deflate]
+    end
+
+    context "with :auto_deflate" do
+      it "sends gzipped body" do
+        client   = HTTP.use :auto_deflate
+        body     = "Hello!"
+        response = client.post("#{dummy.endpoint}/echo-body", :body => body)
+        encoded  = response.to_s
+
+        expect(Zlib::GzipReader.new(StringIO.new(encoded)).read).to eq body
+      end
+    end
+
+    context "with :auto_inflate" do
+      it "returns raw body when Content-Encoding type is missing" do
+        client   = HTTP.use :auto_inflate
+        body     = "Hello!"
+        response = client.post("#{dummy.endpoint}/encoded-body", :body => body)
+        expect(response.to_s).to eq("#{body}-raw")
+      end
+
+      it "returns decoded body" do
+        client   = HTTP.use(:auto_inflate).headers("Accept-Encoding" => "gzip")
+        body     = "Hello!"
+        response = client.post("#{dummy.endpoint}/encoded-body", :body => body)
+
+        expect(response.to_s).to eq("#{body}-gzipped")
+      end
+
+      it "returns deflated body" do
+        client   = HTTP.use(:auto_inflate).headers("Accept-Encoding" => "deflate")
+        body     = "Hello!"
+        response = client.post("#{dummy.endpoint}/encoded-body", :body => body)
+
+        expect(response.to_s).to eq("#{body}-deflated")
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# coding: utf-8
 
 require "simplecov"
 require "coveralls"
@@ -20,11 +19,6 @@ require "http"
 require "rspec/its"
 require "support/capture_warning"
 
-# Are we in a flaky environment?
-def flaky_env?
-  defined?(JRUBY_VERSION) && ENV["CI"]
-end
-
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -50,6 +44,7 @@ RSpec.configure do |config|
   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
   # get run.
   config.filter_run :focus
+  config.filter_run_excluding :flaky if defined?(JRUBY_VERSION) && ENV["CI"]
   config.run_all_when_everything_filtered = true
 
   # Limits the available syntax to the non-monkey patched syntax that is recommended.

data/spec/support/dummy_server/servlet.rb

@@ -2,6 +2,7 @@
 # encoding: UTF-8
 
 class DummyServer < WEBrick::HTTPServer
+  # rubocop:disable Metrics/ClassLength
   class Servlet < WEBrick::HTTPServlet::AbstractServlet
     def self.sockets
       @sockets ||= []
@@ -146,5 +147,26 @@ class DummyServer < WEBrick::HTTPServer
       res.status = 200
       res.body   = req.body
     end
+
+    post "/encoded-body" do |req, res|
+      res.status = 200
+
+      res.body = case req["Accept-Encoding"]
+                 when "gzip" then
+                   res["Content-Encoding"] = "gzip"
+                   StringIO.open do |out|
+                     Zlib::GzipWriter.wrap(out) do |gz|
+                       gz.write "#{req.body}-gzipped"
+                       gz.finish
+                       out.tap(&:rewind).read
+                     end
+                   end
+                 when "deflate" then
+                   res["Content-Encoding"] = "deflate"
+                   Zlib::Deflate.deflate("#{req.body}-deflated")
+                 else
+                   "#{req.body}-raw"
+                 end
+    end
   end
 end

data/spec/support/http_handling_shared.rb

@@ -50,8 +50,7 @@ RSpec.shared_context "HTTP handling" do
         context "of 0" do
           let(:read_timeout) { 0 }
 
-          it "times out" do
-            skip "flaky environment" if flaky_env?
+          it "times out", :flaky do
             expect { response }.to raise_error(HTTP::TimeoutError, /Read/i)
           end
         end
@@ -59,10 +58,7 @@ RSpec.shared_context "HTTP handling" do
         context "of 2.5" do
           let(:read_timeout) { 2.5 }
 
-          it "does not time out" do
-            # TODO: investigate sporadic JRuby timeouts on CI
-            skip "flaky environment" if flaky_env?
-
+          it "does not time out", :flaky do
             expect { client.get("#{server.endpoint}/sleep").body.to_s }.to_not raise_error
           end
         end
@@ -96,10 +92,7 @@ RSpec.shared_context "HTTP handling" do
 
         let(:read_timeout) { 2.5 }
 
-        it "does not timeout" do
-          # TODO: investigate sporadic JRuby timeouts on CI
-          skip "flaky environment" if flaky_env?
-
+        it "does not timeout", :flaky do
           client.get("#{server.endpoint}/sleep").body.to_s
           client.get("#{server.endpoint}/sleep").body.to_s
         end
@@ -130,9 +123,7 @@ RSpec.shared_context "HTTP handling" do
       end
 
       context "on a mixed state" do
-        it "re-opens the connection" do
-          skip "flaky environment" if flaky_env?
-
+        it "re-opens the connection", :flaky do
           first_socket_id = client.get("#{server.endpoint}/socket/1").body.to_s
 
           client.instance_variable_set(:@state, :dirty)
@@ -163,9 +154,7 @@ RSpec.shared_context "HTTP handling" do
       end
 
       context "with a socket issue" do
-        it "transparently reopens" do
-          skip "flaky environment" if flaky_env?
-
+        it "transparently reopens", :flaky do
           first_socket_id = client.get("#{server.endpoint}/socket").body.to_s
           expect(first_socket_id).to_not eq("")
           # Kill off the sockets we used
@@ -195,9 +184,7 @@ RSpec.shared_context "HTTP handling" do
     context "when disabled" do
       let(:options) { {} }
 
-      it "opens new sockets" do
-        skip "flaky environment" if flaky_env?
-
+      it "opens new sockets", :flaky do
         expect(sockets_used).to_not include("")
         expect(sockets_used.uniq.length).to eq(2)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Tony Arcieri
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
@@ -95,6 +95,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
 - CHANGES.md
@@ -111,6 +112,9 @@ files:
 - lib/http/connection.rb
 - lib/http/content_type.rb
 - lib/http/errors.rb
+- lib/http/feature.rb
+- lib/http/features/auto_deflate.rb
+- lib/http/features/auto_inflate.rb
 - lib/http/headers.rb
 - lib/http/headers/known.rb
 - lib/http/headers/mixin.rb
@@ -123,6 +127,7 @@ files:
 - lib/http/request/writer.rb
 - lib/http/response.rb
 - lib/http/response/body.rb
+- lib/http/response/inflater.rb
 - lib/http/response/parser.rb
 - lib/http/response/status.rb
 - lib/http/response/status/reasons.rb
@@ -134,9 +139,12 @@ files:
 - logo.png
 - spec/lib/http/client_spec.rb
 - spec/lib/http/content_type_spec.rb
+- spec/lib/http/features/auto_deflate_spec.rb
+- spec/lib/http/features/auto_inflate_spec.rb
 - spec/lib/http/headers/mixin_spec.rb
 - spec/lib/http/headers_spec.rb
 - spec/lib/http/options/body_spec.rb
+- spec/lib/http/options/features_spec.rb
 - spec/lib/http/options/form_spec.rb
 - spec/lib/http/options/headers_spec.rb
 - spec/lib/http/options/json_spec.rb
@@ -183,16 +191,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: HTTP should be easy
 test_files:
 - spec/lib/http/client_spec.rb
 - spec/lib/http/content_type_spec.rb
+- spec/lib/http/features/auto_deflate_spec.rb
+- spec/lib/http/features/auto_inflate_spec.rb
 - spec/lib/http/headers/mixin_spec.rb
 - spec/lib/http/headers_spec.rb
 - spec/lib/http/options/body_spec.rb
+- spec/lib/http/options/features_spec.rb
 - spec/lib/http/options/form_spec.rb
 - spec/lib/http/options/headers_spec.rb
 - spec/lib/http/options/json_spec.rb