terminal-shop 1.8.0 → 2.1.0

data/lib/terminal-shop/type/unknown.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Type
+    # @api private
+    #
+    # @abstract
+    #
+    # When we don't know what to expect for the value.
+    class Unknown
+      extend TerminalShop::Type::Converter
+
+      # rubocop:disable Lint/UnusedMethodArgument
+
+      # @param other [Object]
+      #
+      # @return [Boolean]
+      def self.===(other) = true
+
+      # @param other [Object]
+      #
+      # @return [Boolean]
+      def self.==(other) = other.is_a?(Class) && other <= TerminalShop::Unknown
+
+      class << self
+        # @api private
+        #
+        # @param value [Object]
+        #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean, :strong] :strictness
+        #
+        #   @option state [Hash{Symbol=>Object}] :exactness
+        #
+        #   @option state [Integer] :branched
+        #
+        # @return [Object]
+        def coerce(value, state:)
+          state.fetch(:exactness)[:yes] += 1
+          value
+        end
+
+        # @!parse
+        #   # @api private
+        #   #
+        #   # @param value [Object]
+        #   #
+        #   # @return [Object]
+        #   def dump(value) = super
+      end
+
+      # rubocop:enable Lint/UnusedMethodArgument
+    end
+  end
+end

data/lib/terminal-shop/type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  Unknown = TerminalShop::Type::Unknown
+
+  BooleanModel = TerminalShop::Type::BooleanModel
+
+  Enum = TerminalShop::Type::Enum
+
+  Union = TerminalShop::Type::Union
+
+  ArrayOf = TerminalShop::Type::ArrayOf
+
+  HashOf = TerminalShop::Type::HashOf
+
+  BaseModel = TerminalShop::Type::BaseModel
+
+  RequestParameters = TerminalShop::Type::RequestParameters
+
+  # This module contains various type declarations.
+  module Type
+  end
+end

data/lib/terminal-shop/util.rb

@@ -75,7 +75,7 @@ module TerminalShop
       def coerce_boolean(input)
         case input.is_a?(String) ? input.downcase : input
         in Numeric
-          !input.zero?
+          input.nonzero?
         in "true"
           true
         in "false"
@@ -165,14 +165,12 @@ module TerminalShop
       private def deep_merge_lr(lhs, rhs, concat: false)
         case [lhs, rhs, concat]
         in [Hash, Hash, _]
-          # rubocop:disable Style/YodaCondition
-          rhs_cleaned = rhs.reject { |_, val| OMIT == val }
+          rhs_cleaned = rhs.reject { _2 == TerminalShop::Util::OMIT }
           lhs
-            .reject { |key, _| OMIT == rhs[key] }
+            .reject { |key, _| rhs[key] == TerminalShop::Util::OMIT }
             .merge(rhs_cleaned) do |_, old_val, new_val|
               deep_merge_lr(old_val, new_val, concat: concat)
             end
-          # rubocop:enable Style/YodaCondition
         in [Array, Array, true]
           lhs.concat(rhs)
         else
@@ -367,13 +365,14 @@ module TerminalShop
       # @return [Hash{String=>String}]
       def normalized_headers(*headers)
         {}.merge(*headers.compact).to_h do |key, val|
-          case val
-          in Array
-            val.map { _1.to_s.strip }.join(", ")
-          else
-            val&.to_s&.strip
-          end
-          [key.downcase, val]
+          value =
+            case val
+            in Array
+              val.map { _1.to_s.strip }.join(", ")
+            else
+              val&.to_s&.strip
+            end
+          [key.downcase, value]
         end
       end
     end
@@ -428,6 +427,8 @@ module TerminalShop
       #
       # @param stream [String, IO, StringIO, Enumerable]
       # @param blk [Proc]
+      #
+      # @yieldparam [String]
       def initialize(stream, &blk)
         @stream = stream.is_a?(String) ? StringIO.new(stream) : stream
         @buf = String.new.b
@@ -438,6 +439,7 @@ module TerminalShop
     class << self
       # @param blk [Proc]
       #
