metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/lib/metronome_sdk/internal/transport/base_client.rb

@@ -7,6 +7,8 @@ module MetronomeSDK
       #
       # @abstract
       class BaseClient
+        extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
+
         # from whatwg fetch spec
         MAX_REDIRECTS = 20
 
@@ -151,6 +153,27 @@ module MetronomeSDK
           end
         end
 
+        # @return [URI::Generic]
+        attr_reader :base_url
+
+        # @return [Float]
+        attr_reader :timeout
+
+        # @return [Integer]
+        attr_reader :max_retries
+
+        # @return [Float]
+        attr_reader :initial_retry_delay
+
+        # @return [Float]
+        attr_reader :max_retry_delay
+
+        # @return [Hash{String=>String}]
+        attr_reader :headers
+
+        # @return [String, nil]
+        attr_reader :idempotency_header
+
         # @api private
         # @return [MetronomeSDK::Internal::Transport::PooledNetRequester]
         attr_reader :requester
@@ -182,10 +205,11 @@ module MetronomeSDK
             },
             headers
           )
-          @base_url = MetronomeSDK::Internal::Util.parse_uri(base_url)
+          @base_url_components = MetronomeSDK::Internal::Util.parse_uri(base_url)
+          @base_url = MetronomeSDK::Internal::Util.unparse_uri(@base_url_components)
           @idempotency_header = idempotency_header&.to_s&.downcase
-          @max_retries = max_retries
           @timeout = timeout
+          @max_retries = max_retries
           @initial_retry_delay = initial_retry_delay
           @max_retry_delay = max_retry_delay
         end
@@ -261,7 +285,7 @@ module MetronomeSDK
             headers["x-stainless-retry-count"] = "0"
           end
 
-          timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
+          timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..)
           unless headers.key?("x-stainless-timeout") || timeout.zero?
             headers["x-stainless-timeout"] = timeout.to_s
           end
