lithic 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: febba602b14ac4bf3aa9463771562e22cf994cb9d6dceea77a605999b16b98d9
-  data.tar.gz: 1f336fd1d3754875d979d622bce1a91315b924ad2d89fec39df0766a3eb4850e
+  metadata.gz: c878a0ee5f6aba02f1f1ccd5ea1afeb092e3b5b71495a3ebf590154ad80b4d88
+  data.tar.gz: d849bdf0caf2255bddaaa86f9ed6c3af7a1b4e277015cdae0adaba2861f48e3e
 SHA512:
-  metadata.gz: ab90c3f56d7c0a438195aaa7b3b78c103ebd3f855f8a9ba1292a622ab4298d823dd49566646adefd7a2adc5d477fb34ef5f625523a12564d53cfe09779e82314
-  data.tar.gz: 46640e59b8a10b3d9e8612a55141cd0c0850e2a846c2c658eebc9d151172096a44859af3fb5cbc3a40b2c6773393e59acd8e827e77f315460dad752b805bae8e
+  metadata.gz: 7be928a465d075049a036380e5c195b634095d0a417bc1c4ca451db1a6aa0a87661ac51e528c5fcdb3cff69ce6281675063927becb88abb11ff066b8cae65c50
+  data.tar.gz: b9711354f43f14e04e7fbe2aa47f0d6faa580271e67c76981f3074ce17e02bb5ef1318773424ac6272c068b6f67d1ade506bec1c57896fe9f95856dd1a0b232f

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.0.0+ application.
+The Lithic Ruby library provides convenient access to the Lithic REST API from any Ruby 3.1.0+ application.
 
 ## Documentation
 
@@ -13,7 +13,7 @@ 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`:
 
 ```ruby
-gem "lithic", "~> 0.1.0.pre.alpha.2"
+gem "lithic", "~> 0.1.0.pre.alpha.4"
 ```
 
 To fetch an initial copy of the gem:
@@ -64,7 +64,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 ```ruby
 begin
   card = lithic.cards.create(type: "an_incorrect_type")
-rescue Lithic::Error => e
+rescue Lithic::Errors::APIError => e
   puts(e.status) # 400
 end
 ```
@@ -80,7 +80,7 @@ Error codes are as followed:
 | HTTP 409         | `ConflictError`            |
 | HTTP 422         | `UnprocessableEntityError` |
 | HTTP 429         | `RateLimitError`           |
-| HTTP >=500       | `InternalServerError`      |
+| HTTP >= 500      | `InternalServerError`      |
 | Other HTTP error | `APIStatusError`           |
 | Timeout          | `APITimeoutError`          |
 | Network error    | `APIConnectionError`       |
@@ -121,7 +121,9 @@ lithic = Lithic::Client.new(
 lithic.cards.list(page_size: 10, request_options: {timeout: 5})
 ```
 
-## Sorbet Support
+## LSP Support
+
+### Sorbet
 
 **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
 
@@ -141,6 +143,31 @@ lithic.cards.create(**model)
 
 ## Advanced
 
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### 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.
+
+#### 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.
+
+```ruby
+response =
+  client.request(
+    method: :post,
+    path: '/undocumented/endpoint',
+    query: {"dog": "woof"},
+    headers: {"useful-header": "interesting-value"},
+    body: {"he": "llo"},
+  )
+```
+
 ### 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.
@@ -159,4 +186,4 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.0.0 or higher.
+Ruby 3.1.0 or higher.

data/lib/lithic/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Lithic
-  class Client < Lithic::Transport::BaseClient
+  class Client < Lithic::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -100,11 +100,13 @@ module Lithic
 
     # Status of api
     #
-    # @param params [Lithic::Models::ClientAPIStatusParams, Hash{Symbol=>Object}] .
+    # @overload api_status(request_options: {})
     #
-    #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+    # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
     #
     # @return [Lithic::Models::APIStatus]
