lithic 0.1.0.pre.alpha.11 → 0.1.0.pre.alpha.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8345e32a155e6a1e033d160c478dbc15e245cf60f62f03e21dbc56db982e44e
-  data.tar.gz: 9e5cbced2f15565f0c0dc8b0f80f3d87034c546d07fff2a4076128d389b91ddd
+  metadata.gz: 488e7e7c02bda44d666c79ab398ee65c00d5994049f4aa48439bdb344330fbb6
+  data.tar.gz: 7ff630d6290e4abe4304cc2bde7325650d83d2e7b710ac1b93536e22ce8e1351
 SHA512:
-  metadata.gz: 11cc54d6e196f755a4ac4bf058799851a598a6c8d25f33989b5f0b6d4e11af50eb2199d61d0aa411ef998ebb0a85b6ee723490b721e38e59ec1e14ba5998ca72
-  data.tar.gz: 99cc29235b0673eea35abd9bd020c57f009b9307ef4d184029944f6ab066a15358a8347617d06e5fd9816e2b07aadaedd7b5a9d14a2476bada3548474f5d8f64
+  metadata.gz: b88593452a1e5a38014849baf782b3030d41bce4fb0b19c3656172590fc381a12892dc7c597d6e9a718560be4be2c083a5d2967140f463aafcf43e493af48d3f
+  data.tar.gz: c72e9785ce3b02549023b34b8d8e2a5c3616928ae0bf964f85c8ed7e25e3f2bfa88e97830af80ae7e1c9a107b918eeab7a534c3576360267657d1300fafca04f

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.1.0-alpha.12 (2025-04-17)
+
+Full Changelog: [v0.1.0-alpha.11...v0.1.0-alpha.12](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.11...v0.1.0-alpha.12)
+
+### Features
+
+* **client:** enable setting base URL from environment variable ([4f4585e](https://github.com/lithic-com/lithic-ruby/commit/4f4585e1557f60480629b83e6e2850f6b4a5dc98))
+
+
+### Bug Fixes
+
+* **client:** send correct HTTP path ([743cdc2](https://github.com/lithic-com/lithic-ruby/commit/743cdc28a16b5cfd724bf5b66cd699c840af8bad))
+
+
+### Chores
+
+* **internal:** always run post-processing when formatting when syntax_tree ([cfb9196](https://github.com/lithic-com/lithic-ruby/commit/cfb9196cccd8dea098fc52678e0eb2c777b0f900))
+* **internal:** codegen related update ([c743e5d](https://github.com/lithic-com/lithic-ruby/commit/c743e5dd161480e7d3bf5305fb1135137b55d7de))
+* **internal:** loosen internal type restrictions ([be1ae99](https://github.com/lithic-com/lithic-ruby/commit/be1ae999e5f9c36ed16367dfd9a9d0be4115b108))
+* **internal:** minor touch ups on sdk internals ([a9ff4a6](https://github.com/lithic-com/lithic-ruby/commit/a9ff4a6e7da32387c68195b1bdbfe683f63435ff))
+* **internal:** mostly README touch ups ([95ec3f1](https://github.com/lithic-com/lithic-ruby/commit/95ec3f10b027ca3be7dce6ffa2c45b9f8ba0b258))
+* **internal:** protect SSE parsing pipeline from broken UTF-8 characters ([810686a](https://github.com/lithic-com/lithic-ruby/commit/810686a28f0a1d4710c632be010912b2ae41316f))
+* make internal types pretty print ([eb5f0d9](https://github.com/lithic-com/lithic-ruby/commit/eb5f0d9f11b86370cfdca97b4a4716565a20c140))
+
+
+### Documentation
+
+* update documentation links to be more uniform ([6d246be](https://github.com/lithic-com/lithic-ruby/commit/6d246be6b7a3d16f4e8fb88980d2f53b45d85346))
+
 ## 0.1.0-alpha.11 (2025-04-11)
 
 Full Changelog: [v0.1.0-alpha.10...v0.1.0-alpha.11](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.10...v0.1.0-alpha.11)

data/README.md

@@ -4,9 +4,9 @@ The Lithic Ruby library provides convenient access to the Lithic REST API from a
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/lithic).
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/lithic).
 
-The underlying REST API documentation can be found on [docs.lithic.com](https://docs.lithic.com).
+The REST API documentation can be found on [docs.lithic.com](https://docs.lithic.com).
 
 ## Installation
 
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.1.0.pre.alpha.11"
+gem "lithic", "~> 0.1.0.pre.alpha.12"
 ```
 
 <!-- x-release-please-end -->

data/lib/lithic/client.rb

@@ -134,7 +134,8 @@ module Lithic
     # - `production` corresponds to `https://api.lithic.com`
     # - `sandbox` corresponds to `https://sandbox.lithic.com`
     #
-    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["LITHIC_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -146,21 +147,14 @@ module Lithic
     def initialize(
       api_key: ENV["LITHIC_API_KEY"],
       environment: nil,
-      base_url: nil,
+      base_url: ENV["LITHIC_BASE_URL"],
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: DEFAULT_MAX_RETRY_DELAY
     )
-      case [environment, base_url]
-      in [Symbol | String, String]
-        raise ArgumentError.new("both environment and base_url given, expected only one")
-      in [Symbol | String, nil]
-        base_url = ENVIRONMENTS.fetch(environment.to_sym) do
-          raise ArgumentError.new("environment must be one of #{ENVIRONMENTS.keys}, got #{environment}")
-        end
-      else
-        base_url ||= ENVIRONMENTS.fetch(:production)
+      base_url ||= ENVIRONMENTS.fetch(environment || :production) do
+        raise ArgumentError.new("environment must be one of #{ENVIRONMENTS.keys}, got #{environment}")
       end
 
       if api_key.nil?

data/lib/lithic/internal/cursor_page.rb

@@ -22,29 +22,6 @@ module Lithic
       # @return [Boolean]
       attr_accessor :has_more
 
-      # @api private
-      #
-      # @param client [Lithic::Internal::Transport::BaseClient]
-      # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
-      # @param page_data [Hash{Symbol=>Object}]
-      def initialize(client:, req:, headers:, page_data:)
-        super
-        model = req.fetch(:model)
-
-        case page_data
-        in {data: Array | nil => data}
-          @data = data&.map { Lithic::Internal::Type::Converter.coerce(model, _1) }
-        else
-        end
-
-        case page_data
-        in {has_more: true | false => has_more}
-          @has_more = has_more
-        else
-        end
-      end
-
       # @return [Boolean]
       def next_page?
         has_more
@@ -69,17 +46,40 @@ module Lithic
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
         end
+
         page = self
         loop do
-          page.data&.each { blk.call(_1) }
+          page.data&.each(&blk)
+
           break unless page.next_page?
           page = page.next_page
         end
       end
 
+      # @api private
+      #
+      # @param client [Lithic::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array | nil => data}
+          @data = data&.map { Lithic::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        @has_more = page_data[:has_more]
+      end
+
+      # @api private
+      #
       # @return [String]
       def inspect
-        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} has_more=#{has_more.inspect}>"
+        model = Lithic::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} has_more=#{has_more.inspect}>"
       end
     end
   end

data/lib/lithic/internal/single_page.rb

@@ -22,29 +22,6 @@ module Lithic
       # @return [Boolean]
       attr_accessor :has_more
 
-      # @api private
-      #
-      # @param client [Lithic::Internal::Transport::BaseClient]
-      # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
-      # @param page_data [Array<Object>]
-      def initialize(client:, req:, headers:, page_data:)
-        super
-        model = req.fetch(:model)
-
-        case page_data
-        in {data: Array | nil => data}
-          @data = data&.map { Lithic::Internal::Type::Converter.coerce(model, _1) }
-        else
-        end
-
-        case page_data
-        in {has_more: true | false => has_more}
-          @has_more = has_more
-        else
-        end
-      end
-
       # @return [Boolean]
       def next_page?
         has_more
@@ -63,17 +40,40 @@ module Lithic
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
         end
+
         page = self
         loop do
-          page.data&.each { blk.call(_1) }
+          page.data&.each(&blk)
+
           break unless page.next_page?
           page = page.next_page
         end
       end
 
+      # @api private
+      #
+      # @param client [Lithic::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Array<Object>]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array | nil => data}
+          @data = data&.map { Lithic::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        @has_more = page_data[:has_more]
+      end
+
+      # @api private
+      #
       # @return [String]
       def inspect
-        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} has_more=#{has_more.inspect}>"
+        model = Lithic::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} has_more=#{has_more.inspect}>"
       end
     end
   end

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

@@ -93,7 +93,11 @@ module Lithic
                 URI.join(url, response_headers["location"])
               rescue ArgumentError
                 message = "Server responded with status #{status} but no valid location header."
-                raise Lithic::Errors::APIConnectionError.new(url: url, message: message)
+                raise Lithic::Errors::APIConnectionError.new(
+                  url: url,
+                  response: response_headers,
+                  message: message
+                )
               end
 
             request = {**request, url: location}
@@ -101,7 +105,11 @@ module Lithic
             case [url.scheme, location.scheme]
             in ["https", "http"]
               message = "Tried to redirect to a insecure URL"
-              raise Lithic::Errors::APIConnectionError.new(url: url, message: message)
+              raise Lithic::Errors::APIConnectionError.new(
+                url: url,
+                response: response_headers,
+                message: message
+              )
             else
               nil
             end
@@ -350,7 +358,7 @@ module Lithic
             self.class.reap_connection!(status, stream: stream)
 
             message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects."
-            raise Lithic::Errors::APIConnectionError.new(url: url, message: message)
+            raise Lithic::Errors::APIConnectionError.new(url: url, response: response, message: message)
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
@@ -460,6 +468,8 @@ module Lithic
           end
         end
 
+        # @api private
+        #
         # @return [String]
         def inspect
           # rubocop:disable Layout/LineLength

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

@@ -57,11 +57,15 @@ module Lithic
           # @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.to_s
+              url
             )
 
             headers.each { req[_1] = _2 }
@@ -149,7 +153,7 @@ module Lithic
                 break if finished
 
                 rsp.read_body do |bytes|
-                  y << bytes
+                  y << bytes.force_encoding(Encoding::BINARY)
                   break if finished
 
                   self.class.calibrate_socket_timeout(conn, deadline)

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.11"
+  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

data/rbi/lib/lithic/internal/type/io_like.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(
                 StringIO,
@@ -33,7 +32,7 @@ module Lithic
           def coerce(value, state:); end
 
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(
                 value: T.any(Pathname, StringIO, IO, String, T.anything),

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

@@ -63,6 +63,10 @@ module Lithic
           ).returns(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/unknown.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.anything, state: Lithic::Internal::Type::Converter::CoerceState)
               .returns(T.anything)
@@ -28,7 +27,7 @@ module Lithic
           def coerce(value, state:); end
 
           # @api private
-          sig(:final) do
+          sig do
             override.params(
               value: T.anything,
               state: Lithic::Internal::Type::Converter::DumpState

data/rbi/lib/lithic/internal/util.rbi

@@ -215,6 +215,14 @@ module Lithic
         def encode_content(headers, body); end
 
         # @api private
+        #
+        # https://www.iana.org/assignments/character-sets/character-sets.xhtml
+        sig { params(content_type: String, text: String).void }
+        def force_charset!(content_type, text:); end
+
+        # @api private
+        #
+        # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
             headers: T.any(T::Hash[String, String], Net::HTTPHeader),
@@ -263,12 +271,19 @@ 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.
         sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) }
         def decode_lines(enum); end
 
         # @api private
         #
         # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+        #
+        # Assumes that `lines` has been decoded with `#decode_lines`.
         sig do
           params(lines: T::Enumerable[String]).returns(T::Enumerable[Lithic::Internal::Util::ServerSentEvent])
         end

data/rbi/lib/lithic/internal.rbi

@@ -7,6 +7,6 @@ module Lithic
     # this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
 
-    OMIT = T.let(T.anything, T.anything)
+    OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

data/sig/lithic/internal/type/array_of.rbs

@@ -35,6 +35,8 @@ module Lithic
           | Lithic::Internal::Type::Converter::input type_info,
           ?::Hash[Symbol, top] spec
         ) -> void
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/lithic/internal/type/base_model.rbs

@@ -75,6 +75,8 @@ module Lithic
 
         def initialize: (?::Hash[Symbol, top] | self data) -> void
 
+        def self.inspect: (?depth: Integer) -> String
+
         def inspect: -> String
       end
     end

data/sig/lithic/internal/type/converter.rbs

@@ -23,6 +23,8 @@ module Lithic
           state: Lithic::Internal::Type::Converter::dump_state
         ) -> top
 
+        def inspect: (?depth: Integer) -> String
+
         def self.type_info: (
           {
             const: (nil | bool | Integer | Float | Symbol)?,
@@ -44,6 +46,8 @@ module Lithic
           top value,
           ?state: Lithic::Internal::Type::Converter::dump_state
         ) -> top
+
+        def self.inspect: (top target, depth: Integer) -> String
       end
     end
   end

data/sig/lithic/internal/type/enum.rbs

@@ -21,6 +21,8 @@ module Lithic
           Symbol | top value,
           state: Lithic::Internal::Type::Converter::dump_state
         ) -> (Symbol | top)
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/lithic/internal/type/hash_of.rbs

@@ -35,6 +35,8 @@ module Lithic
           | Lithic::Internal::Type::Converter::input type_info,
           ?::Hash[Symbol, top] spec
         ) -> void
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/lithic/internal/type/union.rbs

@@ -39,6 +39,8 @@ module Lithic
           top value,
           state: Lithic::Internal::Type::Converter::dump_state
         ) -> top
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/lithic/internal/util.rbs

@@ -120,6 +120,8 @@ module Lithic
         top body
       ) -> top
 
+      def self?.force_charset!: (String content_type, text: String) -> void
+
       def self?.decode_content: (
         ::Hash[String, String] headers,
         stream: Enumerable[String],

data/sig/lithic/internal.rbs

@@ -1,5 +1,5 @@
 module Lithic
   module Internal
-    OMIT: top
+    OMIT: Object
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lithic
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.11
+  version: 0.1.0.pre.alpha.12
 platform: ruby
 authors:
 - Lithic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool