dodopayments 0.0.1.pre.alpha.0

data/lib/dodopayments/base_page.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  # @abstract
+  #
+  # @example
+  # ```ruby
+  # if page.has_next?
+  #   page = page.next_page
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # page.auto_paging_each do |payment|
+  #   puts(payment)
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # payments = page
+  #   .to_enum
+  #   .lazy
+  #   .select { _1.object_id.even? }
+  #   .map(&:itself)
+  #   .take(2)
+  #   .to_a
+  #
+  # payments => Array
+  # ```
+  module BasePage
+    # @return [Boolean]
+    def next_page? = (raise NotImplementedError)
+
+    # @raise [Dodopayments::APIError]
+    # @return [Dodopayments::BasePage]
+    def next_page = (raise NotImplementedError)
+
+    # @param blk [Proc]
+    #
+    # @return [void]
+    def auto_paging_each(&) = (raise NotImplementedError)
+
+    # @return [Enumerable]
+    def to_enum = super(:auto_paging_each)
+
+    alias_method :enum_for, :to_enum
+
+    # @api private
+    #
+    # @param client [Dodopayments::BaseClient]
+    # @param req [Hash{Symbol=>Object}]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param page_data [Object]
+    def initialize(client:, req:, headers:, page_data:)
+      @client = client
+      @req = req
+      super()
+    end
+  end
+end

data/lib/dodopayments/client.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  class Client < Dodopayments::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
+
+    # rubocop:disable Style/MutableConstant
+    ENVIRONMENTS = {live_mode: "https://live.dodopayments.com", test_mode: "https://test.dodopayments.com"}
+    # rubocop:enable Style/MutableConstant
+
+    # Bearer Token for API authentication
+    # @return [String]
+    attr_reader :bearer_token
+
+    # @return [Dodopayments::Resources::Payments]
+    attr_reader :payments
+
+    # @return [Dodopayments::Resources::Subscriptions]
+    attr_reader :subscriptions
+
+    # @return [Dodopayments::Resources::Invoices]
+    attr_reader :invoices
+
+    # @return [Dodopayments::Resources::Licenses]
+    attr_reader :licenses
+
+    # @return [Dodopayments::Resources::LicenseKeys]
+    attr_reader :license_keys
+
+    # @return [Dodopayments::Resources::LicenseKeyInstances]
+    attr_reader :license_key_instances
+
+    # @return [Dodopayments::Resources::Customers]
+    attr_reader :customers
+
+    # @return [Dodopayments::Resources::Refunds]
+    attr_reader :refunds
+
+    # @return [Dodopayments::Resources::Disputes]
+    attr_reader :disputes
+
+    # @return [Dodopayments::Resources::Payouts]
+    attr_reader :payouts
+
+    # @return [Dodopayments::Resources::WebhookEvents]
+    attr_reader :webhook_events
+
+    # @return [Dodopayments::Resources::Products]
+    attr_reader :products
+
+    # @return [Dodopayments::Resources::Misc]
+    attr_reader :misc
+
+    # @return [Dodopayments::Resources::Discounts]
+    attr_reader :discounts
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @bearer_token.nil?
+
+      {"authorization" => "Bearer #{@bearer_token}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param environment [:live_mode, :test_mode, nil] Specifies the environment to use for the API.
+    #
+    #   Each environment maps to a different base URL:
+    #
+    #   - `live_mode` corresponds to `https://live.dodopayments.com`
+    #   - `test_mode` corresponds to `https://test.dodopayments.com`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param bearer_token [String, nil] Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
+    #
+    # @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]
+    def initialize(
+      environment: nil,
+      base_url: nil,
+      bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
+      max_retries: DEFAULT_MAX_RETRIES,
+      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+    )
+      case [environment, base_url]
+      in [Symbol | String, String]
+        raise ArgumentError.new("both environment and base_url given, expected only one")
+      in [Symbol | String, nil]
+        base_url = ENVIRONMENTS.fetch(environment.to_sym) do
+          raise ArgumentError.new("environment must be one of #{ENVIRONMENTS.keys}, got #{environment}")
+        end
+      else
+        base_url ||= ENVIRONMENTS.fetch(:production)
+      end
+
+      if bearer_token.nil?
+        raise ArgumentError.new("bearer_token is required")
+      end
+
+      @bearer_token = bearer_token.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
+      )
+
+      @payments = Dodopayments::Resources::Payments.new(client: self)
+      @subscriptions = Dodopayments::Resources::Subscriptions.new(client: self)
+      @invoices = Dodopayments::Resources::Invoices.new(client: self)
+      @licenses = Dodopayments::Resources::Licenses.new(client: self)
+      @license_keys = Dodopayments::Resources::LicenseKeys.new(client: self)
+      @license_key_instances = Dodopayments::Resources::LicenseKeyInstances.new(client: self)
+      @customers = Dodopayments::Resources::Customers.new(client: self)
+      @refunds = Dodopayments::Resources::Refunds.new(client: self)
+      @disputes = Dodopayments::Resources::Disputes.new(client: self)
+      @payouts = Dodopayments::Resources::Payouts.new(client: self)
+      @webhook_events = Dodopayments::Resources::WebhookEvents.new(client: self)
+      @products = Dodopayments::Resources::Products.new(client: self)
+      @misc = Dodopayments::Resources::Misc.new(client: self)
+      @discounts = Dodopayments::Resources::Discounts.new(client: self)
+    end
+  end
+end

