nodexpay 0.1.0

data/rbi/nodex_pay.rbi

@@ -0,0 +1,243 @@
+# typed: strict
+
+module NodexPay
+  VERSION = T.let(T.unsafe(nil), String)
+
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class ValidationError < Error; end
+  class SignatureVerificationError < Error; end
+  class TransportError < Error; end
+  class TimeoutError < TransportError; end
+  class InvalidResponseError < Error; end
+
+  class APIError < Error
+    ERROR_NAMES = T.let(T.unsafe(nil), T::Hash[Integer, String])
+
+    sig { returns(Symbol) }
+    attr_reader :operation
+
+    sig { returns(Integer) }
+    attr_reader :status
+
+    sig { returns(T::Array[Integer]) }
+    attr_reader :error_codes
+
+    sig { returns(T::Hash[String, String]) }
+    attr_reader :response_headers
+
+    sig { returns(String) }
+    attr_reader :response_body
+
+    sig do
+      params(
+        operation: Symbol,
+        status: Integer,
+        error_codes: T::Array[Integer],
+        response_headers: T::Hash[String, String],
+        response_body: String
+      ).void
+    end
+    def initialize(operation:, status:, error_codes:, response_headers:, response_body:); end
+  end
+
+  class BadRequestError < APIError; end
+  class ServiceUnavailableError < APIError; end
+  class UnexpectedHTTPStatusError < APIError; end
+
+  class Payment < Data
+    sig { returns(String) }
+    attr_reader :url
+
+    sig { returns(String) }
+    attr_reader :token
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :ext_reserved
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :ext_description
+
+    sig do
+      params(
+        url: String,
+        token: String,
+        ext_reserved: T.nilable(String),
+        ext_description: T.nilable(String)
+      ).void
+    end
+    def initialize(url:, token:, ext_reserved:, ext_description:); end
+  end
+
+  class PaymentResult < Data
+    sig { returns(String) }
+    attr_reader :order_code
+
+    sig { returns(String) }
+    attr_reader :transaction_code
+
+    sig { returns(String) }
+    attr_reader :amount
+
+    sig { returns(String) }
+    attr_reader :symbol
+
+    sig { returns(T::Boolean) }
+    attr_reader :result
+
+    sig { returns(String) }
+    attr_reader :chain_id
+
+    sig { returns(String) }
+    attr_reader :transaction_hash
+
+    sig do
+      params(
+        order_code: String,
+        transaction_code: String,
+        amount: String,
+        symbol: String,
+        result: T::Boolean,
+        chain_id: String,
+        transaction_hash: String
+      ).void
+    end
+    def initialize(order_code:, transaction_code:, amount:, symbol:, result:, chain_id:, transaction_hash:); end
+
+    sig { returns(T::Boolean) }
+    def success?; end
+  end
+
+  module Transport
+    class Request < Data
+      sig { returns(Symbol) }
+      attr_reader :method
+
+      sig { returns(URI::Generic) }
+      attr_reader :uri
+
+      sig { returns(T::Hash[String, String]) }
+      attr_reader :headers
+
+      sig { returns(String) }
+      attr_reader :body
+
+      sig { returns(Numeric) }
+      attr_reader :open_timeout
+
+      sig { returns(Numeric) }
+      attr_reader :read_timeout
+
+      sig { returns(Numeric) }
+      attr_reader :write_timeout
+
+      sig do
+        params(
+          method: Symbol,
+          uri: URI::Generic,
+          headers: T::Hash[String, String],
+          body: String,
+          open_timeout: Numeric,
+          read_timeout: Numeric,
+          write_timeout: Numeric
+        ).void
+      end
+      def initialize(method:, uri:, headers:, body:, open_timeout:, read_timeout:, write_timeout:); end
+    end
+
+    class Response < Data
+      sig { returns(Integer) }
+      attr_reader :status
+
+      sig { returns(T::Hash[String, String]) }
+      attr_reader :headers
+
+      sig { returns(String) }
+      attr_reader :body
+
+      sig do
+        params(
+          status: Integer,
+          headers: T::Hash[String, String],
+          body: String
+        ).void
+      end
+      def initialize(status:, headers:, body:); end
+    end
+
+    class NetHTTP
+      sig { params(request: Request).returns(Response) }
+      def call(request); end
+    end
+  end
+
+  class Client
+    BASE_URLS = T.let(T.unsafe(nil), T::Hash[Symbol, String])
+    DEFAULT_OPEN_TIMEOUT = T.let(T.unsafe(nil), Integer)
+    DEFAULT_READ_TIMEOUT = T.let(T.unsafe(nil), Integer)
+    DEFAULT_WRITE_TIMEOUT = T.let(T.unsafe(nil), Integer)
+
+    sig { returns(Symbol) }
+    attr_reader :environment
+
+    sig { returns(Numeric) }
+    attr_reader :open_timeout
+
+    sig { returns(Numeric) }
+    attr_reader :read_timeout
+
+    sig { returns(Numeric) }
+    attr_reader :write_timeout
+
+    sig do
+      params(
+        identification_token: String,
+        hash_token: String,
+        environment: Symbol,
+        open_timeout: Numeric,
+        read_timeout: Numeric,
+        write_timeout: Numeric,
+        transport: T.untyped
+      ).void
+    end
+    def initialize(
+      identification_token:,
+      hash_token:,
+      environment:,
+      open_timeout: 5,
+      read_timeout: 30,
+      write_timeout: 30,
+      transport: nil
+    ); end
+
+    sig do
+      params(
+        order_code: String,
+        amount: T.nilable(T.any(String, Integer, BigDecimal)),
+        amount_type: T.nilable(T.any(String, Symbol)),
+        color_theme: T.nilable(T.any(String, Symbol)),
+        ui_mode: T.nilable(T.any(String, Symbol)),
+        ext_description: T.nilable(String),
+        deadline: T.nilable(T.any(Time, Integer)),
+        description: T.nilable(String)
+      ).returns(Payment)
+    end
+    def create_payment(
+      order_code:,
+      amount: nil,
+      amount_type: nil,
+      color_theme: nil,
+      ui_mode: nil,
+      ext_description: nil,
+      deadline: nil,
+      description: nil
+    ); end
+
+    sig { params(order_code: String).returns(TrueClass) }
+    def cancel_payment(order_code:); end
+
+    sig { params(raw_body: String).returns(PaymentResult) }
+    def verify_payment_result(raw_body); end
+  end
+end
+