@@ -276,10 +300,14 @@ module MetronomeSDK
               MetronomeSDK::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          url = MetronomeSDK::Internal::Util.join_parsed_uri(
+            @base_url_components,
+            {**req, path: path, query: query}
+          )
           headers, encoded = MetronomeSDK::Internal::Util.encode_content(headers, body)
           {
             method: method,
-            url: MetronomeSDK::Internal::Util.join_parsed_uri(@base_url, {**req, path: path, query: query}),
+            url: url,
             headers: headers,
             body: encoded,
             max_retries: opts.fetch(:max_retries, @max_retries),
@@ -461,9 +489,9 @@ module MetronomeSDK
 
           decoded = MetronomeSDK::Internal::Util.decode_content(response, stream: stream)
           case req
-          in { stream: Class => st }
+          in {stream: Class => st}
             st.new(model: model, url: url, status: status, response: response, stream: decoded)
-          in { page: Class => page }
+          in {page: Class => page}
             page.new(client: self, req: req, headers: response, page_data: decoded)
           else
             unwrapped = MetronomeSDK::Internal::Util.dig(decoded, req[:unwrap])
@@ -476,10 +504,54 @@ module MetronomeSDK
         # @return [String]
         def inspect
           # rubocop:disable Layout/LineLength
-          base_url = MetronomeSDK::Internal::Util.unparse_uri(@base_url)
-          "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
+          "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
           # rubocop:enable Layout/LineLength
         end
+
+        define_sorbet_constant!(:RequestComponents) do
+          T.type_alias do
+            {
+              method: Symbol,
+              path: T.any(String, T::Array[String]),
+              query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+              headers: T.nilable(
+                T::Hash[String,
+                        T.nilable(
+                          T.any(
+                            String,
+                            Integer,
+                            T::Array[T.nilable(T.any(String, Integer))]
+                          )
+                        )]
+              ),
+              body: T.nilable(T.anything),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
+              page: T.nilable(T::Class[MetronomeSDK::Internal::Type::BasePage[MetronomeSDK::Internal::Type::BaseModel]]),
+              stream: T.nilable(T::Class[T.anything]),
+              model: T.nilable(MetronomeSDK::Internal::Type::Converter::Input),
+              options: T.nilable(MetronomeSDK::RequestOptions::OrHash)
+            }
+          end
+        end
+        define_sorbet_constant!(:RequestInput) do
+          T.type_alias do
+            {
+              method: Symbol,
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              body: T.anything,
+              max_retries: Integer,
+              timeout: Float
+            }
+          end
+        end
       end
     end
   end

data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb

@@ -5,10 +5,14 @@ module MetronomeSDK
     module Transport
       # @api private
       class PooledNetRequester
+        extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
+
         # from the golang stdlib
         # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
+        DEFAULT_MAX_CONNECTIONS = [Etc.nprocessors, 99].max
+
         class << self
           # @api private
           #
@@ -182,11 +186,23 @@ module MetronomeSDK
         # @api private
         #
         # @param size [Integer]
-        def initialize(size: Etc.nprocessors)
+        def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
           @pools = {}
         end
+
+        define_sorbet_constant!(:Request) do
+          T.type_alias do
+            {
+              method: Symbol,
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              body: T.anything,
+              deadline: Float
+            }
+          end
+        end
       end
     end
   end

data/lib/metronome_sdk/internal/type/array_of.rb

@@ -12,6 +12,7 @@ module MetronomeSDK
       # Array of items of a given type.
       class ArrayOf
         include MetronomeSDK::Internal::Type::Converter
+        include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -29,7 +30,7 @@ module MetronomeSDK
         #
         #   @option spec [Boolean] :"nil?"
         #
-        # @return [MetronomeSDK::Internal::Type::ArrayOf]
+        # @return [self]
         def self.[](...) = new(...)
 
         # @api public
@@ -110,6 +111,13 @@ module MetronomeSDK
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Array[MetronomeSDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/metronome_sdk/internal/type/base_model.rb

@@ -6,6 +6,7 @@ module MetronomeSDK
       # @abstract
       class BaseModel
         extend MetronomeSDK::Internal::Type::Converter
+        extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         class << self
           # @api private
@@ -13,11 +14,17 @@ module MetronomeSDK
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
           #
-          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
-          def known_fields
-            @known_fields ||= (self < MetronomeSDK::Internal::Type::BaseModel ? superclass.known_fields.dup : {})
+          # @param child [Class<MetronomeSDK::Internal::Type::BaseModel>]
+          def inherited(child)
+            super
+            child.known_fields.replace(known_fields.dup)
           end
 
+          # @api private
+          #
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def known_fields = @known_fields ||= {}
+
           # @api private
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
@@ -204,7 +211,7 @@ module MetronomeSDK
           #
           #   @option state [Integer] :branched
           #
-          # @return [MetronomeSDK::Internal::Type::BaseModel, Object]
+          # @return [self, Object]
           def coerce(value, state:)
             exactness = state.fetch(:exactness)
 
@@ -263,7 +270,7 @@ module MetronomeSDK
 
           # @api private
           #
-          # @param value [MetronomeSDK::Internal::Type::BaseModel, Object]
+          # @param value [self, Object]
           #
           # @param state [Hash{Symbol=>Object}] .
           #
@@ -302,6 +309,46 @@ module MetronomeSDK
 
             acc
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            self
+          end
+        end
+
+        class << self
+          # @api private
+          #
+          # @param model [MetronomeSDK::Internal::Type::BaseModel]
+          # @param convert [Boolean]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def recursively_to_h(model, convert:)
+            rec = ->(x) do
+              case x
+              in MetronomeSDK::Internal::Type::BaseModel
+                if convert
+                  fields = x.class.known_fields
+                  x.to_h.to_h do |key, val|
+                    [key, rec.call(fields.key?(key) ? x.public_send(key) : val)]
+                  rescue MetronomeSDK::Errors::ConversionError
+                    [key, rec.call(val)]
+                  end
+                else
+                  rec.call(x.to_h)
+                end
+              in Hash
+                x.transform_values(&rec)
+              in Array
+                x.map(&rec)
+              else
+                x
+              end
+            end
+            rec.call(model)
+          end
         end
 
         # @api public
@@ -340,9 +387,23 @@ module MetronomeSDK
 
         alias_method :to_hash, :to_h
 
+        # @api public
+        #
+        # In addition to the behaviour of `#to_h`, this method will recursively call
+        # `#to_h` on nested models.
+        #
+        # @return [Hash{Symbol=>Object}]
+        def deep_to_h = self.class.recursively_to_h(@data, convert: false)
+
         # @param keys [Array<Symbol>, nil]
         #
         # @return [Hash{Symbol=>Object}]
+        #
+        # @example
+        #   # `contract_retrieve_response` is a `MetronomeSDK::Models::V2::ContractRetrieveResponse`
+        #   contract_retrieve_response => {
+        #     data: data
+        #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)
             .filter_map do |k|
@@ -355,29 +416,6 @@ module MetronomeSDK
             .to_h
         end
 
-        class << self
-          # @api private
-          #
-          # @param model [MetronomeSDK::Internal::Type::BaseModel]
-          #
-          # @return [Hash{Symbol=>Object}]
-          def walk(model)
-            walk = ->(x) do
-              case x
-              in MetronomeSDK::Internal::Type::BaseModel
-                walk.call(x.to_h)
-              in Hash
-                x.transform_values(&walk)
-              in Array
-                x.map(&walk)
-              else
-                x
-              end
-            end
-            walk.call(model)
-          end
-        end
-
         # @api public
         #
         # @param a [Object]
@@ -395,15 +433,7 @@ module MetronomeSDK
         # Create a new instance of a model.
         #
         # @param data [Hash{Symbol=>Object}, self]
-        def initialize(data = {})
-          case MetronomeSDK::Internal::Util.coerce_hash(data)
-          in Hash => coerced
-            @data = coerced
-          else
-            message = "Expected a #{Hash} or #{MetronomeSDK::Internal::Type::BaseModel}, got #{data.inspect}"
-            raise ArgumentError.new(message)
-          end
-        end
+        def initialize(data = {}) = (@data = MetronomeSDK::Internal::Util.coerce_hash!(data).to_h)
 
         class << self
           # @api private
@@ -431,12 +461,19 @@ module MetronomeSDK
         # @api public
         #
         # @return [String]
-        def to_s = self.class.walk(@data).to_s
+        def to_s = deep_to_h.to_s
 
         # @api private
         #
         # @return [String]
-        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
+        def inspect
+          converted = self.class.recursively_to_h(self, convert: true)
+          "#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>"
+        end
+
+        define_sorbet_constant!(:KnownField) do
+          T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} }
+        end
       end
     end
   end