data/lib/dodopayments/default_page_number_pagination.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  # @example
+  # ```ruby
+  # if default_page_number_pagination.has_next?
+  #   default_page_number_pagination = default_page_number_pagination.next_page
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # default_page_number_pagination.auto_paging_each do |payment|
+  #   puts(payment)
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # payments = default_page_number_pagination
+  #   .to_enum
+  #   .lazy
+  #   .select { _1.object_id.even? }
+  #   .map(&:itself)
+  #   .take(2)
+  #   .to_a
+  #
+  # payments => Array
+  # ```
+  class DefaultPageNumberPagination
+    include Dodopayments::BasePage
+
+    # @return [Array<Object>, nil]
+    attr_accessor :items
+
+    # @api private
+    #
+    # @param client [Dodopayments::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 {items: Array | nil => items}
+        @items = items&.map { model.coerce(_1) }
+      else
+      end
+    end
+
+    # @return [Boolean]
+    def next_page?
+      !items.to_a.empty?
+    end
+
+    # @raise [Dodopayments::HTTP::Error]
+    # @return [Dodopayments::DefaultPageNumberPagination]
+    def next_page
+      unless next_page?
+        raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}")
+      end
+
+      req = Dodopayments::Util.deep_merge(
+        @req,
+        {
+          query: {
+            page_number: @req.fetch(:query).fetch(
+              :page_number,
+              1
+            ).to_i.succ
+          }
+        }
+      )
+      @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.items&.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)} items=#{items.inspect}>"
+    end
+  end
+end

data/lib/dodopayments/errors.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  class Error < StandardError
+    # @!parse
+    #   # @return [StandardError, nil]
+    #   attr_accessor :cause
+  end
+
+  class ConversionError < Dodopayments::Error
+  end
+
+  class APIError < Dodopayments::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 < Dodopayments::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 < Dodopayments::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 < Dodopayments::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 [Dodopayments::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
+        Dodopayments::BadRequestError.new(**kwargs)
+      in 401
+        Dodopayments::AuthenticationError.new(**kwargs)
+      in 403
+        Dodopayments::PermissionDeniedError.new(**kwargs)
+      in 404
+        Dodopayments::NotFoundError.new(**kwargs)
+      in 409
+        Dodopayments::ConflictError.new(**kwargs)
+      in 422
+        Dodopayments::UnprocessableEntityError.new(**kwargs)
+      in 429
+        Dodopayments::RateLimitError.new(**kwargs)
+      in (500..)
+        Dodopayments::InternalServerError.new(**kwargs)
+      else
+        Dodopayments::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 < Dodopayments::APIStatusError
+    HTTP_STATUS = 400
+  end
+
+  class AuthenticationError < Dodopayments::APIStatusError
+    HTTP_STATUS = 401
+  end
+
+  class PermissionDeniedError < Dodopayments::APIStatusError
+    HTTP_STATUS = 403
+  end
+
+  class NotFoundError < Dodopayments::APIStatusError
+    HTTP_STATUS = 404
+  end
+
+  class ConflictError < Dodopayments::APIStatusError
+    HTTP_STATUS = 409
+  end
+
+  class UnprocessableEntityError < Dodopayments::APIStatusError
+    HTTP_STATUS = 422
+  end
+
+  class RateLimitError < Dodopayments::APIStatusError
+    HTTP_STATUS = 429
+  end
+
+  class InternalServerError < Dodopayments::APIStatusError
+    HTTP_STATUS = (500..)
+  end
+end

data/lib/dodopayments/extern.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  # @api private
+  #
+  # @abstract
+  module Extern
+  end
+end

data/lib/dodopayments/models/attach_existing_customer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class AttachExistingCustomer < Dodopayments::BaseModel
+      # @!attribute customer_id
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!parse
+      #   # @param customer_id [String]
+      #   #
+      #   def initialize(customer_id:, **) = super
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/billing_address.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class BillingAddress < Dodopayments::BaseModel
+      # @!attribute city
+      #   City name
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   ISO country code alpha2 variant
+      #
+      #   @return [Symbol, Dodopayments::Models::CountryCode]
+      required :country, enum: -> { Dodopayments::Models::CountryCode }
+
+      # @!attribute state
+      #   State or province name
+      #
+      #   @return [String]
+      required :state, String
+
+      # @!attribute street
+      #   Street address including house number and unit/apartment if applicable
+      #
+      #   @return [String]
+      required :street, String
+
+      # @!attribute zipcode
+      #   Postal code or ZIP code
+      #
+      #   @return [String]
+      required :zipcode, String
+
+      # @!parse
+      #   # @param city [String]
+      #   # @param country [Symbol, Dodopayments::Models::CountryCode]
+      #   # @param state [String]
+      #   # @param street [String]
+      #   # @param zipcode [String]
+      #   #
+      #   def initialize(city:, country:, state:, street:, zipcode:, **) = super
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end