modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

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

@@ -5,6 +5,8 @@ module ModernTreasury
     module Transport
       # @api private
       class PooledNetRequester
+        extend ModernTreasury::Internal::Util::SorbetRuntimeSupport
+
         # from the golang stdlib
         # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
@@ -57,15 +59,11 @@ module ModernTreasury
           # @return [Array(Net::HTTPGenericRequest, Proc)]
           def build_request(request, &blk)
             method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
-
-            # ensure we construct a URI class of the right scheme
-            url = URI(url.to_s)
-
             req = Net::HTTPGenericRequest.new(
               method.to_s.upcase,
               !body.nil?,
               method != :head,
-              url
+              URI(url.to_s) # ensure we construct a URI class of the right scheme
             )
 
             headers.each { req[_1] = _2 }
@@ -180,7 +178,7 @@ module ModernTreasury
             conn.finish if !eof && conn&.started?
             closing&.call
           end
-          [Integer(response.code), response, (response.body = body)]
+          [Integer(response.code), response, body]
         end
 
         # @api private
@@ -191,6 +189,18 @@ module ModernTreasury
           @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/modern_treasury/internal/type/array_of.rb

@@ -28,13 +28,19 @@ module ModernTreasury
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
+        #
+        # @return [self]
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = other.is_a?(Array) && other.all?(item_type)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -44,6 +50,11 @@ module ModernTreasury
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
         # @api private
         #
         # @param value [Array<Object>, Object]

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

@@ -4,15 +4,9 @@ module ModernTreasury
   module Internal
     module Type
       # @abstract
-      #
-      # @example
-      #   # `async_response` is a `ModernTreasury::Models::AsyncResponse`
-      #   async_response => {
-      #     id: id,
-      #     object: object
-      #   }
       class BaseModel
         extend ModernTreasury::Internal::Type::Converter
+        extend ModernTreasury::Internal::Util::SorbetRuntimeSupport
 
         class << self
           # @api private
@@ -20,11 +14,17 @@ module ModernTreasury
           # 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 < ModernTreasury::Internal::Type::BaseModel ? superclass.known_fields.dup : {})
+          # @param child [Class<ModernTreasury::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}}]
@@ -97,11 +97,13 @@ module ModernTreasury
                   target, value, state: state
                 )
               end
-            rescue StandardError
+            rescue StandardError => e
               cls = self.class.name.split("::").last
-              # rubocop:disable Layout/LineLength
-              message = "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}. To get the unparsed API response, use #{cls}[:#{__method__}]."
-              # rubocop:enable Layout/LineLength
+              message = [
+                "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}.",
+                "To get the unparsed API response, use #{cls}[#{__method__.inspect}].",
+                "Cause: #{e.message}"
+              ].join(" ")
               raise ModernTreasury::Errors::ConversionError.new(message)
             end
           end
@@ -169,19 +171,33 @@ module ModernTreasury
             @mode = nil
           end
 
+          # @api public
+          #
           # @param other [Object]
           #
           # @return [Boolean]
           def ==(other)
             other.is_a?(Class) && other <= ModernTreasury::Internal::Type::BaseModel && other.fields == fields
           end
+
+          # @api public
+          #
+          # @return [Integer]
+          def hash = fields.hash
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ==(other) = self.class == other.class && @data == other.to_h
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, @data].hash
+
         class << self
           # @api private
           #
@@ -195,7 +211,7 @@ module ModernTreasury
           #
           #   @option state [Integer] :branched
           #
-          # @return [ModernTreasury::Internal::Type::BaseModel, Object]
+          # @return [self, Object]
           def coerce(value, state:)
             exactness = state.fetch(:exactness)
 
@@ -254,7 +270,7 @@ module ModernTreasury
 
           # @api private
           #
-          # @param value [ModernTreasury::Internal::Type::BaseModel, Object]
+          # @param value [self, Object]
           #
           # @param state [Hash{Symbol=>Object}] .
           #
@@ -298,6 +314,41 @@ module ModernTreasury
           end
         end
 
+        class << self
+          # @api private
+          #
+          # @param model [ModernTreasury::Internal::Type::BaseModel]
+          # @param convert [Boolean]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def recursively_to_h(model, convert:)
+            rec = ->(x) do
+              case x
+              in ModernTreasury::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 ModernTreasury::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
+        #
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
         # returned.
         #
@@ -316,6 +367,8 @@ module ModernTreasury
           @data[key]
         end
 
+        # @api public
+        #
         # Returns a Hash of the data underlying this object. O(1)
         #
         # Keys are Symbols and values are the raw values from the response. The return