+    #
+    # @see Lithic::Models::ClientAPIStatusParams
     def api_status(params = {})
       request(
         method: :get,
@@ -123,6 +125,8 @@ module Lithic
 
     # Creates and returns a new client for interacting with the API.
     #
+    # @param api_key [String, nil] Defaults to `ENV["LITHIC_API_KEY"]`
+    #
     # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
     #
     #   Each environment maps to a different base URL:
@@ -132,8 +136,6 @@ module Lithic
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
     #
-    # @param api_key [String, nil] Defaults to `ENV["LITHIC_API_KEY"]`
-    #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
     # @param timeout [Float]
@@ -142,9 +144,9 @@ module Lithic
     #
     # @param max_retry_delay [Float]
     def initialize(
+      api_key: ENV["LITHIC_API_KEY"],
       environment: nil,
       base_url: nil,
-      api_key: ENV["LITHIC_API_KEY"],
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
@@ -162,7 +164,7 @@ module Lithic
       end
 
       if api_key.nil?
-        raise ArgumentError.new("api_key is required")
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"LITHIC_API_KEY\"")
       end
 
       headers = {

data/lib/lithic/errors.rb

@@ -1,183 +1,192 @@
 # frozen_string_literal: true
 
 module Lithic
-  class Error < StandardError
-    # @!parse
-    #   # @return [StandardError, nil]
-    #   attr_accessor :cause
-  end
-
-  class ConversionError < Lithic::Error
-  end
-
-  class APIError < Lithic::Error
-    # @return [URI::Generic]
-    attr_accessor :url
-
-    # @return [Integer, nil]
-    attr_accessor :status
-
-    # @return [Object, nil]
-    attr_accessor :body
-
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer, nil]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
-      @url = url
-      @status = status
-      @body = body
-      @request = request
-      @response = response
-      super(message)
+  module Errors
+    class Error < StandardError
+      # @!parse
+      #   # @return [StandardError, nil]
+      #   attr_accessor :cause
     end
-  end
 
-  class APIConnectionError < Lithic::APIError
-    # @!parse
-    #   # @return [nil]
-    #   attr_accessor :status
-
-    # @!parse
-    #   # @return [nil]
-    #   attr_accessor :body
-
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [nil]
-    # @param body [nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(
-      url:,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: "Connection error."
-    )
-      super
+    class ConversionError < Lithic::Errors::Error
     end
-  end
 
-  class APITimeoutError < Lithic::APIConnectionError
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [nil]
-    # @param body [nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(
-      url:,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: "Request timed out."
-    )
-      super
+    class APIError < Lithic::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
     end
-  end
 
-  class APIStatusError < Lithic::APIError
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    #
-    # @return [Lithic::APIStatusError]
-    def self.for(url:, status:, body:, request:, response:, message: nil)
-      kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
-
-      case status
-      in 400
-        Lithic::BadRequestError.new(**kwargs)
-      in 401
-        Lithic::AuthenticationError.new(**kwargs)
-      in 403
-        Lithic::PermissionDeniedError.new(**kwargs)
-      in 404
-        Lithic::NotFoundError.new(**kwargs)
-      in 409
-        Lithic::ConflictError.new(**kwargs)
-      in 422
-        Lithic::UnprocessableEntityError.new(**kwargs)
-      in 429
-        Lithic::RateLimitError.new(**kwargs)
-      in (500..)
-        Lithic::InternalServerError.new(**kwargs)
-      else
-        Lithic::APIStatusError.new(**kwargs)
+    class APIConnectionError < Lithic::Errors::APIError
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :status
+
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
       end
     end
 
-    # @!parse
-    #   # @return [Integer]
-    #   attr_accessor :status
-
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(url:, status:, body:, request:, response:, message: nil)
-      message ||= {url: url.to_s, status: status, body: body}
-      super(
-        url: url,
-        status: status,
-        body: body,
-        request: request,
-        response: response,
-        message: message&.to_s
+    class APITimeoutError < Lithic::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
       )
+        super
+      end
     end
-  end
 
