ezclient 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95857956414f9377de79dd8b0b29bc54de9dcb57ef0cdcff1e2964f14030d3f
-  data.tar.gz: 0e37a6cda106514431b61640582e89b97434c59bd8e281549a1e1de528e18ab3
+  metadata.gz: b9d924fb42fdf0d2417695af6b836c5a5901a93ebf49e427810b53e9f39eb895
+  data.tar.gz: 847bf2ad2e91ec4671d24c23f51cff227540bbdc20701bd7d45ed352ade9777f
 SHA512:
-  metadata.gz: d3541368eac52018a2ef482e41d13fc785466da7be953d4a6a9f44ea86ce66a0498d844f8ff86cd5b6048fbb334ad508249273ad0fa8f91fadf3cca0e9430609
-  data.tar.gz: ada38c6791768ceb5a3f01877b0236b9400392b32dc4f32d0b9a4c6299bd685f13c38499c49b3e23c63f9461c4e18e3b9829242ce5a804043d06be9b6bc19194
+  metadata.gz: a0166d4e24074988276d31315675ff36565bb398c49970f554b3a5b903f5ad98b73428bfeb8ac0e65dd49902d48c3099a29a60076dcba96f2882281003336969
+  data.tar.gz: d5d6eb11f69e26aa5d4b51d5cc52c0afa30bf2a36ae1fe0dfb9e40ae9540df33b73e735a9525173bb814cb2e790fd9547c867941b83d7f0c3990a4811cb0091a

data/.github/workflows/ci.yml