@@ -330,6 +383,14 @@ module ModernTreasury
 
         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}]
@@ -345,11 +406,15 @@ module ModernTreasury
             .to_h
         end
 
+        # @api public
+        #
         # @param a [Object]
         #
         # @return [String]
         def to_json(*a) = ModernTreasury::Internal::Type::Converter.dump(self.class, self).to_json(*a)
 
+        # @api public
+        #
         # @param a [Object]
         #
         # @return [String]
@@ -357,16 +422,8 @@ module ModernTreasury
 
         # Create a new instance of a model.
         #
-        # @param data [Hash{Symbol=>Object}, ModernTreasury::Internal::Type::BaseModel]
-        def initialize(data = {})
-          case ModernTreasury::Internal::Util.coerce_hash(data)
-          in Hash => coerced
-            @data = coerced
-          else
-            message = "Expected a #{Hash} or #{ModernTreasury::Internal::Type::BaseModel}, got #{data.inspect}"
-            raise ArgumentError.new(message)
-          end
-        end
+        # @param data [Hash{Symbol=>Object}, self]
+        def initialize(data = {}) = (@data = ModernTreasury::Internal::Util.coerce_hash!(data).to_h)
 
         class << self
           # @api private
@@ -380,30 +437,32 @@ module ModernTreasury
             depth = depth.succ
             deferred = fields.transform_values do |field|
               type, required, nilable = field.fetch_values(:type, :required, :nilable)
-              -> do
-                [
-                  ModernTreasury::Internal::Type::Converter.inspect(type, depth: depth),
-                  !required || nilable ? "nil" : nil
-                ].compact.join(" | ")
-              end
-                .tap { _1.define_singleton_method(:inspect) { call } }
+              inspected = [
+                ModernTreasury::Internal::Type::Converter.inspect(type, depth: depth),
+                !required || nilable ? "nil" : nil
+              ].compact.join(" | ")
+              -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } }
             end
 
             "#{name}[#{deferred.inspect}]"
           end
         end
 
+        # @api public
+        #
+        # @return [String]
+        def to_s = deep_to_h.to_s
+
         # @api private
         #
         # @return [String]
         def inspect
-          rows = @data.map do
-            "#{_1}=#{self.class.known_fields.key?(_1) ? public_send(_1).inspect : ''}"
-          rescue ModernTreasury::Errors::ConversionError
-            "#{_1}=#{_2.inspect}"
-          end
+          converted = self.class.recursively_to_h(self, convert: true)
+          "#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>"
+        end
 
-          "#<#{self.class}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
+        define_sorbet_constant!(:KnownField) do
+          T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} }
         end
       end
     end

data/lib/modern_treasury/internal/type/base_page.rb

@@ -3,19 +3,27 @@
 module ModernTreasury
   module Internal
     module Type
+      # @api private
+      #
       # @generic Elem
       #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
 
+        # @api public
+        #
         # @return [Boolean]
         def next_page? = (raise NotImplementedError)
 
+        # @api public
+        #
         # @raise [ModernTreasury::Errors::APIError]
-        # @return [ModernTreasury::Internal::Type::BasePage]
+        # @return [self]
         def next_page = (raise NotImplementedError)
 
+        # @api public
+        #
         # @param blk [Proc]
         #
         # @yieldparam [generic<Elem>]

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

@@ -13,11 +13,15 @@ module ModernTreasury
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other) = other == true || other == false
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -42,17 +46,16 @@ module ModernTreasury
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Boolean, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Boolean, Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Boolean, Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Boolean, Object]
         end
       end
     end

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

@@ -5,6 +5,8 @@ module ModernTreasury
     module Type
       # @api private
       module Converter
+        extend ModernTreasury::Internal::Util::SorbetRuntimeSupport
+
         # rubocop:disable Lint/UnusedMethodArgument
 
         # @api private
@@ -43,7 +45,10 @@ module ModernTreasury
             value.string
           in Pathname | IO
             state[:can_retry] = false if value.is_a?(IO)
-            ModernTreasury::Internal::Util::SerializationAdapter.new(value)
+            ModernTreasury::FilePart.new(value)
+          in ModernTreasury::FilePart
+            state[:can_retry] = false if value.content.is_a?(IO)
+            value
           else
             value
           end
@@ -265,6 +270,22 @@ module ModernTreasury
             end
           end
         end
