terminal-shop 0.1.0.pre.alpha.6 → 0.1.0.pre.alpha.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c76c0706cc0ac7c7f3721e93f81a5736151f216a1c7d75d0ebd5208108a1b1
-  data.tar.gz: 555e6ad0a93b697aea3913ba9dfe7405301326d6f8ad95fb04b89e53a671bd22
+  metadata.gz: a7302bc4cca8faceca8577dce4b9b10362963e1d51e24657389a8c663376299e
+  data.tar.gz: 2fd2e9b55fc3c9ba9f4038a44e6bf71e18a49d1d4186a44031ffbe2e43be1fe7
 SHA512:
-  metadata.gz: 22e0a17d4bd138846272ee720cece9523b1e218119dfb316e58ba2b76f00994d702e5922a5fe2aa1e3755e85616d98a6b5b56675ac7d9b58758d066339bcde54
-  data.tar.gz: f7e5686301b9ab66da74361d30cd073f21c1532265524ce63904b90932373a6dc1fe4b6938c7c78d5f8058ad203a0f664960eb5acffdcdf586265fc063ddffa5
+  metadata.gz: 0f8be58ee44eddefe127293b9423358e625982a33a00d83076f23acfcb5845bb27633e0ee6820fe1b7c7915bfdad29a9b40db3a971cf74490082e5cc0573189d
+  data.tar.gz: 6bff5193dcd2072b584d1a6ff52d4bf7173c66ff6d2568665fcd1c1a7a73e536718fd90c4f393574c579f8a368afeb547ff83bb2475493c25de5917a4d753280

data/README.md

@@ -41,7 +41,7 @@ require "terminal-shop"
 
 terminal = TerminalShop::Client.new(
   bearer_token: "My Bearer Token", # defaults to ENV["TERMINAL_BEARER_TOKEN"]
-  environment: "sandbox" # defaults to "production"
+  environment: "dev" # defaults to "production"
 )
 
 product = terminal.product.list

data/lib/terminal-shop/base_client.rb

@@ -126,10 +126,16 @@ module TerminalShop
 
       path = TerminalShop::Util.interpolate_path(uninterpolated_path)
 
+      query = TerminalShop::Util.deep_merge(
+        req[:query].to_h,
+        opts[:extra_query].to_h
+      )
+
       headers = TerminalShop::Util.normalized_headers(
         @headers,
         auth_headers,
-        *[req[:headers], opts[:extra_headers]].compact
+        req[:headers].to_h,
+        opts[:extra_headers].to_h
       )
 
       if @idempotency_header &&
@@ -157,7 +163,7 @@ module TerminalShop
           TerminalShop::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
         end
 
-      url = TerminalShop::Util.join_parsed_uri(@base_url, {**req, path: path})
+      url = TerminalShop::Util.join_parsed_uri(@base_url, {**req, path: path, query: query})
       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}
@@ -387,12 +393,10 @@ module TerminalShop
       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]
+      case [req[:page], req.fetch(:model, TerminalShop::Unknown)]
+      in [Class => page, _]
         page.new(client: self, req: req, headers: response, unwrapped: unwrapped)
-      in [nil, Class | TerminalShop::Converter]
+      in [nil, Class | TerminalShop::Converter => model]
         TerminalShop::Converter.coerce(model, unwrapped)
       in [nil, nil]
         unwrapped

data/lib/terminal-shop/base_model.rb

@@ -586,7 +586,7 @@ module TerminalShop
       case other
       in Array
         # rubocop:disable Style/CaseEquality
-        other.all? { |item| type === item }
+        other.all? { type === _1 }
         # rubocop:enable Style/CaseEquality
       else
         false
@@ -609,7 +609,7 @@ module TerminalShop
       type = item_type
       case value
       in Enumerable unless value.is_a?(Hash)
-        value.map { |item| TerminalShop::Converter.coerce(type, item) }
+        value.map { TerminalShop::Converter.coerce(type, _1) }
       else
         value
       end
@@ -625,7 +625,7 @@ module TerminalShop
       type = item_type
       case value
       in Enumerable unless value.is_a?(Hash)
-        value.map { |item| TerminalShop::Converter.dump(type, item) }.to_a
+        value.map { TerminalShop::Converter.dump(type, _1) }.to_a
       else
         value
       end
@@ -906,7 +906,7 @@ module TerminalShop
       setter = "#{name_sym}="
 
       if known_fields.key?(name_sym)