data/sig/nodex_pay.rbs

@@ -0,0 +1,165 @@
+module NodexPay
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class ValidationError < Error
+  end
+
+  class SignatureVerificationError < Error
+  end
+
+  class TransportError < Error
+  end
+
+  class TimeoutError < TransportError
+  end
+
+  class InvalidResponseError < Error
+  end
+
+  class APIError < Error
+    ERROR_NAMES: Hash[Integer, String]
+
+    attr_reader operation: Symbol
+    attr_reader status: Integer
+    attr_reader error_codes: Array[Integer]
+    attr_reader response_headers: Hash[String, String]
+    attr_reader response_body: String
+
+    def initialize: (
+      operation: Symbol,
+      status: Integer,
+      error_codes: Array[Integer],
+      response_headers: Hash[String, String],
+      response_body: String
+    ) -> void
+  end
+
+  class BadRequestError < APIError
+  end
+
+  class ServiceUnavailableError < APIError
+  end
+
+  class UnexpectedHTTPStatusError < APIError
+  end
+
+  class Payment
+    attr_reader url: String
+    attr_reader token: String
+    attr_reader ext_reserved: String?
+    attr_reader ext_description: String?
+
+    def initialize: (
+      url: String,
+      token: String,
+      ext_reserved: String?,
+      ext_description: String?
+    ) -> void
+  end
+
+  class PaymentResult
+    attr_reader order_code: String
+    attr_reader transaction_code: String
+    attr_reader amount: String
+    attr_reader symbol: String
+    attr_reader result: bool
+    attr_reader chain_id: String
+    attr_reader transaction_hash: String
+
+    def initialize: (
+      order_code: String,
+      transaction_code: String,
+      amount: String,
+      symbol: String,
+      result: bool,
+      chain_id: String,
+      transaction_hash: String
+    ) -> void
+
+    def success?: () -> bool
+  end
+
+  module Transport
+    class Request
+      attr_reader method: :post
+      attr_reader uri: URI::Generic
+      attr_reader headers: Hash[String, String]
+      attr_reader body: String
+      attr_reader open_timeout: Numeric
+      attr_reader read_timeout: Numeric
+      attr_reader write_timeout: Numeric
+
+      def initialize: (
+        method: :post,
+        uri: URI::Generic,
+        headers: Hash[String, String],
+        body: String,
+        open_timeout: Numeric,
+        read_timeout: Numeric,
+        write_timeout: Numeric
+      ) -> void
+    end
+
+    class Response
+      attr_reader status: Integer
+      attr_reader headers: Hash[String, String]
+      attr_reader body: String
+
+      def initialize: (
+        status: Integer,
+        headers: Hash[String, String],
+        body: String
+      ) -> void
+    end
+
+    interface _Transport
+      def call: (Request request) -> Response
+    end
+
+    class NetHTTP
+      include _Transport
+    end
+  end
+
+  class Client
+    BASE_URLS: Hash[Symbol, String]
+    DEFAULT_OPEN_TIMEOUT: Integer
+    DEFAULT_READ_TIMEOUT: Integer
+    DEFAULT_WRITE_TIMEOUT: Integer
+
+    attr_reader environment: :production | :testnet
+    attr_reader open_timeout: Numeric
+    attr_reader read_timeout: Numeric
+    attr_reader write_timeout: Numeric
+
+    def initialize: (
+      identification_token: String,
+      hash_token: String,
+      environment: :production | :testnet,
+      ?open_timeout: Numeric,
+      ?read_timeout: Numeric,
+      ?write_timeout: Numeric,
+      ?transport: Transport::_Transport?
+    ) -> void
+
+    def create_payment: (
+      order_code: String,
+      ?amount: String | Integer | BigDecimal | nil,
+      ?amount_type: String | Symbol | nil,
+      ?color_theme: String | Symbol | nil,
+      ?ui_mode: String | Symbol | nil,
+      ?ext_description: String?,
+      ?deadline: Time | Integer | nil,
+      ?description: String?
+    ) -> Payment
+
+    def cancel_payment: (order_code: String) -> true
+    def verify_payment_result: (String raw_body) -> PaymentResult
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: nodexpay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- supermomonga
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A small, dependency-free Ruby client for creating and cancelling Nodex
+  Pay payments and verifying Payment Result callbacks.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- docs/README.md
+- docs/api-contract.md
+- docs/architecture.md
+- docs/http-and-errors.md
+- docs/implementation-plan.md
+- docs/payment-results.md
+- docs/testing.md
+- lib/nodex_pay.rb
+- lib/nodex_pay/amount_serializer.rb
+- lib/nodex_pay/client.rb
+- lib/nodex_pay/errors.rb
+- lib/nodex_pay/models.rb
+- lib/nodex_pay/signer.rb
+- lib/nodex_pay/transport.rb
+- lib/nodex_pay/validator.rb
+- lib/nodex_pay/version.rb
+- rbi/nodex_pay.rbi
+- sig/nodex_pay.rbs
+homepage: https://app.nodexpay.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://app.nodexpay.com/
+  documentation_uri: https://nodex-pay.gitbook.io/docs/integration-guide/apis
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Unofficial Ruby client SDK for the Nodex Pay API
+test_files: []