ezclient 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7c441970d24a2206c3cd0f2f93ed5cbecb592ae8344d6a7ba449dd3d0b16f6
-  data.tar.gz: '049c93b96e988fc0e2898161e87ff1b8cadb6282c4deb2a88d34f00ffc2cccb0'
+  metadata.gz: fa2cb8306bd3eef023200502bf45328c0c449d3ee5c462587f6654ecdda6ed46
+  data.tar.gz: 122807a192e55ce43ba40f6e639d5ef37c290e53cfd04bc36fa1cd36f51e5e77
 SHA512:
-  metadata.gz: 6b5a1fb31992687e9bf84f10cc1bdd4fc34b84672ce7a3e6f097778f2e07a0b8516f7c82d8a55e655dd85a7cf24de6b92484c5d7c0165f2408bcf3309ce60808
-  data.tar.gz: e3a4e0dde38f1da48c7d18c330014e14275853cacd7e3b693ab58b5ac6735524a89d081c818f56def176a06bde8ba1714a2d0f5b4de24c4c3daac3792e59f396
+  metadata.gz: 28f28f6623afc9200fdc949452e88d27157ac7ee8512329cfff5b2af078dc066cac27b8d8a509fd99834776493c9625268bb523f4f30d327b2ed5adbc5754c93
+  data.tar.gz: c8b58ff10962b02ad3eb7948c5d912acff4f2c7c2bfdc0cd90fc10efbeb01428b8fcae963010245168cf1712306f52e11984de3ee0ac706b62c2d4cfb2e44143

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    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.0", "3.1", "3.2", "3.3"]
+
+    name: ${{ matrix.ruby }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - run: bundle exec rake
+
+    - uses: coverallsapp/github-action@v2
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -7,5 +7,3 @@
 /spec/reports/
 /tmp/
 .rspec_status
-Gemfile.lock
-/gemfiles/*.lock

data/.rubocop.yml

@@ -1,9 +1,11 @@
+require: rubocop-rake
+
 inherit_gem:
   rubocop-config-umbrellio: lib/rubocop.yml
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
   Include:
     - bin/console
     - Gemfile
@@ -14,4 +16,9 @@ AllCops:
     - gemfile/**/*
   Exclude:
     - vendor/**/*
-    - gemfiles/**/*
+
+RSpec/Rails/HaveHttpStatus:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false

data/Gemfile

@@ -2,3 +2,14 @@
 
 source "https://rubygems.org"
 gemspec
+
+gem "bundler"
+gem "coveralls"
+gem "pry"
+gem "rake"
+gem "rspec"
+gem "rubocop-config-umbrellio"
+gem "rubocop-rake"
+gem "simplecov"
+gem "simplecov-lcov"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    ezclient (1.7.0)
+      http (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    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.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    domain_name (0.6.20240107)
+    drb (2.2.1)
+    ffi (1.17.0)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
+    hashdiff (1.1.0)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.6)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    method_source (1.1.0)
+    mime-types (3.5.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2024.0702)
+    minitest (5.24.1)
+    multi_json (1.15.0)
+    mutex_m (0.2.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.7)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-config-umbrellio (1.63.0.93)
+      rubocop (~> 1.63.0)
+      rubocop-performance (~> 1.21.0)
+      rubocop-rails (~> 2.24.0)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.29.0)
+      rubocop-sequel (~> 0.3.3)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.24.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    rubocop-sequel (0.3.4)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
+    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 (2.5.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls
+  ezclient!
+  pry
+  rake
+  rspec
+  rubocop-config-umbrellio
+  rubocop-rake
+  simplecov
+  simplecov-lcov
+  webmock
+
+BUNDLED WITH
+   2.5.16

data/README.md

@@ -35,6 +35,7 @@ Valid client options are:
 
 - `api_auth` – arguments for `ApiAuth.sign!` (see https://github.com/mgomes/api_auth)
 - `basic_auth` – arguments for basic authentication (either a hash with `:user` and `:pass` keys or a two-element array)
+- `cookies` – a hash of cookies (or `HTTP::CookieJar` object) for requests
 - `headers` – a hash of headers for requests
 - `keep_alive` – timeout for persistent connection in seconds
 - `max_retries` – maximum number of retries in case `retry_exceptions` option is provided
@@ -44,7 +45,8 @@ Valid client options are:
 - `retry_exceptions` – an array of exception classes to retry
 - `ssl_context` – ssl context for requests (an `OpenSSL::SSL::SSLContext` instance)
 - `timeout` – timeout for requests in seconds or hash like `{ read: 5, write: 5, connect: 1 }`
-- `follow` - enable following redirects (`true` or hash with options – e.g. `{ max_hops: 1, strict: false}`)
+- `follow` – enable following redirects (`true` or hash with options – e.g. `{ max_hops: 1, strict: false}`)
+- `error_wrapper` – callback called on request exception, makes it possible to handle any error, default behavior: `raise error`
 
 All these options are passed to each request made by this client but can be overriden on per-request basis.
 
@@ -90,6 +92,7 @@ You can provide `on_complete`, `on_error` and `on_retry` callbacks like this:
 on_complete = -> (request, response, metadata) { ... }
 on_error = -> (request, error, metadata) { ... }
 on_retry = -> (request, error, metadata) { ... }
+error_wrapper = -> (request, error, metadata) { raise error }
 
 client = EzClient.new(
   on_complete: on_complete,
@@ -97,6 +100,7 @@ client = EzClient.new(
   on_retry: on_retry,
   retry_exceptions: [StandardError],
   max_retries: 2,
+  error_wrapper: error_wrapper
 )
 
 response = client.perform!(:get, url, metadata: :hello)
@@ -118,6 +122,7 @@ request.verb # => "POST"
 request.url # => "http://example.com"
 request.body # => '{"a": 1}'
 request.headers # => { "Content-Type" => "application/json; charset=UTF-8", ... }
+request.elapsed_seconds # => 0.08117745001072763
 ```
 
 ## Response object

data/bin/rspec

@@ -15,7 +15,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/ezclient.gemspec

@@ -5,28 +5,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ezclient/version"
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 3.0"
 
-  spec.name    = "ezclient"
+  spec.name = "ezclient"
   spec.version = EzClient::VERSION
   spec.authors = ["Yuri Smirnov"]
-  spec.email   = ["tycooon@yandex.ru", "oss@umbrellio.biz"]
+  spec.email = ["tycooon@yandex.ru", "oss@umbrellio.biz"]
 
-  spec.summary  = "An HTTP gem wrapper for easy persistent connections and more."
+  spec.summary = "An HTTP gem wrapper for easy persistent connections and more."
   spec.homepage = "https://github.com/umbrellio/ezclient"
-  spec.license  = "MIT"
+  spec.license = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "http", ">= 4"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop-config-umbrellio"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "webmock"
 end

data/lib/ezclient/client.rb

@@ -15,6 +15,7 @@ class EzClient::Client
     ssl_context
     timeout
     follow
+    error_wrapper
   ].freeze
 
   def initialize(options = {})

data/lib/ezclient/errors.rb

@@ -6,6 +6,7 @@ module EzClient
 
     def initialize(response)
       self.response = response
+      super
     end
 
     def message

data/lib/ezclient/request.rb

@@ -10,7 +10,7 @@ class EzClient::Request
     query
   ].freeze
 
-  attr_accessor :verb, :url, :options
+  attr_accessor :verb, :url, :options, :elapsed_seconds
 
   def initialize(verb, url, options)
     self.verb = verb.to_s.upcase
@@ -23,12 +23,12 @@ class EzClient::Request
   def perform
     http_response = perform_request
 
-    EzClient::Response.new(http_response).tap do |response|
+    EzClient::Response.new(http_response, http_request).tap do |response|
       on_complete.call(self, response, options[:metadata])
     end
   rescue => error
     on_error.call(self, error, options[:metadata])
-    raise error
+    error_wrapper.call(self, error, options[:metadata])
   end
 
   def perform!
@@ -101,6 +101,7 @@ class EzClient::Request
   end
 
   def perform_request
+    perform_started_at = EzClient.get_time
     with_retry do
       # Use original client so that connection can be reused
       res = client.perform(http_request, http_options)
@@ -110,6 +111,8 @@ class EzClient::Request
         client.perform(request, http_options)
       end
     end
+  ensure
+    self.elapsed_seconds = EzClient.get_time - perform_started_at
   end
 
   def with_retry(&block)
@@ -171,6 +174,10 @@ class EzClient::Request
     options[:follow].is_a?(Hash) ? options[:follow] : {}
   end
 
+  def error_wrapper
+    options[:error_wrapper] || proc { |_request, error, _metadata| raise error }
+  end
+
   def prepare_headers(headers)
     headers = HTTP::Headers.coerce(headers)
     headers[:user_agent] ||= "ezclient/#{EzClient::VERSION}"
@@ -198,7 +205,7 @@ class EzClient::Request
   end
 
   def basic_auth
-    @basic_auth ||= begin
+    @basic_auth ||=
       case options[:basic_auth]
       when Array
         user, password = options[:basic_auth]
@@ -206,6 +213,5 @@ class EzClient::Request
       when Hash
         options[:basic_auth]
       end
-    end
   end
 end

data/lib/ezclient/response.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 class EzClient::Response
-  attr_accessor :http_response, :body
+  attr_accessor :http_response, :body, :http_request
 
-  def initialize(http_response)
+  def initialize(http_response, http_request)
     self.http_response = http_response
+    self.http_request = http_request
     self.body = http_response.body.to_s # Make sure we read the body for persistent connection
   end
 
@@ -40,4 +41,22 @@ class EzClient::Response
   def error?
     client_error? || server_error?
   end
+
+  def inspect
+    {
+      req: {
+        raw: http_request.inspect,
+        hdrs: http_request.headers,
+      },
+      resp: {
+        raw: http_response.inspect,
+        hdrs: headers,
+        body: body,
+      },
+    }.to_s
+  end
+
+  def to_s
+    inspect
+  end
 end

data/lib/ezclient/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezclient
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -24,118 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-config-umbrellio
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
 - tycooon@yandex.ru
@@ -144,18 +32,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/rspec
 - ezclient.gemspec
-- gemfiles/http3.gemfile
 - lib/ezclient.rb
 - lib/ezclient/check_options.rb
 - lib/ezclient/client.rb
@@ -177,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: An HTTP gem wrapper for easy persistent connections and more.

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-
-os: linux
-
-dist: xenial
-
-before_install: gem install bundler
-
-jobs:
-  fast_finish: true
-  include:
-  - rvm: 2.5
-  - rvm: 2.6
-  - rvm: 2.7
-  - rvm: ruby-head
-  allow_failures:
-  - rvm: ruby-head

data/gemfiles/http3.gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec path: ".."
-
-gem "http", "~> 3.0"