-        [name_sym, setter].each { |name| undef_method(name) }
+        [name_sym, setter].each { undef_method(_1) }
       end
 
       known_fields[name_sym] = {mode: @mode, key: key, required: required, type_fn: type_fn}
@@ -1015,8 +1015,8 @@ module TerminalShop
     # @return [TerminalShop::BaseModel, Object]
     #
     def self.coerce(value)
-      case (coerced = TerminalShop::Util.coerce_hash(value))
-      in Hash
+      case TerminalShop::Util.coerce_hash(value)
+      in Hash => coerced
         new(coerced)
       else
         value
@@ -1166,8 +1166,8 @@ module TerminalShop
     # @param data [Hash{Symbol=>Object}, TerminalShop::BaseModel]
     #
     def initialize(data = {})
-      case (coerced = TerminalShop::Util.coerce_hash(data))
-      in Hash
+      case TerminalShop::Util.coerce_hash(data)
+      in Hash => coerced
         @data = coerced.transform_keys(&:to_sym)
       else
         raise ArgumentError.new("Expected a #{Hash} or #{TerminalShop::BaseModel}, got #{data.inspect}")

data/lib/terminal-shop/client.rb

@@ -16,7 +16,7 @@ module TerminalShop
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # rubocop:disable Style/MutableConstant
-    ENVIRONMENTS = {production: "https://api.terminal.shop/", sandbox: "https://sandbox.terminal.shop/"}
+    ENVIRONMENTS = {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"}
     # rubocop:enable Style/MutableConstant
 
     # Client option
@@ -61,17 +61,19 @@ module TerminalShop
     # @return [Hash{String=>String}]
     #
     private def auth_headers
+      return {} if @bearer_token.nil?
+
       {"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.
+    # @param environment [:production, :dev, 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/`
+    #   - `dev` corresponds to `https://api.dev.terminal.shop/`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
     #

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

@@ -60,6 +60,16 @@ module TerminalShop
       #   # @return [String]
       #   attr_writer :next_
 
+      # @!attribute [r] schedule
+      #   Schedule of the subscription.
+      #
+      #   @return [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly, nil]
+      optional :schedule, union: -> { TerminalShop::Models::SubscriptionAPI::Schedule }
+
+      # @!parse
+      #   # @return [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly]
+      #   attr_writer :schedule
+
       # @!parse
       #   # Subscription to a Terminal shop product.
       #   #
@@ -70,8 +80,9 @@ module TerminalShop
       #   # @param product_variant_id [String]
       #   # @param quantity [Integer]
       #   # @param next_ [String]
+      #   # @param schedule [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly]
       #   #
-      #   def initialize(id:, address_id:, card_id:, frequency:, product_variant_id:, quantity:, next_: nil, **) = super
+      #   def initialize(id:, address_id:, card_id:, frequency:, product_variant_id:, quantity:, next_: nil, schedule: nil, **) = super
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
@@ -108,6 +119,72 @@ module TerminalShop
         #   #
         #   def self.values; end
       end
+
+      # @abstract
+      #
+      # Schedule of the subscription.
+      #
+      # @example
+      # ```ruby
+      # case schedule
+      # in TerminalShop::Models::SubscriptionAPI::Schedule::Fixed
+      #   # ...
+      # in TerminalShop::Models::SubscriptionAPI::Schedule::Weekly
+      #   # ...
+      # end
+      # ```
+      class Schedule < TerminalShop::Union
+        variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Fixed }
+
+        variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Weekly }
+
+        # @example
+        # ```ruby
+        # fixed => {
+        #   type: :fixed
+        # }
+        # ```
+        class Fixed < TerminalShop::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :fixed]
+          required :type, const: :fixed
+
+          # @!parse
+          #   # @param type [Symbol, :fixed]
+          #   #
+          #   def initialize(type: :fixed, **) = super
+
+          # def initialize: (Hash | TerminalShop::BaseModel) -> void
+        end
+
+        # @example
+        # ```ruby
+        # weekly => {
+        #   interval: Integer,
+        #   type: :weekly
+        # }
+        # ```
+        class Weekly < TerminalShop::BaseModel
+          # @!attribute interval
+          #
+          #   @return [Integer]
+          required :interval, Integer
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :weekly]
+          required :type, const: :weekly
+
+          # @!parse
+          #   # @param interval [Integer]
+          #   # @param type [Symbol, :weekly]
+          #   #
+          #   def initialize(interval:, type: :weekly, **) = super
+
+          # def initialize: (Hash | TerminalShop::BaseModel) -> void
+        end
+      end
     end
   end
 end

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

