Additional endpoints

Author: andreibondarev

README.md

@@ -187,6 +187,17 @@ client.query.aggs(
 )
 ```
 
+#### Nodes
+```ruby
+client.nodes
+```
+
+#### Health
+```ruby
+client.live?
+client.ready?
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

lib/weaviate.rb

@@ -11,6 +11,8 @@ module Weaviate
   autoload :Objects, "weaviate/objects"
   autoload :OIDC, "weaviate/oidc"
   autoload :Query, "weaviate/query"
+  autoload :Nodes, "weaviate/nodes"
+  autoload :Health, "weaviate/health"
 
   module Response
     autoload :Base, "weaviate/response/base"

lib/weaviate/client.rb

@@ -44,6 +44,21 @@ def meta
       @meta.get
     end
 
+    def nodes
+      @nodes ||= Weaviate::Nodes.new(client: self)
+      @nodes.list
+    end
+
+    def live?
+      @health ||= Weaviate::Health.new(client: self)
+      @health.live?
+    end
+
+    def ready?
+      @health ||= Weaviate::Health.new(client: self)
+      @health.ready?
+    end
+
     def objects
       @objects ||= Weaviate::Objects.new(client: self)
     end

lib/weaviate/health.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Health < Base
+    PATH = ".well-known"
+
+    def live?
+      response = client.connection.get("#{PATH}/live")
+      response.status == 200
+    end
+
+    def ready?
+      response = client.connection.get("#{PATH}/ready")
+      response.status == 200
+    end
+  end
+end

lib/weaviate/nodes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Nodes < Base
+    PATH = "nodes"
+
+    def list
+      response = client.connection.get(PATH)
+      response.body
+    end
+  end
+end

lib/weaviate/objects.rb

@@ -40,8 +40,11 @@ def create(
         req.body["id"] = id unless id.nil?
         req.body["vector"] = vector unless vector.nil?
       end
+
       if response.success?
         Weaviate::Response::Object.new(response.body)
+      else
+        response.body
       end
     end
 

spec/fixtures/nodes.json

@@ -0,0 +1,21 @@
+{
+  "nodes": [
+    {
+      "gitHash": "00c9d31",
+      "name": "weaviate-0",
+      "shards": [
+        {
+          "class": "Question",
+          "name": "G1SJoaYlFnm4",
+          "objectCount": 10
+        }
+      ],
+      "stats": {
+        "objectCount": 10,
+        "shardCount": 1
+      },
+      "status": "HEALTHY",
+      "version": "1.18.1"
+    }
+  ]
+}

spec/weaviate/health_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Weaviate::Health do
+  let(:client) {
+    Weaviate::Client.new(
+      scheme: "http",
+      host: "localhost:8080"
+    )
+  }
+
+  let(:response) {
+    OpenStruct.new(status: 200)
+  }
+
+  describe "#live" do
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:get)
+        .with(".well-known/live")
+        .and_return(response)
+    end
+
+    it "return 200" do
+      expect(client.live?).to eq(true)
+    end
+  end
+
+  describe "#ready" do
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:get)
+        .with(".well-known/ready")
+        .and_return(response)
+    end
+
+    it "return 200" do
+      expect(client.ready?).to eq(true)
+    end
+  end
+end

spec/weaviate/nodes_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Weaviate::Nodes do
+  let(:client) {
+    Weaviate::Client.new(
+      scheme: "http",
+      host: "localhost:8080"
+    )
+  }
+
+  let(:nodes_fixture) { JSON.parse(File.read("spec/fixtures/nodes.json")) }
+
+  describe "#list" do
+    let(:response) {
+      OpenStruct.new(body: nodes_fixture)
+    }
+
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:get)
+        .with("nodes")
+        .and_return(response)
+    end
+
+    it "return the nodes info" do
+      expect(client.nodes).to be_a(Hash)
+    end
+  end
+end