lithic 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c878a0ee5f6aba02f1f1ccd5ea1afeb092e3b5b71495a3ebf590154ad80b4d88
-  data.tar.gz: d849bdf0caf2255bddaaa86f9ed6c3af7a1b4e277015cdae0adaba2861f48e3e
+  metadata.gz: 6cc0455f8a47c113c091409b3b4ed5b5522a3ae3c2272f68701084ffbb4b35bf
+  data.tar.gz: 1bc14153bdcce95840ab82520a99ca49f9a943850313c0f73fa15a2a8d4cfc94
 SHA512:
-  metadata.gz: 7be928a465d075049a036380e5c195b634095d0a417bc1c4ca451db1a6aa0a87661ac51e528c5fcdb3cff69ce6281675063927becb88abb11ff066b8cae65c50
-  data.tar.gz: b9711354f43f14e04e7fbe2aa47f0d6faa580271e67c76981f3074ce17e02bb5ef1318773424ac6272c068b6f67d1ade506bec1c57896fe9f95856dd1a0b232f
+  metadata.gz: f8c91140b58743c9972ebb4d79a003844f242f076056a3c1ce7052125ec5c6941bf1033972b23f9c8637768123abc450c32efa651ea59c9acf571c673b021f14
+  data.tar.gz: 12ccc695ebb93e4df2aa828dbff4bece059d99ddd249dfa7e837229c01ca196a5a7956d832fc01557ffa33a524231e880aea6c8578d238713b58161b7cf1c04e

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.5"
 ```
 
+<!-- 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/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}

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

@@ -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

@@ -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]
@@ -256,6 +258,7 @@ module Lithic
               return super
             end
 
+            is_param = singleton_class <= Lithic::Internal::Type::RequestParameters::Converter
             acc = {}
 
             coerced.each do |key, val|
@@ -264,19 +267,21 @@ module Lithic
               in nil
                 acc.store(name, super(val))
               else
-                mode, api_name, type_fn = field.fetch_values(:mode, :api_name, :type_fn)
+                mode, type_fn = field.fetch_values(: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))
                 end
               end
             end
 
-            known_fields.each_value do |field|
-              mode, api_name, const = field.fetch_values(:mode, :api_name, :const)
+            known_fields.each do |name, field|
+              mode, const = field.fetch_values(:mode, :const)
+              api_name = is_param ? name : field.fetch(:api_name)
               next if mode == :coerce || acc.key?(api_name) || const == Lithic::Internal::OMIT
               acc.store(api_name, const)
             end
@@ -350,7 +355,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 +364,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

@@ -64,7 +64,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
@@ -168,6 +168,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,7 +212,9 @@ 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

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

@@ -58,7 +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
         end
 
         # @api private

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

data/lib/lithic/internal/util.rb

@@ -61,7 +61,7 @@ module Lithic
         # @return [Boolean]
         def primitive?(input)
           case input
-          in true | false | Integer | Float | Symbol | String
+          in true | false | Numeric | Symbol | String
             true
           else
             false
@@ -70,13 +70,11 @@ module Lithic
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Boolean]
         #
         # @return [Boolean, Object]
         def coerce_boolean(input)
           case input.is_a?(String) ? input.downcase : input
-          in Numeric
-            input.nonzero?
           in "true"
             true
           in "false"
@@ -88,7 +86,7 @@ module Lithic
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Boolean]
         #
         # @raise [ArgumentError]
         # @return [Boolean, nil]
@@ -103,34 +101,20 @@ module Lithic
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Integer]
         #
         # @return [Integer, Object]
         def coerce_integer(input)
-          case input
-          in true
-            1
-          in false
-            0
-          else
-            Integer(input, exception: false) || input
-          end
+          Integer(input, exception: false) || input
         end
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Integer, Float]
         #
         # @return [Float, Object]
         def coerce_float(input)
-          case input
-          in true
-            1.0
-          in false
-            0.0
-          else
-            Float(input, exception: false) || input
-          end
+          Float(input, exception: false) || input
         end
 
         # @api private
@@ -159,12 +143,7 @@ module Lithic
         private def deep_merge_lr(lhs, rhs, concat: false)
           case [lhs, rhs, concat]
           in [Hash, Hash, _]
-            rhs_cleaned = rhs.reject { _2 == Lithic::Internal::OMIT }
-            lhs
-              .reject { |key, _| rhs[key] == Lithic::Internal::OMIT }
-              .merge(rhs_cleaned) do |_, old_val, new_val|
-                deep_merge_lr(old_val, new_val, concat: concat)
-              end
+            lhs.merge(rhs) { deep_merge_lr(_2, _3, concat: concat) }
           in [Array, Array, true]
             lhs.concat(rhs)
           else
@@ -362,7 +341,7 @@ module Lithic
             value =
               case val
               in Array
-                val.map { _1.to_s.strip }.join(", ")
+                val.filter_map { _1&.to_s&.strip }.join(", ")
               else
                 val&.to_s&.strip
               end
@@ -419,7 +398,7 @@ module Lithic
 
         # @api private
         #
-        # @param stream [String, IO, StringIO, Enumerable]
+        # @param stream [String, IO, StringIO, Enumerable<String>]
         # @param blk [Proc]
         #
         # @yieldparam [String]
@@ -434,7 +413,7 @@ module Lithic
         # @param blk [Proc]
         #
         # @yieldparam [Enumerator::Yielder]
-        # @return [Enumerable]
+        # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
             y.define_singleton_method(:write) do
@@ -469,7 +448,7 @@ module Lithic
           case val
           in IO
             y << "Content-Type: application/octet-stream\r\n\r\n"
-            IO.copy_stream(val, y)
+            IO.copy_stream(val.tap(&:rewind), y)
           in StringIO
             y << "Content-Type: application/octet-stream\r\n\r\n"
             y << val.string
@@ -490,7 +469,7 @@ module Lithic
         #
         # @param body [Object]
         #
-        # @return [Array(String, Enumerable)]
+        # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
           boundary = SecureRandom.urlsafe_base64(60)
 
@@ -525,7 +504,7 @@ module Lithic
         def encode_content(headers, body)
           content_type = headers["content-type"]
           case [content_type, body]
-          in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array]
+          in [%r{^application/(?:vnd\.api\+)?json}, _] unless body.nil?
             [headers, JSON.fast_generate(body)]
           in [%r{^application/(?:x-)?jsonl}, Enumerable]
             [headers, body.lazy.map { JSON.fast_generate(_1) }]
@@ -533,8 +512,12 @@ module Lithic
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
             [headers, strio]
+          in [_, IO]
+            [headers, body.tap(&:rewind)]
           in [_, StringIO]
             [headers, body.string]
+          in [_, Symbol | Numeric]
+            [headers, body.to_s]
           else
             [headers, body]
           end
@@ -543,7 +526,7 @@ module Lithic
         # @api private
         #
         # @param headers [Hash{String=>String}, Net::HTTPHeader]
-        # @param stream [Enumerable]
+        # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #
         # @raise [JSON::ParserError]
@@ -580,11 +563,11 @@ module Lithic
         #
         # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
         #
-        # @param enum [Enumerable]
+        # @param enum [Enumerable<Object>]
         # @param external [Boolean]
         # @param close [Proc]
         #
-        # @return [Enumerable]
+        # @return [Enumerable<Object>]
         def fused_enum(enum, external: false, &close)
           fused = false
           iter = Enumerator.new do |y|
@@ -610,7 +593,7 @@ module Lithic
 
         # @api private
         #
-        # @param enum [Enumerable, nil]
+        # @param enum [Enumerable<Object>, nil]
         def close_fused!(enum)
           return unless enum.is_a?(Enumerator)
 
@@ -621,11 +604,11 @@ module Lithic
 
         # @api private
         #
-        # @param enum [Enumerable, nil]
+        # @param enum [Enumerable<Object>, nil]
         # @param blk [Proc]
         #
         # @yieldparam [Enumerator::Yielder]
-        # @return [Enumerable]
+        # @return [Enumerable<Object>]
         def chain_fused(enum, &blk)
           iter = Enumerator.new { blk.call(_1) }
           fused_enum(iter) { close_fused!(enum) }
@@ -635,9 +618,9 @@ module Lithic
       class << self
         # @api private
         #
-        # @param enum [Enumerable]
+        # @param enum [Enumerable<String>]
         #
-        # @return [Enumerable]
+        # @return [Enumerable<String>]
         def decode_lines(enum)
           re = /(\r\n|\r|\n)/
           buffer = String.new.b
@@ -671,9 +654,9 @@ module Lithic
         #
         # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
         #
-        # @param lines [Enumerable]
+        # @param lines [Enumerable<String>]
         #
-        # @return [Hash{Symbol=>Object}]
+        # @return [Enumerable<Hash{Symbol=>Object}>]
         def decode_sse(lines)
           # rubocop:disable Metrics/BlockLength
           chain_fused(lines) do |y|

data/lib/lithic/models/account_holder.rb

@@ -27,8 +27,7 @@ module Lithic
       #   attr_writer :account_token
 
       # @!attribute [r] beneficial_owner_entities
-      #   Only present when user_type == "BUSINESS". List of all entities with >25%
-      #     ownership in the company.
+      #   Deprecated. Only present when user_type == "BUSINESS".
       #
       #   @return [Array<Lithic::Models::AccountHolder::BeneficialOwnerEntity>, nil]
       optional :beneficial_owner_entities,