@@ -21,6 +21,8 @@ module TerminalShop
       #
       #   @option params [String] :next_ Next shipment and billing date for the subscription.
       #
+      #   @option params [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly] :schedule Schedule of the subscription.
+      #
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::SubscriptionCreateResponse]

data/lib/terminal-shop/util.rb

@@ -48,8 +48,8 @@ module TerminalShop
     # @return [Boolean, nil]
     #
     def self.coerce_boolean!(input)
-      case (coerced = coerce_boolean(input))
-      in true | false | nil
+      case coerce_boolean(input)
+      in true | false | nil => coerced
         coerced
       else
         raise ArgumentError.new("Unable to coerce #{input.inspect} into boolean value")
@@ -159,25 +159,20 @@ module TerminalShop
     # @return [Object]
     #
     private_class_method def self.deep_merge_lr(lhs, rhs, concat: false)
-      rhs_cleaned =
-        case rhs
-        in Hash
-          rhs.reject { |_, value| value == OMIT }
-        else
-          rhs
-        end
-
-      case [lhs, rhs_cleaned, concat]
+      case [lhs, rhs, concat]
       in [Hash, Hash, _]
+        # rubocop:disable Style/YodaCondition
+        rhs_cleaned = rhs.reject { |_, val| OMIT == val }
         lhs
-          .reject { |key, _| rhs[key] == OMIT }
+          .reject { |key, _| OMIT == rhs[key] }
           .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_cleaned)
+        lhs.concat(rhs)
       else
-        rhs_cleaned
+        rhs
       end
     end
 
@@ -235,7 +230,7 @@ module TerminalShop
       in []
         ""
       in [String, *interpolations]
-        encoded = interpolations.map { |v| ERB::Util.url_encode(v) }
+        encoded = interpolations.map { ERB::Util.url_encode(_1) }
         path.first % encoded
       end
     end
@@ -297,8 +292,6 @@ module TerminalShop
     #
     #   @option rhs [Hash{String=>Array<String>}] :query
     #
-    #   @option rhs [Hash{String=>Array<String>}] :extra_query
-    #
     # @return [URI::Generic]
     #
     def self.join_parsed_uri(lhs, rhs)
@@ -312,7 +305,7 @@ module TerminalShop
       query = deep_merge(
         joined.path == base_path ? base_query : {},
         parsed_query,
-        *rhs.values_at(:query, :extra_query).compact,
+        rhs[:query].to_h,
         concat: true
       )
 
@@ -332,12 +325,12 @@ module TerminalShop
 
     # @private
     #
-    # @param query [Hash{String=>Array<String>, String, nil}]
+    # @param query [Hash{String=>Array<String>, String, nil}, nil]
     #
     # @return [String, nil]
     #
     def self.encode_query(query)
-      query.empty? ? nil : URI.encode_www_form(query)
+      query.to_h.empty? ? nil : URI.encode_www_form(query)
     end
 
     # @private

data/lib/terminal-shop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  VERSION = "0.1.0-alpha.6"
+  VERSION = "0.1.0-alpha.9"
 end

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

@@ -35,10 +35,13 @@ module TerminalShop
     def self.validate!(req)
     end
 
-    # @private
-    #
     sig { returns(T.anything) }
