Merge pull request #29 from obie/main

Adds support for multitenancy

Author: andreibondarev

.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.rubocop.yml

Gemfile.lock

@@ -93,6 +93,7 @@ GEM
     yard (0.9.34)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
   x86_64-linux
 

lib/weaviate/objects.rb

@@ -8,6 +8,7 @@ class Objects < Base
     def list(
       class_name: nil,
       limit: nil,
+      tenant: nil,
       offset: nil,
       after: nil,
       include: nil,
@@ -16,6 +17,7 @@ def list(
     )
       response = client.connection.get(PATH) do |req|
         req.params["class"] = class_name unless class_name.nil?
+        req.params["tenant"] = tenant unless tenant.nil?
         req.params["limit"] = limit unless limit.nil?
         req.params["offset"] = offset unless offset.nil?
         req.params["after"] = after unless after.nil?
@@ -31,6 +33,7 @@ def list(
     def create(
       class_name:,
       properties:,
+      tenant: nil,
       consistency_level: nil,
       id: nil,
       vector: nil
@@ -47,6 +50,7 @@ def create(
         req.body = {}
         req.body["class"] = class_name
         req.body["properties"] = properties
+        req.body["tenant"] = tenant unless tenant.blank?
         req.body["id"] = id unless id.nil?
         req.body["vector"] = vector unless vector.nil?
       end

lib/weaviate/query.rb

@@ -6,6 +6,7 @@ def get(
       class_name:,
       fields:,
       after: nil,
+      tenant: nil,
       limit: nil,
       offset: nil,
       sort: nil,
@@ -21,6 +22,7 @@ def get(
       response = client.graphql.execute(
         get_query(
           class_name: class_name,
+          tenant: tenant,
           fields: fields,
           sort: sort,
           where: where,
@@ -131,7 +133,7 @@ def explore_query(
 
     def get_query(
       class_name:,
-      fields:,
+      fields:, tenant: nil,
       where: nil,
       near_text: nil,
       near_vector: nil,
@@ -153,6 +155,7 @@ def get_query(
               after: $after,
               limit: $limit,
               offset: $offset,
+              #{tenant.present? ? "tenant: #{tenant}" : ""}
               #{near_text.present? ? "nearText: #{near_text}" : ""},
               #{near_vector.present? ? "nearVector: #{near_vector}" : ""},
               #{near_image.present? ? "nearImage: #{near_image}" : ""},

lib/weaviate/schema.rb

@@ -26,6 +26,7 @@ def create(
       class_name:,
       description: nil,
       properties: nil,
+      multi_tenant: nil,
       vector_index_type: nil,
       vector_index_config: nil,
       vectorizer: nil,
@@ -42,6 +43,7 @@ def create(
         req.body["vectorizer"] = vectorizer unless vectorizer.nil?
         req.body["moduleConfig"] = module_config unless module_config.nil?
         req.body["properties"] = properties unless properties.nil?
+        req.body["multiTenancyConfig"] = {enabled: true} unless multi_tenant.nil?
         req.body["invertedIndexConfig"] = inverted_index_config unless inverted_index_config.nil?
         req.body["replicationConfig"] = replication_config unless replication_config.nil?
       end
@@ -93,6 +95,38 @@ def update(
       response.body
     end
 
+    # Adds one or more tenants to a class.
+    def add_tenants(
+      class_name:,
+      tenants:
+    )
+      client.connection.post("#{PATH}/#{class_name}/tenants") do |req|
+        tenants_str = tenants.map { |t| %({"name": "#{t}"}) }.join(", ")
+        req.body = "[#{tenants_str}]"
+      end
+    end
+
+    # List tenants of a class.
+    def list_tenants(class_name:)
+      response = client.connection.get("#{PATH}/#{class_name}/tenants")
+      response.body
+    end
+
+    # Remove one or more tenants from a class.
+    def remove_tenants(
+      class_name:,
+      tenants:
+    )
+      response = client.connection.delete("#{PATH}/#{class_name}/tenants") do |req|
+        req.body = tenants
+      end
+
+      if response.success?
+      end
+
+      response.body
+    end
+
     # Add a property to an existing schema class.
     def add_property(
       class_name:,

spec/weaviate/objects_spec.rb

@@ -26,6 +26,7 @@
     it "creates an object" do
       response = objects.create(
         class_name: "Question",
+        tenant: "tenant_name",
         properties: {
           answer: "42",
           question: "What is the meaning of life?",

spec/weaviate/query_spec.rb

@@ -55,6 +55,7 @@
         class_name: "Question",
         fields: "question, category",
         near_text: "{ concepts: [\"biology\"] }",
+        tenant: "tenant_name",
         limit: "1"
       )
 

spec/weaviate/schema_spec.rb

@@ -57,6 +57,7 @@
       response = schema.create(
         class_name: "Question",
         description: "Information from a Jeopardy! question",
+        multi_tenant: true,
         properties: [
           {
             dataType: ["text"],
@@ -111,9 +112,30 @@
     end
   end
 
-  xdescribe "#add_property" do
+  describe "#add_property"
+
+  describe "#add_tenants" do
+    let(:response) { OpenStruct.new(success?: true, body: class_fixture) }
+
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:post)
+        .with("schema/Question/tenants")
+        .and_return(response)
+    end
+
+    it "returns the schema" do
+      response = schema.add_tenants(
+        class_name: "Question",
+        tenants: ["tenant1", "tenant2"]
+      )
+      expect(response.dig("class")).to eq("Question")
+    end
   end
 
+  describe "#list_tenants"
+
+  describe "#remove_tenants"
+
   describe "#shards" do
     let(:response) { OpenStruct.new(success?: true, body: shard_fixture) }