prelude-sdk 0.1.0.pre.alpha.2

data/README.md

@@ -0,0 +1,217 @@
+# Prelude Ruby API library
+
+The Prelude Ruby library provides convenient access to the Prelude REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/prelude-so/ruby-sdk#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/prelude-sdk).
+
+The REST API documentation can be found on [docs.prelude.so](https://docs.prelude.so).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "prelude-sdk", "~> 0.1.0.pre.alpha.2"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "prelude_sdk"
+
+prelude = PreludeSDK::Client.new(
+  api_token: ENV["API_TOKEN"] # This is the default and can be omitted
+)
+
+verification = prelude.verification.create(target: {type: "phone_number", value: "+30123456789"})
+
+puts(verification.id)
+```
+
+### Handling errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `PreludeSDK::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  verification = prelude.verification.create(target: {type: "phone_number", value: "+30123456789"})
+rescue PreludeSDK::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue PreludeSDK::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue PreludeSDK::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
+```
+
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+prelude = PreludeSDK::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+prelude.verification.create(
+  target: {type: "phone_number", value: "+30123456789"},
+  request_options: {max_retries: 5}
+)
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+prelude = PreludeSDK::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+prelude.verification.create(
+  target: {type: "phone_number", value: "+30123456789"},
+  request_options: {timeout: 5}
+)
+```
+
+On timeout, `PreludeSDK::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `PreludeSDK::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+verification =
+  prelude.verification.create(
+    target: {type: "phone_number", value: "+30123456789"},
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(verification[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `PreludeSDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `PreludeSDK::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+prelude.verification.create(
+  target: PreludeSDK::VerificationCreateParams::Target.new(type: "phone_number", value: "+30123456789")
+)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+prelude.verification.create(target: {type: "phone_number", value: "+30123456789"})
+
+# You can also splat a full Params class:
+params = PreludeSDK::VerificationCreateParams.new(
+  target: PreludeSDK::VerificationCreateParams::Target.new(type: "phone_number", value: "+30123456789")
+)
+prelude.verification.create(**params)
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/prelude-so/ruby-sdk/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Prelude, please follow the respective company's security reporting guidelines.
+
+### Prelude Terms and Policies
+
+Please contact hello@prelude.so for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/prelude_sdk/client.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  class Client < PreludeSDK::Internal::Transport::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
+
+    # Bearer token for authorizing API requests.
+    # @return [String]
+    attr_reader :api_token
+
+    # @return [PreludeSDK::Resources::Lookup]
+    attr_reader :lookup
+
+    # @return [PreludeSDK::Resources::Transactional]
+    attr_reader :transactional
+
+    # @return [PreludeSDK::Resources::Verification]
+    attr_reader :verification
+
+    # @return [PreludeSDK::Resources::Watch]
+    attr_reader :watch
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_token.nil?
+
+      {"authorization" => "Bearer #{@api_token}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_token [String, nil] Bearer token for authorizing API requests. Defaults to `ENV["API_TOKEN"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["PRELUDE_BASE_URL"]`
+    #
+    # @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(
+      api_token: ENV["API_TOKEN"],
+      base_url: ENV["PRELUDE_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.prelude.dev"
+
+      if api_token.nil?
+        raise ArgumentError.new("api_token is required, and can be set via environ: \"API_TOKEN\"")
+      end
+
+      @api_token = api_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
+      )
+
+      @lookup = PreludeSDK::Resources::Lookup.new(client: self)
+      @transactional = PreludeSDK::Resources::Transactional.new(client: self)
+      @verification = PreludeSDK::Resources::Verification.new(client: self)
+      @watch = PreludeSDK::Resources::Watch.new(client: self)
+    end
+  end
+end

data/lib/prelude_sdk/errors.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < PreludeSDK::Errors::Error
+      # @return [StandardError, nil]
+      def cause = @cause.nil? ? super : @cause
+
+      # @api private
+      #
+      # @param on [Class<StandardError>]
+      # @param method [Symbol]
+      # @param target [Object]
+      # @param value [Object]
+      # @param cause [StandardError, nil]
+      def initialize(on:, method:, target:, value:, cause: nil)
+        cls = on.name.split("::").last
+
+        message = [
+          "Failed to parse #{cls}.#{method} from #{value.class} to #{target.inspect}.",
+          "To get the unparsed API response, use #{cls}[#{method.inspect}].",
+          cause && "Cause: #{cause.message}"
+        ].filter(&:itself).join(" ")
+
+        @cause = cause
+        super(message)
+      end
+    end
+
+    class APIError < PreludeSDK::Errors::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 < PreludeSDK::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @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 < PreludeSDK::Errors::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 < PreludeSDK::Errors::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 [self]
+      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
+          PreludeSDK::Errors::BadRequestError.new(**kwargs)
+        in 401
+          PreludeSDK::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          PreludeSDK::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          PreludeSDK::Errors::NotFoundError.new(**kwargs)
+        in 409
+          PreludeSDK::Errors::ConflictError.new(**kwargs)
+        in 422
+          PreludeSDK::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          PreludeSDK::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          PreludeSDK::Errors::InternalServerError.new(**kwargs)
+        else
+          PreludeSDK::Errors::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 < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/prelude_sdk/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        else
+          filename.nil? ? nil : ::File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end