terminal-shop 0.1.0.pre.alpha.5

data/lib/terminal-shop/base_page.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  # @private
+  #
+  # @abstract
+  #
+  module BasePage
+    # rubocop:disable Lint/UnusedMethodArgument
+
+    # @return [Boolean]
+    #
+    def next_page? = (raise NotImplementedError)
+
+    # @raise [TerminalShop::APIError]
+    # @return [TerminalShop::BasePage]
+    #
+    def next_page = (raise NotImplementedError)
+
+    # @param blk [Proc]
+    #
+    # @return [void]
+    #
+    def auto_paging_each(&blk) = (raise NotImplementedError)
+
+    # @return [Enumerable]
+    #
+    def to_enum = super(:auto_paging_each)
+
+    alias_method :enum_for, :to_enum
+
+    # @!parse
+    #   # @private
+    #   #
+    #   # @param client [TerminalShop::BaseClient]
+    #   # @param req [Hash{Symbol=>Object}]
+    #   # @param headers [Hash{String=>String}]
+    #   # @param unwrapped [Object]
+    #   #
+    #   def initialize(client:, req:, headers:, unwrapped:); end
+
+    # rubocop:enable Lint/UnusedMethodArgument
+  end
+end

data/lib/terminal-shop/client.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  class Client < TerminalShop::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # rubocop:disable Style/MutableConstant
+    ENVIRONMENTS = {production: "https://api.terminal.shop/", sandbox: "https://sandbox.terminal.shop/"}
+    # rubocop:enable Style/MutableConstant
+
+    # Client option
+    # @return [String]
+    attr_reader :bearer_token
+
+    # @return [TerminalShop::Resources::Product]
+    attr_reader :product
+
+    # @return [TerminalShop::Resources::Profile]
+    attr_reader :profile
+
+    # @return [TerminalShop::Resources::Address]
+    attr_reader :address
+
+    # @return [TerminalShop::Resources::Card]
+    attr_reader :card
+
+    # @return [TerminalShop::Resources::Cart]
+    attr_reader :cart
+
+    # @return [TerminalShop::Resources::Order]
+    attr_reader :order
+
+    # @return [TerminalShop::Resources::Subscription]
+    attr_reader :subscription
+
+    # @return [TerminalShop::Resources::Token]
+    attr_reader :token
+
+    # @return [TerminalShop::Resources::App]
+    attr_reader :app
+
+    # @return [TerminalShop::Resources::Email]
+    attr_reader :email
+
+    # @return [TerminalShop::Resources::View]
+    attr_reader :view
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def auth_headers
+      {"Authorization" => "Bearer #{@bearer_token}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
+    #
+    #   Each environment maps to a different base URL:
+    #
+    #   - `production` corresponds to `https://api.terminal.shop/`
+    #   - `sandbox` corresponds to `https://sandbox.terminal.shop/`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param bearer_token [String, nil] Defaults to `ENV["TERMINAL_BEARER_TOKEN"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    #
+    def initialize(
+      environment: nil,
+      base_url: nil,
+      bearer_token: ENV["TERMINAL_BEARER_TOKEN"],
+      max_retries: DEFAULT_MAX_RETRIES,
+      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: 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)
+      end
+
+      if bearer_token.nil?
+        raise ArgumentError.new("bearer_token is required")
+      end
+
+      @bearer_token = bearer_token.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @product = TerminalShop::Resources::Product.new(client: self)
+      @profile = TerminalShop::Resources::Profile.new(client: self)
+      @address = TerminalShop::Resources::Address.new(client: self)
+      @card = TerminalShop::Resources::Card.new(client: self)
+      @cart = TerminalShop::Resources::Cart.new(client: self)
+      @order = TerminalShop::Resources::Order.new(client: self)
+      @subscription = TerminalShop::Resources::Subscription.new(client: self)
+      @token = TerminalShop::Resources::Token.new(client: self)
+      @app = TerminalShop::Resources::App.new(client: self)
+      @email = TerminalShop::Resources::Email.new(client: self)
+      @view = TerminalShop::Resources::View.new(client: self)
+    end
+  end
+end

data/lib/terminal-shop/errors.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  class Error < StandardError
+    # @!parse
+    #   # @return [StandardError, nil]
+    #   attr_reader :cause
+  end
+
+  class ConversionError < TerminalShop::Error
+  end
+
+  class APIError < TerminalShop::Error
+    # @return [URI::Generic]
+    attr_reader :url
+
+    # @return [Integer, nil]
+    attr_reader :status
+
+    # @return [Object, nil]
+    attr_reader :body
+
+    # @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::APIError
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :status
+
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :body
+
+    # @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::APIConnectionError
+    # @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::APIError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @param request [nil]
+    # @param response [nil]
+    #
+    # @return [TerminalShop::APIStatusError]
+    #
+    def self.for(url:, status:, body:, request:, response:)
+      kwargs = {url: url, status: status, body: body, request: request, response: response}
+
+      case status
+      in 400
+        TerminalShop::BadRequestError.new(**kwargs)
+      in 401
+        TerminalShop::AuthenticationError.new(**kwargs)
+      in 403
+        TerminalShop::PermissionDeniedError.new(**kwargs)
+      in 404
+        TerminalShop::NotFoundError.new(**kwargs)
+      in 409
+        TerminalShop::ConflictError.new(**kwargs)
+      in 422
+        TerminalShop::UnprocessableEntityError.new(**kwargs)
+      in 429
+        TerminalShop::RateLimitError.new(**kwargs)
+      in (500..)
+        TerminalShop::InternalServerError.new(**kwargs)
+      else
+        TerminalShop::APIStatusError.new(**kwargs)
+      end
+    end
+
+    # @!parse
+    #   # @return [Integer]
+    #   attr_reader :status
+
+    # @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::APIStatusError
+    HTTP_STATUS = 400
+  end
+
+  class AuthenticationError < TerminalShop::APIStatusError
+    HTTP_STATUS = 401
+  end
+
+  class PermissionDeniedError < TerminalShop::APIStatusError
+    HTTP_STATUS = 403
+  end
+
+  class NotFoundError < TerminalShop::APIStatusError
+    HTTP_STATUS = 404
+  end
+
+  class ConflictError < TerminalShop::APIStatusError
+    HTTP_STATUS = 409
+  end
+
+  class UnprocessableEntityError < TerminalShop::APIStatusError
+    HTTP_STATUS = 422
+  end
+
+  class RateLimitError < TerminalShop::APIStatusError
+    HTTP_STATUS = 429
+  end
+
+  class InternalServerError < TerminalShop::APIStatusError
+    HTTP_STATUS = (500..)
+  end
+end

data/lib/terminal-shop/extern.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  # @private
+  #
+  # @abstract
+  #
+  module Extern
+  end
+end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # address_api => {
+    #   id: String,
+    #   city: String,
+    #   country: String,
+    #   name: String,
+    #   street1: String,
+    #   **_
+    # }
+    # ```
+    class AddressAPI < TerminalShop::BaseModel
+      # @!attribute id
+      #   Unique object identifier. The format and length of IDs may change over time.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute city
+      #   City of the address.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country code of the address.
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute name
+      #   The recipient's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute street1
+      #   Street of the address.
+      #
+      #   @return [String]
+      required :street1, String
+
+      # @!attribute zip
+      #   Zip code of the address.
+      #
+      #   @return [String]
+      required :zip, String
+
+      # @!attribute [r] phone
+      #   Phone number of the recipient.
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :phone
+
+      # @!attribute [r] province
+      #   Province or state of the address.
+      #
+      #   @return [String, nil]
+      optional :province, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :province
+
+      # @!attribute [r] street2
+      #   Apartment, suite, etc. of the address.
+      #
+      #   @return [String, nil]
+      optional :street2, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :street2
+
+      # @!parse
+      #   # Physical address associated with a Terminal shop user.
+      #   #
+      #   # @param id [String]
+      #   # @param city [String]
+      #   # @param country [String]
+      #   # @param name [String]
+      #   # @param street1 [String]
+      #   # @param zip [String]
+      #   # @param phone [String]
+      #   # @param province [String]
+      #   # @param street2 [String]
+      #   #
+      #   def initialize(id:, city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class AddressCreateParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!attribute city
+      #   City of the address.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country code of the address.
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute name
+      #   The recipient's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute street1
+      #   Street of the address.
+      #
+      #   @return [String]
+      required :street1, String
+
+      # @!attribute zip
+      #   Zip code of the address.
+      #
+      #   @return [String]
+      required :zip, String
+
+      # @!attribute [r] phone
+      #   Phone number of the recipient.
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :phone
+
+      # @!attribute [r] province
+      #   Province or state of the address.
+      #
+      #   @return [String, nil]
+      optional :province, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :province
+
+      # @!attribute [r] street2
+      #   Apartment, suite, etc. of the address.
+      #
+      #   @return [String, nil]
+      optional :street2, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :street2
+
+      # @!parse
+      #   # @param city [String]
+      #   # @param country [String]
+      #   # @param name [String]
+      #   # @param street1 [String]
+      #   # @param zip [String]
+      #   # @param phone [String]
+      #   # @param province [String]
+      #   # @param street2 [String]
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # address_create_response => {
+    #   data: String
+    # }
+    # ```
+    class AddressCreateResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Shipping address ID.
+      #
+      #   @return [String]
+      required :data, String
+
+      # @!parse
+      #   # @param data [String]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class AddressDeleteParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!parse
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # address_delete_response => {
+    #   data: :ok
+    # }
+    # ```
+    class AddressDeleteResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!parse
+      #   # @param data [Symbol, :ok]
+      #   #
+      #   def initialize(data: :ok, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class AddressListParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!parse
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # address_list_response => {
+    #   data: -> { TerminalShop::ArrayOf[TerminalShop::Models::AddressAPI] === _1 }
+    # }
+    # ```
+    class AddressListResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Shipping addresses.
+      #
+      #   @return [Array<TerminalShop::Models::AddressAPI>]
+      required :data, -> { TerminalShop::ArrayOf[TerminalShop::Models::AddressAPI] }
+
+      # @!parse
+      #   # @param data [Array<TerminalShop::Models::AddressAPI>]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end