lithic 0.1.0.pre.alpha.1

data/lib/lithic/base_page.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Lithic
+  # @example
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
+  #
+  # @example
+  #   page.auto_paging_each do |client|
+  #     puts(client)
+  #   end
+  #
+  # @example
+  #   clients =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
+  #
+  #   clients => Array
+  module BasePage
+    # rubocop:disable Lint/UnusedMethodArgument
+
+    # @return [Boolean]
+    def next_page? = (raise NotImplementedError)
+
+    # @raise [Lithic::APIError]
+    # @return [Lithic::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 [Lithic::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
+
+    # rubocop:enable Lint/UnusedMethodArgument
+  end
+end

data/lib/lithic/client.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Lithic
+  class Client < Lithic::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
+    # @type [Hash{Symbol=>String}]
+    ENVIRONMENTS = {production: "https://api.lithic.com", sandbox: "https://sandbox.lithic.com"}
+    # rubocop:enable Style/MutableConstant
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [Lithic::Resources::Accounts]
+    attr_reader :accounts
+
+    # @return [Lithic::Resources::AccountHolders]
+    attr_reader :account_holders
+
+    # @return [Lithic::Resources::AuthRules]
+    attr_reader :auth_rules
+
+    # @return [Lithic::Resources::AuthStreamEnrollment]
+    attr_reader :auth_stream_enrollment
+
+    # @return [Lithic::Resources::TokenizationDecisioning]
+    attr_reader :tokenization_decisioning
+
+    # @return [Lithic::Resources::Tokenizations]
+    attr_reader :tokenizations
+
+    # @return [Lithic::Resources::Cards]
+    attr_reader :cards
+
+    # @return [Lithic::Resources::Balances]
+    attr_reader :balances
+
+    # @return [Lithic::Resources::AggregateBalances]
+    attr_reader :aggregate_balances
+
+    # @return [Lithic::Resources::Disputes]
+    attr_reader :disputes
+
+    # @return [Lithic::Resources::Events]
+    attr_reader :events
+
+    # @return [Lithic::Resources::Transfers]
+    attr_reader :transfers
+
+    # @return [Lithic::Resources::FinancialAccounts]
+    attr_reader :financial_accounts
+
+    # @return [Lithic::Resources::Transactions]
+    attr_reader :transactions
+
+    # @return [Lithic::Resources::ResponderEndpoints]
+    attr_reader :responder_endpoints
+
+    # @return [Lithic::Resources::ExternalBankAccounts]
+    attr_reader :external_bank_accounts
+
+    # @return [Lithic::Resources::Payments]
+    attr_reader :payments
+
+    # @return [Lithic::Resources::ThreeDS]
+    attr_reader :three_ds
+
+    # @return [Lithic::Resources::Reports]
+    attr_reader :reports
+
+    # @return [Lithic::Resources::CardPrograms]
+    attr_reader :card_programs
+
+    # @return [Lithic::Resources::DigitalCardArt]
+    attr_reader :digital_card_art
+
+    # @return [Lithic::Resources::BookTransfers]
+    attr_reader :book_transfers
+
+    # @return [Lithic::Resources::CreditProducts]
+    attr_reader :credit_products
+
+    # @return [Lithic::Resources::ExternalPayments]
+    attr_reader :external_payments
+
+    # @return [Lithic::Resources::ManagementOperations]
+    attr_reader :management_operations
+
+    # Status of api
+    #
+    # @param params [Lithic::Models::ClientAPIStatusParams, Hash{Symbol=>Object}] .
+    #
+    #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+    #
+    # @return [Lithic::Models::APIStatus]
+    def api_status(params = {})
+      request(
+        method: :get,
+        path: "v1/status",
+        model: Lithic::Models::APIStatus,
+        options: params[:request_options]
+      )
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      {"authorization" => @api_key}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
+    #
+    #   Each environment maps to a different base URL:
+    #
+    #   - `production` corresponds to `https://api.lithic.com`
+    #   - `sandbox` corresponds to `https://sandbox.lithic.com`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param api_key [String, nil] Defaults to `ENV["LITHIC_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,
+      api_key: ENV["LITHIC_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 api_key.nil?
+        raise ArgumentError.new("api_key is required")
+      end
+
+      headers = {
+        "x-lithic-pagination" => "cursor"
+      }
+
+      @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,
+        headers: headers
+      )
+
+      @accounts = Lithic::Resources::Accounts.new(client: self)
+      @account_holders = Lithic::Resources::AccountHolders.new(client: self)
+      @auth_rules = Lithic::Resources::AuthRules.new(client: self)
+      @auth_stream_enrollment = Lithic::Resources::AuthStreamEnrollment.new(client: self)
+      @tokenization_decisioning = Lithic::Resources::TokenizationDecisioning.new(client: self)
+      @tokenizations = Lithic::Resources::Tokenizations.new(client: self)
+      @cards = Lithic::Resources::Cards.new(client: self)
+      @balances = Lithic::Resources::Balances.new(client: self)
+      @aggregate_balances = Lithic::Resources::AggregateBalances.new(client: self)
+      @disputes = Lithic::Resources::Disputes.new(client: self)
+      @events = Lithic::Resources::Events.new(client: self)
+      @transfers = Lithic::Resources::Transfers.new(client: self)
+      @financial_accounts = Lithic::Resources::FinancialAccounts.new(client: self)
+      @transactions = Lithic::Resources::Transactions.new(client: self)
+      @responder_endpoints = Lithic::Resources::ResponderEndpoints.new(client: self)
+      @external_bank_accounts = Lithic::Resources::ExternalBankAccounts.new(client: self)
+      @payments = Lithic::Resources::Payments.new(client: self)
+      @three_ds = Lithic::Resources::ThreeDS.new(client: self)
+      @reports = Lithic::Resources::Reports.new(client: self)
+      @card_programs = Lithic::Resources::CardPrograms.new(client: self)
+      @digital_card_art = Lithic::Resources::DigitalCardArt.new(client: self)
+      @book_transfers = Lithic::Resources::BookTransfers.new(client: self)
+      @credit_products = Lithic::Resources::CreditProducts.new(client: self)
+      @external_payments = Lithic::Resources::ExternalPayments.new(client: self)
+      @management_operations = Lithic::Resources::ManagementOperations.new(client: self)
+    end
+  end
+end

data/lib/lithic/cursor_page.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Lithic
+  # @example
+  #   if cursor_page.has_next?
+  #     cursor_page = cursor_page.next_page
+  #   end
+  #
+  # @example
+  #   cursor_page.auto_paging_each do |account|
+  #     puts(account)
+  #   end
+  #
+  # @example
+  #   accounts =
+  #     cursor_page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
+  #
+  #   accounts => Array
+  class CursorPage
+    include Lithic::BasePage
+
+    # @return [Array<Object>, nil]
+    attr_accessor :data
+
+    # @return [Boolean]
+    attr_accessor :has_more
+
+    # @api private
+    #
+    # @param client [Lithic::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::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::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::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

data/lib/lithic/errors.rb

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

data/lib/lithic/extern.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lithic
+  # @api private
+  module Extern
+  end
+end