-  class BadRequestError < Lithic::APIStatusError
-    HTTP_STATUS = 400
-  end
+    class APIStatusError < Lithic::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [Lithic::Errors::APIStatusError]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          Lithic::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Lithic::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Lithic::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Lithic::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Lithic::Errors::ConflictError.new(**kwargs)
+        in 422
+          Lithic::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Lithic::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Lithic::Errors::InternalServerError.new(**kwargs)
+        else
+          Lithic::Errors::APIStatusError.new(**kwargs)
+        end
+      end
 
-  class AuthenticationError < Lithic::APIStatusError
-    HTTP_STATUS = 401
-  end
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
 
-  class PermissionDeniedError < Lithic::APIStatusError
-    HTTP_STATUS = 403
-  end
+    class BadRequestError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
 
-  class NotFoundError < Lithic::APIStatusError
-    HTTP_STATUS = 404
-  end
+    class AuthenticationError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
 
-  class ConflictError < Lithic::APIStatusError
-    HTTP_STATUS = 409
-  end
+    class PermissionDeniedError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
 
-  class UnprocessableEntityError < Lithic::APIStatusError
-    HTTP_STATUS = 422
-  end
+    class NotFoundError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
 
-  class RateLimitError < Lithic::APIStatusError
-    HTTP_STATUS = 429
-  end
+    class ConflictError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
 
-  class InternalServerError < Lithic::APIStatusError
-    HTTP_STATUS = (500..)
+    class RateLimitError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
   end
 end

data/lib/lithic/internal/cursor_page.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Internal
+    # @example
+    #   if cursor_page.has_next?
+    #     cursor_page = cursor_page.next_page
+    #   end
+    #
+    # @example
+    #   cursor_page.auto_paging_each do |account|
+    #     puts(account)
+    #   end
+    class CursorPage
+      include Lithic::Internal::Type::BasePage
+
+      # @return [Array<Object>, nil]
+      attr_accessor :data
+
+      # @return [Boolean]
+      attr_accessor :has_more
+
+      # @api private
+      #
+      # @param client [Lithic::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+        model = req.fetch(:model)
+
+        case page_data
+        in {data: Array | nil => data}
+          @data = data&.map { Lithic::Internal::Type::Converter.coerce(model, _1) }
+        else
+        end
+
+        case page_data
+        in {has_more: true | false => has_more}
+          @has_more = has_more
+        else
+        end
+      end
+
+      # @return [Boolean]
+      def next_page?
+        has_more
+      end
+
+      # @raise [Lithic::HTTP::Error]
+      # @return [Lithic::Internal::CursorPage]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Lithic::Internal::Util.deep_merge(@req, {query: {starting_after: data&.last&.token}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+        page = self
+        loop do
+          page.data&.each { blk.call(_1) }
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} has_more=#{has_more.inspect}>"
+      end
+    end
+  end
+end

data/lib/lithic/internal/single_page.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Internal
+    # @example
+    #   if single_page.has_next?
+    #     single_page = single_page.next_page
+    #   end
+    #
+    # @example
+    #   single_page.auto_paging_each do |account_holder|
+    #     puts(account_holder)
+    #   end
+    class SinglePage
+      include Lithic::Internal::Type::BasePage
+
+      # @return [Array<Object>, nil]
+      attr_accessor :data
+
+      # @return [Boolean]
+      attr_accessor :has_more
+
+      # @api private
+      #
+      # @param client [Lithic::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Array<Object>]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+        model = req.fetch(:model)
+
+        case page_data
+        in {data: Array | nil => data}
+          @data = data&.map { Lithic::Internal::Type::Converter.coerce(model, _1) }
+        else
+        end
+
+        case page_data
+        in {has_more: true | false => has_more}
+          @has_more = has_more
+        else
+        end
+      end
+
+      # @return [Boolean]
+      def next_page?
+        has_more
+      end
+
+      # @raise [Lithic::HTTP::Error]
+      # @return [Lithic::Internal::SinglePage]
+      def next_page
+        RuntimeError.new("No more pages available.")
+      end
+
+      # @param blk [Proc]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+        page = self
+        loop do
+          page.data&.each { blk.call(_1) }
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} has_more=#{has_more.inspect}>"
+      end
+    end
+  end
+end