lithic 0.1.0.pre.alpha.10 → 0.1.0.pre.alpha.12

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

@@ -13,6 +13,10 @@ module Lithic
       class ArrayOf
         include Lithic::Internal::Type::Converter
 
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
         # @param type_info [Hash{Symbol=>Object}, Proc, Lithic::Internal::Type::Converter, Class]
         #
         # @param spec [Hash{Symbol=>Object}] .
@@ -24,7 +28,7 @@ module Lithic
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
-        def self.[](type_info, spec = {}) = new(type_info, spec)
+        def self.[](...) = new(...)
 
         # @param other [Object]
         #
@@ -120,7 +124,18 @@ module Lithic
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = Lithic::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 = Lithic::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
+
+          "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]"
         end
       end
     end

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

@@ -63,7 +63,7 @@ module Lithic
 
             setter = "#{name_sym}="
             api_name = info.fetch(:api_name, name_sym)
-            nilable = info[:nil?]
+            nilable = info.fetch(:nil?, false)
             const = required && !nilable ? info.fetch(:const, Lithic::Internal::OMIT) : Lithic::Internal::OMIT
 
             [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
@@ -361,14 +361,42 @@ module Lithic
           end
         end
 
+        class << self
+          # @api private
+          #
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(depth: 0)
+            return super() if depth.positive?
+
+            depth = depth.succ
+            deferred = fields.transform_values do |field|
+              type, required, nilable = field.fetch_values(:type, :required, :nilable)
+              -> do
+                [
+                  Lithic::Internal::Type::Converter.inspect(type, depth: depth),
+                  !required || nilable ? "nil" : nil
+                ].compact.join(" | ")
+              end
+                .tap { _1.define_singleton_method(:inspect) { call } }
+            end
+
+            "#{name}[#{deferred.inspect}]"
+          end
+        end
+
+        # @api private
+        #
         # @return [String]
         def inspect
-          rows = self.class.known_fields.keys.map do
-            "#{_1}=#{@data.key?(_1) ? public_send(_1) : ''}"
+          rows = @data.map do
+            "#{_1}=#{self.class.known_fields.key?(_1) ? public_send(_1).inspect : ''}"
           rescue Lithic::Errors::ConversionError
-            "#{_1}=#{@data.fetch(_1)}"
+            "#{_1}=#{_2.inspect}"
           end
-          "#<#{self.class.name}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
+
+          "#<#{self.class}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
         end
       end
     end

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

@@ -36,6 +36,7 @@ module Lithic
         def initialize(client:, req:, headers:, page_data:)
           @client = client
           @req = req
+          @model = req.fetch(:model)
           super()
         end
 

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

@@ -11,6 +11,8 @@ module Lithic
       class Boolean
         extend Lithic::Internal::Type::Converter
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

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

@@ -49,6 +49,15 @@ module Lithic
           end
         end
 
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          super()
+        end
+
         # rubocop:enable Lint/UnusedMethodArgument
 
         class << self
@@ -240,6 +249,21 @@ module Lithic
               Lithic::Internal::Type::Unknown.dump(value, state: state)
             end
           end
+
+          # @api private
+          #
+          # @param target [Object]
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(target, depth:)
+            case target
+            in Lithic::Internal::Type::Converter
+              target.inspect(depth: depth.succ)
+            else
+              target.inspect
+            end
+          end
         end
       end
     end

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

@@ -58,9 +58,9 @@ module Lithic
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
-          other.is_a?(Module) && other.singleton_class <= Lithic::Internal::Type::Enum && other.values.to_set == values.to_set
-          # rubocop:enable Layout/LineLength
+          # rubocop:disable Style/CaseEquality
+          Lithic::Internal::Type::Enum === other && other.values.to_set == values.to_set
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -103,6 +103,22 @@ module Lithic
         #   #
         #   # @return [Symbol, Object]
         #   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 { Lithic::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/lithic/internal/type/hash_of.rb

@@ -13,6 +13,10 @@ module Lithic
       class HashOf
         include Lithic::Internal::Type::Converter
 
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
         # @param type_info [Hash{Symbol=>Object}, Proc, Lithic::Internal::Type::Converter, Class]
         #
         # @param spec [Hash{Symbol=>Object}] .
@@ -24,7 +28,7 @@ module Lithic
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
-        def self.[](type_info, spec = {}) = new(type_info, spec)
+        def self.[](...) = new(...)
 
         # @param other [Object]
         #
@@ -140,7 +144,18 @@ module Lithic
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = Lithic::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 = Lithic::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
+
+          "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]"
         end
       end
     end

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

@@ -11,6 +11,8 @@ module Lithic
       class IOLike
         extend Lithic::Internal::Type::Converter
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

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

@@ -111,9 +111,7 @@ module Lithic
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
-          other.is_a?(Module) && other.singleton_class <= Lithic::Internal::Type::Union && other.derefed_variants == derefed_variants
-          # rubocop:enable Layout/LineLength
+          Lithic::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
         # @api private
@@ -196,6 +194,22 @@ module Lithic
 
         # 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 { Lithic::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/lithic/internal/type/unknown.rb

@@ -13,6 +13,8 @@ module Lithic
 
         # rubocop:disable Lint/UnusedMethodArgument
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

data/lib/lithic/internal/util.rb

@@ -448,7 +448,7 @@ module Lithic
             else
               src
             end
-          @buf = String.new.b
+          @buf = String.new
           @blk = blk
         end
       end
@@ -460,7 +460,7 @@ module Lithic
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new.b
+            buf = String.new
             y.define_singleton_method(:write) do
               self << buf.replace(_1)
               buf.bytesize
@@ -582,6 +582,27 @@ module Lithic
 
         # @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]
@@ -589,7 +610,7 @@ module Lithic
         # @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
@@ -606,11 +627,10 @@ module Lithic
           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
@@ -675,12 +695,17 @@ module Lithic
       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|
@@ -711,6 +736,8 @@ module Lithic
         #
         # 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}>]
@@ -734,7 +761,7 @@ module Lithic
                 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/lithic/internal.rb

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

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.10"
+  VERSION = "0.1.0.pre.alpha.12"
 end

data/rbi/lib/lithic/client.rbi

@@ -128,8 +128,9 @@ module Lithic
       # - `production` corresponds to `https://api.lithic.com`
       # - `sandbox` corresponds to `https://sandbox.lithic.com`
       environment: nil,
-      # 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["LITHIC_BASE_URL"]`
+      base_url: ENV["LITHIC_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/lithic/internal/cursor_page.rbi

@@ -13,6 +13,7 @@ module Lithic
       sig { returns(T::Boolean) }
       attr_accessor :has_more
 
+      # @api private
       sig { returns(String) }
       def inspect; end
     end

data/rbi/lib/lithic/internal/single_page.rbi

@@ -13,6 +13,7 @@ module Lithic
       sig { returns(T::Boolean) }
       attr_accessor :has_more
 
+      # @api private
       sig { returns(String) }
       def inspect; end
     end

data/rbi/lib/lithic/internal/transport/base_client.rbi

@@ -190,6 +190,7 @@ module Lithic
           model: Lithic::Internal::Type::Unknown,
           options: {}
         ); end
+        # @api private
         sig { returns(String) }
         def inspect; end
       end

data/rbi/lib/lithic/internal/type/array_of.rbi

@@ -10,11 +10,10 @@ module Lithic
         include Lithic::Internal::Type::Converter
 
         abstract!
-        final!
 
         Elem = type_member(:out)
 
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Lithic::Internal::AnyHash,
@@ -27,14 +26,14 @@ module Lithic
         end
         def self.[](type_info, spec = {}); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Array[T.anything], T.anything),
