barkibu-kb 0.32.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b53777b2236e073a8943960012027f45b5dcb853c068e1f09a2fbf093d863791
-  data.tar.gz: d02bbd5e466a2c0dd0fe58d6a5221851c76edfdc15887786d26088cf3691c731
+  metadata.gz: d6665ca6f0d74295cacf6bea9ee921b3dba5decc6b5cb3775bbaa0392fd65b86
+  data.tar.gz: 700cae8005557d25ff41c3f9583725686485eff37ccbb0eec11ff07473ad9077
 SHA512:
-  metadata.gz: aae274ead93d952cd495e8f88c6c7a437011e83a5074f2b05c297d3c573a8f2593584e4a3fd30750589eb2d32c186ea112a138a1560b6cd161b41a71e1d90131
-  data.tar.gz: 06bb84dfd34a396755856ba5e5d17438a40bcc4189b5b6c7e22c69f43daccc431dda6ecbbefa40c4d420615200ef60f7d97a5db0d8948baf6b6425933c2942c0
+  metadata.gz: 97dac9ae9946f9398bd62b2fda16acbd978c1e4e153e23884ab78ac3a055dec7d201fcbf3a98ed4b65403324af2b03d034a6073f30d15c20690699021fccae74
+  data.tar.gz: f9ed89dff91778420037ad50e7531af48d9b7b6d11c7d92afb1d05cdc31192498310520da51d35aa32e9ed77041e808137f5d9b699fcea24d495f2d17379b475

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - run: bundle exec rubocop lib spec
+
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - run: bundle exec rspec

data/CHANGELOG.md

@@ -6,7 +6,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [unreleased]
-- See diff: https://github.com/barkibu/kb-ruby/compare/v0.32.0...HEAD
+- See diff: https://github.com/barkibu/kb-ruby/compare/v1.1.0...HEAD
+
+## [1.1.0]
+- Add `read_timeout:` to `KB::Client#request` to raise the read budget for a single call (e.g. `GET /v1/pets/birthdays`, whose server-side work runs for seconds). Connect and write budgets stay global; the override does not leak into later calls on the same connection.
+
+## [1.0.0]
+- [Breaking changes] Split the single global request timeout into per-phase budgets: `KB.config.request.connect_timeout` (default 1s, bounds TCP connect + TLS handshake), `write_timeout` (default 3s), `read_timeout` (default 5s). `KB.config.request.timeout` is removed — assigning it now raises `NoMethodError` at boot. Migration: a previous global `timeout` maps to `read_timeout` (e.g. `KB_REQUEST_TIMEOUT_SECONDS=12` → `read_timeout = 12`).
+- [Breaking changes] Switch the HTTP adapter from http.rb (`faraday-http`) to Net::HTTP (`faraday-net_http`) — the stock adapter honours all three phase timeouts, aligns the KB client with the rest of our outbound HTTP, and opens a one-line upgrade path to `faraday-net_http_persistent` for connection reuse. Raw error classes change accordingly (`Net::OpenTimeout`/`Net::ReadTimeout`/`Net::WriteTimeout`/`Errno::*` instead of `HTTP::*`) — relevant to APM span queries on `error.type`.
+- Faraday-level wrapping keeps the same three classes (`Faraday::TimeoutError`/`ConnectionFailed`/`SSLError`) with one movement between them: a connect/TLS-phase expiry now surfaces as `Faraday::ConnectionFailed` (was `Faraday::TimeoutError`), making `ConnectionFailed` cleanly mean "the request never got through the pipe".
+- Net::HTTP's idempotent auto-retry stays disabled (`max_retries = 0`, enforced by the adapter and pinned by a spec) — no behaviour change vs. the previous no-retry client.
+- There is no total request budget anymore; worst-case wall clock is the sum of the phase budgets rather than a single number.
+- barkibu-kb-fake: disable Sinatra's host authorization (`set :host_authorization, permitted_hosts: []`). Sinatra >= 4.1 authorizes the Host header and, when it infers a development environment, only permits localhost-style hosts — rejecting requests to the stubbed KB host with `403 Host not permitted`. Permitting the host on the consumer side stops working with the net_http adapter, because WebMock intercepts before Net::HTTP adds the Host header, so the header is absent and can never match a permitted list. Consumers can drop their own `set :host_authorization` workarounds.
 
 ## [0.32.0]
 - Allow Ruby 3.3/3.4: raise `required_ruby_version` ceiling to `< 3.6` (floor stays `>= 2.6`)

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    barkibu-kb (0.32.0)
+    barkibu-kb (1.1.0)
       activemodel (>= 4.0.2)
       activerecord
       activesupport (>= 3.0.0)
       dry-configurable (~> 0.9)
       faraday