+      # @yieldparam [Enumerator::Yielder]
       # @return [Enumerable]
       def string_io(&blk)
         Enumerator.new do |y|
@@ -452,6 +454,8 @@ module TerminalShop
     end
 
     class << self
+      # rubocop:disable Naming/MethodParameterName
+
       # @api private
       #
       # @param y [Enumerator::Yielder]
@@ -490,6 +494,8 @@ module TerminalShop
         y << "\r\n"
       end
 
+      # rubocop:enable Naming/MethodParameterName
+
       # @api private
       #
       # @param body [Object]
@@ -628,6 +634,7 @@ module TerminalShop
       # @param enum [Enumerable, nil]
       # @param blk [Proc]
       #
+      # @yieldparam [Enumerator::Yielder]
       # @return [Enumerable]
       def chain_fused(enum, &blk)
         iter = Enumerator.new { blk.call(_1) }

data/lib/terminal-shop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  VERSION = "1.8.0"
+  VERSION = "2.1.0"
 end

data/lib/terminal-shop.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$0]).chain(ARGV).grep(/tapioca/)
+  Warning.warn(
+    <<~WARN
+      \n
+      ⚠️ skipped loading of "terminal-shop" gem under `tapioca`.
+
+      This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation.
+      \n
+    WARN
+  )
+  return
+end
+
 # Standard libraries.
 require "cgi"
 require "date"
@@ -21,13 +36,21 @@ require "connection_pool"
 # Package files.
 require_relative "terminal-shop/version"
 require_relative "terminal-shop/util"
-require_relative "terminal-shop/extern"
-require_relative "terminal-shop/base_model"
-require_relative "terminal-shop/base_page"
+require_relative "terminal-shop/type/converter"
+require_relative "terminal-shop/type/unknown"
+require_relative "terminal-shop/type/boolean_model"
+require_relative "terminal-shop/type/enum"
+require_relative "terminal-shop/type/union"
+require_relative "terminal-shop/type/array_of"
+require_relative "terminal-shop/type/hash_of"
+require_relative "terminal-shop/type/base_model"
+require_relative "terminal-shop/type/base_page"
+require_relative "terminal-shop/type/request_parameters"
+require_relative "terminal-shop/type"
 require_relative "terminal-shop/request_options"
 require_relative "terminal-shop/errors"
-require_relative "terminal-shop/base_client"
-require_relative "terminal-shop/pooled_net_requester"
+require_relative "terminal-shop/transport/base_client"
+require_relative "terminal-shop/transport/pooled_net_requester"
 require_relative "terminal-shop/client"
 require_relative "terminal-shop/models/subscription"
 require_relative "terminal-shop/models/address"

data/rbi/lib/terminal-shop/client.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module TerminalShop
-  class Client < TerminalShop::BaseClient
+  class Client < TerminalShop::Transport::BaseClient
     DEFAULT_MAX_RETRIES = 2
 
     DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
