philiprehberger-http_client 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e63a67f4b54b15483e76030335e46423d1845a22a33d6e72aa07e984455c7f6
-  data.tar.gz: ba12ae4825bfde2e9e8e4e0a968a8bf96faaf368b83c17d87713064b8cbf8243
+  metadata.gz: 87104396621af222e4e5c94c6f7bdaedbfd6ff95ad89d9e147e7980ab33d868f
+  data.tar.gz: 9b814c9ded6a9792d4dd782343e9b622790dc0d6cd86c6979b7e54c300031e02
 SHA512:
-  metadata.gz: 5c184d72bd21f7ba81f5a26ec9a06405c822ee8ff447c8ce842255dc872a06311465c41a9a2f71f539860c26131f30dec10bd9e07e98bb61471b1524367e01a8
-  data.tar.gz: ae802ee7c9d369673bf9c3ea28d8c1230fa3071755b7e82d2b92d7396d9a539e7e19bd623d96596d3bb2b1d1c2416e5ae4737e2b5aa449cc6906179e68e8bff6
+  metadata.gz: 1e8c83eff3473cd63ea842deb56a7660aeb3fcf3139ba4ae22da7f279f45d8e9686a1e4091dea1e583314c1c682d32f4dab9fb0082521841fbd9cb8825a545e3
+  data.tar.gz: 58b943703382d92960828bf002b7e00e48e45ffcc1a27b8dfaae4ece0d8b047181f440272fffac0bb87bbb10dfc1c02d2c07e732d291faadec83b0b200239a31

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [0.9.1] - 2026-04-23
+
+### Changed
+- Added YARD documentation on `Philiprehberger::HttpClient.new` and `Philiprehberger::HttpClient.open` module methods.
+- Completed Keep a Changelog version link references for all released versions.
+
 ## [0.9.0] - 2026-04-20
 
 ### Added
@@ -171,5 +177,27 @@ and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Response wrapper with `ok?` and `json` convenience methods
 - Zero dependencies — built on Ruby stdlib `net/http`
 
-[0.2.0]: https://github.com/philiprehberger/rb-http-client/releases/tag/v0.2.0
+[Unreleased]: https://github.com/philiprehberger/rb-http-client/compare/v0.9.1...HEAD
+[0.9.1]: https://github.com/philiprehberger/rb-http-client/compare/v0.9.0...v0.9.1
+[0.9.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.8.2...v0.9.0
+[0.8.2]: https://github.com/philiprehberger/rb-http-client/compare/v0.8.1...v0.8.2
+[0.8.1]: https://github.com/philiprehberger/rb-http-client/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.6.1...v0.7.0
+[0.6.1]: https://github.com/philiprehberger/rb-http-client/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.7...v0.5.0
+[0.4.7]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.6...v0.4.7
+[0.4.6]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.5...v0.4.6
+[0.4.5]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.4...v0.4.5
+[0.4.4]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.3...v0.4.4
+[0.4.3]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.2...v0.4.3
+[0.4.2]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.1...v0.4.2
+[0.4.1]: https://github.com/philiprehberger/rb-http-client/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.3.3...v0.4.0
+[0.3.3]: https://github.com/philiprehberger/rb-http-client/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/philiprehberger/rb-http-client/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/philiprehberger/rb-http-client/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/philiprehberger/rb-http-client/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/philiprehberger/rb-http-client/releases/tag/v0.1.0

data/lib/philiprehberger/http_client/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module HttpClient
-    VERSION = '0.9.0'
+    VERSION = '0.9.1'
   end
 end

data/lib/philiprehberger/http_client.rb

@@ -15,18 +15,28 @@ require_relative 'http_client/client'
 
 module Philiprehberger
   module HttpClient
-    # Convenience constructor.
+    # Convenience constructor that instantiates a new {Client}.
     #
-    # @param options [Hash] Forwarded to {Client#initialize}
-    # @return [Client]
+    # This is a thin wrapper around {Client.new} so callers can write
+    # `Philiprehberger::HttpClient.new(base_url: '...')` without reaching
+    # into the nested {Client} constant.
+    #
+    # @param options [Hash] Keyword options forwarded to {Client#initialize}
+    #   (e.g. `base_url:`, `headers:`, `timeout:`, `retries:`, `pool:`, `cache:`)
+    # @return [Client] a new configured client instance
     def self.new(**options)
       Client.new(**options)
     end
 
-    # Block form — creates a client, yields it, and ensures cleanup.
+    # Block form constructor — creates a {Client}, yields it, and guarantees
+    # cleanup by calling `#close` in an `ensure` block when the block exits.
+    #
+    # Equivalent to {Client.open}; prefer this form when you want automatic
+    # connection pool draining without manually calling `#close`.
     #
-    # @param options [Hash] Forwarded to {Client#initialize}
-    # @yield [Client]
+    # @param options [Hash] Keyword options forwarded to {Client#initialize}
+    # @yield [client] yields the client instance to the block
+    # @yieldparam client [Client] the newly created client
     # @return [Object] the return value of the block
     def self.open(...)
       Client.open(...)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-http_client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-04-23 00:00:00.000000000 Z
 dependencies: []
 description: A zero-dependency HTTP client built on Ruby's net/http with automatic
   retries, request/response interceptors, and a clean API for JSON services.