lithic 0.1.0.pre.alpha.26 → 0.1.0.pre.alpha.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10f3f3cedbb34d6d368733a60b4bdfc92ba330fe109d479a63006c93ff911fc
-  data.tar.gz: b5b22aa1165e17b822d55cb3b358375830cb22ffbe6d97fd9da60bdd49248e5c
+  metadata.gz: 426157664cabd078c520246758b0be9f3e439382455dd4fe952a8574d9e3078c
+  data.tar.gz: b525e1679bbee873e6611a88b5f66d7fc84ef86d61c269cba80f3e9b0e4eea87
 SHA512:
-  metadata.gz: 0f3b7b0ed169bf42c5802fd5acb76004603da0cb03827e8d5862e1e3066ef0cbcd49f6e5a1f87cacf71a00759cda1064476ec80eb42d1c4ddc898a990b632cf8
-  data.tar.gz: 0c44fe7f1151d82fde547b4202f82a9f8358bfa9f6f71b360af53fd7e630907eb02fbbcc3444a72a6ba547a8771b4839b60b8b3ed91725c23075437d9c2dc39e
+  metadata.gz: d22da8f96ade56b0e448482b4e5a759737f91c9f6291b0425a723de9674d2ea9389225afd2beb280a127aef3262f4bc1e78d307f1379d4d91a3127574b7b8d00
+  data.tar.gz: 458c6e85d3e27c08d31b7a27dd88fc8f7cc522f296268b1b3070c3c6b2805d7e706daa0280d09a14a6516056f290bdf6ad2c5bb4832f1f32222bbb008e789722

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 0.1.0-alpha.28 (2025-05-23)
+
+Full Changelog: [v0.1.0-alpha.27...v0.1.0-alpha.28](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.27...v0.1.0-alpha.28)
+
+### Bug Fixes
+
+* prevent rubocop from mangling `===` to `is_a?` check ([17d829b](https://github.com/lithic-com/lithic-ruby/commit/17d829bdf146635a77f48734396b7bab4ace5ec7))
+
+
+### Chores
+
+* **docs:** grammar improvements ([32caea3](https://github.com/lithic-com/lithic-ruby/commit/32caea327297944f1981f54b5c6180b63f938e1d))
+* force utf-8 locale via `RUBYOPT` when formatting ([1b5a754](https://github.com/lithic-com/lithic-ruby/commit/1b5a754e631bf579fc6a79569ad847cc65ddff1c))
+* use fully qualified names for yard annotations and rbs aliases ([2f72cee](https://github.com/lithic-com/lithic-ruby/commit/2f72cee42923b41ac739d0dd7b118152a36a8b93))
+
+## 0.1.0-alpha.27 (2025-05-20)
+
+Full Changelog: [v0.1.0-alpha.26...v0.1.0-alpha.27](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.26...v0.1.0-alpha.27)
+
+### Bug Fixes
+
+* correctly instantiate sorbet type aliases for enums and unions ([456477f](https://github.com/lithic-com/lithic-ruby/commit/456477fed1f46dd9ecfd278ddda29c642e5684f7))
+
+
+### Chores
+
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([1c7093d](https://github.com/lithic-com/lithic-ruby/commit/1c7093dac0961af658685d5788c2b0dbe1871947))
+* use sorbet union aliases where available ([68cbe7c](https://github.com/lithic-com/lithic-ruby/commit/68cbe7c8831d674ddb1080ca53ae1018966f1c87))
+* whitespaces ([862a44f](https://github.com/lithic-com/lithic-ruby/commit/862a44f890c5b9d0034a99e2d09125f9a4551a1b))
+
+
+### Documentation
+
+* rewrite much of README.md for readability ([786647f](https://github.com/lithic-com/lithic-ruby/commit/786647f1e376849b800dfb59fdc941925590ab17))
+
 ## 0.1.0-alpha.26 (2025-05-14)
 
 Full Changelog: [v0.1.0-alpha.25...v0.1.0-alpha.26](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.25...v0.1.0-alpha.26)

data/README.md

@@ -1,6 +1,6 @@
 # Lithic Ruby API library
 
-The Lithic Ruby library provides convenient access to the Lithic REST API from any Ruby 3.2.0+ application.
+The Lithic Ruby library provides convenient access to the Lithic REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/lithic-com/lithic-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 ## Documentation
 
@@ -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.26"
+gem "lithic", "~> 0.1.0.pre.alpha.28"
 ```
 
 <!-- x-release-please-end -->
@@ -36,16 +36,6 @@ card = lithic.cards.create(type: "SINGLE_USE")
 puts(card.token)
 ```
 
-## Sorbet
-
-This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
-
-When using sorbet, it is recommended to use model classes as below. This provides stronger type checking and tooling integration.
-
-```ruby
-lithic.cards.create(type: "SINGLE_USE")
-```
-
 ### Pagination
 
 List methods in the Lithic API are paginated.
@@ -65,15 +55,30 @@ page.auto_paging_each do |card|
 end
 ```
 
-### Errors
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].product_id)
+end
+```
+
+### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Lithic::Errors::APIError` will be thrown:
 
 ```ruby
 begin
   card = lithic.cards.create(type: "MERCHANT_LOCKED")
-rescue Lithic::Errors::APIError => e
-  puts(e.status) # 400
+rescue Lithic::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue Lithic::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue Lithic::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
 end
 ```
 
@@ -113,11 +118,7 @@ lithic.cards.list(page_size: 10, request_options: {max_retries: 5})
 
 ### Timeouts
 
-By default, requests will time out after 60 seconds.
-
-Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
-
-You can use the `timeout` option to configure or disable this:
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
 
 ```ruby
 # Configure the default for all requests:
@@ -129,39 +130,53 @@ lithic = Lithic::Client.new(
 lithic.cards.list(page_size: 10, request_options: {timeout: 5})
 ```
 
-## Model DSL
+On timeout, `Lithic::Errors::APITimeoutError` is raised.
 
-This library uses a simple DSL to represent request parameters and response shapes in `lib/lithic/models`.
+Note that requests that time out are retried by default.
 
-With the right [editor plugins](https://shopify.github.io/ruby-lsp), you can ctrl-click on elements of the DSL to navigate around and explore the library.
+## Advanced concepts
 
-In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can also be used. For example, the following are interchangeable as arguments:
+### BaseModel
 
-```ruby
-# This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
-params = Lithic::Models::CardCreateParams.new(type: "SINGLE_USE")
+All parameter and response objects inherit from `Lithic::Internal::Type::BaseModel`, which provides several conveniences, including:
 
-# This also works
-params = {
-  type: "SINGLE_USE"
-}
-```
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
 
-## Editor support
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
 
-A combination of [Shopify LSP](https://shopify.github.io/ruby-lsp) and [Solargraph](https://solargraph.org/) is recommended for non-[Sorbet](https://sorbet.org) users. The former is especially good at go to definition, while the latter has much better auto-completion support.
+3. Both instances and the classes themselves can be pretty-printed.
 
-## Advanced concepts
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
 
-### Making custom/undocumented requests
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+page =
+  lithic.cards.list(
+    page_size: 10,
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(page[:my_undocumented_property])
+```
 
 #### Undocumented request params
 
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above.
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
 
 #### Undocumented endpoints
 
-To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
 
 ```ruby
 response = client.request(
@@ -169,42 +184,67 @@ response = client.request(
   path: '/undocumented/endpoint',
   query: {"dog": "woof"},
   headers: {"useful-header": "interesting-value"},
-  body: {"he": "llo"},
+  body: {"hello": "world"}
 )
 ```
 
 ### Concurrency & connection pooling
 
-The `Lithic::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count.
+The `Lithic::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
 
-When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
+Each instance of `Lithic::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
 
 Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
 
-Currently, `Lithic::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+## Sorbet
 
-### Sorbet
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
 
-#### Enums
+You can provide typesafe request parameters like so:
 
-Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbet.org/docs/tenum) from the `sorbet-runtime` gem.
+```ruby
+lithic.cards.create(type: "SINGLE_USE")
+```
 
-Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
+Or, equivalently:
 
 ```ruby
-module Lithic::AccountFinancialAccountType
-  # This alias aids language service driven navigation.
-  TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::AccountFinancialAccountType) }
-end
+# Hashes work, but are not typesafe:
+lithic.cards.create(type: "SINGLE_USE")
+
+# You can also splat a full Params class:
+params = Lithic::CardCreateParams.new(type: "SINGLE_USE")
+lithic.cards.create(**params)
 ```
 
-#### Argument passing trick
+### Enums
 
-It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator.
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-params = Lithic::Models::CardCreateParams.new(type: "SINGLE_USE")
-lithic.cards.create(**params)
+# :ACTIVE
+puts(Lithic::AccountUpdateParams::State::ACTIVE)
+
+# Revealed type: `T.all(Lithic::AccountUpdateParams::State, Symbol)`
+T.reveal_type(Lithic::AccountUpdateParams::State::ACTIVE)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+lithic.accounts.update(
+  state: Lithic::AccountUpdateParams::State::ACTIVE,
+  # …
+)
+
+# Literal values are also permissible:
+lithic.accounts.update(
+  state: :ACTIVE,
+  # …
+)
 ```
 
 ## Versioning

data/SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Lithic please follow the respective company's security reporting guidelines.
+or products provided by Lithic, please follow the respective company's security reporting guidelines.
 
 ### Lithic Terms and Policies
 
-Please contact sdk-feedback@lithic.com for any questions or concerns regarding security of our services.
+Please contact sdk-feedback@lithic.com for any questions or concerns regarding the security of our services.
 
 ---
 

data/lib/lithic/client.rb

@@ -107,7 +107,7 @@ module Lithic
     #
     # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
     #
-    # @return [Lithic::APIStatus]
+    # @return [Lithic::Models::APIStatus]
     #
     # @see Lithic::Models::ClientAPIStatusParams
     def api_status(params = {})

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

@@ -12,6 +12,7 @@ module Lithic
       # Array of items of a given type.
       class ArrayOf
         include Lithic::Internal::Type::Converter
+        include Lithic::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -110,6 +111,13 @@ module Lithic
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Array[Lithic::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

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

@@ -304,6 +304,13 @@ module Lithic
 
             acc
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            self
+          end
         end
 
         class << self
@@ -386,6 +393,14 @@ module Lithic
         # @param keys [Array<Symbol>, nil]
         #
         # @return [Hash{Symbol=>Object}]
+        #
+        # @example
+        #   # `address` is a `Lithic::Address`
+        #   address => {
+        #     address1: address1,
+        #     city: city,
+        #     country: country
+        #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)
             .filter_map do |k|

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

@@ -10,6 +10,7 @@ module Lithic
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend Lithic::Internal::Type::Converter
+        extend Lithic::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -56,6 +57,13 @@ module Lithic
           #     @option state [Boolean] :can_retry
           #
           #   @return [Boolean, Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T::Boolean
+          end
         end
       end
     end

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

@@ -108,6 +108,18 @@ module Lithic
         #
         #   @return [Symbol, Object]
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case values
+          in []
+            T.noreturn
+          in [value, *_]
+            T.all(Lithic::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          end
+        end
+
         # @api private
         #
         # @param depth [Integer]

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

@@ -89,6 +89,13 @@ module Lithic
 
             value
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.any(Pathname, StringIO, IO, String, Lithic::FilePart)
+          end
         end
       end
     end

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

@@ -12,6 +12,7 @@ module Lithic
       # Hash of items of a given type.
       class HashOf
         include Lithic::Internal::Type::Converter
+        include Lithic::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -130,6 +131,13 @@ module Lithic
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Hash[Lithic::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

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

@@ -202,6 +202,18 @@ module Lithic
           super
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case (v = variants)
+          in []
+            T.noreturn
+          else
+            T.any(*v.map { Lithic::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+          end
+        end
+
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 

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

@@ -10,6 +10,7 @@ module Lithic
       # When we don't know what to expect for the value.
       class Unknown
         extend Lithic::Internal::Type::Converter
+        extend Lithic::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
 
@@ -58,6 +59,13 @@ module Lithic
           #     @option state [Boolean] :can_retry
           #
           #   @return [Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.anything
+          end
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/lithic/internal/util.rb

@@ -9,6 +9,23 @@ module Lithic
       # @return [Float]
       def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      # @api private
+      #
+      # @param ns [Module, Class]
+      #
+      # @return [Enumerable<Module, Class>]
+      def self.walk_namespaces(ns)
+        ns.constants(false).lazy.flat_map do
+          case (c = ns.const_get(_1, false))
+          in Module | Class
+            walk_namespaces(c)
+          else
+            []
+          end
+        end
+          .chain([ns])
+      end
+
       class << self
         # @api private
         #
@@ -583,11 +600,13 @@ module Lithic
         #
         # @return [Object]
         def encode_content(headers, body)
+          # rubocop:disable Style/CaseEquality
+          # rubocop:disable Layout/LineLength
           content_type = headers["content-type"]
           case [content_type, body]
           in [Lithic::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.generate(body)]
-          in [Lithic::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Lithic::Internal::Type::FileInput)
+          in [Lithic::Internal::Util::JSONL_CONTENT, Enumerable] unless Lithic::Internal::Type::FileInput === body
             [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | Lithic::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
@@ -602,6 +621,8 @@ module Lithic
           else
             [headers, body]
           end
+          # rubocop:enable Layout/LineLength
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -826,11 +847,39 @@ module Lithic
           sorbet_runtime_constants.fetch(name).call
         end
 
+        # @api private
+        #
+        # @param name [Symbol]
+        #
+        # @return [Boolean]
+        def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name)
+
         # @api private
         #
         # @param name [Symbol]
         # @param blk [Proc]
         def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type = raise NotImplementedError
+
+        class << self
+          # @api private
+          #
+          # @param type [Lithic::Internal::Util::SorbetRuntimeSupport, Object]
+          #
+          # @return [Object]
+          def to_sorbet_type(type)
+            case type
+            in Lithic::Internal::Util::SorbetRuntimeSupport
+              type.to_sorbet_type
+            else
+              type
+            end
+          end
+        end
       end
 
       extend Lithic::Internal::Util::SorbetRuntimeSupport

data/lib/lithic/internal.rb

@@ -13,5 +13,8 @@ module Lithic
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Lithic::FilePart) }
+    end
   end
 end