+
+        define_sorbet_constant!(:Input) do
+          T.type_alias { T.any(ModernTreasury::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/modern_treasury/internal/type/enum.rb

@@ -17,11 +17,11 @@ module ModernTreasury
       # values safely.
       #
       # @example
-      #   # `accounts_type` is a `ModernTreasury::Models::AccountsType`
+      #   # `accounts_type` is a `ModernTreasury::AccountsType`
       #   case accounts_type
-      #   when ModernTreasury::Models::AccountsType::EXTERNAL_ACCOUNTS
+      #   when ModernTreasury::AccountsType::EXTERNAL_ACCOUNTS
       #     # ...
-      #   when ModernTreasury::Models::AccountsType::INTERNAL_ACCOUNTS
+      #   when ModernTreasury::AccountsType::INTERNAL_ACCOUNTS
       #     # ...
       #   else
       #     puts(accounts_type)
@@ -38,22 +38,22 @@ module ModernTreasury
       #   end
       module Enum
         include ModernTreasury::Internal::Type::Converter
+        include ModernTreasury::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
         #
         # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
-        def values = (@values ||= constants.map { const_get(_1) })
+        def values = constants.map { const_get(_1) }
 
-        # @api private
+        # @api public
         #
-        # Guard against thread safety issues by instantiating `@values`.
-        private def finalize! = values
-
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = values.include?(other)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -63,6 +63,11 @@ module ModernTreasury
           # rubocop:enable Style/CaseEquality
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = values.to_set.hash
+
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
@@ -92,17 +97,16 @@ module ModernTreasury
           end
         end
 
-        # @!parse
-        #   # @api private
-        #   #
-        #   # @param value [Symbol, Object]
-        #   #
-        #   # @param state [Hash{Symbol=>Object}] .
-        #   #
-        #   #   @option state [Boolean] :can_retry
-        #   #
-        #   # @return [Symbol, Object]
-        #   def dump(value, state:) = super
+        # @!method dump(value, state:)
+        #   @api private
+        #
+        #   @param value [Symbol, Object]
+        #
+        #   @param state [Hash{Symbol=>Object}] .
+        #
+        #     @option state [Boolean] :can_retry
+        #
+        #   @return [Symbol, Object]
 
         # @api private
         #

data/lib/modern_treasury/internal/type/{io_like.rb → file_input.rb}

@@ -7,28 +7,36 @@ module ModernTreasury
       #
       # @abstract
       #
-      # Either `Pathname` or `StringIO`.
-      class IOLike
+      # Either `Pathname` or `StringIO`, or `IO`, or
+      # `ModernTreasury::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
         extend ModernTreasury::Internal::Type::Converter
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other)
           case other
-          in StringIO | Pathname | IO
+          in Pathname | StringIO | IO | String | ModernTreasury::FilePart
             true
           else
             false
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
-        def self.==(other) = other.is_a?(Class) && other <= ModernTreasury::Internal::Type::IOLike
+        def self.==(other) = other.is_a?(Class) && other <= ModernTreasury::Internal::Type::FileInput
 
         class << self
           # @api private
@@ -59,17 +67,28 @@ module ModernTreasury
             end
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Pathname, StringIO, IO, String, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Pathname, StringIO, IO, String, Object]
-          #   def dump(value, state:) = super
+          # @api private
+          #
+          # @param value [Pathname, StringIO, IO, String, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
+          # @return [Pathname, StringIO, IO, String, Object]
+          def dump(value, state:)
+            # rubocop:disable Lint/DuplicateBranch
+            case value
+            in IO
+              state[:can_retry] = false
+            in ModernTreasury::FilePart if value.content.is_a?(IO)
+              state[:can_retry] = false
+            else
+            end
+            # rubocop:enable Lint/DuplicateBranch
+
+            value
+          end
         end
       end
     end

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

@@ -28,8 +28,12 @@ module ModernTreasury
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
+        #
+        # @return [self]
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -50,6 +54,8 @@ module ModernTreasury
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -59,6 +65,11 @@ module ModernTreasury
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
         # @api private
         #
         # @param value [Hash{Object=>Object}, Object]

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

@@ -5,16 +5,15 @@ module ModernTreasury
     module Type
       # @api private
       module RequestParameters
-        # @!parse
-        #   # Options to specify HTTP behaviour for this request.
-        #   # @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-        #   attr_accessor :request_options
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)
-          return unless mod <= ModernTreasury::Internal::Type::BaseModel
+          raise ArgumentError.new(mod) unless mod <= ModernTreasury::Internal::Type::BaseModel
 
-          mod.extend(ModernTreasury::Internal::Type::RequestParameters::Converter)
           mod.optional(:request_options, ModernTreasury::RequestOptions)
         end
 
@@ -29,14 +28,8 @@ module ModernTreasury
             state = {can_retry: true}
             case (dumped = dump(params, state: state))
             in Hash
-              options = ModernTreasury::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 = ModernTreasury::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]