http 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8593353cd2283b2ac49c557ff71d5f1a668066dbac59b3d2a6f59429b9b2f5e8
-  data.tar.gz: e9316b3c4dd519825eeaa255a4f86932ce4a9e7f374f9be8273ca4051f5b9c3d
+  metadata.gz: da85aeba1d2d3dce86f59a678ade3f74df35514397cb7488f9aaab9ea5a57220
+  data.tar.gz: 28e5143890592f55f51fa65874f787f3c3e9eac5f9f6103c589082414eff378e
 SHA512:
-  metadata.gz: 0ae34b411a233ca8601aebe2295f2a1d8e0bec7e742a95fdd6e075b4f7dd3c68d42448cfbac1146b645ee59424e91af8eb3878c43e7a7fb17c3569681cf4ccf3
-  data.tar.gz: a76bc0a41338e67677370014d803ea79e3a34078172cc81491f31b085613394c7290b2402e199a2e1de77c7fecf7e05fde8fc2d9924016105ce429751f202e85
+  metadata.gz: 6b14bb800aefa920d2511b962967253fc034847bb07f8d181bb9cec6dba136ca0c51655fd0da716986897be5ef83e6023705578016db7bbd12bbd1f2ed4bbeb4
+  data.tar.gz: dc996c20d358b382fbb2b1d93af7a706f858167392c8db3d8bf11e114419c0c7ed0a61350753f9c13422ca48b469af0b359f80694fe423066a02439066bfdd07

data/.rubocop/rspec.yml

