http 2.2.2 → 3.0.0.pre

data/lib/http/client.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "forwardable"
 
 require "http/form_data"
@@ -23,7 +24,7 @@ module HTTP
     end
 
     # Make an HTTP request
-    def request(verb, uri, opts = {})
+    def request(verb, uri, opts = {}) # rubocop:disable Style/OptionHash
       opts    = @default_options.merge(opts)
       uri     = make_request_uri(uri, opts)
       headers = make_request_headers(opts)
@@ -31,11 +32,12 @@ module HTTP
       proxy   = opts.proxy
 
       req = HTTP::Request.new(
-        :verb    => verb,
-        :uri     => uri,
-        :headers => headers,
-        :proxy   => proxy,
-        :body    => body
+        :verb         => verb,
+        :uri          => uri,
+        :headers      => headers,
+        :proxy        => proxy,
+        :body         => body,
+        :auto_deflate => opts.feature(:auto_deflate)
       )
 
       res = perform(req, opts)
@@ -146,29 +148,30 @@ module HTTP
         headers[Headers::COOKIE] = cookies
       end
 
+      if (auto_deflate = opts.feature(:auto_deflate))
+        # 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] = auto_deflate.method
+      end
+
       headers
     end
 
     # Create the request body object to send
     def make_request_body(opts, headers)
-      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
+      case
+      when opts.body
+        opts.body
+      when opts.form
+        form = HTTP::FormData.create opts.form
+        headers[Headers::CONTENT_TYPE] ||= form.content_type
+        form
+      when opts.json
+        body = MimeType[:json].encode opts.json
+        headers[Headers::CONTENT_TYPE] ||= "application/json; charset=#{body.encoding.name}"
+        body
       end
     end
   end

data/lib/http/connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "forwardable"
 
 require "http/headers"
@@ -10,17 +11,17 @@ module HTTP
     extend Forwardable
 
     # Allowed values for CONNECTION header
-    KEEP_ALIVE = "Keep-Alive".freeze
-    CLOSE      = "close".freeze
+    KEEP_ALIVE = "Keep-Alive"
+    CLOSE      = "close"
 
     # Attempt to read this much data
     BUFFER_SIZE = 16_384
 
     # HTTP/1.0
-    HTTP_1_0 = "1.0".freeze
+    HTTP_1_0 = "1.0"
 
     # HTTP/1.1
-    HTTP_1_1 = "1.1".freeze
+    HTTP_1_1 = "1.1"
 
     # Returned after HTTP CONNECT (via proxy)
     attr_reader :proxy_response_headers
@@ -211,6 +212,7 @@ module HTTP
 
       value = @socket.readpartial(size)
       if value == :eof
+        @parser << ""
         :eof
       elsif value
         @parser << value

data/lib/http/content_type.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module HTTP
   ContentType = Struct.new(:mime_type, :charset) do
     MIME_TYPE_RE = %r{^([^/]+/[^;]+)(?:$|;)}

data/lib/http/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module HTTP
   # Generic error
   class Error < StandardError; end
@@ -18,6 +19,6 @@ module HTTP
   # Generic Timeout error
   class TimeoutError < Error; end
 
-  # Header name is invalid
-  class InvalidHeaderNameError < Error; end
+  # Header value is of unexpected format (similar to Net::HTTPHeaderSyntaxError)
+  class HeaderError < Error; end
 end

data/lib/http/feature.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module HTTP
   class Feature
-    def initialize(opts = {})
+    def initialize(opts = {}) # rubocop:disable Style/OptionHash
       @opts = opts
     end
   end

data/lib/http/features/auto_deflate.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "zlib"
+require "tempfile"
 
 module HTTP
   module Features
@@ -12,32 +13,88 @@ module HTTP
 
         @method = @opts.key?(:method) ? @opts[:method].to_s : "gzip"
 
-        raise Error, "Only gzip and deflate methods are supported" unless %w(gzip deflate).include?(@method)
+        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)
+      def deflated_body(body)
+        case method
+        when "gzip"
+          GzippedBody.new(body)
+        when "deflate"
+          DeflatedBody.new(body)
+        else
+          raise ArgumentError, "Unsupported deflate method: #{method}"
+        end
+      end
 
