modern_treasury 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.18

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

@@ -58,9 +58,9 @@ module ModernTreasury
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
-          other.is_a?(Module) && other.singleton_class <= ModernTreasury::Internal::Type::Enum && other.values.to_set == values.to_set
-          # rubocop:enable Layout/LineLength
+          # rubocop:disable Style/CaseEquality
+          ModernTreasury::Internal::Type::Enum === other && other.values.to_set == values.to_set
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -97,8 +97,28 @@ module ModernTreasury
         #   #
         #   # @param value [Symbol, Object]
         #   #
+        #   # @param state [Hash{Symbol=>Object}] .
+        #   #
+        #   #   @option state [Boolean] :can_retry
+        #   #
         #   # @return [Symbol, Object]
-        #   def dump(value) = super
+        #   def dump(value, state:) = super
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          if depth.positive?
+            return is_a?(Module) ? super() : self.class.name
+          end
+
+          members = values.map { ModernTreasury::Internal::Type::Converter.inspect(_1, depth: depth.succ) }
+          prefix = is_a?(Module) ? name : self.class.name
+
+          "#{prefix}[#{members.join(' | ')}]"
+        end
       end
     end
   end

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

@@ -13,6 +13,10 @@ module ModernTreasury
       class HashOf
         include ModernTreasury::Internal::Type::Converter
 
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
         # @param type_info [Hash{Symbol=>Object}, Proc, ModernTreasury::Internal::Type::Converter, Class]
         #
         # @param spec [Hash{Symbol=>Object}] .
@@ -24,7 +28,7 @@ module ModernTreasury
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
-        def self.[](type_info, spec = {}) = new(type_info, spec)
+        def self.[](...) = new(...)
 
         # @param other [Object]
         #
@@ -99,12 +103,16 @@ module ModernTreasury
         #
         # @param value [Hash{Object=>Object}, Object]
         #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean] :can_retry
+        #
         # @return [Hash{Symbol=>Object}, Object]
-        def dump(value)
+        def dump(value, state:)
           target = item_type
           if value.is_a?(Hash)
             value.transform_values do
-              ModernTreasury::Internal::Type::Converter.dump(target, _1)
+              ModernTreasury::Internal::Type::Converter.dump(target, _1, state: state)
             end
           else
             super
@@ -136,7 +144,18 @@ module ModernTreasury
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = ModernTreasury::Internal::Type::Converter.type_info(type_info || spec)
-          @nilable = spec[:nil?]
+          @nilable = spec.fetch(:nil?, false)
+        end
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          items = ModernTreasury::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
+
+          "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]"
         end
       end
     end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Internal
+    module Type
+      # @api private
+      #
+      # @abstract
+      #
+      # Either `Pathname` or `StringIO`.
+      class IOLike
+        extend ModernTreasury::Internal::Type::Converter
+
+        private_class_method :new
+
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def self.===(other)
+          case other
+          in StringIO | Pathname | IO
+            true
+          else
+            false
+          end
+        end
+
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def self.==(other) = other.is_a?(Class) && other <= ModernTreasury::Internal::Type::IOLike
+
+        class << self
+          # @api private
+          #
+          # @param value [StringIO, String, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean, :strong] :strictness
+          #
+          #   @option state [Hash{Symbol=>Object}] :exactness
+          #
+          #   @option state [Integer] :branched
+          #
+          # @return [StringIO, Object]
+          def coerce(value, state:)
+            exactness = state.fetch(:exactness)
+            case value
+            in String
+              exactness[:yes] += 1
+              StringIO.new(value)
+            in StringIO
+              exactness[:yes] += 1
+              value
+            else
+              exactness[:no] += 1
+              value
+            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
+        end
+      end
+    end
+  end
+end

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

@@ -26,9 +26,18 @@ module ModernTreasury
           #
           # @return [Array(Object, Hash{Symbol=>Object})]
           def dump_request(params)
-            case (dumped = dump(params))
+            state = {can_retry: true}
+            case (dumped = dump(params, state: state))
             in Hash
-              [dumped.except(:request_options), dumped[:request_options]]
+              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
+              [dumped.except(:request_options), request_options]
             else
               [dumped, nil]
             end

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

@@ -111,9 +111,7 @@ module ModernTreasury
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
-          other.is_a?(Module) && other.singleton_class <= ModernTreasury::Internal::Type::Union && other.derefed_variants == derefed_variants
-          # rubocop:enable Layout/LineLength
+          ModernTreasury::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
         # @api private
@@ -176,15 +174,25 @@ module ModernTreasury
         #
         # @param value [Object]
         #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean] :can_retry
+        #
         # @return [Object]
