Add Stopwords API

Author: phiamo

docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.5'
 
 services:
     typesense:
-        image: typesense/typesense:0.21.0.rc20
+        image: typesense/typesense:26.0
         environment:
             TYPESENSE_DATA_DIR: /data
             TYPESENSE_API_KEY: xyz

src/ApiCall.php

@@ -233,7 +233,7 @@ private function makeRequest(string $method, string $endPoint, bool $asJson, arr
 
                 if (!(200 <= $statusCode && $statusCode < 300)) {
                     $errorMessage = json_decode($response->getBody()
-                            ->getContents(), true, 512, JSON_THROW_ON_ERROR)['message'] ?? 'API error.';
+                        ->getContents(), true, 512, JSON_THROW_ON_ERROR)['message'] ?? 'API error.';
                     throw $this->getException($statusCode)
                         ->setMessage($errorMessage);
                 }
@@ -244,7 +244,7 @@ private function makeRequest(string $method, string $endPoint, bool $asJson, arr
             } catch (HttpException $exception) {
                 if (
                     $exception->getResponse()
-                        ->getStatusCode() === 408
+                    ->getStatusCode() === 408
                 ) {
                     continue;
                 }

src/Client.php

@@ -24,6 +24,11 @@ class Client
      */
     public Collections $collections;
 
+    /**
+     * @var Stopwords
+     */
+    public Stopwords $stopwords;
+
     /**
      * @var Aliases
      */
@@ -87,6 +92,7 @@ public function __construct(array $config)
         $this->apiCall = new ApiCall($this->config);
 
         $this->collections = new Collections($this->apiCall);
+        $this->stopwords = new Stopwords($this->apiCall);
         $this->aliases     = new Aliases($this->apiCall);
         $this->keys        = new Keys($this->apiCall);
         $this->debug       = new Debug($this->apiCall);
@@ -106,6 +112,14 @@ public function getCollections(): Collections
         return $this->collections;
     }
 
+    /**
+     * @return Stopwords
+     */
+    public function getStopwords(): Stopwords
+    {
+        return $this->stopwords;
+    }
+
     /**
      * @return Aliases
      */

src/Stopwords.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace Typesense;
+
+use Http\Client\Exception as HttpClientException;
+use Typesense\Exceptions\TypesenseClientError;
+
+/**
+ * Class Document
+ *
+ * @package \Typesense
+ * @date    4/5/20
+ * @author  Abdullah Al-Faqeir <abdullah@devloops.net>
+ */
+class Stopwords
+{
+    /**
+     * @var ApiCall
+     */
+    private $apiCall;
+
+    public const STOPWORDS_PATH = '/stopwords';
+
+    /**
+     * Document constructor.
+     *
+     * @param ApiCall $apiCall
+     */
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    /**
+     * @return array|string
+     * @throws HttpClientException
+     * @throws TypesenseClientError
+     */
+    public function get(string $stopwordsName)
+    {
+        return $this->apiCall->get(
+            $this->endpointPath($stopwordsName),
+            []
+        );
+    }
+    /**
+     * @return array|string
+     * @throws HttpClientException
+     * @throws TypesenseClientError
+     */
+    public function getAll()
+    {
+        return $this->apiCall->get(static::STOPWORDS_PATH, []);
+    }
+
+    /**
+     * @param array $options
+     *
+     * @return array
+     * @throws HttpClientException
+     * @throws TypesenseClientError
+     */
+    public function put(array $options = [])
+    {
+        $stopwordsName = $options['stopwords_name'];
+        $stopwordsData = $options['stopwords_data'];
+        return $this->apiCall->put(
+            $this->endpointPath($stopwordsName),
+            ['stopwords' => $stopwordsData]
+        );
+    }
+
+    /**
+     * @param $presetName
+     * @return array
+     * @throws HttpClientException
+     * @throws TypesenseClientError
+     */
+    public function delete($presetName)
+    {
+        return $this->apiCall->delete(
+            $this->endpointPath($presetName)
+        );
+    }
+
+    /**
+     * @param $stopwordsName
+     * @return string
+     */
+    private function endpointPath($stopwordsName)
+    {
+        return sprintf(
+            '%s/%s',
+            static::STOPWORDS_PATH,
+            $stopwordsName
+        );
+    }
+}