-    attr_accessor :requester
+    def requester
+    end
+
+    sig { params(_: T.anything).returns(T.anything) }
+    def requester=(_)
+    end
 
     sig do
       params(

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

@@ -11,47 +11,59 @@ module TerminalShop
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
     ENVIRONMENTS = T.let(
-      {production: "https://api.terminal.shop/", sandbox: "https://sandbox.terminal.shop/"},
+      {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"},
       T::Hash[Symbol, String]
     )
 
     sig { returns(String) }
-    attr_reader :bearer_token
+    def bearer_token
+    end
 
     sig { returns(TerminalShop::Resources::Product) }
-    attr_reader :product
+    def product
+    end
 
     sig { returns(TerminalShop::Resources::Profile) }
-    attr_reader :profile
+    def profile
+    end
 
     sig { returns(TerminalShop::Resources::Address) }
-    attr_reader :address
+    def address
+    end
 
     sig { returns(TerminalShop::Resources::Card) }
-    attr_reader :card
+    def card
+    end
 
     sig { returns(TerminalShop::Resources::Cart) }
-    attr_reader :cart
+    def cart
+    end
 
     sig { returns(TerminalShop::Resources::Order) }
-    attr_reader :order
+    def order
+    end
 
     sig { returns(TerminalShop::Resources::Subscription) }
-    attr_reader :subscription
+    def subscription
+    end
 
     sig { returns(TerminalShop::Resources::Token) }
-    attr_reader :token
+    def token
+    end
 
     sig { returns(TerminalShop::Resources::App) }
-    attr_reader :app
+    def app
+    end
 
     sig { returns(TerminalShop::Resources::Email) }
-    attr_reader :email
+    def email
+    end
 
     sig { returns(TerminalShop::Resources::View) }
-    attr_reader :view
+    def view
+    end
 
-    sig { returns(T::Hash[String, String]) }
+    sig { override.returns(T::Hash[String, String]) }
     private def auth_headers
     end
 

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

@@ -3,7 +3,8 @@
 module TerminalShop
   class Error < StandardError
     sig { returns(T.nilable(StandardError)) }
-    attr_reader :cause
+    def cause
+    end
   end
 
   class ConversionError < TerminalShop::Error
@@ -11,13 +12,16 @@ module TerminalShop
 
   class APIError < TerminalShop::Error
     sig { returns(URI::Generic) }
-    attr_reader :url
+    def url
+    end
 
     sig { returns(T.nilable(Integer)) }
-    attr_reader :status
+    def status
+    end
 
     sig { returns(T.nilable(T.anything)) }
-    attr_reader :body
+    def body
+    end
 
     sig do
       params(
@@ -35,10 +39,12 @@ module TerminalShop
 
   class APIConnectionError < TerminalShop::APIError
     sig { void }
-    attr_reader :status
+    def status
+    end
 
     sig { void }
-    attr_reader :body
+    def body
+    end
 
     sig do
       params(
@@ -83,7 +89,8 @@ module TerminalShop
     end
 
     sig { returns(Integer) }
-    attr_reader :status
+    def status
+    end
 
     sig do
       params(

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

@@ -4,40 +4,76 @@ module TerminalShop
   module Models
     class AddressAPI < TerminalShop::BaseModel
       sig { returns(String) }
-      attr_accessor :id
+      def id
+      end
+
+      sig { params(_: String).returns(String) }
+      def id=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :city
+      def city
+      end
+
+      sig { params(_: String).returns(String) }
+      def city=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :country
+      def country
+      end
+
+      sig { params(_: String).returns(String) }
+      def country=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :name
+      def name
+      end
+
+      sig { params(_: String).returns(String) }
+      def name=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :street1
+      def street1
+      end
+
+      sig { params(_: String).returns(String) }
+      def street1=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :zip
+      def zip
+      end
+
+      sig { params(_: String).returns(String) }
+      def zip=(_)
+      end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :phone
+      def phone
+      end
 
-      sig { params(phone: String).void }
-      attr_writer :phone
+      sig { params(_: String).returns(String) }
+      def phone=(_)
+      end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :province
+      def province
+      end
 
-      sig { params(province: String).void }
-      attr_writer :province
+      sig { params(_: String).returns(String) }
+      def province=(_)
+      end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :street2
+      def street2
+      end
 
-      sig { params(street2: String).void }
-      attr_writer :street2
+      sig { params(_: String).returns(String) }
+      def street2=(_)
+      end
 
       sig do
         params(

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

@@ -7,37 +7,68 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       sig { returns(String) }
-      attr_accessor :city
+      def city
+      end
+
+      sig { params(_: String).returns(String) }
+      def city=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :country
+      def country
+      end
+
+      sig { params(_: String).returns(String) }
+      def country=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :name
+      def name
+      end
+
+      sig { params(_: String).returns(String) }
+      def name=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :street1
+      def street1
+      end
+
+      sig { params(_: String).returns(String) }
+      def street1=(_)
+      end
 
       sig { returns(String) }
-      attr_accessor :zip
+      def zip
+      end
+
+      sig { params(_: String).returns(String) }
+      def zip=(_)
+      end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :phone
+      def phone
+      end
 
-      sig { params(phone: String).void }
-      attr_writer :phone
+      sig { params(_: String).returns(String) }
+      def phone=(_)
+      end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :province
+      def province
+      end
 
-      sig { params(province: String).void }
-      attr_writer :province
+      sig { params(_: String).returns(String) }
+      def province=(_)
+      end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :street2
+      def street2
+      end
 
-      sig { params(street2: String).void }
-      attr_writer :street2
+      sig { params(_: String).returns(String) }
+      def street2=(_)
+      end
 
       sig do
         params(