-        def dump(value)
+        def dump(value, state:)
           if (target = resolve_variant(value))
-            return ModernTreasury::Internal::Type::Converter.dump(target, value)
+            return ModernTreasury::Internal::Type::Converter.dump(target, value, state: state)
           end
 
           known_variants.each do
             target = _2.call
-            return ModernTreasury::Internal::Type::Converter.dump(target, value) if target === value
+            if target === value
+              return ModernTreasury::Internal::Type::Converter.dump(
+                target,
+                value,
+                state: state
+              )
+            end
           end
 
           super
@@ -192,6 +200,22 @@ module ModernTreasury
 
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          if depth.positive?
+            return is_a?(Module) ? super() : self.class.name
+          end
+
+          members = variants.map { ModernTreasury::Internal::Type::Converter.inspect(_1, depth: depth.succ) }
+          prefix = is_a?(Module) ? name : self.class.name
+
+          "#{prefix}[#{members.join(' | ')}]"
+        end
       end
     end
   end

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

@@ -13,6 +13,8 @@ module ModernTreasury
 
         # rubocop:disable Lint/UnusedMethodArgument
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]
@@ -47,8 +49,12 @@ module ModernTreasury
           #   #
           #   # @param value [Object]
           #   #
+          #   # @param state [Hash{Symbol=>Object}] .
+          #   #
+          #   #   @option state [Boolean] :can_retry
+          #   #
           #   # @return [Object]
-          #   def dump(value) = super
+          #   def dump(value, state:) = super
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/modern_treasury/internal/util.rb

@@ -122,7 +122,7 @@ module ModernTreasury
         # @return [Hash{Object=>Object}, Object]
         def coerce_hash(input)
           case input
-          in NilClass | Array | Set | Enumerator
+          in NilClass | Array | Set | Enumerator | StringIO | IO
             input
           else
             input.respond_to?(:to_h) ? input.to_h : input
@@ -348,10 +348,47 @@ module ModernTreasury
         end
       end
 
+      # @api private
+      class SerializationAdapter
+        # @return [Pathname, IO]
+        attr_reader :inner
+
+        # @param a [Object]
+        #
+        # @return [String]
+        def to_json(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_json(*a)
+
+        # @param a [Object]
+        #
+        # @return [String]
+        def to_yaml(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_yaml(*a)
+
+        # @api private
+        #
+        # @param inner [Pathname, IO]
+        def initialize(inner) = @inner = inner
+      end
+
       # @api private
       #
       # An adapter that satisfies the IO interface required by `::IO.copy_stream`
       class ReadIOAdapter
+        # @api private
+        #
+        # @return [Boolean, nil]
+        def close? = @closing
+
+        # @api private
+        def close
+          case @stream
+          in Enumerator
+            ModernTreasury::Internal::Util.close_fused!(@stream)
+          in IO if close?
+            @stream.close
+          else
+          end
+        end
+
         # @api private
         #
         # @param max_len [Integer, nil]
@@ -396,13 +433,22 @@ module ModernTreasury
 
         # @api private
         #
-        # @param stream [String, IO, StringIO, Enumerable<String>]
+        # @param src [String, Pathname, StringIO, Enumerable<String>]
         # @param blk [Proc]
         #
         # @yieldparam [String]
-        def initialize(stream, &blk)
-          @stream = stream.is_a?(String) ? StringIO.new(stream) : stream
-          @buf = String.new.b
+        def initialize(src, &blk)
+          @stream =
+            case src
+            in String
+              StringIO.new(src)
+            in Pathname
+              @closing = true
+              src.open(binmode: true)
+            else
+              src
+            end
+          @buf = String.new
           @blk = blk
         end
       end
@@ -414,9 +460,10 @@ module ModernTreasury
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
+            buf = String.new
             y.define_singleton_method(:write) do
-              self << _1.clone
-              _1.bytesize
+              self << buf.replace(_1)
+              buf.bytesize
             end
 
             blk.call(y)
@@ -431,29 +478,39 @@ module ModernTreasury
         # @param boundary [String]
         # @param key [Symbol, String]
         # @param val [Object]
-        private def write_multipart_chunk(y, boundary:, key:, val:)
+        # @param closing [Array<Proc>]
+        private def write_multipart_chunk(y, boundary:, key:, val:, closing:)
+          val = val.inner if val.is_a?(ModernTreasury::Internal::Util::SerializationAdapter)
+
           y << "--#{boundary}\r\n"
           y << "Content-Disposition: form-data"
           unless key.nil?
             name = ERB::Util.url_encode(key.to_s)
             y << "; name=\"#{name}\""
           end
-          if val.is_a?(IO)
+          case val
+          in Pathname | IO
             filename = ERB::Util.url_encode(File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
+          else
           end
           y << "\r\n"
           case val
+          in Pathname
+            y << "Content-Type: application/octet-stream\r\n\r\n"
+            io = val.open(binmode: true)
+            closing << io.method(:close)
+            IO.copy_stream(io, y)
           in IO
             y << "Content-Type: application/octet-stream\r\n\r\n"
-            IO.copy_stream(val.tap(&:rewind), y)
+            IO.copy_stream(val, y)
           in StringIO
             y << "Content-Type: application/octet-stream\r\n\r\n"
             y << val.string
           in String
             y << "Content-Type: application/octet-stream\r\n\r\n"
             y << val.to_s
-          in true | false | Integer | Float | Symbol
+          in _ if primitive?(val)
             y << "Content-Type: text/plain\r\n\r\n"
             y << val.to_s
           else
@@ -471,6 +528,7 @@ module ModernTreasury
         private def encode_multipart_streaming(body)
           boundary = SecureRandom.urlsafe_base64(60)
 
+          closing = []
           strio = writable_enum do |y|
             case body
             in Hash
@@ -478,19 +536,20 @@ module ModernTreasury
                 case val
                 in Array if val.all? { primitive?(_1) }
                   val.each do |v|
-                    write_multipart_chunk(y, boundary: boundary, key: key, val: v)
+                    write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
                 else
-                  write_multipart_chunk(y, boundary: boundary, key: key, val: val)
+                  write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing)
                 end
               end
             else
-              write_multipart_chunk(y, boundary: boundary, key: nil, val: body)
+              write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing)
             end
             y << "--#{boundary}--\r\n"
           end
 
-          [boundary, strio]
+          fused_io = fused_enum(strio) { closing.each(&:call) }
+          [boundary, fused_io]
         end
 
         # @api private
@@ -501,21 +560,21 @@ module ModernTreasury
         # @return [Object]
         def encode_content(headers, body)
           content_type = headers["content-type"]
+          body = body.inner if body.is_a?(ModernTreasury::Internal::Util::SerializationAdapter)
+
           case [content_type, body]
-          in [%r{^application/(?:vnd\.api\+)?json}, _] unless body.nil?
+          in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.fast_generate(body)]
-          in [%r{^application/(?:x-)?jsonl}, Enumerable]
+          in [%r{^application/(?:x-)?jsonl}, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO)
             [headers, body.lazy.map { JSON.fast_generate(_1) }]
