terminal-shop 0.1.0.pre.alpha.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e704b8a4a9cafad6a1d79786d5776fc7fe4d414891dc728dc2846fa97ad92d6b
+  data.tar.gz: ba8a7dd2383e49209caff17134baa50d22651eac0f85fb14be7f902f067209bd
+SHA512:
+  metadata.gz: 1d15f11e333baa688f83beaf05a9128a47e24b0de5101cee4a18e4a276ec1a5cfd4c3cec242bdc4f0dd2be498af2fd5c64e27ea8a04df139698f76c3d2692b72
+  data.tar.gz: db877d28fa6cae93e9c80accaa44b16bda8fe1698c716dff9d9a83229f1a8ef1880e5ef78f35ee577450f1b2e0518f3f022e6dbaa2a6d82afb9d91ed8580703d

data/README.md

@@ -0,0 +1,127 @@
+# Terminal Ruby API library
+
+The Terminal Ruby library provides convenient access to the Terminal REST API from any Ruby 3.0+
+application.
+
+It is generated with [Stainless](https://www.stainlessapi.com/).
+
+## Documentation
+
+Documentation for the most recent release of this gem can be found [on RubyDoc](https://gemdocs.org/gems/terminal-shop/latest).
+
+The underlying REST API documentation can be found on [terminal.shop](https://terminal.shop/docs).
+
+## Installation
+
+To use this gem during the beta, install directly from GitHub with Bundler by
+adding the following to your application's `Gemfile`:
+
+```ruby
+gem "terminal-shop", git: "https://github.com/terminaldotshop/terminal-sdk-ruby", branch: "main"
+```
+
+To fetch an initial copy of the gem:
+
+```sh
+bundle install
+```
+
+To update the version used by your application when updates are pushed to
+GitHub:
+
+```sh
+bundle update terminal-shop
+```
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "terminal-shop"
+
+terminal = TerminalShop::Client.new(
+  bearer_token: "My Bearer Token", # defaults to ENV["TERMINAL_BEARER_TOKEN"]
+  environment: "sandbox" # defaults to "production"
+)
+
+product = terminal.product.list
+
+puts(product.data)
+```
+
+### 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:
+
+```ruby
+begin
+  product = terminal.product.list
+rescue TerminalShop::Error => e
+  puts(e.status) # 400
+end
+```
+
+Error codes are as followed:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >=500       | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short
+exponential backoff. Connection errors (for example, due to a network
+connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors,
+and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+terminal = TerminalShop::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+terminal.product.list(request_options: {max_retries: 5})
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds.
+Timeouts are applied separately to the initial connection and the overall request time,
+so in some cases a request could wait 2\*timeout seconds before it fails.
+
+You can use the `timeout` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+terminal = TerminalShop::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+terminal.product.list(request_options: {timeout: 5})
+```
+
+## 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.
+
+## Requirements
+
+Ruby 3.0 or higher.

data/lib/terminal-shop/base_client.rb

@@ -0,0 +1,452 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  # @private
+  #
+  # @abstract
+  #
+  class BaseClient
+    # from whatwg fetch spec
+    MAX_REDIRECTS = 20
+
+    # @private
+    #
+    # @param req [Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    #
+    def self.validate!(req)
+      keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :model, :options]
+      case req
+      in Hash
+        req.each_key do |k|
+          unless keys.include?(k)
+            raise ArgumentError.new("Request `req` keys must be one of #{keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `req` must be a Hash or RequestOptions, got #{req.inspect}")
+      end
+    end
+
+    # @private
+    #
+    # @return [TerminalShop::PooledNetRequester]
+    attr_accessor :requester
+
+    # @private
+    #
+    # @param base_url [String]
+    # @param timeout [Float]
+    # @param max_retries [Integer]
+    # @param initial_retry_delay [Float]
+    # @param max_retry_delay [Float]
+    # @param headers [Hash{String=>String, nil}]
+    # @param idempotency_header [String, nil]
+    #
+    def initialize(
+      base_url:,
+      timeout: 0.0,
+      max_retries: 0,
+      initial_retry_delay: 0.0,
+      max_retry_delay: 0.0,
+      headers: {},
+      idempotency_header: nil
+    )
+      @requester = TerminalShop::PooledNetRequester.new
+      @headers = TerminalShop::Util.normalized_headers(
+        {
+          "X-Stainless-Lang" => "ruby",
+          "X-Stainless-Package-Version" => TerminalShop::VERSION,
+          "X-Stainless-Runtime" => RUBY_ENGINE,
+          "X-Stainless-Runtime-Version" => RUBY_ENGINE_VERSION,
+          "Content-Type" => "application/json",
+          "Accept" => "application/json"
+        },
+        headers
+      )
+      @base_url = TerminalShop::Util.parse_uri(base_url)
+      @idempotency_header = idempotency_header&.to_s&.downcase
+      @max_retries = max_retries
+      @timeout = timeout
+      @initial_retry_delay = initial_retry_delay
+      @max_retry_delay = max_retry_delay
+    end
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def auth_headers = {}
+
+    # @private
+    #
+    # @return [String]
+    #
+    private def generate_idempotency_key = "stainless-ruby-retry-#{SecureRandom.uuid}"
+
+    # @private
+    #
+    # @param req [Hash{Symbol=>Object}] .
+    #
+    #   @option req [Symbol] :method
+    #
+    #   @option req [String, Array<String>] :path
+    #
+    #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
+    #
+    #   @option req [Hash{String=>String, nil}, nil] :headers
+    #
+    #   @option req [Object, nil] :body
+    #
+    #   @option req [Symbol, nil] :unwrap
+    #
+    #   @option req [Class, nil] :page
+    #
+    #   @option req [TerminalShop::Converter, Class, nil] :model
+    #
+    # @param opts [Hash{Symbol=>Object}] .
+    #
+    #   @option opts [String, nil] :idempotency_key
+    #
+    #   @option opts [Hash{String=>Array<String>, String, nil}, nil] :extra_query
+    #
+    #   @option opts [Hash{String=>String, nil}, nil] :extra_headers
+    #
+    #   @option opts [Hash{Symbol=>Object}, nil] :extra_body
+    #
+    #   @option opts [Integer, nil] :max_retries
+    #
+    #   @option opts [Float, nil] :timeout
+    #
+    # @return [Hash{Symbol=>Object}]
+    #
+    private def build_request(req, opts)
+      method, uninterpolated_path = req.fetch_values(:method, :path)
+
+      path = TerminalShop::Util.interpolate_path(uninterpolated_path)
+
+      headers = TerminalShop::Util.normalized_headers(
+        @headers,
+        auth_headers,
+        *[req[:headers], opts[:extra_headers]].compact
+      )
+
+      if @idempotency_header &&
+         !headers.key?(@idempotency_header) &&
+         !Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase)
+        headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key }
+      end
+
+      unless headers.key?("x-stainless-retry-count")
+        headers["x-stainless-retry-count"] = "0"
+      end
+
+      timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
+      unless headers.key?("x-stainless-read-timeout") || timeout.zero?
+        headers["x-stainless-read-timeout"] = timeout.to_s
+      end
+
+      headers.reject! { |_, v| v.to_s.empty? }
+
+      body =
+        case method
+        in :get | :head | :options | :trace
+          nil
+        else
+          TerminalShop::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
+        end
+
+      url = TerminalShop::Util.join_parsed_uri(@base_url, {**req, path: path})
+      headers, encoded = TerminalShop::Util.encode_content(headers, body)
+      max_retries = opts.fetch(:max_retries, @max_retries)
+      {method: method, url: url, headers: headers, body: encoded, max_retries: max_retries, timeout: timeout}
+    end
+
+    # @private
+    #
+    # @param status [Integer]
+    # @param headers [Hash{String=>String}]
+    #
+    # @return [Boolean]
+    #
+    private def should_retry?(status, headers:)
+      coerced = TerminalShop::Util.coerce_boolean(headers["x-should-retry"])
+      case [coerced, status]
+      in [true | false, _]
+        coerced
+      in [_, 408 | 409 | 429 | (500..)]
+        # retry on:
+        # 408: timeouts
+        # 409: locks
+        # 429: rate limits
+        # 500+: unknown errors
+        true
+      else
+        false
+      end
+    end
+
+    # @private
+    #
+    # @param headers [Hash{String=>String}]
+    # @param retry_count [Integer]
+    #
+    # @return [Float]
+    #
+    private def retry_delay(headers, retry_count:)
+      # Non-standard extension
+      span = Float(headers["retry-after-ms"], exception: false)&.then { _1 / 1000 }
+      return span if span
+
+      retry_header = headers["retry-after"]
+      return span if (span = Float(retry_header, exception: false))
+
+      span = retry_header && TerminalShop::Util.suppress(ArgumentError) do
+        Time.httpdate(retry_header) - Time.now
+      end
+      return span if span
+
+      scale = retry_count**2
+      jitter = 1 - (0.25 * rand)
+      (@initial_retry_delay * scale * jitter).clamp(0, @max_retry_delay)
+    end
+
+    # @private
+    #
+    # @param request [Hash{Symbol=>Object}] .
+    #
+    #   @option request [Symbol] :method
+    #
+    #   @option request [URI::Generic] :url
+    #
+    #   @option request [Hash{String=>String}] :headers
+    #
+    #   @option request [Object] :body
+    #
+    #   @option request [Integer] :max_retries
+    #
+    #   @option request [Float] :timeout
+    #
+    # @param status [Integer]
+    #
+    # @param location_header [String]
+    #
+    # @return [Hash{Symbol=>Object}]
+    #
+    private def follow_redirect(request, status:, location_header:)
+      method, url, headers = request.fetch_values(:method, :url, :headers)
+      location =
+        TerminalShop::Util.suppress(ArgumentError) do
+          URI.join(url, location_header)
+        end
+
+      unless location
+        message = "Server responded with status #{status} but no valid location header."
+        raise TerminalShop::APIConnectionError.new(url: url, message: message)
+      end
+
+      request = {**request, url: location}
+
+      case [url.scheme, location.scheme]
+      in ["https", "http"]
+        message = "Tried to redirect to a insecure URL"
+        raise TerminalShop::APIConnectionError.new(url: url, message: message)
+      else
+        nil
+      end
+
+      # from whatwg fetch spec
+      case [status, method]
+      in [301 | 302, :post] | [303, _]
+        drop = %w[content-encoding content-language content-length content-location content-type]
+        request = {
+          **request,
+          method: method == :head ? :head : :get,
+          headers: headers.except(*drop),
+          body: nil
+        }
+      else
+      end
+
+      # from undici
+      if TerminalShop::Util.uri_origin(url) != TerminalShop::Util.uri_origin(location)
+        drop = %w[authorization cookie host proxy-authorization]
+        request = {**request, headers: request.fetch(:headers).except(*drop)}
+      end
+
+      request
+    end
+
+    # @private
+    #
+    # @param request [Hash{Symbol=>Object}] .
+    #
+    #   @option request [Symbol] :method
+    #
+    #   @option request [URI::Generic] :url
+    #
+    #   @option request [Hash{String=>String}] :headers
+    #
+    #   @option request [Object] :body
+    #
+    #   @option request [Integer] :max_retries
+    #
+    #   @option request [Float] :timeout
+    #
+    # @param redirect_count [Integer]
+    #
+    # @param retry_count [Integer]
+    #
+    # @param send_retry_header [Boolean]
+    #
+    # @raise [TerminalShop::APIError]
+    # @return [Net::HTTPResponse]
+    #
+    private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+      url, headers, body, max_retries = request.fetch_values(:url, :headers, :body, :max_retries)
+      no_retry = retry_count >= max_retries || body.is_a?(IO) || body.is_a?(StringIO)
+
+      if send_retry_header
+        headers["x-stainless-retry-count"] = retry_count.to_s
+      end
+
+      begin
+        response = @requester.execute(request)
+        status = Integer(response.code)
+      rescue TerminalShop::APIConnectionError => e
+        status = e
+      end
+
+      case status
+      in ..299
+        response
+      in 300..399 if redirect_count >= MAX_REDIRECTS
+        message = "Failed to complete the request within #{MAX_REDIRECTS} redirects."
+        raise TerminalShop::APIConnectionError.new(url: url, message: message)
+      in 300..399
+        request = follow_redirect(request, status: status, location_header: response["location"])
+        send_request(
+          request,
+          redirect_count: redirect_count + 1,
+          retry_count: retry_count,
+          send_retry_header: send_retry_header
+        )
+      in TerminalShop::APIConnectionError if retry_count >= max_retries
+        raise status
+      in (400..) if no_retry || (response && !should_retry?(status, headers: response))
+        body = TerminalShop::Util.decode_content(response, suppress_error: true)
+
+        raise TerminalShop::APIStatusError.for(
+          url: url,
+          status: status,
+          body: body,
+          request: nil,
+          response: response
+        )
+      in (400..) | TerminalShop::APIConnectionError
+        delay = retry_delay(response, retry_count: retry_count)
+        sleep(delay)
+
+        send_request(
+          request,
+          redirect_count: redirect_count,
+          retry_count: retry_count + 1,
+          send_retry_header: send_retry_header
+        )
+      end
+    end
+
+    # @private
+    #
+    # @param req [Hash{Symbol=>Object}] .
+    #
+    #   @option req [Symbol] :method
+    #
+    #   @option req [String, Array<String>] :path
+    #
+    #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
+    #
+    #   @option req [Hash{String=>String, nil}, nil] :headers
+    #
+    #   @option req [Object, nil] :body
+    #
+    #   @option req [Symbol, nil] :unwrap
+    #
+    #   @option req [Class, nil] :page
+    #
+    #   @option req [TerminalShop::Converter, Class, nil] :model
+    #
+    #   @option req [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :options
+    #
+    # @param response [nil]
+    #
+    # @return [Object]
+    #
+    private def parse_response(req, response)
+      parsed = TerminalShop::Util.decode_content(response)
+      unwrapped = TerminalShop::Util.dig(parsed, req[:unwrap])
+
+      page = req[:page]
+      model = req.fetch(:model, TerminalShop::Unknown)
+      case [page, model]
+      in [Class, Class | TerminalShop::Converter | nil]
+        page.new(client: self, req: req, headers: response, unwrapped: unwrapped)
+      in [nil, Class | TerminalShop::Converter]
+        TerminalShop::Converter.coerce(model, unwrapped)
+      in [nil, nil]
+        unwrapped
+      end
+    end
+
+    # Execute the request specified by `req`. This is the method that all resource
+    #   methods call into.
+    #
+    # @param req [Hash{Symbol=>Object}] .
+    #
+    #   @option req [Symbol] :method
+    #
+    #   @option req [String, Array<String>] :path
+    #
+    #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
+    #
+    #   @option req [Hash{String=>String, nil}, nil] :headers
+    #
+    #   @option req [Object, nil] :body
+    #
+    #   @option req [Symbol, nil] :unwrap
+    #
+    #   @option req [Class, nil] :page
+    #
+    #   @option req [TerminalShop::Converter, Class, nil] :model
+    #
+    #   @option req [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :options
+    #
+    # @raise [TerminalShop::APIError]
+    # @return [Object]
+    #
+    def request(req)
+      self.class.validate!(req)
+      opts = req[:options].to_h
+      TerminalShop::RequestOptions.validate!(opts)
+      request = build_request(req, opts)
+
+      # Don't send the current retry count in the headers if the caller modified the header defaults.
+      send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0"
+      response = send_request(
+        request,
+        redirect_count: 0,
+        retry_count: 0,
+        send_retry_header: send_retry_header
+      )
+      parse_response(req, response)
+    end
+
+    # @return [String]
+    #
+    def inspect
+      base_url = TerminalShop::Util.unparse_uri(@base_url)
+      "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
+    end
+  end
+end