terminal-shop 1.8.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 606d2ca50e2cc108dcbc274b0cc1ce406225f2b58b99c38ab143a3123bbd8108
-  data.tar.gz: e6905a7f6cc83c547df50855ce3fe79ffbf372c4ce7c038e960e0751e5c9df26
+  metadata.gz: fc09a5779386790999a7439865ea22d8e82c09d0048c9116ff0d55a74f9f14ca
+  data.tar.gz: 15901e6cbfb87f75a4e4c662b22c8de824518353b81529bc6dc14b65b3d84325
 SHA512:
-  metadata.gz: 260c58e58cbe1f73ed1aef212cca96d125c740e5ab40b1152f3d1ba5798404ba1093b5f46b1412d3a05a5ea34d7bdd41fa39d72940495380c2232ef1b3af3e5f
-  data.tar.gz: 2a7887b08b9703fd060d71a70a41be8fcf3408d83da436d68a1e0e1910a75e8041e80f5aaed27f00e00472691cb4908309b80d438fb4993ebd47de5cd6c6a07d
+  metadata.gz: 15e48a9e13e6a2ff9afe005aa2663e2c3fd19b2f35490277d2eb4e2578bcc3eb8a26e0693efdc32f03700f485adfaa43bd4c52f87ee11dc3ae4b900fb1940d69
+  data.tar.gz: 4842e7a98db1fe06a240c121366ad656064e9bca721ffee7c56ecaf12882913aafb9e3785f9078d2b11912f9b5ed59c4479bdc69b9b8a7adb86eaf2acd180ce2

data/README.md

@@ -12,10 +12,10 @@ The underlying REST API documentation can be found on [terminal.shop](https://te
 
 ## Installation
 
-To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
 ```ruby
-gem "terminal-shop", git: "https://github.com/terminaldotshop/terminal-sdk-ruby", branch: "main"
+gem "terminal-shop", "~> 2.0.0"
 ```
 
 To fetch an initial copy of the gem:
@@ -24,12 +24,6 @@ To fetch an initial copy of the gem:
 bundle install
 ```
 
-To update the version used by your application when updates are pushed to GitHub:
-
-```sh
-bundle update terminal-shop
-```
-
 ## Usage
 
 ```ruby
@@ -112,6 +106,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 +122,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/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  class Client < TerminalShop::BaseClient
+  class Client < TerminalShop::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -16,6 +16,7 @@ module TerminalShop
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # rubocop:disable Style/MutableConstant
+    # @type [Hash{Symbol=>String}]
     ENVIRONMENTS = {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"}
     # rubocop:enable Style/MutableConstant
 

data/lib/terminal-shop/models/address_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute city

data/lib/terminal-shop/models/address_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/address_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/address_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/app_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute name

data/lib/terminal-shop/models/app_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/app_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/app_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_collect_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardCollectParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute token

data/lib/terminal-shop/models/card_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_clear_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartClearParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_convert_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartConvertParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_set_address_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartSetAddressParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute address_id

data/lib/terminal-shop/models/cart_set_card_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartSetCardParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute card_id

data/lib/terminal-shop/models/cart_set_item_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartSetItemParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute product_variant_id

data/lib/terminal-shop/models/email_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class EmailCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute email

data/lib/terminal-shop/models/order_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class OrderCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute address_id

data/lib/terminal-shop/models/order_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class OrderGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/order_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class OrderListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/product.rb

@@ -72,14 +72,18 @@ module TerminalShop
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
-      # @abstract
-      #
       # Whether the product must be or can be subscribed to.
-      class Subscription < TerminalShop::Enum
+      module Subscription
+        extend TerminalShop::Enum
+
         ALLOWED = :allowed
         REQUIRED = :required
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
 
       class Tags < TerminalShop::BaseModel

data/lib/terminal-shop/models/product_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProductGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/product_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProductListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/profile_me_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProfileMeParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/profile_update_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProfileUpdateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute email

data/lib/terminal-shop/models/region.rb

@@ -2,14 +2,18 @@
 
 module TerminalShop
   module Models
-    # @abstract
-    #
     # A Terminal shop user's region.
-    class Region < TerminalShop::Enum
+    module Region
+      extend TerminalShop::Enum
+
       EU = :eu
       NA = :na
 
       finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   def self.values; end
     end
   end
 end

data/lib/terminal-shop/models/subscription.rb

@@ -68,10 +68,10 @@ module TerminalShop
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
-      # @abstract
-      #
       # Schedule of the subscription.
-      class Schedule < TerminalShop::Union
+      module Schedule
+        extend TerminalShop::Union
+
         variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Fixed }
 
         variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Weekly }
@@ -111,10 +111,8 @@ module TerminalShop
         end
 
         # @!parse
-        #   class << self
-        #     # @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
-        #     def variants; end
-        #   end
+        #   # @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
+        #   def self.variants; end
       end
     end
   end

data/lib/terminal-shop/models/subscription_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionCreateParams < TerminalShop::Models::SubscriptionAPI
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/subscription_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/subscription_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/subscription_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/view_init_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ViewInitParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/request_options.rb

@@ -1,39 +1,6 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  # @api private
-  module RequestParameters
-    # @!parse
-    #   # Options to specify HTTP behaviour for this request.
-    #   # @return [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
-    #   attr_accessor :request_options
-
-    # @param mod [Module]
-    def self.included(mod)
-      return unless mod <= TerminalShop::BaseModel
-
-      mod.extend(TerminalShop::RequestParameters::Converter)
-      mod.optional(:request_options, TerminalShop::RequestOptions)
-    end
-
-    # @api private
-    module Converter
-      # @api private
-      #
-      # @param params [Object]
-      #
-      # @return [Array(Object, Hash{Symbol=>Object})]
-      def dump_request(params)
-        case (dumped = dump(params))
-        in Hash
-          [dumped.except(:request_options), dumped[:request_options]]
-        else
-          [dumped, nil]
-        end
-      end
-    end
-  end
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   #   or override those provided at the client level.
   #
@@ -83,7 +50,7 @@ module TerminalShop
     #   Extra data to send with the request. These are deep merged into any data
     #     generated as part of the normal request.
     #
-    #   @return [Hash{Symbol=>Object}, nil]
+    #   @return [Object, nil]
     optional :extra_body, TerminalShop::HashOf[TerminalShop::Unknown]
 
     # @!attribute max_retries