-          in [%r{^multipart/form-data}, Hash | IO | StringIO]
+          in [%r{^multipart/form-data}, Hash | Pathname | StringIO | IO]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
             [headers, strio]
-          in [_, IO]
-            [headers, body.tap(&:rewind)]
-          in [_, StringIO]
-            [headers, body.string]
           in [_, Symbol | Numeric]
             [headers, body.to_s]
+          in [_, StringIO]
+            [headers, body.string]
           else
             [headers, body]
           end
@@ -523,6 +582,27 @@ module ModernTreasury
 
         # @api private
         #
+        # https://www.iana.org/assignments/character-sets/character-sets.xhtml
+        #
+        # @param content_type [String]
+        # @param text [String]
+        def force_charset!(content_type, text:)
+          charset = /charset=([^;\s]+)/.match(content_type)&.captures&.first
+
+          return unless charset
+
+          begin
+            encoding = Encoding.find(charset)
+            text.force_encoding(encoding)
+          rescue ArgumentError
+            nil
+          end
+        end
+
+        # @api private
+        #
+        # Assumes each chunk in stream has `Encoding::BINARY`.
+        #
         # @param headers [Hash{String=>String}, Net::HTTPHeader]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
@@ -530,7 +610,7 @@ module ModernTreasury
         # @raise [JSON::ParserError]
         # @return [Object]
         def decode_content(headers, stream:, suppress_error: false)
-          case headers["content-type"]
+          case (content_type = headers["content-type"])
           in %r{^application/(?:vnd\.api\+)?json}
             json = stream.to_a.join
             begin
@@ -547,11 +627,10 @@ module ModernTreasury
           in %r{^text/event-stream}
             lines = decode_lines(stream)
             decode_sse(lines)
-          in %r{^text/}
-            stream.to_a.join
           else
-            # TODO: parsing other response types
-            StringIO.new(stream.to_a.join)
+            text = stream.to_a.join
+            force_charset!(content_type, text: text)
+            StringIO.new(text)
           end
         end
       end
@@ -616,12 +695,17 @@ module ModernTreasury
       class << self
         # @api private
         #