@@ -0,0 +1,9 @@
+RSpec/ExampleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+RSpec/MultipleExpectations:
+  Max: 5

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 100`
-# on 2022-06-16 14:35:44 UTC using RuboCop version 1.30.1.
+# on 2025-06-09 02:44:43 UTC using RuboCop version 1.30.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,7 +14,7 @@ Gemspec/DeprecatedAttributeAssignment:
   Exclude:
     - 'http.gemspec'
 
-# Offense count: 53
+# Offense count: 55
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: leading, trailing
@@ -30,7 +30,14 @@ Layout/DotPosition:
     - 'spec/lib/http_spec.rb'
     - 'spec/support/http_handling_shared.rb'
 
-# Offense count: 176
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_braces
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Offense count: 206
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
 # SupportedStyles: space, no_space, compact
@@ -62,6 +69,18 @@ Lint/MissingSuper:
     - 'lib/http/features/logging.rb'
     - 'lib/http/features/normalize_uri.rb'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'spec/lib/http/retriable/performer_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowComments, AllowNil.
+Lint/SuppressedException:
+  Exclude:
+    - 'spec/lib/http/retriable/performer_spec.rb'
+
 # Offense count: 8
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
@@ -74,34 +93,6 @@ Metrics/AbcSize:
     - 'lib/http/request.rb'
     - 'lib/http/response.rb'
 
-# Offense count: 70
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
-Metrics/BlockLength:
-  Exclude:
-    - '**/*.gemspec'
-    - 'spec/lib/http/client_spec.rb'
-    - 'spec/lib/http/connection_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/features/instrumentation_spec.rb'
-    - 'spec/lib/http/features/logging_spec.rb'
-    - 'spec/lib/http/headers/mixin_spec.rb'
-    - 'spec/lib/http/headers_spec.rb'
-    - 'spec/lib/http/options/merge_spec.rb'
-    - 'spec/lib/http/redirector_spec.rb'
-    - 'spec/lib/http/request/body_spec.rb'
-    - 'spec/lib/http/request/writer_spec.rb'
-    - 'spec/lib/http/request_spec.rb'
-    - 'spec/lib/http/response/body_spec.rb'
-    - 'spec/lib/http/response/parser_spec.rb'
-    - 'spec/lib/http/response/status_spec.rb'
-    - 'spec/lib/http/response_spec.rb'
-    - 'spec/lib/http/uri_spec.rb'
-    - 'spec/lib/http_spec.rb'
-    - 'spec/support/http_handling_shared.rb'
-
 # Offense count: 4
 # Configuration parameters: CountComments, Max, CountAsOne.
 Metrics/ClassLength:
@@ -118,7 +109,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/http/chainable.rb'
     - 'lib/http/client.rb'
 
-# Offense count: 18
+# Offense count: 19
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Exclude:
@@ -133,6 +124,7 @@ Metrics/MethodLength:
     - 'lib/http/request.rb'
     - 'lib/http/response.rb'
     - 'lib/http/response/body.rb'
+    - 'lib/http/retriable/performer.rb'
     - 'lib/http/timeout/global.rb'
 
 # Offense count: 1
@@ -173,6 +165,27 @@ Style/Encoding:
     - 'spec/lib/http_spec.rb'
     - 'spec/support/dummy_server/servlet.rb'
 
+# Offense count: 71
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never, either
+Style/HashSyntax:
+  Exclude:
+    - 'spec/lib/http/features/raise_error_spec.rb'
+    - 'spec/lib/http/retriable/delay_calculator_spec.rb'
+    - 'spec/lib/http/retriable/performer_spec.rb'
+    - 'spec/lib/http_spec.rb'
+
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/http/headers/normalizer.rb'
+    - 'lib/http/retriable/delay_calculator.rb'
+
 # Offense count: 17
 # Configuration parameters: SuspiciousParamNames, Allowlist.
 # SuspiciousParamNames: options, opts, args, params, parameters

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.3.0] - 2025-06-09
+
+### Added
+
+- (backported) Add .retriable feature to Http
+- (backported) Add more specific ConnectionError classes
+- (backported) New feature: RaiseError
+
+### Changed
+
+- (backported) Drop depenency on base64
+- (backported) Cache header normalization to reduce object allocation
+- (backported) Use native llhttp on MRI
+
+
 ## [5.2.0] - 2024-02-05
 
 ### Added
@@ -37,5 +52,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Prevent CRLF injection due to broken URL normalizer
   ([#765](https://github.com/httprb/http/pull/765))
 
-[unreleased]: https://github.com/httprb/http/compare/v5.2.0...5-x-stable
+[unreleased]: https://github.com/httprb/http/compare/v5.3.0...5-x-stable
+[5.3.0]: https://github.com/httprb/http/compare/v5.2.0...v5.3.0
 [5.2.0]: https://github.com/httprb/http/compare/v5.1.1...v5.2.0

data/Gemfile

@@ -37,6 +37,7 @@ group :test do
 
   gem "rspec", "~> 3.10"
   gem "rspec-its"
+  gem "rspec-memory"
 
   gem "yardstick"
 end

data/http.gemspec

@@ -28,10 +28,15 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.6"
 
   gem.add_runtime_dependency "addressable",    "~> 2.8"
-  gem.add_runtime_dependency "base64",         "~> 0.1"
   gem.add_runtime_dependency "http-cookie",    "~> 1.0"
   gem.add_runtime_dependency "http-form_data", "~> 2.2"
-  gem.add_runtime_dependency "llhttp-ffi",     "~> 0.5.0"
+
+  # Use native llhttp for MRI (more performant) and llhttp-ffi for other interpreters (better compatibility)
+  if RUBY_ENGINE == "ruby"
+    gem.add_runtime_dependency "llhttp",     "~> 0.5.0"
+  else
+    gem.add_runtime_dependency "llhttp-ffi", "~> 0.5.0"
+  end
 
   gem.add_development_dependency "bundler", "~> 2.0"
 

data/lib/http/base64.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module HTTP
+  module Base64
+    module_function
+
+    # Equivalent to Base64.strict_encode64
+    def encode64(input)
+      [input].pack("m0")
+    end
+  end
+end

data/lib/http/chainable.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require "base64"
-
+require "http/base64"
 require "http/headers"
 
 module HTTP
   module Chainable
+    include HTTP::Base64
+
     # Request a get sans response body
     # @param uri
     # @option options [Hash]
@@ -215,7 +216,7 @@ module HTTP
       pass  = opts.fetch(:pass)
       creds = "#{user}:#{pass}"
 
-      auth("Basic #{Base64.strict_encode64(creds)}")
+      auth("Basic #{encode64(creds)}")
     end
 
     # Get options for HTTP
@@ -242,11 +243,34 @@ module HTTP
     # * instrumentation
     # * logging
     # * normalize_uri
+    # * raise_error
     # @param features
     def use(*features)
       branch default_options.with_features(features)
     end
 
+    # Returns retriable client instance, which retries requests if they failed
+    # due to some socket errors or response status is `5xx`.
+    #
+    # @example Usage
+    #
+    #   # Retry max 5 times with randomly growing delay between retries
+    #   HTTP.retriable.get(url)
+    #
+    #   # Retry max 3 times with randomly growing delay between retries
+    #   HTTP.retriable(times: 3).get(url)
+    #
+    #   # Retry max 3 times with 1 sec delay between retries
+    #   HTTP.retriable(times: 3, delay: proc { 1 }).get(url)
+    #
+    #   # Retry max 3 times with geometrically progressed delay between retries
+    #   HTTP.retriable(times: 3, delay: proc { |i| 1 + i*i }).get(url)
+    #
+    # @param (see Performer#initialize)
+    def retriable(**options)
+      Retriable::Client.new(Retriable::Performer.new(options), default_options)
+    end
+
     private
 
     # :nodoc:

data/lib/http/connection.rb

@@ -105,10 +105,11 @@ module HTTP
 
     # Reads data from socket up until headers are loaded
     # @return [void]
+    # @raise [ResponseHeaderError] when unable to read response headers
     def read_headers!
       until @parser.headers?
         result = read_more(BUFFER_SIZE)
-        raise ConnectionError, "couldn't read response headers" if result == :eof
+        raise ResponseHeaderError, "couldn't read response headers" if result == :eof
       end
 
       set_keep_alive
@@ -217,6 +218,7 @@ module HTTP
 
     # Feeds some more data into parser
     # @return [void]
+    # @raise [SocketReadError] when unable to read from socket
     def read_more(size)
       return if @parser.finished?
 
@@ -228,7 +230,7 @@ module HTTP
         @parser << value
       end
     rescue IOError, SocketError, SystemCallError => e
-      raise ConnectionError, "error reading from socket: #{e}", e.backtrace
+      raise SocketReadError, "error reading from socket: #{e}", e.backtrace
     end
   end
 end

data/lib/http/errors.rb

@@ -7,6 +7,11 @@ module HTTP
   # Generic Connection error
   class ConnectionError < Error; end
 
+  # Types of Connection errors
+  class ResponseHeaderError < ConnectionError; end
+  class SocketReadError < ConnectionError; end
+  class SocketWriteError < ConnectionError; end
+
   # Generic Request error
   class RequestError < Error; end
 
@@ -16,6 +21,17 @@ module HTTP
   # Requested to do something when we're in the wrong state
   class StateError < ResponseError; end
 
+  # When status code indicates an error
+  class StatusError < ResponseError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+
+      super("Unexpected status code #{response.code}")
+    end
+  end
+
   # Generic Timeout error
   class TimeoutError < Error; end
 

data/lib/http/feature.rb

@@ -20,6 +20,7 @@ end
 
 require "http/features/auto_inflate"
 require "http/features/auto_deflate"
-require "http/features/logging"
 require "http/features/instrumentation"
+require "http/features/logging"
 require "http/features/normalize_uri"
+require "http/features/raise_error"

data/lib/http/features/raise_error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module HTTP
+  module Features
+    class RaiseError < Feature
+      def initialize(ignore: [])
+        super()
+
+        @ignore = ignore
+      end
+
+      def wrap_response(response)
+        return response if response.code < 400
+        return response if @ignore.include?(response.code)
+
+        raise HTTP::StatusError, response
+      end
+
+      HTTP::Options.register_feature(:raise_error, self)
+    end
+  end
+end

data/lib/http/headers/normalizer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module HTTP
+  class Headers
+    class Normalizer
+      # Matches HTTP header names when in "Canonical-Http-Format"
+      CANONICAL_NAME_RE = /\A[A-Z][a-z]*(?:-[A-Z][a-z]*)*\z/
+
+      # Matches valid header field name according to RFC.
+      # @see http://tools.ietf.org/html/rfc7230#section-3.2
+      COMPLIANT_NAME_RE = /\A[A-Za-z0-9!#$%&'*+\-.^_`|~]+\z/
+
+      NAME_PARTS_SEPARATOR_RE = /[\-_]/
+
+      # @private
+      # Normalized header names cache
+      class Cache
+        MAX_SIZE = 200
+
+        def initialize
+          @store = {}
+        end
+
+        def get(key)
+          @store[key]
+        end
+        alias [] get
+
+        def set(key, value)
+          # Maintain cache size
+          @store.delete(@store.each_key.first) while MAX_SIZE <= @store.size
+
+          @store[key] = value
+        end
+        alias []= set
+      end
+
+      def initialize
+        @cache = Cache.new
+      end
+
+      # Transforms `name` to canonical HTTP header capitalization
+      def call(name)
+        name  = -name.to_s
+        value = (@cache[name] ||= -normalize_header(name))
+
+        value.dup
+      end
+
+      private
+
+      # Transforms `name` to canonical HTTP header capitalization
+      #
+      # @param [String] name
+      # @raise [HeaderError] if normalized name does not
+      #   match {COMPLIANT_NAME_RE}
+      # @return [String] canonical HTTP header name
+      def normalize_header(name)
+        return name if CANONICAL_NAME_RE.match?(name)
+
+        normalized = name.split(NAME_PARTS_SEPARATOR_RE).each(&:capitalize!).join("-")
+
+        return normalized if COMPLIANT_NAME_RE.match?(normalized)
+
+        raise HeaderError, "Invalid HTTP header field name: #{name.inspect}"
+      end
+    end
+  end
+end

