Added Debug, Metrics and Health endpoints

Author: jasonbosco

examples/info_operations.php

@@ -0,0 +1,30 @@
+<?php
+
+/** @noinspection ForgottenDebugOutputInspection */
+
+include '../vendor/autoload.php';
+
+use Typesense\Client;
+
+try {
+    $client = new Client(
+        [
+            'api_key' => 'xyz',
+            'nodes' => [
+                [
+                    'host' => 'localhost',
+                    'port' => '8108',
+                    'protocol' => 'http',
+                ],
+            ],
+            'connection_timeout_seconds' => 2,
+        ]
+    );
+    echo '<pre>';
+
+    print_r($client->debug->retrieve());
+    print_r($client->metrics->retrieve());
+    print_r($client->health->retrieve());
+} catch (Exception $e) {
+    echo $e->getMessage();
+}

src/Alias.php

@@ -4,7 +4,6 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Typesense\Exceptions\TypesenseClientError;
-use Typesense\Lib\Configuration;
 
 /**
  * Class Alias

src/Aliases.php

@@ -4,7 +4,6 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Typesense\Exceptions\TypesenseClientError;
-use Typesense\Lib\Configuration;
 
 /**
  * Class Aliases

src/Client.php

@@ -35,6 +35,21 @@ class Client
      */
     public Keys $keys;
 
+    /**
+     * @var Debug
+     */
+    public Debug $debug;
+
+    /**
+     * @var Metrics
+     */
+    public Metrics $metrics;
+
+    /**
+     * @var Health
+     */
+    public Health $health;
+
     /**
      * @var ApiCall
      */
@@ -55,6 +70,9 @@ public function __construct(array $config)
         $this->collections = new Collections($this->apiCall);
         $this->aliases     = new Aliases($this->apiCall);
         $this->keys        = new Keys($this->apiCall);
+        $this->debug       = new Debug($this->apiCall);
+        $this->metrics     = new Metrics($this->apiCall);
+        $this->health      = new Health($this->apiCall);
     }
 
     /**
@@ -80,4 +98,28 @@ public function getKeys(): Keys
     {
         return $this->keys;
     }
+
+    /**
+     * @return Debug
+     */
+    public function getDebug(): Debug
+    {
+        return $this->debug;
+    }
+
+    /**
+     * @return Metrics
+     */
+    public function getMetrics(): Metrics
+    {
+        return $this->metrics;
+    }
+
+    /**
+     * @return Health
+     */
+    public function getHealth(): Health
+    {
+        return $this->health;
+    }
 }

src/Collection.php

@@ -4,7 +4,6 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Typesense\Exceptions\TypesenseClientError;
-use Typesense\Lib\Configuration;
 
 /**
  * Class Collection

src/Collections.php

@@ -4,7 +4,6 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Typesense\Exceptions\TypesenseClientError;
-use Typesense\Lib\Configuration;
 
 /**
  * Class Collections

src/Debug.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Typesense;
+
+use GuzzleHttp\Exception\GuzzleException;
+use Typesense\Exceptions\TypesenseClientError;
+
+/**
+ * Class Debug
+ *
+ * @package \Typesense
+ * @date    10/12/20
+ */
+class Debug
+{
+    public const RESOURCE_PATH = '/debug';
+
+    /**
+     * @var ApiCall
+     */
+    private ApiCall $apiCall;
+
+    /**
+     * Alias constructor.
+     *
+     * @param ApiCall $apiCall
+     */
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    /**
+     * @return array
+     * @throws TypesenseClientError|GuzzleException
+     */
+    public function retrieve(): array
+    {
+        return $this->apiCall->get(Debug::RESOURCE_PATH, []);
+    }
+}

src/Document.php

@@ -4,7 +4,6 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Typesense\Exceptions\TypesenseClientError;
-use Typesense\Lib\Configuration;
 
 /**
  * Class Document

src/Documents.php

@@ -4,7 +4,6 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Typesense\Exceptions\TypesenseClientError;
-use Typesense\Lib\Configuration;
 
 /**
  * Class Documents

src/Health.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Typesense;
+
+use GuzzleHttp\Exception\GuzzleException;
+use Typesense\Exceptions\TypesenseClientError;
+
+/**
+ * Class Health
+ *
+ * @package \Typesense
+ * @date    10/12/20
+ */
+class Health
+{
+    public const RESOURCE_PATH = '/health';
+
+    /**
+     * @var ApiCall
+     */
+    private ApiCall $apiCall;
+
+    /**
+     * Alias constructor.
+     *
+     * @param ApiCall $apiCall
+     */
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    /**
+     * @return array
+     * @throws TypesenseClientError|GuzzleException
+     */
+    public function retrieve(): array
+    {
+        return $this->apiCall->get(Health::RESOURCE_PATH, []);
+    }
+}