-        # We need to delete Content-Length header. It will be set automatically
-        # by HTTP::Request::Writer
-        headers.delete(Headers::CONTENT_LENGTH)
+      class CompressedBody
+        def initialize(body)
+          @body       = body
+          @compressed = nil
+        end
 
-        headers[Headers::CONTENT_ENCODING] = method
+        def size
+          compress_all! unless @compressed
+          @compressed.size
+        end
 
-        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
+        def each(&block)
+          return to_enum __method__ unless block
+
+          if @compressed
+            compressed_each(&block)
+          else
+            compress(&block)
           end
-        when "deflate" then
-          Zlib::Deflate.deflate(body)
-        else
-          raise ArgumentError, "Unsupported deflate method: #{method}"
+
+          self
+        end
+
+        private
+
+        def compressed_each
+          while (data = @compressed.read(Connection::BUFFER_SIZE))
+            yield data
+          end
+        ensure
+          @compressed.close!
+        end
+
+        def compress_all!
+          @compressed = Tempfile.new("http-compressed_body", :binmode => true)
+          compress { |data| @compressed.write(data) }
+          @compressed.rewind
+        end
+      end
+
+      class GzippedBody < CompressedBody
+        def compress(&block)
+          gzip = Zlib::GzipWriter.new(BlockIO.new(block))
+          @body.each { |chunk| gzip.write(chunk) }
+        ensure
+          gzip.finish
+        end
+
+        class BlockIO
+          def initialize(block)
+            @block = block
+          end
+
+          def write(data)
+            @block.call(data)
+          end
+        end
+      end
+
+      class DeflatedBody < CompressedBody
+        def compress
+          deflater = Zlib::Deflate.new
+
+          @body.each { |chunk| yield deflater.deflate(chunk) }
+
+          yield deflater.finish
+        ensure
+          deflater.close
         end
       end
     end

data/lib/http/features/auto_inflate.rb

@@ -1,9 +1,10 @@
 # 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])
+        if %w[deflate gzip x-gzip].include?(response.headers[:content_encoding])
           Response::Inflater.new(connection)
         else
           connection

data/lib/http/headers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "forwardable"
 
 require "http/errors"
@@ -196,7 +197,7 @@ module HTTP
     # Transforms `name` to canonical HTTP header capitalization
     #
     # @param [String] name
-    # @raise [InvalidHeaderNameError] if normalized name does not
+    # @raise [HeaderError] if normalized name does not
     #   match {HEADER_NAME_RE}
     # @return [String] canonical HTTP header name
     def normalize_header(name)
@@ -206,7 +207,7 @@ module HTTP
 
       return normalized if normalized =~ COMPLIANT_NAME_RE
 
-      raise InvalidHeaderNameError, "Invalid HTTP header field name: #{name.inspect}"
+      raise HeaderError, "Invalid HTTP header field name: #{name.inspect}"
     end
   end
 end

data/lib/http/headers/known.rb

@@ -1,83 +1,84 @@
 # frozen_string_literal: true
+
 module HTTP
   class Headers
     # Content-Types that are acceptable for the response.
-    ACCEPT = "Accept".freeze
+    ACCEPT = "Accept"
 
     # The age the object has been in a proxy cache in seconds.
-    AGE = "Age".freeze
+    AGE = "Age"
 
     # Authentication credentials for HTTP authentication.
-    AUTHORIZATION = "Authorization".freeze
+    AUTHORIZATION = "Authorization"
 
     # Used to specify directives that must be obeyed by all caching mechanisms
     # along the request-response chain.
-    CACHE_CONTROL = "Cache-Control".freeze
+    CACHE_CONTROL = "Cache-Control"
 
     # An HTTP cookie previously sent by the server with Set-Cookie.
-    COOKIE = "Cookie".freeze
+    COOKIE = "Cookie"
 
     # Control options for the current connection and list
     # of hop-by-hop request fields.
