turbopuffer-ruby 0.2.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcf94276ec11b6cc5c64c4c45e292e6f214c8417b983f99f7d8f8b58c79c8a4a
+  data.tar.gz: 2b6d53f1a5828714173028e60b0a9590b591a1d9e97fb70b261164d9279f4e15
+SHA512:
+  metadata.gz: 6b6fe86380e51ea769dfadd5b569d62332243dd6e284c7dde7fe603b07450d6bd241e9387bbc40885406f5c68600e572797f3fe9e1feec1096244d0164e83668
+  data.tar.gz: e69578e6a28835f21582ccb0c655c19edff7e900abe19f9cd3dcfc50e85b59a81aeacdfb1c91f31cf0baf0645e98f9d1ecdfee558fa217b94b85a415825f8bfc

data/.ignore

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

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+## 0.2.0-alpha.1 (2025-07-21)
+
+Full Changelog: [v0.1.0-alpha.2...v0.2.0-alpha.1](https://github.com/turbopuffer/turbopuffer-ruby/compare/v0.1.0-alpha.2...v0.2.0-alpha.1)
+
+### Features
+
+* **api:** introduce dedicated Query model ([420e42b](https://github.com/turbopuffer/turbopuffer-ruby/commit/420e42b03f05bafb3441e15167349184ac6705da))
+
+
+### Bug Fixes
+
+* **api:** api update ([7348b90](https://github.com/turbopuffer/turbopuffer-ruby/commit/7348b90f988b59a00f5bb6adb76467a699da8273))
+* **api:** api update ([e600278](https://github.com/turbopuffer/turbopuffer-ruby/commit/e60027807e7ca72cc92dae225c1afebb2b5bc455))
+* **api:** api update ([823d059](https://github.com/turbopuffer/turbopuffer-ruby/commit/823d05948dfb60656d7388ea7d25f11b86e41eb3))
+* **api:** api update ([6380572](https://github.com/turbopuffer/turbopuffer-ruby/commit/63805720cbaf84f048907907e86831fdaa19c546))
+* **api:** api update ([ca95879](https://github.com/turbopuffer/turbopuffer-ruby/commit/ca958796c50576e1c3beb80d4e1eba4b63563b56))
+* **api:** api update ([6f54464](https://github.com/turbopuffer/turbopuffer-ruby/commit/6f544641410f009b954f499a5771fb62965d2750))
+* **ci:** plumb API key to tests ([25603e1](https://github.com/turbopuffer/turbopuffer-ruby/commit/25603e1dff1af7f8d0a4cc5163341b039b3483fc))
+* **ci:** release-doctor — report correct token name ([df0b386](https://github.com/turbopuffer/turbopuffer-ruby/commit/df0b386b694d8b46df995553dd4c4e8116eab1b5))
+* don't require region unless baseUrl contains {region} placeholder ([2d537ff](https://github.com/turbopuffer/turbopuffer-ruby/commit/2d537ff0a6ce8af113b724143b38ab573591c62e))
+* formatting ([5d1aa92](https://github.com/turbopuffer/turbopuffer-ruby/commit/5d1aa92fb0a17331a4c228b01301581601767d22))
+* issue where we cannot mutate arrays on base model derivatives ([bc889aa](https://github.com/turbopuffer/turbopuffer-ruby/commit/bc889aa6865671327bf7f6349bff783f2242a005))
+* request parameters should not be marked required if they can be derived from client properties ([aaa1c73](https://github.com/turbopuffer/turbopuffer-ruby/commit/aaa1c73043810c7d7a12aae8972c0e616765308a))
+* **test:** provide distance_metric ([2c41aee](https://github.com/turbopuffer/turbopuffer-ruby/commit/2c41aee42d290fd3bbd8641eb937f8644b324311))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([0abb0af](https://github.com/turbopuffer/turbopuffer-ruby/commit/0abb0afaaf0ab9b749eaee2fe602b65a64457945))
+* **ci:** only run for pushes and fork pull requests ([eb299b8](https://github.com/turbopuffer/turbopuffer-ruby/commit/eb299b82e3884da5fa620d338be2c2bc6e7e79a9))
+* **internal:** allow streams to also be unwrapped on a per-row basis ([85fbc15](https://github.com/turbopuffer/turbopuffer-ruby/commit/85fbc151fba8e0262a5ae106beecaa6e8eb310c7))
+
+## 0.1.0-alpha.2 (2025-06-14)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/turbopuffer/turbopuffer-ruby/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* add namespace resource and example ([5340ac0](https://github.com/turbopuffer/turbopuffer-ruby/commit/5340ac0b02ccf08dc23df33b1e75ccaa0d7c4ee7))
+
+
+### Chores
+
+* sync repo ([816cc8d](https://github.com/turbopuffer/turbopuffer-ruby/commit/816cc8d9a8ac706c77023e7833c2cad49bc63357))
+
+## 0.1.0-alpha.1 (2025-06-14)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/turbopuffer/turbopuffer-ruby/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* add namespace resource and example ([f72d1f8](https://github.com/turbopuffer/turbopuffer-ruby/commit/f72d1f8d4bdb726f1a05b70be104eff825913fe9))
+
+
+### Chores
+
+* configure new SDK language ([80e0005](https://github.com/turbopuffer/turbopuffer-ruby/commit/80e0005caa84cf6b8d120f78c2d13245d7b2db48))
+* sync repo ([3498e80](https://github.com/turbopuffer/turbopuffer-ruby/commit/3498e802bc2ae9cfe2292b33c803a7762999a5ac))

data/README.md

@@ -0,0 +1,291 @@
+# Turbopuffer Ruby API library
+
+The Turbopuffer Ruby library provides convenient access to the Turbopuffer 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/turbopuffer/turbopuffer-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/turbopuffer-ruby).
+
+The REST API documentation can be found on [turbopuffer.com](https://turbopuffer.com/docs/auth).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "turbopuffer-ruby", "~> 0.2.0.pre.alpha.1"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "turbopuffer"
+
+turbopuffer = Turbopuffer::Client.new(
+  api_key: ENV["TURBOPUFFER_API_KEY"] # This is the default and can be omitted
+)
+
+response = turbopuffer.namespace("products").write(
+  distance_metric: "cosine_distance",
+  upsert_rows: [
+    {id: "2108ed60-6851-49a0-9016-8325434f3845", vector: [0.1, 0.2], attributes: {name: "Red boots", price: 34.99}}
+  ]
+)
+
+puts(response.rows_affected)
+```
+
+### Pagination
+
+List methods in the Turbopuffer 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 = turbopuffer.namespaces(prefix: "products")
+
+# Fetch single item from page.
+client = page.namespaces[0]
+puts(client.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |client|
+  puts(client.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.namespaces[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 `Turbopuffer::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  client = turbopuffer.namespaces(prefix: "foo")
+rescue Turbopuffer::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue Turbopuffer::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue Turbopuffer::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:
+turbopuffer = Turbopuffer::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+turbopuffer.namespaces(prefix: "foo", 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:
+turbopuffer = Turbopuffer::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+turbopuffer.namespaces(prefix: "foo", request_options: {timeout: 5})
+```
+
+On timeout, `Turbopuffer::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `Turbopuffer::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
+page =
+  turbopuffer.namespaces(
+    prefix: "foo",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(page[: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 `Turbopuffer::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `Turbopuffer::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
+turbopuffer.namespace("products").write(
+  distance_metric: "cosine_distance",
+  upsert_rows: [
+    Turbopuffer::Row.new(
+      id: "2108ed60-6851-49a0-9016-8325434f3845",
+      vector: [0.1, 0.2],
+      attributes: {name: "Red boots", price: 34.99}
+    )
+  ]
+)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+turbopuffer.namespace("products").write(
+  distance_metric: "cosine_distance",
+  upsert_rows: [
+    {id: "2108ed60-6851-49a0-9016-8325434f3845", vector: [0.1, 0.2], attributes: {name: "Red boots", price: 34.99}}
+  ]
+)
+
+# You can also splat a full Params class:
+params = Turbopuffer::NamespaceWriteParams.new(
+  distance_metric: "cosine_distance",
+  upsert_rows: [
+    Turbopuffer::Row.new(
+      id: "2108ed60-6851-49a0-9016-8325434f3845",
+      vector: [0.1, 0.2],
+      attributes: {name: "Red boots", price: 34.99}
+    )
+  ]
+)
+turbopuffer.namespace("products").write(**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
+# :float
+puts(Turbopuffer::VectorEncoding::FLOAT)
+
+# Revealed type: `T.all(Turbopuffer::VectorEncoding, Symbol)`
+T.reveal_type(Turbopuffer::VectorEncoding::FLOAT)
+```
+
+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:
+turbopuffer.namespaces.multi_query(
+  vector_encoding: Turbopuffer::VectorEncoding::FLOAT,
+  # …
+)
+
+# Literal values are also permissible:
+turbopuffer.namespaces.multi_query(
+  vector_encoding: :float,
+  # …
+)
+```
+
+## 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/turbopuffer/turbopuffer-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 Turbopuffer, please follow the respective company's security reporting guidelines.
+
+### Turbopuffer Terms and Policies
+
+Please contact info@turbopuffer.com 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/turbopuffer/client.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  class Client < Turbopuffer::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
+
+    # API key used for authentication
+    # @return [String]
+    attr_reader :api_key
+
+    # The turbopuffer region to use.
+    # @return [String, nil]
+    attr_reader :region
+
+    # @return [String, nil]
+    attr_reader :default_namespace
+
+    # Creates a new namespace resource.
+    #
+    # @param namespace [String] The ID of the namespace.
+    #
+    # @return [Turbopuffer::Namespace]
+    def namespace(namespace)
+      Turbopuffer::Namespace.new(self, namespace)
+    end
+
+    # List namespaces.
+    #
+    # @overload namespaces(cursor: nil, page_size: nil, prefix: nil, request_options: {})
+    #
+    # @param cursor [String] Retrieve the next page of results.
+    #
+    # @param page_size [Integer] Limit the number of results per page.
+    #
+    # @param prefix [String] Retrieve only the namespaces that match the prefix.
+    #
+    # @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}, nil]
+    #
+    # @return [Turbopuffer::Internal::NamespacePage<Turbopuffer::Models::NamespaceSummary>]
+    #
+    # @see Turbopuffer::Models::ClientNamespacesParams
+    def namespaces(params = {})
+      parsed, options = Turbopuffer::ClientNamespacesParams.dump_request(params)
+      request(
+        method: :get,
+        path: "v1/namespaces",
+        query: parsed,
+        page: Turbopuffer::Internal::NamespacePage,
+        model: Turbopuffer::NamespaceSummary,
+        options: options
+      )
+    end
+
+    # @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] API key used for authentication Defaults to `ENV["TURBOPUFFER_API_KEY"]`
+    #
+    # @param region [String, nil] The turbopuffer region to use. Defaults to `ENV["TURBOPUFFER_REGION"]`
+    #
+    # @param default_namespace [String, nil]
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["TURBOPUFFER_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["TURBOPUFFER_API_KEY"],
+      region: ENV["TURBOPUFFER_REGION"],
+      default_namespace: nil,
+      base_url: ENV["TURBOPUFFER_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://{region}.turbopuffer.com"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"TURBOPUFFER_API_KEY\"")
+      end
+
+      if base_url.include?("{region}")
+        if region.nil?
+          raise ArgumentError.new("region is required when base_url contains {region} placeholder: #{base_url}")
+        end
+        base_url = base_url.gsub("{region}", region)
+      elsif !region.nil?
+        raise ArgumentError.new("region is set, but would be ignored (baseUrl does not contain {region} placeholder: #{base_url})")
+      end
+
+      @default_namespace = default_namespace&.to_s
+      @api_key = api_key.to_s
+      @region = region&.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
+      )
+    end
+  end
+end