orb-billing 0.1.0.pre.alpha.33

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bc014def44cf0f8ad16a6cc526d9ac74df50e7822aa91cdc5d8c498cf135fdf
+  data.tar.gz: cca6802aad84e121b38e69b42b7b69ab0f1609571059cdadcabd3df6ad49b538
+SHA512:
+  metadata.gz: a181df7c4b7aeecc9359f50bdffe0cc9f7f5a9e443a633ee10de6c967555369ef38c4b6d17f875b4a313d4f8bc1d743288d6fad8e24358901d54128b7c73bbe5
+  data.tar.gz: 531f49d563191a2a0837e32f1cc62804dc599e3325586798b26db3c1e89622f18f136db7bf8602785d11af2d10e524e803e80afed8782e1909582abb69978b0e

data/README.md

@@ -0,0 +1,169 @@
+# Orb Ruby API library
+
+The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.0.0+ application.
+
+## Documentation
+
+Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/orb-billing).
+
+The underlying REST API documentation can be found on [docs.withorb.com](https://docs.withorb.com/reference/api-reference).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+```ruby
+gem "orb-billing", "~> 0.1.0.pre.alpha.32"
+```
+
+To fetch an initial copy of the gem:
+
+```sh
+bundle install
+```
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "orb-billing"
+
+orb = Orb::Client.new(
+  api_key: "My API Key" # defaults to ENV["ORB_API_KEY"]
+)
+
+customer = orb.customers.create(email: "example-customer@withorb.com", name: "My Customer")
+
+puts(customer.id)
+```
+
+### Pagination
+
+List methods in the Orb API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = orb.coupons.list
+
+# Fetch single item from page.
+coupon = page.data[0]
+puts(coupon.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |coupon|
+  puts(coupon.id)
+end
+```
+
+### Errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Orb::Error` will be thrown:
+
+```ruby
+begin
+  customer = orb.customers.create(email: "example-customer@withorb.com", name: "My Customer")
+rescue Orb::Errors::APIError => e
+  puts(e.status) # 400
+end
+```
+
+Error codes are as followed:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+orb = Orb::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+orb.customers.create(
+  email: "example-customer@withorb.com",
+  name: "My Customer",
+  request_options: {max_retries: 5}
+)
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds.
+
+Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
+
+You can use the `timeout` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+orb = Orb::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+orb.customers.create(
+  email: "example-customer@withorb.com",
+  name: "My Customer",
+  request_options: {timeout: 5}
+)
+```
+
+## Sorbet Support
+
+**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+
+This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+
+What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself.
+
+Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `Orb::BaseModel` class, you will need to use the `**` splat operator to pass the arguments:
+
+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")
+
+orb.customers.create(**model)
+```
+
+## Advanced
+
+### 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.
+
+When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+Currently, `Orb::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.0.0 or higher.

data/lib/orb/client.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Orb
+  class Client < Orb::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [Orb::Resources::TopLevel]
+    attr_reader :top_level
+
+    # @return [Orb::Resources::Coupons]
+    attr_reader :coupons
+
+    # @return [Orb::Resources::CreditNotes]
+    attr_reader :credit_notes
+
+    # @return [Orb::Resources::Customers]
+    attr_reader :customers
+
+    # @return [Orb::Resources::Events]
+    attr_reader :events
+
+    # @return [Orb::Resources::InvoiceLineItems]
+    attr_reader :invoice_line_items
+
+    # @return [Orb::Resources::Invoices]
+    attr_reader :invoices
+
+    # @return [Orb::Resources::Items]
+    attr_reader :items
+
+    # @return [Orb::Resources::Metrics]
+    attr_reader :metrics
+
+    # @return [Orb::Resources::Plans]
+    attr_reader :plans
+
+    # @return [Orb::Resources::Prices]
+    attr_reader :prices
+
+    # @return [Orb::Resources::Subscriptions]
+    attr_reader :subscriptions
+
+    # @return [Orb::Resources::Alerts]
+    attr_reader :alerts
+
+    # @return [Orb::Resources::DimensionalPriceGroups]
+    attr_reader :dimensional_price_groups
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["ORB_API_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    #
+    # @param idempotency_header [String]
+    def initialize(
+      api_key: ENV["ORB_API_KEY"],
+      base_url: nil,
+      max_retries: DEFAULT_MAX_RETRIES,
+      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      idempotency_header: "Idempotency-Key"
+    )
+      base_url ||= "https://api.withorb.com/v1"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"ORB_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay,
+        idempotency_header: idempotency_header
+      )
+
+      @top_level = Orb::Resources::TopLevel.new(client: self)
+      @coupons = Orb::Resources::Coupons.new(client: self)
+      @credit_notes = Orb::Resources::CreditNotes.new(client: self)
+      @customers = Orb::Resources::Customers.new(client: self)
+      @events = Orb::Resources::Events.new(client: self)
+      @invoice_line_items = Orb::Resources::InvoiceLineItems.new(client: self)
+      @invoices = Orb::Resources::Invoices.new(client: self)
+      @items = Orb::Resources::Items.new(client: self)
+      @metrics = Orb::Resources::Metrics.new(client: self)
+      @plans = Orb::Resources::Plans.new(client: self)
+      @prices = Orb::Resources::Prices.new(client: self)
+      @subscriptions = Orb::Resources::Subscriptions.new(client: self)
+      @alerts = Orb::Resources::Alerts.new(client: self)
+      @dimensional_price_groups = Orb::Resources::DimensionalPriceGroups.new(client: self)
+    end
+  end
+end

data/lib/orb/errors.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+module Orb
+  module Errors
+    class Error < StandardError
+      # @!parse
+      #   # @return [StandardError, nil]
+      #   attr_accessor :cause
+    end
+
+    class ConversionError < Orb::Errors::Error
+    end
+
+    class APIError < Orb::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
+
+    class APIConnectionError < Orb::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
+
+    class APITimeoutError < Orb::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
+
+    class APIStatusError < Orb::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 [Orb::Errors::APIStatusError]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        key = Orb::Util.dig(body, :type)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case [status, key]
+        in [400, Orb::Errors::ConstraintViolation::TYPE]
+          Orb::Errors::ConstraintViolation.new(**kwargs)
+        in [400, Orb::Errors::DuplicateResourceCreation::TYPE]
+          Orb::Errors::DuplicateResourceCreation.new(**kwargs)
+        in [400, Orb::Errors::FeatureNotAvailable::TYPE]
+          Orb::Errors::FeatureNotAvailable.new(**kwargs)
+        in [400, Orb::Errors::RequestValidationError::TYPE]
+          Orb::Errors::RequestValidationError.new(**kwargs)
+        in [401, Orb::Errors::OrbAuthenticationError::TYPE]
+          Orb::Errors::OrbAuthenticationError.new(**kwargs)
+        in [404, Orb::Errors::ResourceNotFound::TYPE]
+          Orb::Errors::ResourceNotFound.new(**kwargs)
+        in [404, Orb::Errors::URLNotFound::TYPE]
+          Orb::Errors::URLNotFound.new(**kwargs)
+        in [409, Orb::Errors::ResourceConflict::TYPE]
+          Orb::Errors::ResourceConflict.new(**kwargs)
+        in [413, Orb::Errors::RequestTooLarge::TYPE]
+          Orb::Errors::RequestTooLarge.new(**kwargs)
+        in [413, Orb::Errors::ResourceTooLarge::TYPE]
+          Orb::Errors::ResourceTooLarge.new(**kwargs)
+        in [429, Orb::Errors::TooManyRequests::TYPE]
+          Orb::Errors::TooManyRequests.new(**kwargs)
+        in [(500..), Orb::Errors::OrbInternalServerError::TYPE]
+          Orb::Errors::OrbInternalServerError.new(**kwargs)
+        in [400, _]
+          Orb::Errors::BadRequestError.new(**kwargs)
+        in [401, _]
+          Orb::Errors::AuthenticationError.new(**kwargs)
+        in [403, _]
+          Orb::Errors::PermissionDeniedError.new(**kwargs)
+        in [404, _]
+          Orb::Errors::NotFoundError.new(**kwargs)
+        in [409, _]
+          Orb::Errors::ConflictError.new(**kwargs)
+        in [422, _]
+          Orb::Errors::UnprocessableEntityError.new(**kwargs)
+        in [429, _]
+          Orb::Errors::RateLimitError.new(**kwargs)
+        in [(500..), _]
+          Orb::Errors::InternalServerError.new(**kwargs)
+        else
+          Orb::Errors::APIStatusError.new(**kwargs)
+        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
+        )
+      end
+    end
+
+    class BadRequestError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Orb::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+
+    class ConstraintViolation < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation"
+    end
+
+    class DuplicateResourceCreation < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation"
+    end
+
+    class FeatureNotAvailable < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available"
+    end
+
+    class RequestValidationError < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors"
+    end
+
+    class OrbAuthenticationError < Orb::Errors::AuthenticationError
+      TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error"
+    end
+
+    class ResourceNotFound < Orb::Errors::NotFoundError
+      TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found"
+    end
+
+    class URLNotFound < Orb::Errors::NotFoundError
+      TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found"
+    end
+
+    class ResourceConflict < Orb::Errors::ConflictError
+      TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict"
+    end
+
+    class RequestTooLarge < Orb::Errors::APIStatusError
+      TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large"
+    end
+
+    class ResourceTooLarge < Orb::Errors::APIStatusError
+      TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large"
+    end
+
+    class TooManyRequests < Orb::Errors::RateLimitError
+      TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests"
+    end
+
+    class OrbInternalServerError < Orb::Errors::InternalServerError
+      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