-      faraday-http
+      faraday-net_http (~> 1.0)
       faraday_middleware
       i18n
-    barkibu-kb-fake (0.32.0)
-      barkibu-kb (= 0.32.0)
+    barkibu-kb-fake (1.1.0)
+      barkibu-kb (= 1.1.0)
       countries
       sinatra
       webmock
@@ -52,8 +52,6 @@ GEM
       rexml
     diff-lcs (1.4.4)
     docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
     drb (2.2.3)
     dry-configurable (0.16.1)
       dry-core (~> 0.6)
@@ -76,9 +74,6 @@ GEM
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
-    faraday-http (1.1.0)
-      faraday (~> 1.0)
-      http (>= 4.0, < 6)
     faraday-httpclient (1.0.1)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
@@ -89,25 +84,10 @@ GEM
     faraday-retry (1.0.3)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
-    ffi (1.15.5)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
-      rake
     hashdiff (1.0.1)
-    http (5.1.1)
-      addressable (~> 2.8)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.4.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
-    http-form_data (2.3.0)
     i18n (1.15.2)
       concurrent-ruby (~> 1.0)
     json (2.20.0)
-    llhttp-ffi (0.4.0)
-      ffi-compiler (~> 1.0)
-      rake (~> 13.0)
     logger (1.7.0)
     minitest (6.0.6)
       drb (~> 2.0)