-    CONNECTION = "Connection".freeze
+    CONNECTION = "Connection"
 
     # The length of the request body in octets (8-bit bytes).
-    CONTENT_LENGTH = "Content-Length".freeze
+    CONTENT_LENGTH = "Content-Length"
 
     # The MIME type of the body of the request
     # (used with POST and PUT requests).
-    CONTENT_TYPE = "Content-Type".freeze
+    CONTENT_TYPE = "Content-Type"
 
     # The date and time that the message was sent (in "HTTP-date" format as
     # defined by RFC 7231 Date/Time Formats).
-    DATE = "Date".freeze
+    DATE = "Date"
 
     # An identifier for a specific version of a resource,
     # often a message digest.
-    ETAG = "ETag".freeze
+    ETAG = "ETag"
 
     # Gives the date/time after which the response is considered stale (in
     # "HTTP-date" format as defined by RFC 7231).
-    EXPIRES = "Expires".freeze
+    EXPIRES = "Expires"
 
     # The domain name of the server (for virtual hosting), and the TCP port
     # number on which the server is listening. The port number may be omitted
     # if the port is the standard port for the service requested.
-    HOST = "Host".freeze
+    HOST = "Host"
 
     # Allows a 304 Not Modified to be returned if content is unchanged.
-    IF_MODIFIED_SINCE = "If-Modified-Since".freeze
+    IF_MODIFIED_SINCE = "If-Modified-Since"
 
     # Allows a 304 Not Modified to be returned if content is unchanged.
-    IF_NONE_MATCH = "If-None-Match".freeze
+    IF_NONE_MATCH = "If-None-Match"
 
     # The last modified date for the requested object (in "HTTP-date" format as
     # defined by RFC 7231).
-    LAST_MODIFIED = "Last-Modified".freeze
+    LAST_MODIFIED = "Last-Modified"
 
     # Used in redirection, or when a new resource has been created.
-    LOCATION = "Location".freeze
+    LOCATION = "Location"
 
     # Authorization credentials for connecting to a proxy.
-    PROXY_AUTHORIZATION = "Proxy-Authorization".freeze
+    PROXY_AUTHORIZATION = "Proxy-Authorization"
 
     # An HTTP cookie.
-    SET_COOKIE = "Set-Cookie".freeze
+    SET_COOKIE = "Set-Cookie"
 
     # The form of encoding used to safely transfer the entity to the user.
     # Currently defined methods are: chunked, compress, deflate, gzip, identity.
-    TRANSFER_ENCODING = "Transfer-Encoding".freeze
+    TRANSFER_ENCODING = "Transfer-Encoding"
 
     # Indicates what additional content codings have been applied to the
     # entity-body.
-    CONTENT_ENCODING = "Content-Encoding".freeze
+    CONTENT_ENCODING = "Content-Encoding"
 
     # The user agent string of the user agent.
-    USER_AGENT = "User-Agent".freeze
+    USER_AGENT = "User-Agent"
 
     # Tells downstream proxies how to match future request headers to decide
     # whether the cached response can be used rather than requesting a fresh
     # one from the origin server.
-    VARY = "Vary".freeze
+    VARY = "Vary"
   end
 end

data/lib/http/headers/mixin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "forwardable"
 
 module HTTP

data/lib/http/mime_type.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module HTTP
   # MIME type encode/decode adapters
   module MimeType

data/lib/http/mime_type/adapter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "forwardable"
 require "singleton"
 
@@ -13,7 +14,7 @@ module HTTP
         def_delegators :instance, :encode, :decode
       end
 
-      %w(encode decode).each do |operation|
+      %w[encode decode].each do |operation|
         class_eval <<-RUBY, __FILE__, __LINE__
           def #{operation}(*)
             fail Error, "\#{self.class} does not supports ##{operation}"

data/lib/http/mime_type/json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "json"
 require "http/mime_type/adapter"
 
@@ -14,7 +15,7 @@ module HTTP
 
       # Decodes JSON
       def decode(str)
-        ::JSON.load str
+        ::JSON.parse str
       end
     end