lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2b9d69b258cc9761a52dc0632986c5f62d5c2150fa3b23c06fde0b64346017
-  data.tar.gz: '0848b77cb99c28a9c5752260c8532cea2087b3053bb048ffd77677c5e2901de9'
+  metadata.gz: 9fafc3f795882ee224abd07c56daed52c0b894f76cbe97f9b6c578b06ba3aa40
+  data.tar.gz: d04f5e51cdbf0596b57cae1baad86dfd0991ff677396248ff78520d98d3409bd
 SHA512:
-  metadata.gz: 14ccbbef08bf3d2e4e2496fdeaefd03d82210b6bbed70d2d66e663a6fe2d3d88e879b004a9b6f7892ccc0a34dc7417d438a71af2e76588c37da8fac9a63454ca
-  data.tar.gz: f5aea3f807164d03c219be133208aff6216fcfda8cdf289537ae311752d22469f2302cf0a14d9251f20bb9c758ab76ad5266a7acd3a6102ba32a37302bbe8942
+  metadata.gz: 869dd1a4561a4d622d02dd694ec56173da240e7cd1e4505cb20994af65ab1c27c5c464cbedecabbd7d81474ec4e057fba8647ade3cee8bb133bb488c7d400264
+  data.tar.gz: ba0ab63186ac15a2d57b4d44d2e6c75e8f7853101076ca17032b152bf3e5223765bea88e77aaf94e37c3fa82508bbcd3e1d9b5a0f46f22bdcdbe0866cf128568

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.0-alpha.15 (2025-04-18)
+
+Full Changelog: [v0.1.0-alpha.14...v0.1.0-alpha.15](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.14...v0.1.0-alpha.15)
+
+### Features
+
+* **api:** updates to Card definition for PCI clarity ([bb157ab](https://github.com/lithic-com/lithic-ruby/commit/bb157abbede60505c67651947fa8c583d17ac84a))
+
+
+### Chores
+
+* make sorbet enums easier to read ([77f23c5](https://github.com/lithic-com/lithic-ruby/commit/77f23c58d44b4c33b6a897ff988da2cb97965653))
+* refine `#inspect` and `#to_s` for model classes ([7435187](https://github.com/lithic-com/lithic-ruby/commit/74351870d4768cd923ce9d88841ba8c84b6681d6))
+* simplify yard annotations by removing most `@!parse` directives ([12c6882](https://github.com/lithic-com/lithic-ruby/commit/12c6882a7db0b45f91d8e4df7b0d41016567ad7a))
+* use `@!method` instead of `@!parse` for virtual method type definitions ([a73c89a](https://github.com/lithic-com/lithic-ruby/commit/a73c89aa794ebfc771a7410603c10be08d1609d3))
+
 ## 0.1.0-alpha.14 (2025-04-17)
 
 Full Changelog: [v0.1.0-alpha.13...v0.1.0-alpha.14](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.13...v0.1.0-alpha.14)

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.14"
+gem "lithic", "~> 0.1.0.pre.alpha.15"
 ```
 
 <!-- x-release-please-end -->

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

@@ -338,6 +338,29 @@ module Lithic
             .to_h
         end
 
+        class << self
+          # @api private
+          #
+          # @param model [Lithic::Internal::Type::BaseModel]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def walk(model)
+            walk = ->(x) do
+              case x
+              in Lithic::Internal::Type::BaseModel
+                walk.call(x.to_h)
+              in Hash
+                x.transform_values(&walk)
+              in Array
+                x.map(&walk)
+              else
+                x
+              end
+            end
+            walk.call(model)
+          end
+        end
+
         # @param a [Object]
         #
         # @return [String]
@@ -373,13 +396,11 @@ module Lithic
             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 } }
+              inspected = [
+                Lithic::Internal::Type::Converter.inspect(type, depth: depth),
+                !required || nilable ? "nil" : nil
+              ].compact.join(" | ")
+              -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } }
             end
 
             "#{name}[#{deferred.inspect}]"
@@ -389,15 +410,12 @@ module Lithic
         # @api private
         #
         # @return [String]
-        def inspect
-          rows = @data.map do
-            "#{_1}=#{self.class.known_fields.key?(_1) ? public_send(_1).inspect : ''}"
-          rescue Lithic::Errors::ConversionError
-            "#{_1}=#{_2.inspect}"
-          end
+        def to_s = self.class.walk(@data).to_s
 
-          "#<#{self.class}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
-        end
+        # @api private
+        #
+        # @return [String]
+        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
       end
     end
   end

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

@@ -42,12 +42,7 @@ module Lithic
         # All of the valid Symbol values for this enum.
         #
         # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
-        def values = (@values ||= constants.map { const_get(_1) })
-
-        # @api private
-        #
-        # Guard against thread safety issues by instantiating `@values`.
-        private def finalize! = values
+        def values = constants.map { const_get(_1) }
 
         # @param other [Object]
         #

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

@@ -12,9 +12,8 @@ module Lithic
 
         # @param mod [Module]
         def self.included(mod)
-          return unless mod <= Lithic::Internal::Type::BaseModel
+          raise ArgumentError.new(mod) unless mod <= Lithic::Internal::Type::BaseModel
 
-          mod.extend(Lithic::Internal::Type::RequestParameters::Converter)
           mod.optional(:request_options, Lithic::RequestOptions)
         end
 

data/lib/lithic/models/account.rb

@@ -13,8 +13,7 @@ module Lithic
       required :token, String
 
       # @!attribute created
-      #   Timestamp of when the account was created. For accounts created before
-      #   2023-05-11, this field will be null.
+      #   Timestamp of when the account was created.
       #
       #   @return [Time, nil]
       required :created, Time, nil?: true
@@ -45,16 +44,12 @@ module Lithic
       #   @return [Symbol, Lithic::Models::Account::State]
       required :state, enum: -> { Lithic::Models::Account::State }
 
-      # @!attribute [r] account_holder
+      # @!attribute account_holder
       #
       #   @return [Lithic::Models::Account::AccountHolder, nil]
       optional :account_holder, -> { Lithic::Models::Account::AccountHolder }
 
-      # @!parse
-      #   # @return [Lithic::Models::Account::AccountHolder]
-      #   attr_writer :account_holder
-
-      # @!attribute [r] auth_rule_tokens
+      # @!attribute auth_rule_tokens
       #   List of identifiers for the Auth Rule(s) that are applied on the account. This
       #   field is deprecated and will no longer be populated in the `account_holder`
       #   object. The key will be removed from the schema in a future release. Use the
@@ -63,54 +58,26 @@ module Lithic
       #   @return [Array<String>, nil]
       optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
 
-      # @!parse
-      #   # @return [Array<String>]
-      #   attr_writer :auth_rule_tokens
-
-      # @!attribute [r] cardholder_currency
+      # @!attribute cardholder_currency
       #   3-character alphabetic ISO 4217 code for the currency of the cardholder.
       #
       #   @return [String, nil]
       optional :cardholder_currency, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :cardholder_currency
-
-      # @!attribute [r] verification_address
+      # @!attribute verification_address
       #
       #   @return [Lithic::Models::Account::VerificationAddress, nil]
       optional :verification_address, -> { Lithic::Models::Account::VerificationAddress }
 
-      # @!parse
-      #   # @return [Lithic::Models::Account::VerificationAddress]
-      #   attr_writer :verification_address
-
-      # @!parse
-      #   # @param token [String]
-      #   # @param created [Time, nil]
-      #   # @param spend_limit [Lithic::Models::Account::SpendLimit]
-      #   # @param state [Symbol, Lithic::Models::Account::State]
-      #   # @param account_holder [Lithic::Models::Account::AccountHolder]
-      #   # @param auth_rule_tokens [Array<String>]
-      #   # @param cardholder_currency [String]
-      #   # @param verification_address [Lithic::Models::Account::VerificationAddress]
-      #   #
-      #   def initialize(
-      #     token:,
-      #     created:,
-      #     spend_limit:,
-      #     state:,
-      #     account_holder: nil,
-      #     auth_rule_tokens: nil,
-      #     cardholder_currency: nil,
-      #     verification_address: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+      # @!method initialize(token:, created:, spend_limit:, state:, account_holder: nil, auth_rule_tokens: nil, cardholder_currency: nil, verification_address: nil)
+      #   @param token [String]
+      #   @param created [Time, nil]
+      #   @param spend_limit [Lithic::Models::Account::SpendLimit]
+      #   @param state [Symbol, Lithic::Models::Account::State]
+      #   @param account_holder [Lithic::Models::Account::AccountHolder]
+      #   @param auth_rule_tokens [Array<String>]
+      #   @param cardholder_currency [String]
+      #   @param verification_address [Lithic::Models::Account::VerificationAddress]
 
       # @see Lithic::Models::Account#spend_limit
       class SpendLimit < Lithic::Internal::Type::BaseModel
@@ -132,20 +99,16 @@ module Lithic
         #   @return [Integer]
         required :monthly, Integer
 
-        # @!parse
-        #   # Spend limit information for the user containing the daily, monthly, and lifetime
-        #   # spend limit of the account. Any charges to a card owned by this account will be
-        #   # declined once their transaction volume has surpassed the value in the applicable
-        #   # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
-        #   # feature is disabled.
-        #   #
-        #   # @param daily [Integer]
-        #   # @param lifetime [Integer]
-        #   # @param monthly [Integer]
-        #   #
-        #   def initialize(daily:, lifetime:, monthly:, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(daily:, lifetime:, monthly:)
+        #   Spend limit information for the user containing the daily, monthly, and lifetime
+        #   spend limit of the account. Any charges to a card owned by this account will be
+        #   declined once their transaction volume has surpassed the value in the applicable
+        #   time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
+        #   feature is disabled.
+        #
+        #   @param daily [Integer]
+        #   @param lifetime [Integer]
+        #   @param monthly [Integer]
       end
 
       # Account state:
@@ -168,11 +131,8 @@ module Lithic
         PAUSED = :PAUSED
         CLOSED = :CLOSED
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # @see Lithic::Models::Account#account_holder
@@ -203,15 +163,11 @@ module Lithic
         #   @return [String]
         required :phone_number, String
 
-        # @!parse
-        #   # @param token [String]
-        #   # @param business_account_token [String]
-        #   # @param email [String]
-        #   # @param phone_number [String]
-        #   #
-        #   def initialize(token:, business_account_token:, email:, phone_number:, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(token:, business_account_token:, email:, phone_number:)
+        #   @param token [String]
+        #   @param business_account_token [String]
+        #   @param email [String]
+        #   @param phone_number [String]
       end
 
       # @deprecated
@@ -251,27 +207,19 @@ module Lithic
         #   @return [String]
         required :state, String
 
-        # @!attribute [r] address2
+        # @!attribute address2
         #   Unit or apartment number (if applicable).
         #
         #   @return [String, nil]
         optional :address2, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :address2
-
-        # @!parse
-        #   # @param address1 [String]
-        #   # @param city [String]
-        #   # @param country [String]
-        #   # @param postal_code [String]
-        #   # @param state [String]
-        #   # @param address2 [String]
-        #   #
-        #   def initialize(address1:, city:, country:, postal_code:, state:, address2: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+        #   @param address1 [String]
+        #   @param city [String]
+        #   @param country [String]
+        #   @param postal_code [String]
+        #   @param state [String]
+        #   @param address2 [String]
       end
     end
   end

data/lib/lithic/models/account_financial_account_type.rb

@@ -9,11 +9,8 @@ module Lithic
       ISSUING = :ISSUING
       OPERATING = :OPERATING
 
-      finalize!
-
-      # @!parse
-      #   # @return [Array<Symbol>]
-      #   def self.values; end
+      # @!method self.values
+      #   @return [Array<Symbol>]
     end
   end
 end