data/lib/http/headers.rb

@@ -4,6 +4,7 @@ require "forwardable"
 
 require "http/errors"
 require "http/headers/mixin"
+require "http/headers/normalizer"
 require "http/headers/known"
 
 module HTTP
@@ -12,12 +13,31 @@ module HTTP
     extend Forwardable
     include Enumerable
 
-    # Matches HTTP header names when in "Canonical-Http-Format"
-    CANONICAL_NAME_RE = /\A[A-Z][a-z]*(?:-[A-Z][a-z]*)*\z/.freeze
+    class << self
+      # Coerces given `object` into Headers.
+      #
+      # @raise [Error] if object can't be coerced
+      # @param [#to_hash, #to_h, #to_a] object
+      # @return [Headers]
+      def coerce(object)
+        unless object.is_a? self
+          object = case
+                   when object.respond_to?(:to_hash) then object.to_hash
+                   when object.respond_to?(:to_h)    then object.to_h
+                   when object.respond_to?(:to_a)    then object.to_a
+                   else raise Error, "Can't coerce #{object.inspect} to Headers"
+                   end
+        end
+        headers = new
+        object.each { |k, v| headers.add k, v }
+        headers
+      end
+      alias [] coerce
 
-    # Matches valid header field name according to RFC.
-    # @see http://tools.ietf.org/html/rfc7230#section-3.2
-    COMPLIANT_NAME_RE = /\A[A-Za-z0-9!#$%&'*+\-.^_`|~]+\z/.freeze
+      def normalizer
+        @normalizer ||= Headers::Normalizer.new
+      end
+    end
 
     # Class constructor.
     def initialize
@@ -194,45 +214,11 @@ module HTTP
       dup.tap { |dupped| dupped.merge! other }
     end
 
-    class << self
-      # Coerces given `object` into Headers.
-      #
-      # @raise [Error] if object can't be coerced
-      # @param [#to_hash, #to_h, #to_a] object
-      # @return [Headers]
-      def coerce(object)
-        unless object.is_a? self
-          object = case
-                   when object.respond_to?(:to_hash) then object.to_hash
-                   when object.respond_to?(:to_h)    then object.to_h
-                   when object.respond_to?(:to_a)    then object.to_a
-                   else raise Error, "Can't coerce #{object.inspect} to Headers"
-                   end
-        end
-
-        headers = new
-        object.each { |k, v| headers.add k, v }
-        headers
-      end
-      alias [] coerce
-    end
-
     private
 
     # Transforms `name` to canonical HTTP header capitalization
-    #
-    # @param [String] name
-    # @raise [HeaderError] if normalized name does not
-    #   match {HEADER_NAME_RE}
-    # @return [String] canonical HTTP header name
     def normalize_header(name)
-      return name if name =~ CANONICAL_NAME_RE
-
-      normalized = name.split(/[\-_]/).each(&:capitalize!).join("-")
-
-      return normalized if normalized =~ COMPLIANT_NAME_RE
-
-      raise HeaderError, "Invalid HTTP header field name: #{name.inspect}"
+      self.class.normalizer.call(name)
     end
 
     # Ensures there is no new line character in the header value

data/lib/http/request/writer.rb

@@ -108,6 +108,7 @@ module HTTP
 
       private
 
+      # @raise [SocketWriteError] when unable to write to socket
       def write(data)
         until data.empty?
           length = @socket.write(data)
@@ -118,7 +119,7 @@ module HTTP
       rescue Errno::EPIPE
         raise
       rescue IOError, SocketError, SystemCallError => e
-        raise ConnectionError, "error writing to socket: #{e}", e.backtrace
+        raise SocketWriteError, "error writing to socket: #{e}", e.backtrace
       end
     end
   end

data/lib/http/request.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "forwardable"
-require "base64"
 require "time"
 
+require "http/base64"
 require "http/errors"
 require "http/headers"
 require "http/request/body"
@@ -15,6 +15,7 @@ module HTTP
   class Request
     extend Forwardable
 
+    include HTTP::Base64
     include HTTP::Headers::Mixin
 
     # The method given was not understood
@@ -159,7 +160,7 @@ module HTTP
     end
 
     def proxy_authorization_header
-      digest = Base64.strict_encode64("#{proxy[:proxy_username]}:#{proxy[:proxy_password]}")
+      digest = encode64("#{proxy[:proxy_username]}:#{proxy[:proxy_password]}")
       "Basic #{digest}"
     end
 

data/lib/http/retriable/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "http/retriable/performer"
+
+module HTTP
+  module Retriable
+    # Retriable version of HTTP::Client.
+    #
+    # @see http://www.rubydoc.info/gems/http/HTTP/Client
+    class Client < HTTP::Client
+      # @param [Performer] performer
+      # @param [HTTP::Options, Hash] options
+      def initialize(performer, options)
+        @performer = performer
+        super(options)
+      end
+
+      # Overriden version of `HTTP::Client#make_request`.
+      #
+      # Monitors request/response phase with performer.
+      #
+      # @see http://www.rubydoc.info/gems/http/HTTP/Client:perform
+      def perform(req, options)
+        @performer.perform(self, req) { super(req, options) }
+      end
+
+      private
+
+      # Overriden version of `HTTP::Chainable#branch`.
+      #
+      # @return [HTTP::Retriable::Client]
+      def branch(options)
+        Retriable::Client.new(@performer, options)
+      end
+    end
+  end
+end

data/lib/http/retriable/delay_calculator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module HTTP
+  module Retriable
+    # @api private
+    class DelayCalculator
+      def initialize(opts)
+        @max_delay = opts.fetch(:max_delay, Float::MAX).to_f
+        if (delay = opts[:delay]).respond_to?(:call)
+          @delay_proc = opts.fetch(:delay)
+        else
+          @delay = delay
+        end
+      end
+
+      def call(iteration, response)
+        delay = if response && (retry_header = response.headers["Retry-After"])
+                  delay_from_retry_header(retry_header)
+                else
+                  calculate_delay_from_iteration(iteration)
+                end
+
+        ensure_dealy_in_bounds(delay)
+      end
+
+      RFC2822_DATE_REGEX = /^
+        (?:Sun|Mon|Tue|Wed|Thu|Fri|Sat),\s+
+        (?:0[1-9]|[1-2]?[0-9]|3[01])\s+
+        (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s+
+        (?:19[0-9]{2}|[2-9][0-9]{3})\s+
+        (?:2[0-3]|[0-1][0-9]):(?:[0-5][0-9]):(?:60|[0-5][0-9])\s+
+        GMT
+      $/x
+
+      # Spec for Retry-After header
+      # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
+      def delay_from_retry_header(value)
+        value = value.to_s.strip
+
+        case value
+        when RFC2822_DATE_REGEX then DateTime.rfc2822(value).to_time - Time.now.utc
+        when /^\d+$/            then value.to_i
+        else 0
+        end
+      end
+
+      def calculate_delay_from_iteration(iteration)
+        if @delay_proc
+          @delay_proc.call(iteration)
+        elsif @delay
+          @delay
+        else
+          delay = (2**(iteration - 1)) - 1
+          delay_noise = rand
+          delay + delay_noise
+        end
+      end
+
+      def ensure_dealy_in_bounds(delay)
+        delay.clamp(0, @max_delay)
+      end
+    end
+  end
+end