lithic 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e62e72ed7b543b02b1b27f8b6fa01e5d103ade169f16821584c7f25bf795c4
-  data.tar.gz: '059128319fd80fce301facf7fe31a78bb1e7dc285bcf087cbbb865699fa5d799'
+  metadata.gz: c878a0ee5f6aba02f1f1ccd5ea1afeb092e3b5b71495a3ebf590154ad80b4d88
+  data.tar.gz: d849bdf0caf2255bddaaa86f9ed6c3af7a1b4e277015cdae0adaba2861f48e3e
 SHA512:
-  metadata.gz: 59726459104a1e320267baff1fbc631a240c873933213fb240cd3a3f952a36e50b105298890e508bbd3dc38ee004c87f2f3e5c908a717dafdd7d3b31f4986362
-  data.tar.gz: b4e731358d20edad987d145a1fff6f2adc6416fa7fbf0384ff3296e72eb511a30cde488f9451d137547b075dcad602c40540d247bddcd2fee325bf37e6a37a50
+  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.3"
+gem "lithic", "~> 0.1.0.pre.alpha.4"
 ```
 
 To fetch an initial copy of the gem:
@@ -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
 

data/lib/lithic/errors.rb

@@ -189,32 +189,4 @@ module Lithic
       HTTP_STATUS = (500..)
     end
   end
-
-  Error = Lithic::Errors::Error
-
-  ConversionError = Lithic::Errors::ConversionError
-
-  APIError = Lithic::Errors::APIError
-
-  APIStatusError = Lithic::Errors::APIStatusError
-
-  APIConnectionError = Lithic::Errors::APIConnectionError
-
-  APITimeoutError = Lithic::Errors::APITimeoutError
-
-  BadRequestError = Lithic::Errors::BadRequestError
-
-  AuthenticationError = Lithic::Errors::AuthenticationError
-
-  PermissionDeniedError = Lithic::Errors::PermissionDeniedError
-
-  NotFoundError = Lithic::Errors::NotFoundError
-
-  ConflictError = Lithic::Errors::ConflictError
-
-  UnprocessableEntityError = Lithic::Errors::UnprocessableEntityError
-
-  RateLimitError = Lithic::Errors::RateLimitError
-
-  InternalServerError = Lithic::Errors::InternalServerError
 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