supabase-rb 2.0.0

data/lib/supabase/storage/vectors.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require_relative "request"
+require_relative "types"
+require_relative "errors"
+
+module Supabase
+  module Storage
+    # Vector bucket / index / record management. Mirrors storage3's
+    # `SyncStorageVectorsClient`. All endpoints are POSTs to actions under
+    # `{storage_url}/vector/...`.
+    #
+    #   vectors = client.vectors
+    #   vectors.create_bucket("docs")
+    #   vectors.from("docs").create_index("paragraphs", 1536, "cosine", "float32")
+    #   vectors.from("docs").index("paragraphs").put([{ key: "p1", data: { float32: [...] } }])
+    class VectorsClient
+      include Request
+
+      def initialize(session, base_url, headers)
+        @session  = session
+        normalized = base_url.end_with?("/") ? base_url : "#{base_url}/"
+        @base_url = "#{normalized}vector/"
+        @headers  = headers
+      end
+
+      # Scope subsequent index/record operations to a particular vector bucket.
+      def from(bucket_name)
+        VectorBucketScope.new(self, bucket_name)
+      end
+
+      alias from_ from
+
+      def create_bucket(bucket_name)
+        _request(:post, ["CreateVectorBucket"], json: { "vectorBucketName" => bucket_name })
+        nil
+      end
+
+      # Returns nil if the bucket doesn't exist (matches py's swallow of
+      # StorageApiError). Any other API failure still surfaces.
+      def get_bucket(bucket_name)
+        body = _request(:post, ["GetVectorBucket"], json: { "vectorBucketName" => bucket_name })
+        Types::GetVectorBucketResponse.from_hash(body)
+      rescue Errors::StorageApiError
+        nil
+      end
+
+      def list_buckets(prefix: nil, max_results: nil, next_token: nil)
+        json = { "prefix" => prefix, "maxResults" => max_results, "nextToken" => next_token }.compact
+        body = _request(:post, ["ListVectorBuckets"], json: json)
+        Types::ListVectorBucketsResponse.from_hash(body)
+      end
+
+      def delete_bucket(bucket_name)
+        _request(:post, ["DeleteVectorBucket"], json: { "vectorBucketName" => bucket_name })
+        nil
+      end
+
+      # Exposed so the scope classes can reuse our wired-up session/headers
+      # without re-implementing `_request`. Not part of the public API.
+      def send_action(path:, json: nil) # :nodoc:
+        _request(:post, [path], json: json)
+      end
+    end
+
+    # A bucket-scoped facade. Mirrors storage3's `SyncVectorBucketScope`.
+    class VectorBucketScope
+      def initialize(vectors_client, bucket_name)
+        @client      = vectors_client
+        @bucket_name = bucket_name
+      end
+
+      def create_index(index_name, dimension, distance_metric, data_type, metadata: nil)
+        json = with_metadata(
+          "indexName"             => index_name,
+          "dimension"             => dimension,
+          "distanceMetric"        => distance_metric,
+          "dataType"              => data_type,
+          "metadataConfiguration" => metadata
+        )
+        @client.send_action(path: "CreateIndex", json: json)
+        nil
+      end
+
+      def get_index(index_name)
+        body = @client.send_action(path: "GetIndex", json: with_metadata("indexName" => index_name))
+        Types::GetVectorIndexResponse.from_hash(body)
+      rescue Errors::StorageApiError
+        nil
+      end
+
+      def list_indexes(next_token: nil, max_results: nil, prefix: nil)
+        json = with_metadata("next_token" => next_token, "max_results" => max_results, "prefix" => prefix)
+        body = @client.send_action(path: "ListIndexes", json: json)
+        Types::ListVectorIndexesResponse.from_hash(body)
+      end
+
+      def delete_index(index_name)
+        @client.send_action(path: "DeleteIndex", json: with_metadata("indexName" => index_name))
+        nil
+      end
+
+      def index(index_name)
+        VectorIndexScope.new(@client, @bucket_name, index_name)
+      end
+
+      private
+
+      # Drops nil values and stamps the vector bucket name onto every request,
+      # matching the py helper of the same name.
+      def with_metadata(extra = {})
+        { "vectorBucketName" => @bucket_name }.merge(extra).reject { |_, v| v.nil? }
+      end
+    end
+
+    # A bucket+index-scoped facade for record-level operations. Mirrors
+    # storage3's `SyncVectorIndexScope`.
+    class VectorIndexScope
+      VECTOR_BATCH_MIN = 1
+      VECTOR_BATCH_MAX = 500
+
+      def initialize(vectors_client, bucket_name, index_name)
+        @client      = vectors_client
+        @bucket_name = bucket_name
+        @index_name  = index_name
+      end
+
+      def put(vectors)
+        # Accept either Hashes or VectorMatch-like Structs; serialize hashes
+        # directly so callers can pass plain `{ key:, data:, metadata: }`.
+        serialized = Array(vectors).map { |v| v.respond_to?(:to_h) ? v.to_h : v }
+                                   .map { |h| h.reject { |_, val| val.nil? } }
+        @client.send_action(path: "PutVectors", json: with_metadata("vectors" => serialized))
+        nil
+      end
+
+      def get(*keys, return_data: true, return_metadata: true)
+        json = with_metadata("keys" => keys, "returnData" => return_data, "returnMetadata" => return_metadata)
+        body = @client.send_action(path: "GetVectors", json: json)
+        Types::GetVectorsResponse.from_hash(body)
+      end
+
+      def list(max_results: nil, next_token: nil, return_data: true, return_metadata: true,
+               segment_count: nil, segment_index: nil)
+        json = with_metadata(
+          "maxResults"     => max_results,
+          "nextToken"      => next_token,
+          "returnData"     => return_data,
+          "returnMetadata" => return_metadata,
+          "segmentCount"   => segment_count,
+          "segmentIndex"   => segment_index
+        )
+        body = @client.send_action(path: "ListVectors", json: json)
+        Types::ListVectorsResponse.from_hash(body)
+      end
+
+      def query(query_vector, top_k: nil, filter: nil, return_distance: true, return_metadata: true)
+        json = with_metadata(
+          "queryVector"     => query_vector,
+          "topK"            => top_k,
+          "filter"          => filter,
+          "returnDistance"  => return_distance,
+          "returnMetadata"  => return_metadata
+        )
+        body = @client.send_action(path: "QueryVectors", json: json)
+        Types::QueryVectorsResponse.from_hash(body)
+      end
+
+      def delete(keys)
+        keys = Array(keys)
+        if keys.size < VECTOR_BATCH_MIN || keys.size > VECTOR_BATCH_MAX
+          raise Errors::VectorBucketException, "Keys batch size must be between #{VECTOR_BATCH_MIN} and #{VECTOR_BATCH_MAX}."
+        end
+
+        @client.send_action(path: "DeleteVectors", json: with_metadata("keys" => keys))
+        nil
+      end
+
+      private
+
+      def with_metadata(extra = {})
+        {
+          "vectorBucketName" => @bucket_name,
+          "indexName"        => @index_name
+        }.merge(extra).reject { |_, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/supabase/storage/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Supabase
+  module Storage
+    VERSION = "0.1.0"
+  end
+end

data/lib/supabase/storage.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "storage/version"
+require_relative "storage/errors"
+require_relative "storage/types"
+require_relative "storage/utils"
+require_relative "storage/request"
+require_relative "storage/bucket_api"
+require_relative "storage/file_api"
+require_relative "storage/analytics"
+require_relative "storage/vectors"
+require_relative "storage/client"
+
+module Supabase
+  module Storage
+  end
+end

data/lib/supabase/version.rb

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

data/lib/supabase-auth.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "supabase/auth"

data/lib/supabase.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "supabase/version"
+require_relative "supabase/client_options"
+require_relative "supabase/client"
+
+module Supabase
+  # Re-exports of error types from each sub-library, so callers can rescue with
+  # the umbrella names that mirror supabase-py's top-level `__init__.py`:
+  #
+  #   rescue Supabase::PostgrestAPIError       => e   # postgrest
+  #   rescue Supabase::StorageException        => e   # storage
+  #   rescue Supabase::AuthApiError            => e   # auth
+  #   rescue Supabase::FunctionsHttpError      => e   # functions
+  #   rescue Supabase::AuthorizationError      => e   # realtime
+  #
+  # The actual classes live in their sub-namespaces; these are aliases.
+
+  # Postgrest
+  PostgrestAPIError    = Postgrest::Errors::APIError    if defined?(Postgrest::Errors::APIError)
+  PostgrestAPIResponse = Postgrest::APIResponse         if defined?(Postgrest::APIResponse)
+
+  # Storage
+  StorageException = Storage::Errors::StorageError      if defined?(Storage::Errors::StorageError)
+  StorageApiError  = Storage::Errors::StorageApiError   if defined?(Storage::Errors::StorageApiError)
+
+  # Auth (supabase_auth.errors.*)
+  if defined?(Auth::Errors)
+    AuthError                        = Auth::Errors::AuthError                        if defined?(Auth::Errors::AuthError)
+    AuthApiError                     = Auth::Errors::AuthApiError                     if defined?(Auth::Errors::AuthApiError)
+    AuthImplicitGrantRedirectError   = Auth::Errors::AuthImplicitGrantRedirectError   if defined?(Auth::Errors::AuthImplicitGrantRedirectError)
+    AuthInvalidCredentialsError      = Auth::Errors::AuthInvalidCredentialsError      if defined?(Auth::Errors::AuthInvalidCredentialsError)
+    AuthRetryableError               = Auth::Errors::AuthRetryableError               if defined?(Auth::Errors::AuthRetryableError)
+    AuthSessionMissingError          = Auth::Errors::AuthSessionMissingError          if defined?(Auth::Errors::AuthSessionMissingError)
+    AuthUnknownError                 = Auth::Errors::AuthUnknownError                 if defined?(Auth::Errors::AuthUnknownError)
+    AuthWeakPasswordError            = Auth::Errors::AuthWeakPasswordError            if defined?(Auth::Errors::AuthWeakPasswordError)
+  end
+
+  # Functions
+  if defined?(Functions::Errors)
+    FunctionsError      = Functions::Errors::FunctionsError      if defined?(Functions::Errors::FunctionsError)
+    FunctionsHttpError  = Functions::Errors::FunctionsHttpError  if defined?(Functions::Errors::FunctionsHttpError)
+    FunctionsRelayError = Functions::Errors::FunctionsRelayError if defined?(Functions::Errors::FunctionsRelayError)
+  end
+
+  # Realtime
+  if defined?(Realtime::Errors)
+    AuthorizationError = Realtime::Errors::AuthorizationError if defined?(Realtime::Errors::AuthorizationError)
+    NotConnectedError  = Realtime::Errors::NotConnectedError  if defined?(Realtime::Errors::NotConnectedError)
+  end
+
+  # Raised by {Supabase.create_client} on a missing url/key. Mirrors py's
+  # `SupabaseException`. We don't inherit from a sub-library error because the
+  # umbrella factory predates choosing any of them.
+  class SupabaseException < StandardError; end
+
+  # Alias mirroring supabase-py's `acreate_client` / `create_async_client`.
+  # Equivalent to `create_client(..., async: true)`.
+  def self.acreate_client(supabase_url:, supabase_key:, options: {})
+    create_client(supabase_url: supabase_url, supabase_key: supabase_key, options: options, async: true)
+  end
+  singleton_class.send(:alias_method, :create_async_client, :acreate_client)
+end

metadata

@@ -0,0 +1,272 @@
+--- !ruby/object:Gem::Specification
+name: supabase-rb
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Supabase
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+description: 'Ruby client for Supabase: Auth, PostgREST, Storage, Edge Functions,
+  and Realtime exposed through a single Supabase.create_client(supabase_url:, supabase_key:)
+  factory, mirroring supabase-py''s create_client().'
+email:
+- support@supabase.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/supabase-auth.rb
+- lib/supabase.rb
+- lib/supabase/README.md
+- lib/supabase/auth.rb
+- lib/supabase/auth/README.md
+- lib/supabase/auth/admin_api.rb
+- lib/supabase/auth/admin_oauth_api.rb
+- lib/supabase/auth/api.rb
+- lib/supabase/auth/async.rb
+- lib/supabase/auth/async/admin_api.rb
+- lib/supabase/auth/async/admin_oauth_api.rb
+- lib/supabase/auth/async/api.rb
+- lib/supabase/auth/async/client.rb
+- lib/supabase/auth/client.rb
+- lib/supabase/auth/constants.rb
+- lib/supabase/auth/errors.rb
+- lib/supabase/auth/helpers.rb
+- lib/supabase/auth/memory_storage.rb
+- lib/supabase/auth/storage.rb
+- lib/supabase/auth/timer.rb
+- lib/supabase/auth/types.rb
+- lib/supabase/auth/version.rb
+- lib/supabase/client.rb
+- lib/supabase/client_options.rb
+- lib/supabase/functions.rb
+- lib/supabase/functions/README.md
+- lib/supabase/functions/async.rb
+- lib/supabase/functions/async/client.rb
+- lib/supabase/functions/client.rb
+- lib/supabase/functions/errors.rb
+- lib/supabase/functions/types.rb
+- lib/supabase/functions/version.rb
+- lib/supabase/postgrest.rb
+- lib/supabase/postgrest/README.md
+- lib/supabase/postgrest/async.rb
+- lib/supabase/postgrest/async/client.rb
+- lib/supabase/postgrest/client.rb
+- lib/supabase/postgrest/errors.rb
+- lib/supabase/postgrest/request_builder.rb
+- lib/supabase/postgrest/types.rb
+- lib/supabase/postgrest/utils.rb
+- lib/supabase/postgrest/version.rb
+- lib/supabase/realtime.rb
+- lib/supabase/realtime/README.md
+- lib/supabase/realtime/channel.rb
+- lib/supabase/realtime/client.rb
+- lib/supabase/realtime/errors.rb
+- lib/supabase/realtime/message.rb
+- lib/supabase/realtime/presence.rb
+- lib/supabase/realtime/push.rb
+- lib/supabase/realtime/socket.rb
+- lib/supabase/realtime/sockets/async_websocket.rb
+- lib/supabase/realtime/sockets/websocket_client_simple.rb
+- lib/supabase/realtime/test_socket.rb
+- lib/supabase/realtime/transformers.rb
+- lib/supabase/realtime/types.rb
+- lib/supabase/realtime/version.rb
+- lib/supabase/storage.rb
+- lib/supabase/storage/README.md
+- lib/supabase/storage/analytics.rb
+- lib/supabase/storage/async.rb
+- lib/supabase/storage/async/client.rb
+- lib/supabase/storage/bucket_api.rb
+- lib/supabase/storage/client.rb
+- lib/supabase/storage/errors.rb
+- lib/supabase/storage/file_api.rb
+- lib/supabase/storage/request.rb
+- lib/supabase/storage/types.rb
+- lib/supabase/storage/utils.rb
+- lib/supabase/storage/vectors.rb
+- lib/supabase/storage/version.rb
+- lib/supabase/version.rb
+homepage: https://github.com/supabase-ruby/supabase-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/supabase-ruby/supabase-rb
+  source_code_uri: https://github.com/supabase-ruby/supabase-rb
+  documentation_uri: https://github.com/supabase-ruby/supabase-rb/blob/master/lib/supabase/README.md
+  changelog_uri: https://github.com/supabase-ruby/supabase-rb/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.11
+specification_version: 4
+summary: Ruby client for Supabase
+test_files: []