lithic 0.1.0.pre.alpha.6 → 0.1.0.pre.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc0455f8a47c113c091409b3b4ed5b5522a3ae3c2272f68701084ffbb4b35bf
-  data.tar.gz: 1bc14153bdcce95840ab82520a99ca49f9a943850313c0f73fa15a2a8d4cfc94
+  metadata.gz: cffcad507449a6e55f01ed7851a9c6912a40990c5b944c4f936333ae40767460
+  data.tar.gz: c0786e5614e6db99716bcb406919d7c7a461416595ad7265e28f95590eab3fdf
 SHA512:
-  metadata.gz: f8c91140b58743c9972ebb4d79a003844f242f076056a3c1ce7052125ec5c6941bf1033972b23f9c8637768123abc450c32efa651ea59c9acf571c673b021f14
-  data.tar.gz: 12ccc695ebb93e4df2aa828dbff4bece059d99ddd249dfa7e837229c01ca196a5a7956d832fc01557ffa33a524231e880aea6c8578d238713b58161b7cf1c04e
+  metadata.gz: bd4805426b8018a320598907b4a45c22b8b392fa1d623154ae9034252f8485aaeca6bfd6e79969538992fc0c8f679651554fdd36af8ba8a2d5abc08e64dd094f
+  data.tar.gz: '0861a2ac0c6b712cd745f857bc16c740ca39e4ea8317cad315446335637cafc38c77bbcbea45883fa718f8edc5d5781cdd1e0d6310feb4a8186d47b4cdeba62d'

data/README.md

@@ -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.5"
+gem "lithic", "~> 0.1.0.pre.alpha.7"
 ```
 
 <!-- x-release-please-end -->
@@ -141,6 +141,13 @@ After Solargraph is installed, **you must populate its index** either via the pr
 bundle exec solargraph gems
 ```
 
