weaviate-ruby 0.9.2 → 0.10.0

data/lib/weaviate/roles.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Weaviate
+  # Manage RBAC roles and their permissions. Requires RBAC to be enabled.
+  class Roles < Base
+    PATH = "authz/roles"
+
+    def list
+      response = client.connection.get(PATH)
+      response.body
+    end
+
+    def get(name:)
+      response = client.connection.get("#{PATH}/#{name}")
+      response.body
+    end
+
+    # @param permissions [Array<Hash>] e.g. [{ action: "read_data", data: { collection: "Products" } }]
+    def create(name:, permissions:)
+      response = client.connection.post(PATH) do |req|
+        req.body = {name: name, permissions: permissions}
+      end
+      response.success?
+    end
+
+    def delete(name:)
+      response = client.connection.delete("#{PATH}/#{name}")
+      response.success?
+    end
+
+    def add_permissions(name:, permissions:)
+      response = client.connection.post("#{PATH}/#{name}/add-permissions") do |req|
+        req.body = {permissions: permissions}
+      end
+      response.success?
+    end
+
+    def remove_permissions(name:, permissions:)
+      response = client.connection.post("#{PATH}/#{name}/remove-permissions") do |req|
+        req.body = {permissions: permissions}
+      end
+      response.success?
+    end
+
+    # @param permission [Hash] e.g. { action: "read_data", data: { collection: "Products" } }
+    def has_permission?(name:, permission:)
+      response = client.connection.post("#{PATH}/#{name}/has-permission") do |req|
+        req.body = permission
+      end
+      response.body == true
+    end
+
+    # Users the role is assigned to.
+    def user_assignments(name:)
+      response = client.connection.get("#{PATH}/#{name}/user-assignments")
+      response.body
+    end
+
+    # Groups the role is assigned to.
+    def group_assignments(name:)
+      response = client.connection.get("#{PATH}/#{name}/group-assignments")
+      response.body
+    end
+  end
+end

data/lib/weaviate/users.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Weaviate
+  # Manage database users and their roles. Requires RBAC to be enabled.
+  class Users < Base
+    PATH = "users"
+    USER_TYPES = %w[db oidc].freeze
+
+    # Information about the current user.
+    def own_info
+      response = client.connection.get("#{PATH}/own-info")
+      response.body
+    end
+
+    def list(include_last_used_time: nil)
+      response = client.connection.get("#{PATH}/db") do |req|
+        req.params["includeLastUsedTime"] = include_last_used_time unless include_last_used_time.nil?
+      end
+      response.body
+    end
+
+    def get(user_id:, include_last_used_time: nil)
+      response = client.connection.get("#{PATH}/db/#{user_id}") do |req|
+        req.params["includeLastUsedTime"] = include_last_used_time unless include_last_used_time.nil?
+      end
+      response.body
+    end
+
+    # Create a database user. The response contains the user's API key.
+    def create(user_id:)
+      response = client.connection.post("#{PATH}/db/#{user_id}")
+      response.body
+    end
+
+    def delete(user_id:)
+      response = client.connection.delete("#{PATH}/db/#{user_id}")
+      response.success?
+    end
+
+    def activate(user_id:)
+      response = client.connection.post("#{PATH}/db/#{user_id}/activate")
+      response.success?
+    end
+
+    # @param revoke_key [Boolean] Also revoke the user's API key
+    def deactivate(user_id:, revoke_key: nil)
+      response = client.connection.post("#{PATH}/db/#{user_id}/deactivate") do |req|
+        req.body = {revoke_key: revoke_key} unless revoke_key.nil?
+      end
+      response.success?
+    end
+
+    # Rotate a user's API key. The response contains the new key.
+    def rotate_key(user_id:)
+      response = client.connection.post("#{PATH}/db/#{user_id}/rotate-key")
+      response.body
+    end
+
+    # @param user_type [String] "db" or "oidc"
+    def roles(user_id:, user_type: "db", include_full_roles: nil)
+      validate_user_type!(user_type)
+
+      response = client.connection.get("authz/users/#{user_id}/roles/#{user_type}") do |req|
+        req.params["includeFullRoles"] = include_full_roles unless include_full_roles.nil?
+      end
+      response.body
+    end
+
+    def assign_roles(user_id:, roles:, user_type: "db")
+      update_roles(user_id, "assign", roles, user_type)
+    end
+
+    def revoke_roles(user_id:, roles:, user_type: "db")
+      update_roles(user_id, "revoke", roles, user_type)
+    end
+
+    private
+
+    def update_roles(user_id, action, roles, user_type)
+      validate_user_type!(user_type)
+
+      response = client.connection.post("authz/users/#{user_id}/#{action}") do |req|
+        req.body = {roles: Array(roles), userType: user_type}
+      end
+      response.success?
+    end
+
+    def validate_user_type!(user_type)
+      unless USER_TYPES.include?(user_type.to_s)
+        raise ArgumentError, 'user_type must be either "db" or "oidc"'
+      end
+    end
+  end
+end