+        # Assumes Strings have been forced into having `Encoding::BINARY`.
+        #
+        # This decoder is responsible for reassembling lines split across multiple
+        # fragments.
+        #
         # @param enum [Enumerable<String>]
         #
         # @return [Enumerable<String>]
         def decode_lines(enum)
           re = /(\r\n|\r|\n)/
-          buffer = String.new.b
+          buffer = String.new
           cr_seen = nil
 
           chain_fused(enum) do |y|
@@ -652,6 +736,8 @@ module ModernTreasury
         #
         # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
         #
+        # Assumes that `lines` has been decoded with `#decode_lines`.
+        #
         # @param lines [Enumerable<String>]
         #
         # @return [Enumerable<Hash{Symbol=>Object}>]
@@ -675,7 +761,7 @@ module ModernTreasury
                 in "event"
                   current.merge!(event: value)
                 in "data"
-                  (current[:data] ||= String.new.b) << (value << "\n")
+                  (current[:data] ||= String.new) << (value << "\n")
                 in "id" unless value.include?("\0")
                   current.merge!(id: value)
                 in "retry" if /^\d+$/ =~ value

data/lib/modern_treasury/internal.rb

@@ -3,6 +3,10 @@
 module ModernTreasury
   # @api private
   module Internal
-    OMIT = Object.new.freeze
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{ModernTreasury::Internal}::OMIT>" }
+      end
+        .freeze
   end
 end

data/lib/modern_treasury/models/document_create_params.rb

@@ -21,8 +21,8 @@ module ModernTreasury
 
       # @!attribute file
       #
-      #   @return [IO, StringIO]
-      required :file, IO
+      #   @return [Pathname, StringIO]
+      required :file, ModernTreasury::Internal::Type::IOLike
 
       # @!attribute [r] document_type
       #   A category given to the document, can be `null`.
@@ -37,7 +37,7 @@ module ModernTreasury
       # @!parse
       #   # @param documentable_id [String]
       #   # @param documentable_type [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
-      #   # @param file [IO, StringIO]
+      #   # @param file [Pathname, StringIO]
       #   # @param document_type [String]
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #

data/lib/modern_treasury/models/payment_order_create_params.rb

@@ -496,8 +496,8 @@ module ModernTreasury
 
         # @!attribute file
         #
-        #   @return [IO, StringIO]
-        required :file, IO
+        #   @return [Pathname, StringIO]
+        required :file, ModernTreasury::Internal::Type::IOLike
 
         # @!attribute [r] document_type
         #   A category given to the document, can be `null`.
@@ -512,7 +512,7 @@ module ModernTreasury
         # @!parse
         #   # @param documentable_id [String]
         #   # @param documentable_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Document::DocumentableType]
-        #   # @param file [IO, StringIO]
+        #   # @param file [Pathname, StringIO]
         #   # @param document_type [String]
         #   #
         #   def initialize(documentable_id:, documentable_type:, file:, document_type: nil, **) = super

data/lib/modern_treasury/resources/documents.rb

@@ -9,7 +9,7 @@ module ModernTreasury
       #
       # @param documentable_id [String]
       # @param documentable_type [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
-      # @param file [IO, StringIO]
+      # @param file [Pathname, StringIO]
       # @param document_type [String]
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/modern_treasury/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  VERSION = "0.1.0.pre.alpha.17"
+  VERSION = "0.1.0.pre.alpha.18"
 end

data/lib/modern_treasury.rb

@@ -40,6 +40,7 @@ require_relative "modern_treasury/internal/util"
 require_relative "modern_treasury/internal/type/converter"
 require_relative "modern_treasury/internal/type/unknown"
 require_relative "modern_treasury/internal/type/boolean"
+require_relative "modern_treasury/internal/type/io_like"
 require_relative "modern_treasury/internal/type/enum"
 require_relative "modern_treasury/internal/type/union"
 require_relative "modern_treasury/internal/type/array_of"

data/rbi/lib/modern_treasury/client.rbi

@@ -160,8 +160,9 @@ module ModernTreasury
       api_key: ENV["MODERN_TREASURY_API_KEY"],
       # Defaults to `ENV["MODERN_TREASURY_ORGANIZATION_ID"]`
       organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"],
-      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
-      base_url: nil,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERN_TREASURY_BASE_URL"]`
+      base_url: ENV["MODERN_TREASURY_BASE_URL"],
       # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,

data/rbi/lib/modern_treasury/internal/page.rbi

@@ -22,6 +22,7 @@ module ModernTreasury
       sig { override.params(blk: T.proc.params(arg0: Elem).void).void }
       def auto_paging_each(&blk); end
 
+      # @api private
       sig { returns(String) }
       def inspect; end
     end