verisec 1.0.0

data/sig/verisec.rbs

@@ -0,0 +1,213 @@
+# RBS signatures for the hand-written core. The resources, the answer types
+# and the request types are in generated/verisec.rbs.
+
+module VeriSec
+  VERSION: String
+  DEFAULT_BASE_URL: String
+
+  # What every call takes as `request_options:`: `timeout:` (Numeric seconds),
+  # `max_retries:` (Integer), `headers:` (Hash). A Hash rather than a record,
+  # since records with optional keys need RBS 3.5 and Ruby 3.3 bundles RBS 3.4.
+  type request_options = Hash[Symbol | String, untyped]
+
+  interface _Reader
+    def read: () -> String?
+  end
+
+  # A KYC image: a path, an IO, VeriSec::Image.bytes(…), a data: URI or base64 (or raw bytes in a binary String).
+  type image_input = String | Pathname | Image | FileInput | _Reader
+
+  # A Financial upload: a path, an IO, a FileInput (or raw bytes in a binary String).
+  type file_input = String | Pathname | FileInput | Image | _Reader
+
+  class Client
+    def initialize: (?api_key: String?, ?client_id: String?, ?client_secret: String?, ?base_url: String?,
+                     ?timeout: Numeric?, ?max_retries: Integer?) -> void
+    def webhooks: () -> singleton(Webhook)
+    def base_url: () -> String
+    def timeout: () -> Numeric
+    def max_retries: () -> Integer
+    def inspect: () -> String
+  end
+
+  class VeriSecError < StandardError
+    attr_reader status: Integer?
+    attr_reader code: String?
+    attr_reader param: String?
+    attr_reader request_id: String?
+    def headers: () -> Hash[String, String]
+  end
+
+  Error: singleton(VeriSecError)
+
+  class APIError < VeriSecError
+    def initialize: (?String? message, ?status: Integer?, ?code: String?, ?param: String?, ?request_id: String?,
+                     ?headers: Hash[String, String]) -> void
+    def self.from: (Integer status, Hash[Symbol, String?] body, Hash[String, String] headers, String? request_id) -> APIError
+  end
+
+  class InvalidRequestError < APIError
+  end
+
+  class AuthenticationError < APIError
+  end
+
+  class InsufficientCreditsError < APIError
+  end
+
+  class PermissionError < APIError
+  end
+
+  class NotFoundError < APIError
+  end
+
+  class RateLimitError < APIError
+    def retry_after: () -> (Integer | Float)?
+  end
+
+  class APIServerError < APIError
+  end
+
+  class APIConnectionError < VeriSecError
+  end
+
+  class APITimeoutError < APIConnectionError
+  end
+
+  class SignatureVerificationError < VeriSecError
+  end
+
+  class ResponseInfo < Struct[untyped]
+    attr_accessor status: Integer
+    attr_accessor headers: Hash[String, String]
+    attr_accessor request_id: String?
+    attr_accessor warnings: Array[String]
+    attr_accessor latency_ms: Numeric?
+
+    def initialize: (?status: Integer, ?headers: Hash[String, String], ?request_id: String?, ?warnings: Array[String],
+                     ?latency_ms: Numeric?) -> void
+  end
+
+  class VeriSecObject
+    FIELDS: Hash[String, String?]
+
+    attr_reader last_response: ResponseInfo?
+
+    def self.construct: (untyped value, ?ResponseInfo? last_response) -> untyped
+    def self.fields: () -> Hash[String, String?]
+    def self.field_type: (String key) -> singleton(VeriSecObject)
+    def initialize: (?Hash[String | Symbol, untyped]? values, ?last_response: ResponseInfo?) -> void
+    def []: (String | Symbol key) -> untyped
+    def dig: (String | Symbol key, *(String | Symbol | Integer) rest) -> untyped
+    def fetch: (String | Symbol key, *untyped default) ?{ (String key) -> untyped } -> untyped
+    def key?: (String | Symbol key) -> bool
+    def keys: () -> Array[String]
+    def to_h: () -> Hash[String, untyped]
+    def to_json: (*untyped) -> String
+    def as_json: (*untyped) -> Hash[String, untyped]
+    def ==: (untyped other) -> bool
+    def deconstruct_keys: (Array[Symbol]? keys) -> Hash[Symbol, untyped]
+    def to_s: () -> String
+    def inspect: () -> String
+
+    private
+
+    def method_missing: (Symbol name, *untyped args) ?{ (*untyped) -> untyped } -> untyped
+    def respond_to_missing?: (Symbol name, ?bool include_private) -> bool
+  end
+
+  class Image
+    BASE64: Regexp
+    DATA_URI: Regexp
+
+    def self.bytes: (String data) -> Image
+    def self.base64_of: (untyped value, String field) -> String
+    def self.prepare: (Hash[String, untyped] body, Hash[Symbol, untyped] plan) -> Hash[String, untyped]
+
+    attr_reader data: String
+    def initialize: (String data) -> void
+    def base64: () -> String
+  end
+
+  class FileInput
+    DEFAULT_FILENAME: String
+    EXTENSION_TYPES: Hash[String, String]
+
+    def self.sniff: (String bytes) -> String?
+    def self.from_path: (String | Pathname path, ?content_type: String?, ?field: String) -> FileInput
+    def self.wrap: (file_input value, ?String field) -> FileInput
+
+    def initialize: (String | _Reader data, ?filename: String?, ?content_type: String?) -> void
+    def filename: () -> String
+    def bytes: () -> String
+    def content_type: () -> String
+  end
+
+  module Webhook
+    DEFAULT_TOLERANCE: Integer
+
+    type headers = Hash[String | Symbol, String | Array[String]] | _EachPair
+
+    interface _EachPair
+      def each: () { ([untyped, untyped]) -> void } -> untyped
+    end
+
+    class Event < VeriSecObject
+      def `type`: () -> String
+      def timestamp: () -> String
+      def environment: () -> String
+      def data: () -> VeriSecObject
+    end
+
+    def self.construct_event: (String payload, headers? headers, String secret, ?tolerance: Integer) -> Event
+    def self.verify_signature: (String payload, headers? headers, String secret, ?tolerance: Integer) -> bool
+    def self.verify_signature!: (String payload, headers? headers, String secret, ?tolerance: Integer) -> true
+    def self.generate_test_headers: (String payload, String secret, ?id: String?, ?timestamp: Integer) -> Hash[String, String]
+  end
+
+  module Auth
+    class SecretKey
+      def initialize: (String key) -> void
+      def token: () -> String
+      def invalidate: (String? token) -> bool
+    end
+
+    class ClientCredentials
+      REFRESH_MARGIN: Integer
+      DEFAULT_LIFETIME: Integer
+
+      def initialize: (?clock: ^() -> Numeric) { () -> Hash[String, untyped] } -> void
+      def token: () -> String
+      def invalidate: (String? rejected) -> bool
+    end
+  end
+
+  # @api private
+  class Transport
+    DEFAULT_TIMEOUT: Integer
+    DEFAULT_MAX_RETRIES: Integer
+    MAX_RETRY_WAIT: Integer
+    REQUEST_OPTIONS: Array[Symbol]
+    USER_AGENT: String
+    TOKEN_PATH: String
+
+    attr_reader base_url: String
+    attr_reader timeout: Numeric
+    attr_reader max_retries: Integer
+
+    def initialize: (?api_key: String?, ?client_id: String?, ?client_secret: String?, ?base_url: String?,
+                     ?timeout: Numeric?, ?max_retries: Integer?) -> void
+    def request: (Symbol method, String path, ?query: Hash[String, untyped]?, ?body: Hash[String, untyped]?,
+                  ?multipart: [Array[[String, String]], Array[[String, FileInput]]]?, ?envelope: :data | :object | :raw,
+                  ?request_options: request_options?, ?headers: Hash[String, String]?, ?anonymous: bool) -> [untyped, ResponseInfo]
+    def retry_delay: (Integer attempt, String? retry_after) -> Numeric
+  end
+
+  module Resources
+    class Resource
+      SOURCE_HEADER: Hash[String, String]
+
+      def initialize: (Transport transport) -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: verisec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- VeriSec Labs
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-18 00:00:00.000000000 Z
+dependencies: []
+description: 'Every VeriSec API as a method: faces, liveness, documents, MRZ, contact
+  and risk screening, cheques, cards, banks and BIN lookups. Images from files, safe
+  retries that never run a charged call twice, live-key OAuth, and Standard Webhooks
+  verification. Standard library only.'
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples/quickstart.rb
+- lib/verisec.rb
+- lib/verisec/auth.rb
+- lib/verisec/client.rb
+- lib/verisec/errors.rb
+- lib/verisec/file_input.rb
+- lib/verisec/generated/resources.rb
+- lib/verisec/generated/types.rb
+- lib/verisec/image.rb
+- lib/verisec/multipart.rb
+- lib/verisec/resource.rb
+- lib/verisec/response_info.rb
+- lib/verisec/transport.rb
+- lib/verisec/util.rb
+- lib/verisec/verisec_object.rb
+- lib/verisec/version.rb
+- lib/verisec/webhook.rb
+- sig/generated/verisec.rbs
+- sig/verisec.rbs
+homepage: https://verisec.mmose.me
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://verisec.mmose.me
+  documentation_uri: https://verisec.mmose.me
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: 'The official Ruby library for the VeriSec API: identity (KYC) and Financial
+  checks.'
+test_files: []