terminal-shop 2.1.2 → 3.5.0

data/README.md

@@ -1,53 +1,61 @@
 # Terminal Ruby API library
 
-The Terminal Ruby library provides convenient access to the Terminal REST API from any Ruby 3.0.0+ application.
+The Terminal Ruby library provides convenient access to the Terminal REST API from any Ruby 3.1.0+ application.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/terminal-shop).
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/terminal-shop).
 
-The underlying REST API documentation can be found on [terminal.shop](https://terminal.shop/docs).
+The REST API documentation can be found on [terminal.shop](https://terminal.shop/docs).
 
 ## Installation
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
+<!-- x-release-please-start-version -->
+
 ```ruby
-gem "terminal-shop", "~> 2.1.1"
+gem "terminal-shop", "~> 3.5.0"
 ```
 
-To fetch an initial copy of the gem:
-
-```sh
-bundle install
-```
+<!-- x-release-please-end -->
 
 ## Usage
 
 ```ruby
 require "bundler/setup"
-require "terminal-shop"
+require "terminal_shop"
 
 terminal = TerminalShop::Client.new(
   bearer_token: "My Bearer Token", # defaults to ENV["TERMINAL_BEARER_TOKEN"]
   environment: "dev" # defaults to "production"
 )
 
-product = terminal.product.list
+products = terminal.product.list
+
+puts(products.data)
+```
+
+## Sorbet
+
+This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
 
-puts(product.data)
+When using sorbet, it is recommended to use model classes as below. This provides stronger type checking and tooling integration.
+
+```ruby
+terminal.product.list
 ```
 
 ### Errors
 
-When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `TerminalShop::Error` will be thrown:
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `TerminalShop::Errors::APIError` will be thrown:
 
 ```ruby
 begin
   product = terminal.product.list
-rescue TerminalShop::Error => e
+rescue TerminalShop::Errors::APIError => e
   puts(e.status) # 400
 end
 ```
@@ -63,7 +71,7 @@ Error codes are as followed:
 | HTTP 409         | `ConflictError`            |
 | HTTP 422         | `UnprocessableEntityError` |
 | HTTP 429         | `RateLimitError`           |
-| HTTP >=500       | `InternalServerError`      |
+| HTTP >= 500      | `InternalServerError`      |
 | Other HTTP error | `APIStatusError`           |
 | Timeout          | `APITimeoutError`          |
 | Network error    | `APIConnectionError`       |
@@ -104,27 +112,51 @@ terminal = TerminalShop::Client.new(
 terminal.product.list(request_options: {timeout: 5})
 ```
 
-## Sorbet Support
+## Model DSL
 
-**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 uses a simple DSL to represent request parameters and response shapes in `lib/terminal_shop/models`.
 
-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.
-
-Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `TerminalShop::BaseModel` class, you will need to use the `**` splat operator to pass the arguments:
+With the right [editor plugins](https://shopify.github.io/ruby-lsp), you can ctrl-click on elements of the DSL to navigate around and explore the library.
 
-Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
+In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can also be used. For example, the following are interchangeable as arguments:
 
 ```ruby
-model = TerminalShop::Models::ProductListParams.new
+# This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
+params = TerminalShop::Models::ProductListParams.new
 
-terminal.product.list(**model)
+# This also works
+params = {
+
+}
 ```
 
-## Advanced
+## Editor support
+
+A combination of [Shopify LSP](https://shopify.github.io/ruby-lsp) and [Solargraph](https://solargraph.org/) is recommended for non-[Sorbet](https://sorbet.org) users. The former is especially good at go to definition, while the latter has much better auto-completion support.
+
+## Advanced concepts
+
+### Making custom/undocumented requests
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above.
+
+#### Undocumented endpoints
 
-### Concurrency & Connection Pooling
+To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"he": "llo"},
+)
+```
+
+### 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.
 
@@ -134,6 +166,30 @@ Unless otherwise specified, other classes in the SDK do not have locks protectin
 
 Currently, `TerminalShop::Client` instances are only fork-safe if there are no in-flight HTTP requests.
 
+### Sorbet
+
+#### Enums
+
+Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbet.org/docs/tenum) from the `sorbet-runtime` gem.
+
+Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
+
+```ruby
+module TerminalShop::Models::Region
+  # This alias aids language service driven navigation.
+  TaggedSymbol = T.type_alias { T.all(Symbol, TerminalShop::Models::Region) }
+end
+```
+
+#### Argument passing trick
+
+It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator.
+
+```ruby
+params = TerminalShop::Models::ProductListParams.new
+terminal.product.list(**params)
+```
+
 ## 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.
@@ -142,4 +198,8 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.0.0 or higher.
+Ruby 3.1.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/terminaldotshop/terminal-sdk-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Terminal please follow the respective company's security reporting guidelines.
+
+### Terminal Terms and Policies
+
+Please contact dev@terminal.com for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/{terminal-shop → terminal_shop}/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  class Client < TerminalShop::Transport::BaseClient
+  class Client < TerminalShop::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -70,18 +70,19 @@ module TerminalShop
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param environment [:production, :dev, nil] Specifies the environment to use for the API.
+    # @param bearer_token [String, nil] Defaults to `ENV["TERMINAL_BEARER_TOKEN"]`
     #
-    #   Each environment maps to a different base URL:
+    # @param app_id [String, nil]
     #
-    #   - `production` corresponds to `https://api.terminal.shop`
-    #   - `dev` corresponds to `https://api.dev.terminal.shop`
+    # @param environment [:production, :dev, nil] Specifies the environment to use for the API.
     #
-    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    # Each environment maps to a different base URL:
     #
-    # @param bearer_token [String, nil] Defaults to `ENV["TERMINAL_BEARER_TOKEN"]`
+    # - `production` corresponds to `https://api.terminal.shop`
+    # - `dev` corresponds to `https://api.dev.terminal.shop`
     #
-    # @param app_id [String, nil]
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["TERMINAL_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -91,28 +92,22 @@ module TerminalShop
     #
     # @param max_retry_delay [Float]
     def initialize(
-      environment: nil,
-      base_url: nil,
       bearer_token: ENV["TERMINAL_BEARER_TOKEN"],
       app_id: nil,
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+      environment: nil,
+      base_url: ENV["TERMINAL_BASE_URL"],
+      max_retries: TerminalShop::Client::DEFAULT_MAX_RETRIES,
+      timeout: TerminalShop::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: TerminalShop::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: TerminalShop::Client::DEFAULT_MAX_RETRY_DELAY
     )
-      case [environment, base_url]
-      in [Symbol | String, String]
-        raise ArgumentError.new("both environment and base_url given, expected only one")
-      in [Symbol | String, nil]
-        base_url = ENVIRONMENTS.fetch(environment.to_sym) do
-          raise ArgumentError.new("environment must be one of #{ENVIRONMENTS.keys}, got #{environment}")
-        end
-      else
-        base_url ||= ENVIRONMENTS.fetch(:production)
+      base_url ||= TerminalShop::Client::ENVIRONMENTS.fetch(environment&.to_sym || :production) do
+        message = "environment must be one of #{TerminalShop::Client::ENVIRONMENTS.keys}, got #{environment}"
+        raise ArgumentError.new(message)
       end
 
       if bearer_token.nil?
-        raise ArgumentError.new("bearer_token is required")
+        raise ArgumentError.new("bearer_token is required, and can be set via environ: \"TERMINAL_BEARER_TOKEN\"")
       end
 
       headers = {

data/lib/terminal_shop/errors.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Errors
+    class Error < StandardError
+      # @!parse
+      #   # @return [StandardError, nil]
+      #   attr_accessor :cause
+    end
+
+    class ConversionError < TerminalShop::Errors::Error
+    end
+
+    class APIError < TerminalShop::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < TerminalShop::Errors::APIError
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :status
+
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < TerminalShop::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < TerminalShop::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [TerminalShop::Errors::APIStatusError]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          TerminalShop::Errors::BadRequestError.new(**kwargs)
+        in 401
+          TerminalShop::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          TerminalShop::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          TerminalShop::Errors::NotFoundError.new(**kwargs)
+        in 409
+          TerminalShop::Errors::ConflictError.new(**kwargs)
+        in 422
+          TerminalShop::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          TerminalShop::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          TerminalShop::Errors::InternalServerError.new(**kwargs)
+        else
+          TerminalShop::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/terminal_shop/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : File.basename(filename)
+        else
+          filename.nil? ? nil : File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end