turbopuffer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9b214208dbf23c334c0a464b1dcb97937aeab3f74ca8b9afa5a001dc4cb5a2e
+  data.tar.gz: b49f0fe71b1423e38e53e07277a6ca8567ea04534279e498466a50cbd59aad1d
+SHA512:
+  metadata.gz: 3282d03c38c4f1cecf53d38f7b50356a1fd3571d6f16f422ffab07f25fbe28db2653987850d5b52e5dad2daefba0df803225d4fc6a898b0b6372dae240669659
+  data.tar.gz: 4092bf2ccbf9df5e2be3f44752eb2d16b3625f62ea5bd95585451f2b3a4fae8a41b01baaefd759a51e11ce861bcdd492f8ce3598c5e73d3a84fb28ccedb98006

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Adrián Mugnolo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Turbopuffer
+
+A Ruby client for accessing the Turbopuffer API.
+
+## Installation
+
+TODO: Replace
+`UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your
+gem name right after releasing it to RubyGems.org. Please do not do it earlier
+due to security reasons. Alternatively, replace this section with instructions
+to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by
+executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+```ruby
+tpuf = Turbopuffer::Client.new("your-token")
+
+ns = tpuf.namespace("namespace-name")
+
+ns.upsert(
+  ids: [1, 2],
+  vectors: [[0.1, 0.2], [0.3, 0.4]],
+  attributes: {name: ["foo", "bar"]}
+)
+
+results = ns.query(
+  vector: [0.15, 0.22],
+  top_k: 10
+)
+
+ns.delete_all
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/xymbol/turbopuffer-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/turbopuffer/client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Turbopuffer
+  class Client
+    BASE_URL = "https://api.turbopuffer.com"
+
+    def initialize(api_token)
+      @api_token = api_token
+      @connection = Faraday.new(url: BASE_URL) do |conn|
+        conn.request :json
+        conn.response :json, parser_options: {symbolize_names: true}
+        conn.headers["Authorization"] = "Bearer #{@api_token}"
+        conn.headers["Accept-Encoding"] = "gzip"
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def namespace(name)
+      Namespace.new(name, @connection)
+    end
+  end
+end

data/lib/turbopuffer/namespace.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  class Namespace
+    def initialize(name, connection)
+      @name = name
+      @connection = connection
+    end
+
+    def delete(ids:)
+      payload = {
+        ids: ids,
+        vectors: [nil] * ids.length
+      }
+      response = @connection.delete("/v1/namespaces/#{@name}", payload)
+      handle_response(response)
+    end
+
+    def delete_all
+      response = @connection.delete("/v1/namespaces/#{@name}")
+      handle_response(response)
+    end
+
+    def query(vector:, top_k: 10, distance_metric: "cosine_distance", filters: nil, include_attributes: false, include_vectors: false)
+      payload = {
+        vector: vector,
+        top_k: top_k,
+        distance_metric: distance_metric,
+        filters: filters,
+        include_attributes: include_attributes,
+        include_vectors: include_vectors
+      }
+      response = @connection.post("/v1/namespaces/#{@name}/query", payload)
+      handle_response(response)
+    end
+
+    def upsert(ids:, vectors:, attributes: nil, distance_metric: "cosine_distance")
+      payload = {
+        ids: ids,
+        vectors: vectors,
+        attributes: attributes,
+        distance_metric: distance_metric
+      }
+      response = @connection.post("/v1/namespaces/#{@name}", payload)
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      if response.success?
+        response.body
+      else
+        raise Error, "API Error: #{response.status} - #{response.body}"
+      end
+    end
+  end
+end

data/lib/turbopuffer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  VERSION = "0.1.0"
+end

data/lib/turbopuffer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "turbopuffer/version"
+require_relative "turbopuffer/client"
+require_relative "turbopuffer/namespace"
+
+module Turbopuffer
+  class Error < StandardError; end
+end

data/sig/turbopuffer.rbs

@@ -0,0 +1,4 @@
+module Turbopuffer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: turbopuffer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrián Mugnolo
+bindir: exe
+cert_chain: []
+date: 2025-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+description: Turbopuffer is a serverless vector database. This gem lets you access
+  the Turbopuffer API from Ruby.
+email:
+- adrian@mugnolo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/turbopuffer.rb
+- lib/turbopuffer/client.rb
+- lib/turbopuffer/namespace.rb
+- lib/turbopuffer/version.rb
+- sig/turbopuffer.rbs
+homepage: https://github.com/xymbol/turbopuffer-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xymbol/turbopuffer-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Ruby client for accessing the Turbopuffer API.
+test_files: []