@@ -10,62 +10,50 @@ module TerminalShop
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
-    ENVIRONMENTS = T.let(
-      {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"},
-      T::Hash[Symbol, String]
-    )
+    ENVIRONMENTS =
+      T.let(
+        {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"},
+        T::Hash[Symbol, String]
+      )
 
     sig { returns(String) }
-    def bearer_token
-    end
+    attr_reader :bearer_token
 
     sig { returns(T.nilable(String)) }
-    def app_id
-    end
+    attr_reader :app_id
 
     sig { returns(TerminalShop::Resources::Product) }
-    def product
-    end
+    attr_reader :product
 
     sig { returns(TerminalShop::Resources::Profile) }
-    def profile
-    end
+    attr_reader :profile
 
     sig { returns(TerminalShop::Resources::Address) }
-    def address
-    end
+    attr_reader :address
 
     sig { returns(TerminalShop::Resources::Card) }
-    def card
-    end
+    attr_reader :card
 
     sig { returns(TerminalShop::Resources::Cart) }
-    def cart
-    end
+    attr_reader :cart
 
     sig { returns(TerminalShop::Resources::Order) }
-    def order
-    end
+    attr_reader :order
 
     sig { returns(TerminalShop::Resources::Subscription) }
-    def subscription
-    end
+    attr_reader :subscription
 
     sig { returns(TerminalShop::Resources::Token) }
-    def token
-    end
+    attr_reader :token
 
     sig { returns(TerminalShop::Resources::App) }
-    def app
-    end
+    attr_reader :app
 
     sig { returns(TerminalShop::Resources::Email) }
-    def email
-    end
+    attr_reader :email
 
     sig { returns(TerminalShop::Resources::View) }
-    def view
-    end
+    attr_reader :view
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }

data/rbi/lib/terminal-shop/errors.rbi

@@ -3,12 +3,7 @@
 module TerminalShop
   class Error < StandardError
     sig { returns(T.nilable(StandardError)) }
-    def cause
-    end
-
-    sig { params(_: T.nilable(StandardError)).returns(T.nilable(StandardError)) }
-    def cause=(_)
-    end
+    attr_accessor :cause
   end
 
   class ConversionError < TerminalShop::Error
@@ -16,28 +11,13 @@ module TerminalShop
 
   class APIError < TerminalShop::Error
     sig { returns(URI::Generic) }
-    def url
-    end
-
-    sig { params(_: URI::Generic).returns(URI::Generic) }
-    def url=(_)
-    end
+    attr_accessor :url
 
     sig { returns(T.nilable(Integer)) }
-    def status
-    end
-
-    sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
-    def status=(_)
-    end
+    attr_accessor :status
 
     sig { returns(T.nilable(T.anything)) }
-    def body
-    end
-
-    sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
-    def body=(_)
-    end
+    attr_accessor :body
 
     # @api private
     sig do
@@ -57,20 +37,10 @@ module TerminalShop
 
   class APIConnectionError < TerminalShop::APIError
     sig { void }
-    def status
-    end
-
-    sig { params(_: NilClass).void }
-    def status=(_)
-    end
+    attr_accessor :status
 
     sig { void }
-    def body
-    end
-
-    sig { params(_: NilClass).void }
-    def body=(_)
-    end
+    attr_accessor :body
 
     # @api private
     sig do
@@ -122,12 +92,7 @@ module TerminalShop
     end
 
     sig { returns(Integer) }
-    def status
-    end
-
-    sig { params(_: Integer).returns(Integer) }
-    def status=(_)
-    end
+    attr_accessor :status
 
     # @api private
     sig do

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

@@ -5,84 +5,48 @@ module TerminalShop
     class AddressAPI < TerminalShop::BaseModel
       # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
-      def id
-      end
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :id
 
       # City of the address.
       sig { returns(String) }
-      def city
-      end
-
-      sig { params(_: String).returns(String) }
-      def city=(_)
-      end
+      attr_accessor :city
 
       # ISO 3166-1 alpha-2 country code of the address.
       sig { returns(String) }
-      def country
-      end
-
-      sig { params(_: String).returns(String) }
-      def country=(_)
-      end
+      attr_accessor :country
 
       # The recipient's name.
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
       # Street of the address.
       sig { returns(String) }
-      def street1
-      end
-
-      sig { params(_: String).returns(String) }
-      def street1=(_)
-      end
+      attr_accessor :street1
 
       # Zip code of the address.
       sig { returns(String) }
-      def zip
-      end
-
-      sig { params(_: String).returns(String) }
-      def zip=(_)
-      end
+      attr_accessor :zip
 
       # Phone number of the recipient.
       sig { returns(T.nilable(String)) }
-      def phone
-      end
+      attr_reader :phone
 
-      sig { params(_: String).returns(String) }
-      def phone=(_)
-      end
+      sig { params(phone: String).void }
+      attr_writer :phone
 
       # Province or state of the address.
       sig { returns(T.nilable(String)) }
-      def province
-      end
+      attr_reader :province
 
-      sig { params(_: String).returns(String) }
-      def province=(_)
-      end
+      sig { params(province: String).void }
+      attr_writer :province
 
       # Apartment, suite, etc. of the address.
       sig { returns(T.nilable(String)) }
-      def street2
-      end
+      attr_reader :street2
 
-      sig { params(_: String).returns(String) }
-      def street2=(_)
-      end
+      sig { params(street2: String).void }
+      attr_writer :street2
 
       # Physical address associated with a Terminal shop user.
       sig do

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

@@ -3,80 +3,49 @@
 module TerminalShop
   module Models
     class AddressCreateParams < TerminalShop::BaseModel
-      extend TerminalShop::RequestParameters::Converter
+      extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # City of the address.
       sig { returns(String) }
-      def city
-      end
-
-      sig { params(_: String).returns(String) }
-      def city=(_)
-      end
+      attr_accessor :city
 
       # ISO 3166-1 alpha-2 country code of the address.
       sig { returns(String) }
-      def country
-      end
-
-      sig { params(_: String).returns(String) }
-      def country=(_)
-      end
+      attr_accessor :country
 
       # The recipient's name.
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
       # Street of the address.
       sig { returns(String) }
-      def street1
-      end
-
-      sig { params(_: String).returns(String) }
-      def street1=(_)
-      end
+      attr_accessor :street1
 
       # Zip code of the address.
       sig { returns(String) }
-      def zip
-      end
-
-      sig { params(_: String).returns(String) }
-      def zip=(_)
-      end
+      attr_accessor :zip
 
       # Phone number of the recipient.
       sig { returns(T.nilable(String)) }
-      def phone
-      end
+      attr_reader :phone
 
-      sig { params(_: String).returns(String) }
-      def phone=(_)
-      end
+      sig { params(phone: String).void }
+      attr_writer :phone
 
       # Province or state of the address.
       sig { returns(T.nilable(String)) }
-      def province
-      end
+      attr_reader :province
 
-      sig { params(_: String).returns(String) }
-      def province=(_)
-      end
+      sig { params(province: String).void }
+      attr_writer :province
 
       # Apartment, suite, etc. of the address.
       sig { returns(T.nilable(String)) }
-      def street2
-      end
+      attr_reader :street2
 
-      sig { params(_: String).returns(String) }
-      def street2=(_)
-      end
+      sig { params(street2: String).void }
+      attr_writer :street2
 
       sig do
         params(
@@ -88,11 +57,21 @@ module TerminalShop
           phone: String,
           province: String,
           street2: String,
-          request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)
         )
           .returns(T.attached_class)
       end
