cloudpayments-ruby 0.4.1

data/lib/cloudpayments_ruby.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "cloudpayments_ruby/version"
+require_relative "cloudpayments_ruby/internal/util"
+require_relative "cloudpayments_ruby/internal/type/converter"
+require_relative "cloudpayments_ruby/internal/type/unknown"
+require_relative "cloudpayments_ruby/internal/type/boolean"
+require_relative "cloudpayments_ruby/internal/type/file_input"
+require_relative "cloudpayments_ruby/internal/type/enum"
+require_relative "cloudpayments_ruby/internal/type/union"
+require_relative "cloudpayments_ruby/internal/type/array_of"
+require_relative "cloudpayments_ruby/internal/type/hash_of"
+require_relative "cloudpayments_ruby/internal/type/base_model"
+require_relative "cloudpayments_ruby/internal/type/base_page"
+require_relative "cloudpayments_ruby/internal/type/request_parameters"
+require_relative "cloudpayments_ruby/internal"
+require_relative "cloudpayments_ruby/request_options"
+require_relative "cloudpayments_ruby/file_part"
+require_relative "cloudpayments_ruby/errors"
+require_relative "cloudpayments_ruby/internal/transport/base_client"
+require_relative "cloudpayments_ruby/internal/transport/pooled_net_requester"
+require_relative "cloudpayments_ruby/client"
+require_relative "cloudpayments_ruby/models/order_cancel_params"
+require_relative "cloudpayments_ruby/models/order_cancel_response"
+require_relative "cloudpayments_ruby/models/order_create_params"
+require_relative "cloudpayments_ruby/models/order_create_response"
+require_relative "cloudpayments_ruby/models/payment_auth_params"
+require_relative "cloudpayments_ruby/models/payment_auth_response"
+require_relative "cloudpayments_ruby/models/payment_charge_params"
+require_relative "cloudpayments_ruby/models/payment_charge_response"
+require_relative "cloudpayments_ruby/models/payment_confirm_params"
+require_relative "cloudpayments_ruby/models/payment_confirm_response"
+require_relative "cloudpayments_ruby/models/payment_post3ds_params"
+require_relative "cloudpayments_ruby/models/payment_post3ds_response"
+require_relative "cloudpayments_ruby/models/payment_refund_params"
+require_relative "cloudpayments_ruby/models/payment_refund_response"
+require_relative "cloudpayments_ruby/models/payments/token_auth_params"
+require_relative "cloudpayments_ruby/models/payments/token_auth_response"
+require_relative "cloudpayments_ruby/models/payments/token_charge_params"
+require_relative "cloudpayments_ruby/models/payments/token_charge_response"
+require_relative "cloudpayments_ruby/models/payment_void_params"
+require_relative "cloudpayments_ruby/models/payment_void_response"
+require_relative "cloudpayments_ruby/models/subscription"
+require_relative "cloudpayments_ruby/models/subscription_cancel_params"
+require_relative "cloudpayments_ruby/models/subscription_cancel_response"
+require_relative "cloudpayments_ruby/models/subscription_create_params"
+require_relative "cloudpayments_ruby/models/subscription_create_response"
+require_relative "cloudpayments_ruby/models/subscription_find_params"
+require_relative "cloudpayments_ruby/models/subscription_find_response"
+require_relative "cloudpayments_ruby/models/subscription_get_params"
+require_relative "cloudpayments_ruby/models/subscription_get_response"
+require_relative "cloudpayments_ruby/models/subscription_update_params"
+require_relative "cloudpayments_ruby/models/subscription_update_response"
+require_relative "cloudpayments_ruby/models/transaction"
+require_relative "cloudpayments_ruby/models"
+require_relative "cloudpayments_ruby/resources/orders"
+require_relative "cloudpayments_ruby/resources/payments"
+require_relative "cloudpayments_ruby/resources/payments/tokens"
+require_relative "cloudpayments_ruby/resources/subscriptions"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/cloudpayments_ruby/client.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  class Client < CloudpaymentsRuby::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :public_id
+
+    sig { returns(String) }
+    attr_reader :api_secret
+
+    sig { returns(CloudpaymentsRuby::Resources::Payments) }
+    attr_reader :payments
+
+    sig { returns(CloudpaymentsRuby::Resources::Subscriptions) }
+    attr_reader :subscriptions
+
+    sig { returns(CloudpaymentsRuby::Resources::Orders) }
+    attr_reader :orders
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        public_id: T.nilable(String),
+        api_secret: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["CLOUDPAYMENTS_PUBLIC_ID"]`
+      public_id: ENV["CLOUDPAYMENTS_PUBLIC_ID"],
+      # Defaults to `ENV["CLOUDPAYMENTS_API_SECRET"]`
+      api_secret: ENV["CLOUDPAYMENTS_API_SECRET"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["CLOUDPAYMENTS_BASE_URL"]`
+      base_url: ENV["CLOUDPAYMENTS_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: CloudpaymentsRuby::Client::DEFAULT_MAX_RETRIES,
+      timeout: CloudpaymentsRuby::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: CloudpaymentsRuby::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: CloudpaymentsRuby::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/cloudpayments_ruby/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < CloudpaymentsRuby::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < CloudpaymentsRuby::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < CloudpaymentsRuby::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < CloudpaymentsRuby::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < CloudpaymentsRuby::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    end
+
+    class BadRequestError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < CloudpaymentsRuby::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/cloudpayments_ruby/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(T.any(Pathname, String)),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end