data/lib/metronome_sdk/internal/type/boolean.rb

@@ -10,6 +10,7 @@ module MetronomeSDK
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend MetronomeSDK::Internal::Type::Converter
+        extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -56,6 +57,13 @@ module MetronomeSDK
           #     @option state [Boolean] :can_retry
           #
           #   @return [Boolean, Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T::Boolean
+          end
         end
       end
     end

data/lib/metronome_sdk/internal/type/converter.rb

@@ -5,6 +5,8 @@ module MetronomeSDK
     module Type
       # @api private
       module Converter
+        extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
+
         # rubocop:disable Lint/UnusedMethodArgument
 
         # @api private
@@ -268,6 +270,22 @@ module MetronomeSDK
             end
           end
         end
+
+        define_sorbet_constant!(:Input) do
+          T.type_alias { T.any(MetronomeSDK::Internal::Type::Converter, T::Class[T.anything]) }
+        end
+        define_sorbet_constant!(:CoerceState) do
+          T.type_alias do
+            {
+              strictness: T.any(T::Boolean, Symbol),
+              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              branched: Integer
+            }
+          end
+        end
+        define_sorbet_constant!(:DumpState) do
+          T.type_alias { {can_retry: T::Boolean} }
+        end
       end
     end
   end

data/lib/metronome_sdk/internal/type/enum.rb

@@ -17,6 +17,7 @@ module MetronomeSDK
       # values safely.
       module Enum
         include MetronomeSDK::Internal::Type::Converter
+        include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
         #
@@ -86,6 +87,18 @@ module MetronomeSDK
         #
         #   @return [Symbol, Object]
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case values
+          in []
+            T.noreturn
+          in [value, *_]
+            T.all(MetronomeSDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          end
+        end
+
         # @api private
         #
         # @param depth [Integer]

data/lib/metronome_sdk/internal/type/file_input.rb

@@ -89,6 +89,13 @@ module MetronomeSDK
 
             value
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.any(Pathname, StringIO, IO, String, MetronomeSDK::FilePart)
+          end
         end
       end
     end

data/lib/metronome_sdk/internal/type/hash_of.rb

@@ -12,6 +12,7 @@ module MetronomeSDK
       # Hash of items of a given type.
       class HashOf
         include MetronomeSDK::Internal::Type::Converter
+        include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -29,7 +30,7 @@ module MetronomeSDK
         #
         #   @option spec [Boolean] :"nil?"
         #
-        # @return [MetronomeSDK::Internal::Type::HashOf]
+        # @return [self]
         def self.[](...) = new(...)
 
         # @api public
@@ -130,6 +131,13 @@ module MetronomeSDK
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Hash[MetronomeSDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/metronome_sdk/internal/type/request_parameters.rb

@@ -5,10 +5,10 @@ module MetronomeSDK
     module Type
       # @api private
       module RequestParameters
-        # @!parse
-        #   # Options to specify HTTP behaviour for this request.
-        #   # @return [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
-        #   attr_accessor :request_options
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)
@@ -28,14 +28,8 @@ module MetronomeSDK
             state = {can_retry: true}
             case (dumped = dump(params, state: state))
             in Hash
-              options = MetronomeSDK::Internal::Util.coerce_hash(dumped[:request_options])
-              request_options =
-                case [options, state.fetch(:can_retry)]
-                in [Hash | nil, false]
-                  {**options.to_h, max_retries: 0}
-                else
-                  options
-                end
+              options = MetronomeSDK::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
+              request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
               [dumped.except(:request_options), request_options]
             else
               [dumped, nil]

data/lib/metronome_sdk/internal/type/union.rb

@@ -6,6 +6,7 @@ module MetronomeSDK
       # @api private
       module Union
         include MetronomeSDK::Internal::Type::Converter
+        include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         # @api private
         #
@@ -196,6 +197,18 @@ module MetronomeSDK
           super
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case (v = variants)
+          in []
+            T.noreturn
+          else
+            T.any(*v.map { MetronomeSDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+          end
+        end
+
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 

data/lib/metronome_sdk/internal/type/unknown.rb

@@ -10,6 +10,7 @@ module MetronomeSDK
       # When we don't know what to expect for the value.
       class Unknown
         extend MetronomeSDK::Internal::Type::Converter
+        extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
 
@@ -58,6 +59,13 @@ module MetronomeSDK
           #     @option state [Boolean] :can_retry
           #
           #   @return [Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.anything
+          end
         end
 
         # rubocop:enable Lint/UnusedMethodArgument