Support for api_key authentication

Author: andreibondarev

README.md

@@ -22,6 +22,7 @@ require 'weaviate'
 client = Weaviate::Client.new(
     scheme: 'https',
     host: 'some-endpoint.weaviate.network',  # Replace with your endpoint
+    api_key: '', # Weaviate API key
     model_service: :openai, # Service that will be used to generate vectors. Possible values: :openai, :cohere, :huggingface
     model_service_api_key: 'xxxxxxx' # Either OpenAI, Cohere or Hugging Face API key
 )

bin/console

@@ -12,8 +12,9 @@ require "weaviate"
 # Pry.start
 
 client = Weaviate::Client.new(
-  scheme: "https",
+  scheme: "http",
   host: ENV["WEAVIATE_HOST"],
+  api_key: ENV["WEAVIATE_API_KEY"],
   model_service: :openai,
   model_service_api_key: ENV["MODEL_SERVICE_API_KEY"]
 )

lib/weaviate/client.rb

@@ -5,7 +5,7 @@
 
 module Weaviate
   class Client
-    attr_reader :scheme, :host, :model_service, :model_service_api_key, :adapter
+    attr_reader :scheme, :host, :api_key, :model_service, :model_service_api_key, :adapter
 
     API_VERSION = "v1"
 
@@ -18,6 +18,7 @@ class Client
     def initialize(
       scheme:,
       host:,
+      api_key: nil,
       model_service: nil,
       model_service_api_key: nil,
       adapter: Faraday.default_adapter
@@ -26,6 +27,7 @@ def initialize(
 
       @scheme = scheme
       @host = host
+      @api_key = api_key
       @model_service = model_service
       @model_service_api_key = model_service_api_key
       @adapter = adapter
@@ -93,6 +95,9 @@ def graphql
 
     def connection
       @connection ||= Faraday.new(url: "#{scheme}://#{host}/#{API_VERSION}/") do |faraday|
+        if api_key
+          faraday.request :authorization, :Bearer, api_key
+        end
         faraday.request :json
         faraday.response :json, content_type: /\bjson$/
         faraday.adapter adapter

spec/weaviate/client_spec.rb

@@ -53,6 +53,46 @@
     end
   end
 
+  describe "#ready?" do
+    let(:response) { OpenStruct.new(status: 200) }
+
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:get)
+        .with(".well-known/ready")
+        .and_return(response)
+    end
+
+    it "returns a query client" do
+      expect(client.ready?).to eq(true)
+    end
+  end
+
+  describe "#live?" do
+    let(:response) { OpenStruct.new(status: 200) }
+
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:get)
+        .with(".well-known/live")
+        .and_return(response)
+    end
+
+    it "returns a query client" do
+      expect(client.live?).to eq(true)
+    end
+  end
+
+  describe "#classifications" do
+    it "returns a classifications client" do
+      expect(client.classifications).to be_a(Weaviate::Classifications)
+    end
+  end
+
+  describe "#backups" do
+    it "returns a backups client" do
+      expect(client.backups).to be_a(Weaviate::Backups)
+    end
+  end
+
   describe "#oidc" do
     let(:fixture) { JSON.parse(File.read("spec/fixtures/oidc.json")) }
     let(:response) { OpenStruct.new(body: fixture) }