+Note: if you had installed the gem either using a `git:` or `github:` URL, or had vendored the gem using bundler, you will need to set up your [`.solargraph.yml`](https://solargraph.org/guides/configuration) to include the path to the gem's `lib` directory.
+
+```yaml
+include:
+  - 'vendor/bundle/ruby/*/gems/lithic-*/lib/**/*.rb'
+```
+
 Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
 
 ### Sorbet

data/lib/lithic/client.rb

@@ -129,10 +129,10 @@ module Lithic
     #
     # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
     #
-    #   Each environment maps to a different base URL:
+    # Each environment maps to a different base URL:
     #
-    #   - `production` corresponds to `https://api.lithic.com`
-    #   - `sandbox` corresponds to `https://sandbox.lithic.com`
+    # - `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/"`
     #

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

@@ -380,7 +380,7 @@ module Lithic
           in (400..) | Lithic::Errors::APIConnectionError
             self.class.reap_connection!(status, stream: stream)
 
-            delay = retry_delay(response, retry_count: retry_count)
+            delay = retry_delay(response || {}, retry_count: retry_count)
             sleep(delay)
 
             send_request(
@@ -393,7 +393,7 @@ module Lithic
         end
 
         # Execute the request specified by `req`. This is the method that all resource
-        #   methods call into.
+        # methods call into.
         #
         # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Lithic::Internal::Type::Unknown, options: {})
         #

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

@@ -6,7 +6,7 @@ module Lithic
       # @api private
       class PooledNetRequester
         # from the golang stdlib
-        #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
         class << self
@@ -54,7 +54,7 @@ module Lithic
           # @param blk [Proc]
           #
           # @yieldparam [String]
-          # @return [Net::HTTPGenericRequest]
+          # @return [Array(Net::HTTPGenericRequest, Proc)]
           def build_request(request, &blk)
             method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
             req = Net::HTTPGenericRequest.new(
@@ -75,12 +75,12 @@ module Lithic
             in StringIO
               req["content-length"] ||= body.size.to_s unless req["transfer-encoding"]
               req.body_stream = Lithic::Internal::Util::ReadIOAdapter.new(body, &blk)
-            in IO | Enumerator
+            in Pathname | IO | Enumerator
               req["transfer-encoding"] ||= "chunked" unless req["content-length"]
               req.body_stream = Lithic::Internal::Util::ReadIOAdapter.new(body, &blk)
             end
 
-            req
+            [req, req.body_stream&.method(:close)]
           end
         end
 
@@ -123,13 +123,17 @@ module Lithic
         def execute(request)
           url, deadline = request.fetch_values(:url, :deadline)
 
+          req = nil
           eof = false
           finished = false
+          closing = nil
+
+          # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
             with_pool(url, deadline: deadline) do |conn|
               next if finished
 
-              req = self.class.build_request(request) do
+              req, closing = self.class.build_request(request) do
                 self.class.calibrate_socket_timeout(conn, deadline)
               end
 
@@ -154,8 +158,11 @@ module Lithic
               end
             end
           rescue Timeout::Error
-            raise Lithic::Errors::APITimeoutError
+            raise Lithic::Errors::APITimeoutError.new(url: url, request: req)
+          rescue StandardError
+            raise Lithic::Errors::APIConnectionError.new(url: url, request: req)
           end
+          # rubocop:enable Metrics/BlockLength
 
           conn, _, response = enum.next
           body = Lithic::Internal::Util.fused_enum(enum, external: true) do
@@ -165,7 +172,9 @@ module Lithic
             rescue StopIteration
               nil
             end
+          ensure
             conn.finish if !eof && conn&.started?
+            closing&.call
           end
           [Integer(response.code), response, (response.body = body)]
         end

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

@@ -79,10 +79,20 @@ module Lithic
         #
         # @param value [Array<Object>, Object]
         #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean] :can_retry
+        #
         # @return [Array<Object>, Object]
-        def dump(value)
+        def dump(value, state:)
           target = item_type
-          value.is_a?(Array) ? value.map { Lithic::Internal::Type::Converter.dump(target, _1) } : super
+          if value.is_a?(Array)
+            value.map do
+              Lithic::Internal::Type::Converter.dump(target, _1, state: state)
+            end
+          else
+            super
+          end
         end
 
         # @api private

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

@@ -19,7 +19,7 @@ module Lithic
           # @api private
           #
           # Assumes superclass fields are totally defined before fields are accessed /
-          #   defined on subclasses.
+          # defined on subclasses.
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
           def known_fields
@@ -143,7 +143,7 @@ module Lithic
           # @api private
           #
           # `request_only` attributes not excluded from `.#coerce` when receiving responses
-          #   even if well behaved servers should not send them
+          # even if well behaved servers should not send them
           #
           # @param blk [Proc]
           private def request_only(&blk)
@@ -252,36 +252,37 @@ module Lithic
           #
           # @param value [Lithic::Internal::Type::BaseModel, Object]
           #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
           # @return [Hash{Object=>Object}, Object]
-          def dump(value)
+          def dump(value, state:)
             unless (coerced = Lithic::Internal::Util.coerce_hash(value)).is_a?(Hash)
               return super
             end
 
-            is_param = singleton_class <= Lithic::Internal::Type::RequestParameters::Converter
             acc = {}
 
             coerced.each do |key, val|
               name = key.is_a?(String) ? key.to_sym : key
               case (field = known_fields[name])
               in nil
-                acc.store(name, super(val))
+                acc.store(name, super(val, state: state))
               else
-                mode, type_fn = field.fetch_values(:mode, :type_fn)
+                api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn)
                 case mode
                 in :coerce
                   next
                 else
                   target = type_fn.call
-                  api_name = is_param ? name : field.fetch(:api_name)
-                  acc.store(api_name, Lithic::Internal::Type::Converter.dump(target, val))
+                  acc.store(api_name, Lithic::Internal::Type::Converter.dump(target, val, state: state))
                 end
               end
             end
 
-            known_fields.each do |name, field|
-              mode, const = field.fetch_values(:mode, :const)
-              api_name = is_param ? name : field.fetch(:api_name)
+            known_fields.each_value do |field|
+              api_name, mode, const = field.fetch_values(:api_name, :mode, :const)
               next if mode == :coerce || acc.key?(api_name) || const == Lithic::Internal::OMIT
               acc.store(api_name, const)
             end
@@ -291,11 +292,11 @@ module Lithic
         end
 
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
-        #   returned.
+        # returned.
         #
-        #   It is valid to lookup keys that are not in the API spec, for example to access
-        #   undocumented features. This method does not parse response data into
-        #   higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
+        # It is valid to lookup keys that are not in the API spec, for example to access
+        # undocumented features. This method does not parse response data into
+        # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
         #
         # @param key [Symbol]
         #
@@ -310,12 +311,12 @@ module Lithic
 
         # 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
-        #   value indicates which values were ever set on the object. i.e. there will be a
-        #   key in this hash if they ever were, even if the set value was nil.
+        # Keys are Symbols and values are the raw values from the response. The return
+        # value indicates which values were ever set on the object. i.e. there will be a
+        # key in this hash if they ever were, even if the set value was nil.
         #
-        #   This method is not recursive. The returned value is shared by the object, so it
-        #   should not be mutated.
+        # This method is not recursive. The returned value is shared by the object, so it
+        # should not be mutated.
         #
         # @return [Hash{Symbol=>Object}]
         def to_h = @data
@@ -340,12 +341,12 @@ module Lithic
         # @param a [Object]
         #
         # @return [String]
-        def to_json(*a) = self.class.dump(self).to_json(*a)
+        def to_json(*a) = Lithic::Internal::Type::Converter.dump(self.class, self).to_json(*a)
 
         # @param a [Object]
         #
         # @return [String]
-        def to_yaml(*a) = self.class.dump(self).to_yaml(*a)
+        def to_yaml(*a) = Lithic::Internal::Type::Converter.dump(self.class, self).to_yaml(*a)
 
         # Create a new instance of a model.
         #

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

@@ -45,8 +45,12 @@ module Lithic
           #   #
           #   # @param value [Boolean, Object]
           #   #
+          #   # @param state [Hash{Symbol=>Object}] .
+          #   #
+          #   #   @option state [Boolean] :can_retry
+          #   #
           #   # @return [Boolean, Object]
-          #   def dump(value) = super
+          #   def dump(value, state:) = super
         end
       end
     end

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

@@ -3,7 +3,6 @@
 module Lithic
   module Internal
     module Type
-      # rubocop:disable Metrics/ModuleLength
       # @api private
       module Converter
         # rubocop:disable Lint/UnusedMethodArgument
@@ -27,15 +26,24 @@ module Lithic
         #
         # @param value [Object]
         #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean] :can_retry
+        #
         # @return [Object]
-        def dump(value)
+        def dump(value, state:)
           case value
           in Array
-            value.map { Lithic::Internal::Type::Unknown.dump(_1) }
+            value.map { Lithic::Internal::Type::Unknown.dump(_1, state: state) }
           in Hash
-            value.transform_values { Lithic::Internal::Type::Unknown.dump(_1) }
+            value.transform_values { Lithic::Internal::Type::Unknown.dump(_1, state: state) }
           in Lithic::Internal::Type::BaseModel
-            value.class.dump(value)
+            value.class.dump(value, state: state)
+          in StringIO
+            value.string
+          in Pathname | IO
+            state[:can_retry] = false if value.is_a?(IO)
+            Lithic::Internal::Util::SerializationAdapter.new(value)
           else
             value
           end
@@ -76,37 +84,37 @@ module Lithic
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
           #
-          #   1. if the given `value` conforms to `target` already, return the given `value`
-          #   2. if it's possible and safe to convert the given `value` to `target`, then the
-          #      converted value
-          #   3. otherwise, the given `value` unaltered
+          # 1. if the given `value` conforms to `target` already, return the given `value`
+          # 2. if it's possible and safe to convert the given `value` to `target`, then the
+          #    converted value
+          # 3. otherwise, the given `value` unaltered
           #
-          #   The coercion process is subject to improvement between minor release versions.
-          #   See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
+          # The coercion process is subject to improvement between minor release versions.
+          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
           #
           # @param target [Lithic::Internal::Type::Converter, Class]
           #
           # @param value [Object]
           #
           # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-          #   coercion strategy when we have to decide between multiple possible conversion
-          #   targets:
+          # coercion strategy when we have to decide between multiple possible conversion
+          # targets:
           #
-          #   - `true`: the conversion must be exact, with minimum coercion.
-          #   - `false`: the conversion can be approximate, with some coercion.
-          #   - `:strong`: the conversion must be exact, with no coercion, and raise an error
-          #     if not possible.
+          # - `true`: the conversion must be exact, with minimum coercion.
+          # - `false`: the conversion can be approximate, with some coercion.
+          # - `:strong`: the conversion must be exact, with no coercion, and raise an error
+          #   if not possible.
           #
-          #   The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          #   any given conversion attempt, the exactness will be updated based on how closely
-          #   the value recursively matches the target type:
+          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
+          # any given conversion attempt, the exactness will be updated based on how closely
+          # the value recursively matches the target type:
           #
-          #   - `yes`: the value can be converted to the target type with minimum coercion.
-          #   - `maybe`: the value can be converted to the target type with some reasonable
-          #     coercion.
-          #   - `no`: the value cannot be converted to the target type.
+          # - `yes`: the value can be converted to the target type with minimum coercion.
+          # - `maybe`: the value can be converted to the target type with some reasonable
+          #   coercion.
+          # - `no`: the value cannot be converted to the target type.
           #
-          #   See implementation below for more details.
+          # See implementation below for more details.
           #
           #   @option state [Boolean, :strong] :strictness
           #
@@ -141,9 +149,9 @@ module Lithic
                 if value.is_a?(Integer)
                   exactness[:yes] += 1
                   return value
-                elsif strictness == :strong
+                elsif strictness == :strong && Integer(value, exception: false) != value
                   message = "no implicit conversion of #{value.class} into #{target.inspect}"
-                  raise TypeError.new(message)
+                  raise value.is_a?(Numeric) ? ArgumentError.new(message) : TypeError.new(message)
                 else
                   Kernel.then do
                     return Integer(value).tap { exactness[:maybe] += 1 }
@@ -183,18 +191,26 @@ module Lithic
                 rescue ArgumentError, TypeError => e
                   raise e if strictness == :strong
                 end
-              in -> { _1 <= IO } if value.is_a?(String)
+              in -> { _1 <= StringIO } if value.is_a?(String)
                 exactness[:yes] += 1
                 return StringIO.new(value.b)
               else
               end
             in Symbol
-              if (value.is_a?(Symbol) || value.is_a?(String)) && value.to_sym == target
-                exactness[:yes] += 1
-                return target
-              elsif strictness == :strong
-                message = "cannot convert non-matching #{value.class} into #{target.inspect}"
-                raise ArgumentError.new(message)
+              case value
+              in Symbol | String
+                if value.to_sym == target
+                  exactness[:yes] += 1
+                  return target
+                else
+                  exactness[:maybe] += 1
+                  return value
+                end
+              else
+                if strictness == :strong
+                  message = "cannot convert non-matching #{value.class} into #{target.inspect}"
+                  raise ArgumentError.new(message)
+                end
               end
             else
             end
@@ -208,17 +224,24 @@ module Lithic
           # @api private
           #
           # @param target [Lithic::Internal::Type::Converter, Class]
+          #
           # @param value [Object]
           #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
           # @return [Object]
-          def dump(target, value)
-            # rubocop:disable Layout/LineLength
-            target.is_a?(Lithic::Internal::Type::Converter) ? target.dump(value) : Lithic::Internal::Type::Unknown.dump(value)
-            # rubocop:enable Layout/LineLength
+          def dump(target, value, state: {can_retry: true})
+            case target
+            in Lithic::Internal::Type::Converter
+              target.dump(value, state: state)
+            else
+              Lithic::Internal::Type::Unknown.dump(value, state: state)
+            end
           end
         end
       end
-      # rubocop:enable Metrics/ModuleLength
     end
   end
 end

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

@@ -6,15 +6,15 @@ module Lithic
       # @api private
       #
       # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      #   values in the SDK as follows:
+      # values in the SDK as follows:
       #
-      #   1. boolean => true | false
-      #   2. integer => Integer
-      #   3. float => Float
-      #   4. string => Symbol
+      # 1. boolean => true | false
+      # 2. integer => Integer
+      # 3. float => Float
+      # 4. string => Symbol
       #
-      #   We can therefore convert string values to Symbols, but can't convert other
-      #   values safely.
+      # We can therefore convert string values to Symbols, but can't convert other
+      # values safely.
       #
       # @example
       #   # `account_financial_account_type` is a `Lithic::Models::AccountFinancialAccountType`
@@ -66,7 +66,7 @@ module Lithic
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
-        #   of the enum.
+        # of the enum.
         #
         # @param value [String, Symbol, Object]
         #
@@ -97,8 +97,12 @@ module Lithic
         #   #
         #   # @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
       end
     end
   end

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

@@ -99,12 +99,16 @@ module Lithic
         #
         # @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
-              Lithic::Internal::Type::Converter.dump(target, _1)
+              Lithic::Internal::Type::Converter.dump(target, _1, state: state)
             end
           else
             super

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Internal
+    module Type
+      # @api private
+      #
+      # @abstract
+      #
+      # Either `Pathname` or `StringIO`.
+      class IOLike
+        extend Lithic::Internal::Type::Converter
+
+        # @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 <= Lithic::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/lithic/internal/type/request_parameters.rb

@@ -26,9 +26,18 @@ module Lithic
           #
           # @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 = Lithic::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/lithic/internal/type/union.rb

@@ -176,15 +176,19 @@ module Lithic
         #
         # @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 Lithic::Internal::Type::Converter.dump(target, value)
+            return Lithic::Internal::Type::Converter.dump(target, value, state: state)
           end
 
           known_variants.each do
             target = _2.call
-            return Lithic::Internal::Type::Converter.dump(target, value) if target === value
+            return Lithic::Internal::Type::Converter.dump(target, value, state: state) if target === value
           end
 
           super

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

@@ -47,8 +47,12 @@ module Lithic
           #   #
           #   # @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