terminal-shop 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 606d2ca50e2cc108dcbc274b0cc1ce406225f2b58b99c38ab143a3123bbd8108
-  data.tar.gz: e6905a7f6cc83c547df50855ce3fe79ffbf372c4ce7c038e960e0751e5c9df26
+  metadata.gz: bd8072a075bff0dc001f6aaabb37415cada6dfc11b82cb2362fd78400ef2fd69
+  data.tar.gz: 69a0df094ac931a412378137fe036c50b11d36ae628fe526e7392c985ef79466
 SHA512:
-  metadata.gz: 260c58e58cbe1f73ed1aef212cca96d125c740e5ab40b1152f3d1ba5798404ba1093b5f46b1412d3a05a5ea34d7bdd41fa39d72940495380c2232ef1b3af3e5f
-  data.tar.gz: 2a7887b08b9703fd060d71a70a41be8fcf3408d83da436d68a1e0e1910a75e8041e80f5aaed27f00e00472691cb4908309b80d438fb4993ebd47de5cd6c6a07d
+  metadata.gz: b29c0d30aa9ec41963e5aa21d24e2821741868cb591fbec9fd1e015eef059ec06ae2adda746de1c2584b2b20e8babd6382058d85ae89e6948e4998b484c0042a
+  data.tar.gz: cb9eb1e052ec4b94b46523bc698b689fc425fd6ff66b036337138bdfa59108acddcf59ce088876db204eb61284e81643a825ddf43f0d74835c28f52000aef7f9

data/README.md

@@ -112,6 +112,8 @@ terminal.product.list(request_options: {timeout: 5})
 
 ## Sorbet Support
 
+**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+
 This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
 
 What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself.
@@ -126,6 +128,18 @@ model = ProductListParams.new
 terminal.product.list(**model)
 ```
 
+## Advanced
+
+### Concurrency & Connection Pooling
+
+The `TerminalShop::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count.
+
+When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+Currently, `TerminalShop::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+
 ## Versioning
 
 This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.

data/lib/terminal-shop/base_client.rb

@@ -9,14 +9,15 @@ module TerminalShop
     MAX_REDIRECTS = 20
 
     # rubocop:disable Style/MutableConstant
-    PLATFORM_HEADERS = {
-      "x-stainless-arch" => TerminalShop::Util.arch,
-      "x-stainless-lang" => "ruby",
-      "x-stainless-os" => TerminalShop::Util.os,
-      "x-stainless-package-version" => TerminalShop::VERSION,
-      "x-stainless-runtime" => ::RUBY_ENGINE,
-      "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
-    }
+    PLATFORM_HEADERS =
+      {
+        "x-stainless-arch" => TerminalShop::Util.arch,
+        "x-stainless-lang" => "ruby",
+        "x-stainless-os" => TerminalShop::Util.os,
+        "x-stainless-package-version" => TerminalShop::VERSION,
+        "x-stainless-runtime" => ::RUBY_ENGINE,
+        "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
+      }
     # rubocop:enable Style/MutableConstant
 
     class << self
@@ -219,7 +220,7 @@ module TerminalShop
     #
     #   @option opts [Hash{String=>String, nil}, nil] :extra_headers
     #
-    #   @option opts [Hash{Symbol=>Object}, nil] :extra_body
+    #   @option opts [Object, nil] :extra_body
     #
     #   @option opts [Integer, nil] :max_retries
     #
@@ -436,7 +437,7 @@ module TerminalShop
       decoded = TerminalShop::Util.decode_content(response, stream: stream)
       case req
       in { stream: Class => st }
-        st.new(model: model, url: url, status: status, response: response, messages: decoded)
+        st.new(model: model, url: url, status: status, response: response, stream: decoded)
       in { page: Class => page }
         page.new(client: self, req: req, headers: response, page_data: decoded)
       else