@@ -174,9 +154,6 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unaccent (0.4.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
     unicode-display_width (2.5.0)
     uri (1.1.1)
     webmock (3.14.0)

data/README.md

@@ -18,6 +18,15 @@ Or install it yourself as:
 
     $ gem install kb
 
+## Development
+
+Specs and RuboCop run on every pull request (`.github/workflows/ci.yml`) on Ruby 3.4. Locally:
+
+```sh
+docker compose run --rm kb bundle exec rspec
+docker compose run --rm kb bundle exec rubocop lib spec
+```
+
 ## Usage
 
 This gem wraps the Knowledge Base Api and exposes CRUD-_able_ entities into the requiring application.
@@ -43,9 +52,26 @@ KB.config.log_level = :debugger # :info by default
 ```
 
 #### Request timeout configuration
+
+Timeouts are per phase, and each phase fails with its own error class:
+`connect_timeout` maps to Net::HTTP's `open_timeout`, bounding TCP connect plus
+the TLS handshake (`Net::OpenTimeout`); `read_timeout` bounds the wait for the
+response (`Net::ReadTimeout`); `write_timeout` bounds sending the request
+(`Net::WriteTimeout`).
+
 ```ruby
 # config/initializers/kb_ruby.rb
-KB.config.request.timeout = 10 # 5 by default
+KB.config.request.connect_timeout = 2 # 1 by default; TCP connect + TLS handshake
+KB.config.request.write_timeout = 4   # 3 by default
+KB.config.request.read_timeout = 10   # 5 by default
+```
+
+The read budget can be raised for a single call through `KB::Client#request`, for
+the few endpoints whose server-side work legitimately runs for seconds. Connect
+and write budgets stay global:
+
+```ruby
+KB::Pet.kb_client.request('birthdays', filters: { month: 9, day: 22, size: 1000 }, read_timeout: 30)
 ```
 
 ### Exposed Entities

data/barkibu-kb.gemspec

@@ -51,7 +51,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activerecord'
   spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
   spec.add_runtime_dependency 'faraday'
-  spec.add_runtime_dependency 'faraday-http'
+  spec.add_runtime_dependency 'faraday-net_http', '~> 1.0'
   spec.add_runtime_dependency 'faraday_middleware'
   spec.add_runtime_dependency 'i18n'
 end

data/lib/barkibu-kb.rb

@@ -5,7 +5,6 @@ require 'active_support'
 require 'active_support/core_ext/array'
 require 'faraday'
 require 'faraday_middleware'
-require 'faraday/http'
 require 'dry/configurable'
 
 module KB
@@ -19,7 +18,9 @@ module KB
   setting :log_level, default: :info
 
   setting :request do
-    setting :timeout, default: 5
+    setting :connect_timeout, default: 1
+    setting :write_timeout, default: 3
+    setting :read_timeout, default: 5
   end
 end
 

data/lib/kb/client.rb

@@ -7,12 +7,16 @@ module KB
       @base_url = base_url
     end
 
-    def request(sub_path, filters: nil, method: :get)
-      return connection.public_send(method, sub_path, attributes_to_json(filters)).body if method != :get
+    # `read_timeout` overrides KB.config.request.read_timeout for this one call only,
+    # for the few endpoints whose server-side work legitimately runs for seconds
+    # (e.g. GET /v1/pets/birthdays). Connect and write budgets stay global.
+    def request(sub_path, filters: nil, method: :get, read_timeout: nil)
+      options = request_options(read_timeout)
+      return connection.public_send(method, sub_path, attributes_to_json(filters), &options).body if method != :get
 
       cache_key = "#{@base_url}/#{sub_path}/#{(filters || {}).sort.to_h}"
       KB::Cache.fetch(cache_key) do
-        connection.public_send(method, sub_path, filters).body
+        connection.public_send(method, sub_path, filters, &options).body
       end
     end
 
@@ -74,9 +78,7 @@ module KB
     end
 
     def connection
-      @connection ||= Faraday.new(url: base_url,
-                                  headers: headers,
-                                  request: { timeout: KB.config.request.timeout }) do |conn|
+      @connection ||= Faraday.new(url: base_url, headers: headers, request: request_timeouts) do |conn|
         conn.response :json
         conn.response :raise_error
         if KB.config.log_level == :debugger
@@ -84,8 +86,22 @@ module KB
             logger.filter(/(X-api-key:\s)("\w+")/, '\1[API_KEY_SCRUBBED]')
           end
         end
-        conn.adapter :http
+        conn.adapter :net_http
       end
     end
+
+    def request_options(read_timeout)
+      return nil if read_timeout.nil?
+
+      ->(req) { req.options.read_timeout = read_timeout }
+    end
+
+    def request_timeouts
+      {
+        open_timeout: KB.config.request.connect_timeout,
+        write_timeout: KB.config.request.write_timeout,
+        read_timeout: KB.config.request.read_timeout
+      }
+    end
   end
 end

data/lib/kb/fake/api.rb

@@ -44,6 +44,16 @@ module KB
       include BoundedContext::PetFamily::PetContracts
       include BoundedContext::PetFamily::Products
 
+      # Sinatra >= 4.1 ships Rack::Protection::HostAuthorization, which authorizes
+      # on the Host header and, when it infers a development environment, only
+      # permits localhost-style hosts — rejecting requests addressed to the
+      # stubbed KB host with "403 Host not permitted". Permitting specific hosts
+      # on the consumer side is no fix either: with the net_http adapter WebMock
+      # intercepts before Net::HTTP adds the Host header, so the header is absent
+      # and can never match a permitted list. An empty list disables the check;
+      # it guards against DNS rebinding, which cannot apply to an in-process fake.
+      set :host_authorization, permitted_hosts: []
+
       set :state, ApiState.new
 
       def self.snapshot

data/lib/kb/version.rb

@@ -1,3 +1,3 @@
 module KB
-  VERSION = '0.32.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barkibu-kb
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Léo Figea
@@ -220,19 +220,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday-http
+  name: faraday-net_http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +271,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/pull_request_template.md"
+- ".github/workflows/ci.yml"
 - ".github/workflows/release.yaml"
 - ".gitignore"
 - ".rspec"