lithic 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c878a0ee5f6aba02f1f1ccd5ea1afeb092e3b5b71495a3ebf590154ad80b4d88
-  data.tar.gz: d849bdf0caf2255bddaaa86f9ed6c3af7a1b4e277015cdae0adaba2861f48e3e
+  metadata.gz: f8d20c28e43fb2ec6fd932b2f8426228676e0be97ebfc29ae8001074f3caf752
+  data.tar.gz: 1d6a6a4a9aa2516d61ebd574340bc7c7588ab9bdcaa7e6a70f4d39794acc3d36
 SHA512:
-  metadata.gz: 7be928a465d075049a036380e5c195b634095d0a417bc1c4ca451db1a6aa0a87661ac51e528c5fcdb3cff69ce6281675063927becb88abb11ff066b8cae65c50
-  data.tar.gz: b9711354f43f14e04e7fbe2aa47f0d6faa580271e67c76981f3074ce17e02bb5ef1318773424ac6272c068b6f67d1ade506bec1c57896fe9f95856dd1a0b232f
+  metadata.gz: 217b64c26b69a76811e6443c68eae64aa2af2e3d3ab5b51ad323fa9df8d5d38ea88dc92ca5f91d590f51f1397bc7df5292a414cb526e343128cf0f24bdb97c43
+  data.tar.gz: f6ddaa0850bf3f8f30e389a310ba0941689610642423fd7e6b32e8110019619ab5ec7cd16cac61c3accc290c1c5698e8bcd38f28eb1717b6b819d83264cd13c2

data/README.md