data/lib/weaviate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Weaviate
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/lib/weaviate.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "weaviate/version"
+require_relative "weaviate/error"
 
 module Weaviate
   autoload :Base, "weaviate/base"
   autoload :Client, "weaviate/client"
-  autoload :Error, "weaviate/error"
-  autoload :Schema, "weaviate/schema"
+  autoload :Connection, "weaviate/connection"
+  autoload :Collections, "weaviate/collections"
+  autoload :Schema, "weaviate/collections"
+  autoload :GraphQL, "weaviate/graphql"
   autoload :Meta, "weaviate/meta"
   autoload :Objects, "weaviate/objects"
   autoload :OIDC, "weaviate/oidc"
@@ -15,4 +18,8 @@ module Weaviate
   autoload :Health, "weaviate/health"
   autoload :Classifications, "weaviate/classifications"
   autoload :Backups, "weaviate/backups"
+  autoload :Aliases, "weaviate/aliases"
+  autoload :Users, "weaviate/users"
+  autoload :Roles, "weaviate/roles"
+  autoload :Groups, "weaviate/groups"
 end

data/sig/weaviate.rbs

@@ -1,4 +1,422 @@
 module Weaviate
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  # Parsed JSON returned by Weaviate
+  type json = untyped
+
+  # A raw GraphQL string, or a Ruby value serialized to GraphQL
+  type graphql_argument = String | Hash[untyped, untyped] | Array[untyped]
+
+  type consistency_level = String | Symbol
+
+  class Error < StandardError
+  end
+
+  class ConnectionFailed < Error
+  end
+
+  class TimeoutError < ConnectionFailed
+  end
+
+  class HTTPError < Error
+    attr_reader response: Connection::Response?
+
+    def initialize: (?String? message, ?response: Connection::Response?) -> void
+    def status: () -> Integer?
+    def body: () -> json
+  end
+
+  class ClientError < HTTPError
+  end
+
+  class BadRequestError < ClientError
+  end
+
+  class UnauthorizedError < ClientError
+  end
+
+  class ForbiddenError < ClientError
+  end
+
+  class ResourceNotFound < ClientError
+  end
+
+  class ConflictError < ClientError
+  end
+
+  class UnprocessableEntityError < ClientError
+  end
+
+  class ServerError < HTTPError
+  end
+
+  class GraphQLError < Error
+    attr_reader errors: Array[Hash[String, untyped]]
+
+    def initialize: (Array[Hash[String, untyped]] errors) -> void
+  end
+
+  class Client
+    API_VERSION: String
+    API_KEY_HEADERS: Hash[Symbol, String]
+
+    attr_reader url: String
+    attr_reader api_key: String?
+    attr_reader model_service: Symbol?
+    attr_reader model_service_api_key: String?
+    attr_reader headers: Hash[String, String]
+    attr_reader proxy: String?
+    attr_reader logger: Logger
+    attr_reader open_timeout: Numeric?
+    attr_reader read_timeout: Numeric?
+    attr_reader write_timeout: Numeric?
+
+    def initialize: (
+      url: String,
+      ?api_key: String?,
+      ?model_service: Symbol?,
+      ?model_service_api_key: String?,
+      ?headers: Hash[String, String],
+      ?proxy: String?,
+      ?logger: Logger?,
+      ?open_timeout: Numeric?,
+      ?read_timeout: Numeric?,
+      ?write_timeout: Numeric?,
+      ?adapter: untyped
+    ) -> void
+
+    def oidc: () -> json
+    def collections: () -> Collections
+    def schema: () -> Collections
+    def meta: () -> json
+    def nodes: (?output: String?, ?class_name: String?, ?shard_name: String?) -> json
+    def live?: () -> bool
+    def ready?: () -> bool
+    def backups: () -> Backups
+    def classifications: () -> Classifications
+    def objects: () -> Objects
+    def query: () -> Query
+    def aliases: () -> Aliases
+    def users: () -> Users
+    def roles: () -> Roles
+    def groups: () -> Groups
+    def graphql: () -> GraphQL
+    def connection: () -> Connection
+  end
+
+  class Connection
+    class Request < Struct[untyped]
+      attr_accessor params: Hash[String, untyped]
+      attr_accessor headers: Hash[String, String]
+      attr_accessor body: untyped
+    end
+
+    class Response < Struct[untyped]
+      attr_accessor status: Integer
+      attr_accessor reason_phrase: String
+      attr_accessor headers: Hash[String, Array[String]]
+      attr_accessor body: json
+
+      def success?: () -> bool
+    end
+
+    attr_reader url: String
+    attr_reader headers: Hash[String, String]
+    attr_reader logger: Logger?
+    attr_reader proxy: URI::Generic?
+    attr_reader timeouts: Hash[Symbol, Numeric]
+
+    def initialize: (
+      url: String,
+      ?headers: Hash[String, String],
+      ?logger: Logger?,
+      ?proxy: String?,
+      ?open_timeout: Numeric?,
+      ?read_timeout: Numeric?,
+      ?write_timeout: Numeric?
+    ) -> void
+
+    def get: (String path) ?{ (Request) -> void } -> Response
+    def head: (String path) ?{ (Request) -> void } -> Response
+    def post: (String path) ?{ (Request) -> void } -> Response
+    def put: (String path) ?{ (Request) -> void } -> Response
+    def patch: (String path) ?{ (Request) -> void } -> Response
+    def delete: (String path) ?{ (Request) -> void } -> Response
+  end
+
+  class Base
+    attr_reader client: Client
+
+    def initialize: (client: Client) -> void
+  end
+
+  class GraphQL < Base
+    def execute: (String query) -> json
+  end
+
+  class Collections < Base
+    def list: () -> json
+    def get: (class_name: String) -> json
+
+    def create: (
+      class_name: String,
+      ?description: String?,
+      ?properties: Array[Hash[untyped, untyped]]?,
+      ?multi_tenant: bool,
+      ?auto_tenant_creation: bool,
+      ?auto_tenant_activation: bool,
+      ?vector_index_type: String?,
+      ?vector_index_config: Hash[untyped, untyped]?,
+      ?vectorizer: String?,
+      ?module_config: Hash[untyped, untyped]?,
+      ?inverted_index_config: Hash[untyped, untyped]?,
+      ?replication_config: Hash[untyped, untyped]?,
+      ?vector_config: Hash[untyped, untyped]?
+    ) -> json
+
+    def update: (
+      class_name: String,
+      ?description: String?,
+      ?vector_index_type: String?,
+      ?vector_index_config: Hash[untyped, untyped]?,
+      ?vectorizer: String?,
+      ?module_config: Hash[untyped, untyped]?,
+      ?properties: Array[Hash[untyped, untyped]]?,
+      ?inverted_index_config: Hash[untyped, untyped]?,
+      ?replication_config: Hash[untyped, untyped]?,
+      ?vector_config: Hash[untyped, untyped]?
+    ) -> json
+
+    def delete: (class_name: String) -> bool
+    def add_property: (class_name: String, property: Hash[untyped, untyped]) -> json
+    def add_tenants: (class_name: String, tenants: Array[String | Hash[untyped, untyped]]) -> json
+    def update_tenants: (class_name: String, tenants: Array[String | Hash[untyped, untyped]]) -> json
+    def get_tenant: (class_name: String, tenant: String) -> json
+    def tenant_exists?: (class_name: String, tenant: String) -> bool
+    def list_tenants: (class_name: String) -> json
+    def remove_tenants: (class_name: String, tenants: Array[String]) -> json
+    def shards: (class_name: String, ?tenant: String?) -> json
+    def update_shard_status: (class_name: String, shard_name: String, status: String) -> json
+  end
+
+  Schema: singleton(Collections)
+
+  class Objects < Base
+    def list: (
+      ?class_name: String?,
+      ?limit: Integer?,
+      ?tenant: String?,
+      ?offset: Integer?,
+      ?after: String?,
+      ?include: String?,
+      ?sort: String?,
+      ?order: String?
+    ) -> json
+
+    def create: (
+      class_name: String,
+      properties: Hash[untyped, untyped],
+      ?tenant: String?,
+      ?consistency_level: consistency_level?,
+      ?id: String?,
+      ?vector: Array[Float]?
+    ) -> json
+
+    def batch_create: (objects: Array[Hash[untyped, untyped]], ?consistency_level: consistency_level?, ?tenant: String?) -> json
+    def get: (class_name: String, id: String, ?include: String?, ?consistency_level: consistency_level?, ?tenant: String?) -> json
+    def exists?: (class_name: String, id: String, ?consistency_level: consistency_level?, ?tenant: String?) -> bool
+
+    def update: (
+      class_name: String,
+      id: String,
+      properties: Hash[untyped, untyped],
+      ?vector: Array[Float]?,
+      ?tenant: String?,
+      ?consistency_level: consistency_level?
+    ) -> json
+
+    def replace: (
+      class_name: String,
+      id: String,
+      properties: Hash[untyped, untyped],
+      ?vector: Array[Float]?,
+      ?tenant: String?,
+      ?consistency_level: consistency_level?
+    ) -> json
+
+    def delete: (class_name: String, id: String, ?consistency_level: consistency_level?, ?tenant: String?) -> bool
+
+    def batch_delete: (
+      class_name: String,
+      where: Hash[untyped, untyped],
+      ?consistency_level: consistency_level?,
+      ?output: String?,
+      ?dry_run: bool?,
+      ?tenant: String?
+    ) -> json
+
+    def add_reference: (
+      class_name: String,
+      id: String,
+      property: String,
+      to_class_name: String,
+      to_id: String,
+      ?tenant: String?,
+      ?consistency_level: consistency_level?
+    ) -> bool
+
+    def replace_references: (
+      class_name: String,
+      id: String,
+      property: String,
+      to: Array[{ class_name: String, id: String }],
+      ?tenant: String?,
+      ?consistency_level: consistency_level?
+    ) -> bool
+
+    def delete_reference: (
+      class_name: String,
+      id: String,
+      property: String,
+      to_class_name: String,
+      to_id: String,
+      ?tenant: String?,
+      ?consistency_level: consistency_level?
+    ) -> bool
+
+    def batch_create_references: (references: Array[Hash[Symbol, String]], ?consistency_level: consistency_level?) -> json
+    def validate: (class_name: String, properties: Hash[untyped, untyped], ?id: String?) -> bool
+  end
+
+  class Query < Base
+    def get: (
+      class_name: String,
+      fields: String,
+      ?after: String?,
+      ?tenant: String?,
+      ?limit: Integer | String | nil,
+      ?autocut: Integer | String | nil,
+      ?offset: Integer | String | nil,
+      ?sort: graphql_argument?,
+      ?where: graphql_argument?,
+      ?near_text: graphql_argument?,
+      ?near_vector: graphql_argument?,
+      ?near_image: graphql_argument?,
+      ?near_object: graphql_argument?,
+      ?with_hybrid: graphql_argument?,
+      ?bm25: graphql_argument?,
+      ?ask: graphql_argument?,
+      ?group_by: graphql_argument?
+    ) -> json
+
+    def aggs: (
+      class_name: String,
+      ?fields: String?,
+      ?tenant: String?,
+      ?where: graphql_argument?,
+      ?object_limit: Integer | String | nil,
+      ?near_text: graphql_argument?,
+      ?near_vector: graphql_argument?,
+      ?near_image: graphql_argument?,
+      ?near_object: graphql_argument?,
+      ?group_by: Array[String] | String | nil,
+      ?limit: Integer | String | nil,
+      ?with_hybrid: graphql_argument?
+    ) -> json
+
+    # @deprecated
+    def explore: (
+      fields: String,
+      ?after: String?,
+      ?limit: Integer | String | nil,
+      ?offset: Integer | String | nil,
+      ?sort: graphql_argument?,
+      ?where: graphql_argument?,
+      ?near_text: graphql_argument?,
+      ?near_vector: graphql_argument?,
+      ?near_image: graphql_argument?,
+      ?near_object: graphql_argument?
+    ) -> json
+  end
+
+  class Backups < Base
+    def list: (backend: String, ?order: String?) -> json
+    def create: (backend: String, id: String, ?include: Array[String]?, ?exclude: Array[String]?, ?config: Hash[untyped, untyped]?) -> json
+    def get: (backend: String, id: String, ?bucket: String?, ?path: String?) -> json
+    def cancel: (backend: String, id: String, ?bucket: String?, ?path: String?) -> bool
+    def restore: (backend: String, id: String, ?include: Array[String]?, ?exclude: Array[String]?, ?config: Hash[untyped, untyped]?) -> json
+    def restore_status: (backend: String, id: String, ?bucket: String?, ?path: String?) -> json
+    def cancel_restore: (backend: String, id: String, ?bucket: String?, ?path: String?) -> bool
+  end
+
+  class Classifications < Base
+    def get: (id: String) -> json
+
+    def create: (
+      class_name: String,
+      type: String,
+      ?classify_properties: Array[String]?,
+      ?based_on_properties: Array[String]?,
+      ?settings: Hash[untyped, untyped]?,
+      ?filters: Hash[untyped, untyped]?
+    ) -> json
+  end
+
+  class Nodes < Base
+    def list: (?output: String?, ?class_name: String?, ?shard_name: String?) -> json
+  end
+
+  class Health < Base
+    def live?: () -> bool
+    def ready?: () -> bool
+  end
+
+  class Meta < Base
+    def get: () -> json
+  end
+
+  class OIDC < Base
+    def get: () -> json
+  end
+
+  class Aliases < Base
+    def list: (?class_name: String?) -> json
+    def create: (alias_name: String, class_name: String) -> json
+    def get: (alias_name: String) -> json
+    def update: (alias_name: String, class_name: String) -> json
+    def delete: (alias_name: String) -> bool
+  end
+
+  class Users < Base
+    def own_info: () -> json
+    def list: (?include_last_used_time: bool?) -> json
+    def get: (user_id: String, ?include_last_used_time: bool?) -> json
+    def create: (user_id: String) -> json
+    def delete: (user_id: String) -> bool
+    def activate: (user_id: String) -> bool
+    def deactivate: (user_id: String, ?revoke_key: bool?) -> bool
+    def rotate_key: (user_id: String) -> json
+    def roles: (user_id: String, ?user_type: String, ?include_full_roles: bool?) -> json
+    def assign_roles: (user_id: String, roles: Array[String] | String, ?user_type: String) -> bool
+    def revoke_roles: (user_id: String, roles: Array[String] | String, ?user_type: String) -> bool
+  end
+
+  class Roles < Base
+    def list: () -> json
+    def get: (name: String) -> json
+    def create: (name: String, permissions: Array[Hash[untyped, untyped]]) -> bool
+    def delete: (name: String) -> bool
+    def add_permissions: (name: String, permissions: Array[Hash[untyped, untyped]]) -> bool
+    def remove_permissions: (name: String, permissions: Array[Hash[untyped, untyped]]) -> bool
+    def has_permission?: (name: String, permission: Hash[untyped, untyped]) -> bool
+    def user_assignments: (name: String) -> json
+    def group_assignments: (name: String) -> json
+  end
+
+  class Groups < Base
+    def list: () -> json
+    def roles: (group_id: String, ?include_full_roles: bool?) -> json
+    def assign_roles: (group_id: String, roles: Array[String] | String) -> bool
+    def revoke_roles: (group_id: String, roles: Array[String] | String) -> bool
+  end
 end