barkibu-kb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb3a704f422c511e2e30d584cd6a80a7d91a090cfa5452dd197e65496b52eee
-  data.tar.gz: 05d766aeca3b869601193bd1a6310ced1c07f96d6f24cd5424c290a33b1edaf9
+  metadata.gz: d6665ca6f0d74295cacf6bea9ee921b3dba5decc6b5cb3775bbaa0392fd65b86
+  data.tar.gz: 700cae8005557d25ff41c3f9583725686485eff37ccbb0eec11ff07473ad9077
 SHA512:
-  metadata.gz: 994f4d86e1c2d1aa40a173ed0b77a2fcff39cbfe1e0390c728f92887be3817e3851610f85796c24a61919c05789a718c3939ee965866a1fda2f72ed2e68492b1
-  data.tar.gz: c9de80ede2701f7e58bde7f803b473980383d6ec9ac3d8509f2fe0e74ff15a200e48025ecc2535bc7102b82f1199228806d1e1999de32745ae07123123cb7edd
+  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,10 @@ 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/v1.0.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`).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    barkibu-kb (1.0.0)
+    barkibu-kb (1.1.0)
       activemodel (>= 4.0.2)
       activerecord
       activesupport (>= 3.0.0)
@@ -10,8 +10,8 @@ PATH
       faraday-net_http (~> 1.0)
       faraday_middleware
       i18n
-    barkibu-kb-fake (1.0.0)
-      barkibu-kb (= 1.0.0)
+    barkibu-kb-fake (1.1.0)
+      barkibu-kb (= 1.1.0)
       countries
       sinatra
       webmock

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.
@@ -57,6 +66,14 @@ 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
 
 #### Pet Parent 🧍🏾

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
 
@@ -86,6 +90,12 @@ module KB
       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,

data/lib/kb/version.rb

@@ -1,3 +1,3 @@
 module KB
-  VERSION = '1.0.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: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Léo Figea
@@ -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"