Initial commit

xymbol · xymbol · commit 98ac47f6d6bf · 2025-01-04T16:37:09.000-03:00
Set up a Ruby gem project structure with a basic client for the
Turbopuffer API and one test hitting the production API.

The goal is to have a working gem that can be used to try the service
and evaluate it.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,29 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.3.6'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      env:
+        TURBOPUFFER_API_KEY: ${{ secrets.TURBOPUFFER_API_KEY }}
+      run: bundle exec rake
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem
diff --git a/.standard.yml b/.standard.yml
@@ -0,0 +1,4 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0
+fix: true
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in turbopuffer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.16"
+
+gem "standard", "~> 1.3"
diff --git a/LICENSE.txt b/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.
diff --git a/README.md b/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).
diff --git a/Rakefile b/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]
diff --git a/bin/console b/bin/console
@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "turbopuffer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)
diff --git a/bin/setup b/bin/setup
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
diff --git a/lib/turbopuffer.rb b/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
diff --git a/lib/turbopuffer/client.rb b/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
diff --git a/lib/turbopuffer/namespace.rb b/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
diff --git a/lib/turbopuffer/version.rb b/lib/turbopuffer/version.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  VERSION = "0.1.0"
+end
diff --git a/sig/turbopuffer.rbs b/sig/turbopuffer.rbs
@@ -0,0 +1,4 @@
+module Turbopuffer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "turbopuffer"
+
+require "minitest/autorun"
diff --git a/test/test_turbopuffer.rb b/test/test_turbopuffer.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "securerandom"
+
+class TestTurbopuffer < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Turbopuffer::VERSION
+  end
+
+  def test_usage_example
+    tpuf = Turbopuffer::Client.new(ENV["TURBOPUFFER_API_KEY"])
+
+    ns = tpuf.namespace("test-#{SecureRandom.uuid}")
+
+    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
+    )
+
+    assert_equal 2, results.length
+    assert_equal 2, results[0][:id]
+    assert_in_delta 0.001, results[0][:dist], 0.001
+
+    ns.delete_all
+  end
+end
diff --git a/turbopuffer.gemspec b/turbopuffer.gemspec
@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/turbopuffer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "turbopuffer"
+  spec.version = Turbopuffer::VERSION
+  spec.authors = ["Adrián Mugnolo"]
+  spec.email = ["adrian@mugnolo.com"]
+
+  spec.summary = "A Ruby client for accessing the Turbopuffer API."
+  spec.description = "Turbopuffer is a serverless vector database. This gem lets you access the Turbopuffer API from Ruby."
+  spec.homepage = "https://github.com/xymbol/turbopuffer-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/xymbol/turbopuffer-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/xymbol/turbopuffer-ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gemspec = File.basename(__FILE__)
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      (f == gemspec) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "faraday", "~> 2.12", ">= 2.12.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end