@@ -45,7 +44,7 @@ module Lithic
         def coerce(value, state:); end
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Array[T.anything], T.anything),
@@ -56,15 +55,15 @@ module Lithic
         def dump(value, state:); end
 
         # @api private
-        sig(:final) { returns(Elem) }
+        sig { returns(Elem) }
         protected def item_type; end
 
         # @api private
-        sig(:final) { returns(T::Boolean) }
+        sig { returns(T::Boolean) }
         protected def nilable?; end
 
         # @api private
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Lithic::Internal::AnyHash,
@@ -76,6 +75,10 @@ module Lithic
             .void
         end
         def initialize(type_info, spec = {}); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
       end
     end
   end

data/rbi/lib/lithic/internal/type/base_model.rbi

@@ -185,6 +185,13 @@ module Lithic
         sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) }
         def self.new(data = {}); end
 
+        class << self
+          # @api private
+          sig { params(depth: Integer).returns(String) }
+          def inspect(depth: 0); end
+        end
+
+        # @api private
         sig { returns(String) }
         def inspect; end
       end

data/rbi/lib/lithic/internal/type/boolean.rbi

@@ -10,17 +10,16 @@ module Lithic
         extend Lithic::Internal::Type::Converter
 
         abstract!
-        final!
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.==(other); end
 
         class << self
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(value: T.any(
                 T::Boolean,
@@ -32,7 +31,7 @@ module Lithic
           def coerce(value, state:); end
 
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(value: T.any(
                 T::Boolean,

data/rbi/lib/lithic/internal/type/converter.rbi

@@ -34,6 +34,10 @@ module Lithic
         end
         def dump(value, state:); end
 
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
+
         class << self
           # @api private
           sig do
@@ -105,6 +109,10 @@ module Lithic
               .returns(T.anything)
           end
           def self.dump(target, value, state: {can_retry: true}); end
+
+          # @api private
+          sig { params(target: T.anything, depth: Integer).returns(String) }
+          def self.inspect(target, depth:); end
         end
       end
     end

data/rbi/lib/lithic/internal/type/enum.rbi

@@ -57,6 +57,10 @@ module Lithic
             .returns(T.any(Symbol, T.anything))
         end
         def dump(value, state:); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
       end
     end
   end

data/rbi/lib/lithic/internal/type/hash_of.rbi

@@ -10,11 +10,10 @@ module Lithic
         include Lithic::Internal::Type::Converter
 
         abstract!
-        final!
 
         Elem = type_member(:out)
 
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Lithic::Internal::AnyHash,
@@ -27,14 +26,14 @@ module Lithic
         end
         def self.[](type_info, spec = {}); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Hash[T.anything, T.anything], T.anything),
@@ -45,7 +44,7 @@ module Lithic
         def coerce(value, state:); end
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Hash[T.anything, T.anything], T.anything),
@@ -56,15 +55,15 @@ module Lithic
         def dump(value, state:); end
 
         # @api private
-        sig(:final) { returns(Elem) }
+        sig { returns(Elem) }
         protected def item_type; end
 
         # @api private
-        sig(:final) { returns(T::Boolean) }
+        sig { returns(T::Boolean) }
         protected def nilable?; end
 
         # @api private
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Lithic::Internal::AnyHash,
@@ -76,6 +75,10 @@ module Lithic
             .void
         end
         def initialize(type_info, spec = {}); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
       end
     end
   end