orb-billing 0.1.0.pre.alpha.36 → 0.1.0.pre.alpha.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b9a07db051eae4111b0f211028a725503206e57861f9d06cc9b149106f2d4b
-  data.tar.gz: 6cbb4d34bb7b937c10539ca1d9b626605472df33dfc61b0144164cffbcd489a7
+  metadata.gz: 249d2973800ed2fb6c87fe4e0c7b22208082baef56fa69146ebd6b6eb464fd0f
+  data.tar.gz: e3db0fd166e2f0e698bc3487a9e69d6b0461bdab175a105624f43b4b230c150d
 SHA512:
-  metadata.gz: 9d99ade805f47dfffb3523fe4e47479edf7b00814d76699d3cb1ff49bb5217f35b91c1807dbd387065637437db6e2bca2c9fab9d19154572e9c7c2f2230b295c
-  data.tar.gz: 5e7fd4516123aa1974e5d28a0535cd4a466533bc655b9feb184995b1cb83abd06faf39e73e143eddff56b46c11077d1ab26fddc8c0d01a9e56dde202a791998f
+  metadata.gz: ce5534719e3cfa2faa48435c2ec0b84910f1f1cfb4e5679c43ae6cbe4d218855479bac17e467d723799ccf1953197a7cfe9a89442f5b904bcb252a66490b9fb8
+  data.tar.gz: fed3c6b0e6311ab74defabad0b7fa99f6b464de6dce1af15f2212e7c4725211eba89aae5fd4747611ebab9b778a5c036a3b7b8a1d808fdf8609f6b2af28869fe

data/README.md

@@ -1,6 +1,6 @@
 # Orb Ruby API library
 
-The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.0.0+ application.
+The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.1.0+ application.
 
 ## Documentation
 
@@ -12,10 +12,14 @@ The underlying REST API documentation can be found on [docs.withorb.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 "orb-billing", "~> 0.1.0.pre.alpha.35"
+gem "orb-billing", "~> 0.1.0.pre.alpha.37"
 ```
 
+<!-- x-release-please-end -->
+
 To fetch an initial copy of the gem:
 
 ```sh
@@ -128,9 +132,25 @@ orb.customers.create(
 )
 ```
 
-## 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`.
 
@@ -141,13 +161,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 = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer")
+params = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer")
 
-orb.customers.create(**model)
+orb.customers.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 `Orb::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.
@@ -166,4 +217,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/orb/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Orb
-  class Client < Orb::Transport::BaseClient
+  class Client < Orb::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 

data/lib/orb/errors.rb

@@ -101,7 +101,7 @@ module Orb
       #
       # @return [Orb::Errors::APIStatusError]
       def self.for(url:, status:, body:, request:, response:, message: nil)
-        key = Orb::Util.dig(body, :type)
+        key = Orb::Internal::Util.dig(body, :type)
         kwargs = {
           url: url,
           status: status,
@@ -262,56 +262,4 @@ module Orb
       TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error"
     end
   end
-
-  Error = Orb::Errors::Error
-
-  ConversionError = Orb::Errors::ConversionError
-
-  APIError = Orb::Errors::APIError
-
-  APIStatusError = Orb::Errors::APIStatusError
-
-  APIConnectionError = Orb::Errors::APIConnectionError
-
-  APITimeoutError = Orb::Errors::APITimeoutError
-
-  BadRequestError = Orb::Errors::BadRequestError
-
-  AuthenticationError = Orb::Errors::AuthenticationError
-
-  PermissionDeniedError = Orb::Errors::PermissionDeniedError
-
-  NotFoundError = Orb::Errors::NotFoundError
-
-  ConflictError = Orb::Errors::ConflictError
-
-  UnprocessableEntityError = Orb::Errors::UnprocessableEntityError
-
-  RateLimitError = Orb::Errors::RateLimitError
-
-  InternalServerError = Orb::Errors::InternalServerError
-
-  ConstraintViolation = Orb::Errors::ConstraintViolation
-
-  DuplicateResourceCreation = Orb::Errors::DuplicateResourceCreation
-
-  FeatureNotAvailable = Orb::Errors::FeatureNotAvailable
-
-  RequestValidationError = Orb::Errors::RequestValidationError
-
-  OrbAuthenticationError = Orb::Errors::OrbAuthenticationError
-
-  ResourceNotFound = Orb::Errors::ResourceNotFound
-
-  URLNotFound = Orb::Errors::URLNotFound
-
-  ResourceConflict = Orb::Errors::ResourceConflict
-
-  RequestTooLarge = Orb::Errors::RequestTooLarge
-
-  ResourceTooLarge = Orb::Errors::ResourceTooLarge
-
-  TooManyRequests = Orb::Errors::TooManyRequests
-
-  OrbInternalServerError = Orb::Errors::OrbInternalServerError
 end

data/lib/orb/internal/page.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Orb
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if page.has_next?
+    #     page = page.next_page
+    #   end
+    #
+    # @example
+    #   page.auto_paging_each do |coupon|
+    #     puts(coupon)
+    #   end
+    class Page
+      include Orb::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [PaginationMetadata]
+      attr_accessor :pagination_metadata
+
+      # @api private
+      #
+      # @param client [Orb::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 { Orb::Internal::Type::Converter.coerce(model, _1) }
+        else
+        end
+
+        case page_data
+        in {pagination_metadata: Hash | nil => pagination_metadata}
+          @pagination_metadata =
+            Orb::Internal::Type::Converter.coerce(
+              Orb::Internal::Page::PaginationMetadata,
+              pagination_metadata
+            )
+        else
+        end
+      end
+
+      # @return [Boolean]
+      def next_page?
+        !pagination_metadata&.next_cursor.nil?
+      end
+
+      # @raise [Orb::HTTP::Error]
+      # @return [Orb::Internal::Page]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Orb::Internal::Util.deep_merge(@req, {query: {cursor: pagination_metadata&.next_cursor}})
+        @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
+        # rubocop:disable Layout/LineLength
+        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} pagination_metadata=#{pagination_metadata.inspect}>"
+        # rubocop:enable Layout/LineLength
+      end
+
+      class PaginationMetadata < Orb::Internal::Type::BaseModel
+        # @!attribute has_more
+        #
+        #   @return [Boolean]
+        required :has_more, Orb::Internal::Type::Boolean
+
+        # @!attribute next_cursor
+        #
+        #   @return [String, nil]
+        required :next_cursor, String, nil?: true
+
+        # @!parse
+        #   # @param has_more [Boolean]
+        #   # @param next_cursor [String, nil]
+        #   #
+        #   def initialize(has_more:, next_cursor:, **) = super
+
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      end
+    end
+  end
+end