-      def self.new(city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil, request_options: {})
+      def self.new(
+        city:,
+        country:,
+        name:,
+        street1:,
+        zip:,
+        phone: nil,
+        province: nil,
+        street2: nil,
+        request_options: {}
+      )
       end
 
       sig do

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

@@ -5,12 +5,7 @@ module TerminalShop
     class AddressCreateResponse < TerminalShop::BaseModel
       # Shipping address ID.
       sig { returns(String) }
-      def data
-      end
-
-      sig { params(_: String).returns(String) }
-      def data=(_)
-      end
+      attr_accessor :data
 
       sig { params(data: String).returns(T.attached_class) }
       def self.new(data:)

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

@@ -3,11 +3,11 @@
 module TerminalShop
   module Models
     class AddressDeleteParams < TerminalShop::BaseModel
-      extend TerminalShop::RequestParameters::Converter
+      extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       sig do
-        params(request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
           .returns(T.attached_class)
       end
       def self.new(request_options: {})

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

@@ -4,12 +4,7 @@ module TerminalShop
   module Models
     class AddressDeleteResponse < TerminalShop::BaseModel
       sig { returns(Symbol) }
-      def data
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def data=(_)
-      end
+      attr_accessor :data
 
       sig { params(data: Symbol).returns(T.attached_class) }
       def self.new(data: :ok)

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

@@ -3,11 +3,11 @@
 module TerminalShop
   module Models
     class AddressGetParams < TerminalShop::BaseModel
-      extend TerminalShop::RequestParameters::Converter
+      extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       sig do
-        params(request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
           .returns(T.attached_class)
       end
       def self.new(request_options: {})