@@ -29,3 +29,29 @@ jobs:
     - uses: coverallsapp/github-action@v2
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  test-http-6:
+    runs-on: ubuntu-latest
+
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run on push event
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'umbrellio/ezclient'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3"]
+
+    name: http 6 / Ruby ${{ matrix.ruby }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/http_6.gemfile
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - run: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ezclient (1.7.2)
+    ezclient (1.7.3)
       http (>= 4)
 
 GEM

data/gemfiles/http_6.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+eval_gemfile "../Gemfile"
+
+gem "http", "~> 6.0"

data/gemfiles/http_6.gemfile.lock

@@ -0,0 +1,187 @@
+PATH
+  remote: ..
+  specs:
+    ezclient (1.7.3)
+      http (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    domain_name (0.6.20240107)
+    drb (2.2.3)
+    hashdiff (1.2.1)
+    http (6.0.3)
+      http-cookie (~> 1.0)
+      llhttp (~> 0.6.1)
+    http-cookie (1.1.6)
+      domain_name (~> 0.5)
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.2)
+    json (2.19.4)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    llhttp (0.6.1)
+    logger (1.7.0)
+    method_source (1.1.0)
+    mime-types (3.7.0)
+      logger
+      mime-types-data (~> 3.2025, >= 3.2025.0507)
+    mime-types-data (3.2026.0414)
+    minitest (6.0.5)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    multi_json (1.20.1)
+    parallel (1.28.0)
+    parser (3.3.11.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    pry (0.16.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      reline (>= 0.6.0)
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rack (3.2.6)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.84.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-config-umbrellio (1.84.118)
+      rubocop (~> 1.84.0)
+      rubocop-factory_bot (~> 2.28.0)
+      rubocop-performance (~> 1.26.0)
+      rubocop-rails (~> 2.34.0)
+      rubocop-rake (~> 0.7.0)
+      rubocop-rspec (~> 3.9.0)
+      rubocop-sequel (~> 0.4.0)
+    rubocop-factory_bot (2.28.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.34.3)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    rubocop-sequel (0.4.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov-lcov (0.9.0)
+    simplecov_json_formatter (0.1.4)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    webmock (3.26.2)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls
+  ezclient!
+  http (~> 6.0)
+  pry
+  rake
+  rspec
+  rubocop-config-umbrellio
+  rubocop-rake
+  simplecov
+  simplecov-lcov
+  webmock
+
+BUNDLED WITH
+   2.7.2

data/lib/ezclient/httprb_compatibility.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module EzClient::HttprbCompatibility
+  KEYWORD_PARAMETER_TYPES = %i[key keyreq].freeze
+
+  module_function
+
+  def client_supports_build_request?
+    HTTP::Client.method_defined?(:build_request)
+  end
+
+  def httprb_v6_or_later?
+    Gem::Version.new(HTTP::VERSION) >= Gem::Version.new("6")
+  end
+
+  def build_request(client, verb, url, opts)
+    if client_supports_build_request?
+      client.build_request(verb, url, opts)
+    else
+      HTTP::Request::Builder.new(client.default_options.merge(opts)).build(verb, url)
+    end
+  end
+
+  def basic_auth(client, opts)
+    if keyword_initializer?(client.method(:basic_auth))
+      client.basic_auth(**opts)
+    else
+      client.basic_auth(opts)
+    end
+  end
+
+  def redirector(opts)
+    if keyword_initializer?(HTTP::Redirector.instance_method(:initialize))
+      HTTP::Redirector.new(**opts)
+    else
+      HTTP::Redirector.new(opts)
+    end
+  end
+
+  def persistent_client(origin, keep_alive_timeout)
+    if client_supports_build_request?
+      HTTP.persistent(origin, timeout: keep_alive_timeout)
+    else
+      HTTP::Client.new(persistent: origin, keep_alive_timeout: keep_alive_timeout)
+    end
+  end
+
+  def response(**attrs)
+    if keyword_initializer?(HTTP::Response.instance_method(:initialize))
+      HTTP::Response.new(**attrs)
+    else
+      HTTP::Response.new(attrs)
+    end
+  end
+
+  def keyword_initializer?(method)
+    method.parameters.any? { |type, _name| KEYWORD_PARAMETER_TYPES.include?(type) }
+  end
+end

data/lib/ezclient/persistent_client.rb

@@ -3,7 +3,7 @@
 class EzClient::PersistentClient
   extend Forwardable
 
-  def_delegators :http_client, :build_request, :default_options, :timeout
+  def_delegators :http_client, :basic_auth, :build_request, :cookies, :default_options, :timeout
 
   def initialize(origin, keep_alive_timeout)
     self.origin = origin
@@ -26,6 +26,6 @@ class EzClient::PersistentClient
   attr_accessor :origin, :keep_alive_timeout, :last_request_at
 
   def http_client
-    @http_client ||= HTTP.persistent(origin, timeout: keep_alive_timeout)
+    @http_client ||= EzClient::HttprbCompatibility.persistent_client(origin, keep_alive_timeout)
   end
 end

data/lib/ezclient/request.rb

@@ -10,6 +10,51 @@ class EzClient::Request
     query
   ].freeze
 
+  class RedirectCookieState
+    def initialize(response)
+      self.cookie_jar = HTTP::CookieJar.new
+      self.expired_cookie_names = []
+      store(response)
+    end
+
+    def store(response)
+      response.headers.get(HTTP::Headers::SET_COOKIE).each do |set_cookie|
+        HTTP::Cookie.parse(set_cookie, response.request.uri).each do |cookie|
+          expired_cookie_names << cookie.name if cookie.expired?
+          cookie_jar.add(cookie)
+        end
+      end
+    end
+
+    def apply_to(request)
+      cookies = cookie_header_for(request)
+
+      if cookies.empty?
+        request.headers.delete(HTTP::Headers::COOKIE)
+      else
+        request.headers.set(HTTP::Headers::COOKIE, cookies)
+      end
+    end
+
+    private
+
+    attr_accessor :cookie_jar, :expired_cookie_names
+
+    def cookie_header_for(request)
+      response_cookies = cookie_jar.cookies(request.uri)
+      excluded_names = expired_cookie_names | response_cookies.map(&:name)
+
+      cookie_values = request_cookie_values(request, excluded_names)
+      cookie_values.concat(response_cookies.map(&:cookie_value)).join("; ")
+    end
+
+    def request_cookie_values(request, excluded_names)
+      HTTP::Cookie.cookie_value_to_hash(request.headers[HTTP::Headers::COOKIE].to_s)
+        .except(*excluded_names)
+        .map { |name, value| "#{name}=#{HTTP::Cookie::Scanner.quote(value)}" }
+    end
+  end
+
   attr_accessor :verb, :url, :options, :elapsed_seconds
 
   def initialize(verb, url, options)
@@ -43,7 +88,8 @@ class EzClient::Request
 
   def api_auth!(*args)
     raise "ApiAuth gem is not loaded" unless defined?(ApiAuth)
-    ApiAuth.sign!(http_request, *args)
+
+    ApiAuth.sign!(api_auth_request, *args)
     self
   end
 
@@ -73,28 +119,45 @@ class EzClient::Request
 
   attr_accessor :client
 
+  def api_auth_request
+    http_request.tap { |request| define_api_auth_header_accessors(request) }
+  end
+
+  def define_api_auth_header_accessors(request)
+    # api-auth 2.x expects HTTP::Request to expose header accessors that were removed in httprb 6.
+    request.define_singleton_method(:[]) { |key| headers[key] } unless request.respond_to?(:[])
+
+    return if request.respond_to?(:[]=)
+
+    request.define_singleton_method(:[]=) { |key, value| headers[key] = value }
+  end
+
   def http_request
-    @http_request ||= begin
-      opts = {}
-
-      opts[verb == "GET" ? :params : :form] = options[:params]
-      opts[:json] = options[:json] if options[:json]
-      opts[:body] = options[:body] if options[:body]
-      opts[:params] = options[:query] if options[:query]
-      opts[:form] = options[:form] if options[:form]
-      opts[:form] = prepare_form_params(opts[:form]) if opts[:form]
-      opts[:headers] = prepare_headers(options[:headers])
-
-      http_client.build_request(verb, url, opts)
-    end
+    @http_request ||= EzClient::HttprbCompatibility.build_request(
+      http_client,
+      verb,
+      url,
+      build_request_opts,
+    )
+  end
+
+  def build_request_opts
+    opts = {}
+    opts[verb == "GET" ? :params : :form] = options[:params] if options[:params]
+    opts[:json] = options[:json] if options[:json]
+    opts[:body] = options[:body] if options[:body]
+    opts[:params] = options[:query] if options[:query]
+    opts[:form] = options[:form] if options[:form]
+    opts[:form] = prepare_form_params(opts[:form]) if opts[:form]
+    opts[:headers] = prepare_headers(options[:headers])
+    opts
   end
 
   def http_client
-    # Only used to build proper HTTP::Request and HTTP::Options instances
     @http_client ||= begin
       http_client = client.dup
       http_client = set_timeout(http_client)
-      http_client = http_client.basic_auth(basic_auth) if basic_auth
+      http_client = EzClient::HttprbCompatibility.basic_auth(http_client, basic_auth) if basic_auth
       http_client = http_client.cookies(options[:cookies]) if options[:cookies]
       http_client
     end
@@ -107,14 +170,41 @@ class EzClient::Request
       res = client.perform(http_request, http_options)
       return res unless follow
 
-      HTTP::Redirector.new(follow).perform(http_request, res) do |request|
-        client.perform(request, http_options)
-      end
+      perform_redirects(res)
     end
   ensure
     self.elapsed_seconds = EzClient.get_time - perform_started_at
   end
 
+  def perform_redirects(response)
+    if EzClient::HttprbCompatibility.client_supports_build_request?
+      redirector(follow).perform(http_request, response) { |req| client.perform(req, http_options) }
+    else
+      perform_redirects_with_cookies(response)
+    end
+  end
+
+  def perform_redirects_with_cookies(response)
+    cookie_state = RedirectCookieState.new(response)
+    redirect_opts = follow.dup
+    on_redirect = redirect_opts.delete(:on_redirect)
+    redirect_response = response
+
+    redirector(redirect_opts).perform(http_request, response) do |req|
+      cookie_state.apply_to(req)
+      on_redirect&.call(redirect_response, req)
+
+      client.perform(req, http_options).tap do |res|
+        cookie_state.store(res)
+        redirect_response = res
+      end
+    end
+  end
+
+  def redirector(options)
+    EzClient::HttprbCompatibility.redirector(options)
+  end
+
   def with_retry(&block)
     retries = 0
 
@@ -187,7 +277,6 @@ class EzClient::Request
   def prepare_form_params(original_params)
     params = {}
 
-    # NOTE: use Hash#transform_values after Ruby 2.3 support is dropped
     original_params.each do |key, value|
       params[key] =
         if value.is_a?(File)

data/lib/ezclient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzClient
-  VERSION = "1.7.2"
+  VERSION = "1.7.3"
 end

data/lib/ezclient.rb

@@ -3,6 +3,7 @@
 require "http"
 
 require_relative "ezclient/version"
+require_relative "ezclient/httprb_compatibility"
 require_relative "ezclient/client"
 require_relative "ezclient/persistent_client"
 require_relative "ezclient/persistent_client_registry"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezclient
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Yuri Smirnov
@@ -42,10 +42,13 @@ files:
 - bin/console
 - bin/rspec
 - ezclient.gemspec
+- gemfiles/http_6.gemfile
+- gemfiles/http_6.gemfile.lock
 - lib/ezclient.rb
 - lib/ezclient/check_options.rb
 - lib/ezclient/client.rb
 - lib/ezclient/errors.rb
+- lib/ezclient/httprb_compatibility.rb
 - lib/ezclient/persistent_client.rb
 - lib/ezclient/persistent_client_registry.rb
 - lib/ezclient/request.rb
@@ -69,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An HTTP gem wrapper for easy persistent connections and more.
 test_files: []