lithic 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e62e72ed7b543b02b1b27f8b6fa01e5d103ade169f16821584c7f25bf795c4
-  data.tar.gz: '059128319fd80fce301facf7fe31a78bb1e7dc285bcf087cbbb865699fa5d799'
+  metadata.gz: 6cc0455f8a47c113c091409b3b4ed5b5522a3ae3c2272f68701084ffbb4b35bf
+  data.tar.gz: 1bc14153bdcce95840ab82520a99ca49f9a943850313c0f73fa15a2a8d4cfc94
 SHA512:
-  metadata.gz: 59726459104a1e320267baff1fbc631a240c873933213fb240cd3a3f952a36e50b105298890e508bbd3dc38ee004c87f2f3e5c908a717dafdd7d3b31f4986362
-  data.tar.gz: b4e731358d20edad987d145a1fff6f2adc6416fa7fbf0384ff3296e72eb511a30cde488f9451d137547b075dcad602c40540d247bddcd2fee325bf37e6a37a50
+  metadata.gz: f8c91140b58743c9972ebb4d79a003844f242f076056a3c1ce7052125ec5c6941bf1033972b23f9c8637768123abc450c32efa651ea59c9acf571c673b021f14
+  data.tar.gz: 12ccc695ebb93e4df2aa828dbff4bece059d99ddd249dfa7e837229c01ca196a5a7956d832fc01557ffa33a524231e880aea6c8578d238713b58161b7cf1c04e

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
 
@@ -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.3"
+gem "lithic", "~> 0.1.0.pre.alpha.5"
 ```
 
+<!-- x-release-please-end -->
+
 To fetch an initial copy of the gem:
 
 ```sh
@@ -121,9 +125,25 @@ lithic = Lithic::Client.new(
 lithic.cards.list(page_size: 10, request_options: {timeout: 5})
 ```
 
-## Sorbet Support
+## LSP Support
+
+### Solargraph
+
+This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
+
+```ruby
+gem "solargraph", group: :development
+```
 
-**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
+
+```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`.
 
@@ -134,13 +154,44 @@ 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
+
+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 +210,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,86 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Internal
+    # @generic Elem
+    #
+    # @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<generic<Elem>>, 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]
+      #
+      # @yieldparam [generic<Elem>]
+      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,80 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Internal
+    # @generic Elem
+    #
+    # @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<generic<Elem>>, 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]
+      #
+      # @yieldparam [generic<Elem>]
+      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