@@ -12,10 +12,14 @@ The underlying REST API documentation can be found on [docs.lithic.com](https://
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
+<!-- x-release-please-start-version -->
+
 ```ruby
-gem "lithic", "~> 0.1.0.pre.alpha.4"
+gem "lithic", "~> 0.1.0.pre.alpha.6"
 ```
 
+<!-- x-release-please-end -->
+
 To fetch an initial copy of the gem:
 
 ```sh
@@ -123,9 +127,23 @@ lithic.cards.list(page_size: 10, request_options: {timeout: 5})
 
 ## LSP Support
 
-### Sorbet
+### Solargraph
+
+This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
+
+```ruby
+gem "solargraph", group: :development
+```
+
+After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
 
-**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+```sh
+bundle exec solargraph gems
+```
+
+Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
+
+### Sorbet
 
 This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
 
@@ -136,11 +154,17 @@ Due to limitations with the Sorbet type system, where a method otherwise can tak
 Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
 
 ```ruby
-model = Lithic::Models::CardCreateParams.new(type: "SINGLE_USE")
+params = Lithic::Models::CardCreateParams.new(type: "SINGLE_USE")
 
-lithic.cards.create(**model)
+lithic.cards.create(**params)
 ```
 
+Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+
+### Ruby LSP
+
+The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information.
+
 ## Advanced
 
 ### Making custom/undocumented requests

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/cursor_page.rb

@@ -2,6 +2,8 @@
 
 module Lithic
   module Internal
+    # @generic Elem
+    #
     # @example
     #   if cursor_page.has_next?
     #     cursor_page = cursor_page.next_page
@@ -14,7 +16,7 @@ module Lithic
     class CursorPage
       include Lithic::Internal::Type::BasePage
 
-      # @return [Array<Object>, nil]
+      # @return [Array<generic<Elem>>, nil]
       attr_accessor :data
 
       # @return [Boolean]
@@ -61,6 +63,8 @@ module Lithic
       end
 
       # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
       def auto_paging_each(&blk)
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")

data/lib/lithic/internal/single_page.rb

@@ -2,6 +2,8 @@
 
 module Lithic
   module Internal
+    # @generic Elem
+    #
     # @example
     #   if single_page.has_next?
     #     single_page = single_page.next_page
@@ -14,7 +16,7 @@ module Lithic
     class SinglePage
       include Lithic::Internal::Type::BasePage
 
-      # @return [Array<Object>, nil]
+      # @return [Array<generic<Elem>>, nil]
       attr_accessor :data
 
       # @return [Boolean]
@@ -55,6 +57,8 @@ module Lithic
       end
 
       # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
       def auto_paging_each(&blk)
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")

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

@@ -131,7 +131,7 @@ module Lithic
           # @api private
           #
           # @param status [Integer, Lithic::Errors::APIConnectionError]
-          # @param stream [Enumerable, nil]
+          # @param stream [Enumerable<String>, nil]
           def reap_connection!(status, stream:)
             case status
             in (..199) | (300..499)
@@ -328,7 +328,7 @@ module Lithic
         # @param send_retry_header [Boolean]
         #
         # @raise [Lithic::Errors::APIError]
-        # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
+        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: Lithic::Internal::Util.monotonic_secs + timeout}
@@ -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
@@ -119,7 +119,7 @@ module Lithic
         #
         #   @option request [Float] :deadline
         #
-        # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
+        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         def execute(request)
           url, deadline = request.fetch_values(:url, :deadline)
 

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

@@ -7,6 +7,8 @@ module Lithic
       #
       # @abstract
       #
+      # @generic Elem
+      #
       # Array of items of a given type.
       class ArrayOf
         include Lithic::Internal::Type::Converter
@@ -40,7 +42,7 @@ module Lithic
 
         # @api private
         #
-        # @param value [Enumerable, Object]
+        # @param value [Array<Object>, Object]
         #
         # @param state [Hash{Symbol=>Object}] .
         #
@@ -75,7 +77,7 @@ module Lithic
 
         # @api private
         #
-        # @param value [Enumerable, Object]
+        # @param value [Array<Object>, Object]
         #
         # @return [Array<Object>, Object]
         def dump(value)
@@ -85,7 +87,7 @@ module Lithic
 
         # @api private
         #
-        # @return [Lithic::Internal::Type::Converter, Class]
+        # @return [generic<Elem>]
         protected def item_type = @item_type_fn.call
 
         # @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)
@@ -168,7 +168,9 @@ module Lithic
           # @param other [Object]
           #
           # @return [Boolean]
-          def ==(other) = other.is_a?(Class) && other <= Lithic::Internal::Type::BaseModel && other.fields == fields
+          def ==(other)
+            other.is_a?(Class) && other <= Lithic::Internal::Type::BaseModel && other.fields == fields
+          end
         end
 
         # @param other [Object]
@@ -264,7 +266,7 @@ module Lithic
               in nil
                 acc.store(name, super(val))
               else
-                mode, api_name, type_fn = field.fetch_values(:mode, :api_name, :type_fn)
+                api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn)
                 case mode
                 in :coerce
                   next
@@ -276,7 +278,7 @@ module Lithic
             end
 
             known_fields.each_value do |field|
-              mode, api_name, const = field.fetch_values(:mode, :api_name, :const)
+              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
@@ -286,11 +288,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]
         #
@@ -305,12 +307,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
@@ -350,7 +352,8 @@ module Lithic
           in Hash => coerced
             @data = coerced
           else
-            raise ArgumentError.new("Expected a #{Hash} or #{Lithic::Internal::Type::BaseModel}, got #{data.inspect}")
+            message = "Expected a #{Hash} or #{Lithic::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
           end
         end
 
@@ -358,7 +361,7 @@ module Lithic
         def inspect
           rows = self.class.known_fields.keys.map do
             "#{_1}=#{@data.key?(_1) ? public_send(_1) : ''}"
-          rescue Lithic::ConversionError
+          rescue Lithic::Errors::ConversionError
             "#{_1}=#{@data.fetch(_1)}"
           end
           "#<#{self.class.name}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"

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

@@ -3,6 +3,8 @@
 module Lithic
   module Internal
     module Type
+      # @generic Elem
+      #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
@@ -16,10 +18,11 @@ module Lithic
 
         # @param blk [Proc]
         #
+        # @yieldparam [generic<Elem>]
         # @return [void]
         def auto_paging_each(&blk) = (raise NotImplementedError)
 
-        # @return [Enumerable]
+        # @return [Enumerable<generic<Elem>>]
         def to_enum = super(:auto_paging_each)
 
         alias_method :enum_for, :to_enum

data/lib/lithic/internal/type/{boolean_model.rb → boolean.rb}

@@ -8,7 +8,7 @@ module Lithic
       # @abstract
       #
       # Ruby has no Boolean class; this is something for models to refer to.
-      class BooleanModel
+      class Boolean
         extend Lithic::Internal::Type::Converter
 
         # @param other [Object]
@@ -19,7 +19,7 @@ module Lithic
         # @param other [Object]
         #
         # @return [Boolean]
-        def self.==(other) = other.is_a?(Class) && other <= Lithic::Internal::Type::BooleanModel
+        def self.==(other) = other.is_a?(Class) && other <= Lithic::Internal::Type::Boolean
 
         class << self
           # @api private

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
@@ -64,7 +63,7 @@ module Lithic
             in Hash
               type_info(spec.slice(:const, :enum, :union).first&.last)
             in true | false
-              -> { Lithic::Internal::Type::BooleanModel }
+              -> { Lithic::Internal::Type::Boolean }
             in Lithic::Internal::Type::Converter | Class | Symbol
               -> { spec }
             in NilClass | Integer | Float
@@ -76,37 +75,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
           #
@@ -168,6 +167,9 @@ module Lithic
                 in String | Symbol | Numeric
                   exactness[value.is_a?(Numeric) ? :maybe : :yes] += 1
                   return value.to_s
+                in StringIO
+                  exactness[:yes] += 1
+                  return value.string
                 else
                   if strictness == :strong
                     message = "no implicit conversion of #{value.class} into #{target.inspect}"
@@ -209,11 +211,12 @@ module Lithic
           #
           # @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
           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`
@@ -58,13 +58,15 @@ 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
         end
 
         # @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]
         #

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

@@ -7,6 +7,8 @@ module Lithic
       #
       # @abstract
       #
+      # @generic Elem
+      #
       # Hash of items of a given type.
       class HashOf
         include Lithic::Internal::Type::Converter
@@ -111,7 +113,7 @@ module Lithic
 
         # @api private
         #
-        # @return [Lithic::Internal::Type::Converter, Class]
+        # @return [generic<Elem>]
         protected def item_type = @item_type_fn.call
 
         # @api private