straddle 0.1.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6755a5aa778e03b870200b89f235e90809095cabb34dcd6ec13569e80b8037f7
+  data.tar.gz: 48020035384b9a3402ee160b7a21148df693ed977840238d4cbb3d85fc3f11a0
+SHA512:
+  metadata.gz: ad2f1178b4aecdf0d6235e09dd73e7e550d6c77b712868f719851024d3a697435e066823684ac22c21c9d8f357ddb76ac4f89ded181198932e007d5cb3d82ccb
+  data.tar.gz: 1c89ae5461886ea82a7303adbfd83a9eaca1d9638f824550b98783a52c6a2c5d331038c811e95b99d1cecf29d82add1413bb3fa9448f7fbba14c32c3ba228b1f

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0-alpha.1 (2025-07-08)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/straddleio/straddle-ruby/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** Remove explicit environment setting ([74cb379](https://github.com/straddleio/straddle-ruby/commit/74cb379d62b447dbdde9697c938e9065eee6e113))

data/README.md

@@ -0,0 +1,344 @@
+# Straddle Ruby API library
+
+The Straddle Ruby library provides convenient access to the Straddle 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/straddleio/straddle-ruby#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/straddle).
+
+The REST API documentation can be found on [docs.straddle.io](https://docs.straddle.io).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "straddle", "~> 0.1.0.pre.alpha.1"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "straddle"
+
+straddle = Straddle::Client.new(
+  api_key: ENV["STRADDLE_API_KEY"], # This is the default and can be omitted
+  environment: "sandbox" # defaults to "production"
+)
+
+charge_v1 = straddle.charges.create(
+  amount: 10000,
+  config: {balance_check: "required"},
+  consent_type: "internet",
+  currency: "currency",
+  description: "Monthly subscription fee",
+  device: {ip_address: "192.168.1.1"},
+  external_id: "external_id",
+  paykey: "paykey",
+  payment_date: "2019-12-27"
+)
+
+puts(charge_v1.data)
+```
+
+### Pagination
+
+List methods in the Straddle API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = straddle.payments.list
+
+# Fetch single item from page.
+payment = page.data[0]
+puts(payment.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |payment|
+  puts(payment.id)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].id)
+end
+```
+
+### 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 `Straddle::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  charge = straddle.charges.create(
+    amount: 10000,
+    config: {balance_check: "required"},
+    consent_type: "internet",
+    currency: "currency",
+    description: "Monthly subscription fee",
+    device: {ip_address: "192.168.1.1"},
+    external_id: "external_id",
+    paykey: "paykey",
+    payment_date: "2019-12-27"
+  )
+rescue Straddle::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue Straddle::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue Straddle::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:
+straddle = Straddle::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+straddle.charges.create(
+  amount: 10000,
+  config: {balance_check: "required"},
+  consent_type: "internet",
+  currency: "currency",
+  description: "Monthly subscription fee",
+  device: {ip_address: "192.168.1.1"},
+  external_id: "external_id",
+  paykey: "paykey",
+  payment_date: "2019-12-27",
+  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:
+straddle = Straddle::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+straddle.charges.create(
+  amount: 10000,
+  config: {balance_check: "required"},
+  consent_type: "internet",
+  currency: "currency",
+  description: "Monthly subscription fee",
+  device: {ip_address: "192.168.1.1"},
+  external_id: "external_id",
+  paykey: "paykey",
+  payment_date: "2019-12-27",
+  request_options: {timeout: 5}
+)
+```
+
+On timeout, `Straddle::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `Straddle::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
+charge_v1 =
+  straddle.charges.create(
+    amount: 10000,
+    config: {balance_check: "required"},
+    consent_type: "internet",
+    currency: "currency",
+    description: "Monthly subscription fee",
+    device: {ip_address: "192.168.1.1"},
+    external_id: "external_id",
+    paykey: "paykey",
+    payment_date: "2019-12-27",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(charge_v1[: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 `Straddle::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `Straddle::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
+straddle.charges.create(
+  amount: 10000,
+  config: Straddle::ChargeCreateParams::Config.new(balance_check: "required"),
+  consent_type: "internet",
+  currency: "currency",
+  description: "Monthly subscription fee",
+  device: Straddle::DeviceInfoV1.new(ip_address: "192.168.1.1"),
+  external_id: "external_id",
+  paykey: "paykey",
+  payment_date: "2019-12-27"
+)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+straddle.charges.create(
+  amount: 10000,
+  config: {balance_check: "required"},
+  consent_type: "internet",
+  currency: "currency",
+  description: "Monthly subscription fee",
+  device: {ip_address: "192.168.1.1"},
+  external_id: "external_id",
+  paykey: "paykey",
+  payment_date: "2019-12-27"
+)
+
+# You can also splat a full Params class:
+params = Straddle::ChargeCreateParams.new(
+  amount: 10000,
+  config: Straddle::ChargeCreateParams::Config.new(balance_check: "required"),
+  consent_type: "internet",
+  currency: "currency",
+  description: "Monthly subscription fee",
+  device: Straddle::DeviceInfoV1.new(ip_address: "192.168.1.1"),
+  external_id: "external_id",
+  paykey: "paykey",
+  payment_date: "2019-12-27"
+)
+straddle.charges.create(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :standard
+puts(Straddle::Embed::AccountCreateParams::AccessLevel::STANDARD)
+
+# Revealed type: `T.all(Straddle::Embed::AccountCreateParams::AccessLevel, Symbol)`
+T.reveal_type(Straddle::Embed::AccountCreateParams::AccessLevel::STANDARD)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+straddle.embed.accounts.create(
+  access_level: Straddle::Embed::AccountCreateParams::AccessLevel::STANDARD,
+  # …
+)
+
+# Literal values are also permissible:
+straddle.embed.accounts.create(
+  access_level: :standard,
+  # …
+)
+```
+
+## 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/straddleio/straddle-ruby/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 Straddle, please follow the respective company's security reporting guidelines.
+
+### Straddle Terms and Policies
+
+Please contact help@straddle.io 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/straddle/client.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Straddle
+  class Client < Straddle::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
+
+    # rubocop:disable Style/MutableConstant
+    # @type [Hash{Symbol=>String}]
+    ENVIRONMENTS = {production: "https://production.straddle.io", sandbox: "https://sandbox.straddle.io"}
+    # rubocop:enable Style/MutableConstant
+
+    # Use your Straddle API Key in the Authorization header as Bearer <token> to
+    # authorize API requests.
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [Straddle::Resources::Embed]
+    attr_reader :embed
+
+    # @return [Straddle::Resources::Bridge]
+    attr_reader :bridge
+
+    # @return [Straddle::Resources::Customers]
+    attr_reader :customers
+
+    # @return [Straddle::Resources::Paykeys]
+    attr_reader :paykeys
+
+    # @return [Straddle::Resources::Charges]
+    attr_reader :charges
+
+    # @return [Straddle::Resources::FundingEvents]
+    attr_reader :funding_events
+
+    # @return [Straddle::Resources::Payments]
+    attr_reader :payments
+
+    # @return [Straddle::Resources::Payouts]
+    attr_reader :payouts
+
+    # @return [Straddle::Resources::Reports]
+    attr_reader :reports
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Use your Straddle API Key in the Authorization header as Bearer <token> to
+    # authorize API requests. Defaults to `ENV["STRADDLE_API_KEY"]`
+    #
+    # @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://production.straddle.io`
+    # - `sandbox` corresponds to `https://sandbox.straddle.io`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["STRADDLE_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_key: ENV["STRADDLE_API_KEY"],
+      environment: nil,
+      base_url: ENV["STRADDLE_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 ||= Straddle::Client::ENVIRONMENTS.fetch(environment&.to_sym || :production) do
+        message = "environment must be one of #{Straddle::Client::ENVIRONMENTS.keys}, got #{environment}"
+        raise ArgumentError.new(message)
+      end
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"STRADDLE_API_KEY\"")
+      end
+
+      @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
+      )
+
+      @embed = Straddle::Resources::Embed.new(client: self)
+      @bridge = Straddle::Resources::Bridge.new(client: self)
+      @customers = Straddle::Resources::Customers.new(client: self)
+      @paykeys = Straddle::Resources::Paykeys.new(client: self)
+      @charges = Straddle::Resources::Charges.new(client: self)
+      @funding_events = Straddle::Resources::FundingEvents.new(client: self)
+      @payments = Straddle::Resources::Payments.new(client: self)
+      @payouts = Straddle::Resources::Payouts.new(client: self)
+      @reports = Straddle::Resources::Reports.new(client: self)
+    end
+  end
+end