chore: rename recommendation client (#682)

* chore: deprecate RecommendationClient in favor of PersonalizationClient

* chore: update config and tests

* fix: linting

* fix: rename method

Author: DevinCodes

src/Config/PersonalizationConfig.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Config;
+
+final class PersonalizationConfig extends AbstractConfig
+{
+    /**
+     * @param string|null $appId
+     * @param string|null $apiKey
+     * @param string|null $region
+     *
+     * @return PersonalizationConfig
+     */
+    public static function create($appId = null, $apiKey = null, $region = null)
+    {
+        $config = [
+            'appId' => null !== $appId ? $appId : getenv('ALGOLIA_APP_ID'),
+            'apiKey' => null !== $apiKey ? $apiKey : getenv('ALGOLIA_API_KEY'),
+            'region' => null !== $region ? $region : 'us',
+        ];
+
+        return new self($config);
+    }
+
+    public function getRegion()
+    {
+        return $this->config['region'];
+    }
+}

src/Config/RecommendationConfig.php

@@ -2,6 +2,9 @@
 
 namespace Algolia\AlgoliaSearch\Config;
 
+/**
+ * @deprecated Please use Algolia\AlgoliaSearch\Config\PersonalizationConfig instead
+ */
 final class RecommendationConfig extends AbstractConfig
 {
     /**

src/PersonalizationClient.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Algolia\AlgoliaSearch;
+
+use Algolia\AlgoliaSearch\Config\PersonalizationConfig;
+use Algolia\AlgoliaSearch\RequestOptions\RequestOptions;
+use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
+use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
+
+final class PersonalizationClient
+{
+    /**
+     * @var \Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper
+     */
+    private $api;
+
+    /**
+     * @var \Algolia\AlgoliaSearch\Config\PersonalizationConfig
+     */
+    private $config;
+
+    /**
+     * RecommendationClient constructor.
+     */
+    public function __construct(ApiWrapper $api, PersonalizationConfig $config)
+    {
+        $this->api = $api;
+        $this->config = $config;
+    }
+
+    /**
+     * @param string|null $appId
+     * @param string|null $apiKey
+     * @param string|null $region
+     *
+     * @return PersonalizationClient
+     */
+    public static function create($appId = null, $apiKey = null, $region = null)
+    {
+        $config = PersonalizationConfig::create($appId, $apiKey, $region);
+
+        return static::createWithConfig($config);
+    }
+
+    /**
+     * @return PersonalizationClient
+     */
+    public static function createWithConfig(PersonalizationConfig $config)
+    {
+        $config = clone $config;
+
+        if ($hosts = $config->getHosts()) {
+            // If a list of hosts was passed, we ignore the cache
+            $clusterHosts = ClusterHosts::create($hosts);
+        } else {
+            $clusterHosts = ClusterHosts::createForRecommendation($config->getRegion());
+        }
+
+        $apiWrapper = new ApiWrapper(
+            Algolia::getHttpClient(),
+            $config,
+            $clusterHosts
+        );
+
+        return new self($apiWrapper, $config);
+    }
+
+    /**
+     * @param array<string, int|string|array>|RequestOptions $requestOptions
+     *
+     * @return array<string, int|array>
+     */
+    public function getPersonalizationStrategy($requestOptions = [])
+    {
+        return $this->api->read('GET', api_path('/1/strategies/personalization'), $requestOptions);
+    }
+
+    /**
+     * @param array<string, int|array>                       $strategy
+     * @param array<string, int|string|array>|RequestOptions $requestOptions
+     *
+     * @return array<string, int|string>
+     */
+    public function setPersonalizationStrategy($strategy, $requestOptions = [])
+    {
+        return $this->api->write('POST', api_path('/1/strategies/personalization'), $strategy, $requestOptions);
+    }
+}

src/RecommendationClient.php

@@ -7,6 +7,9 @@
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
 use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
 
+/**
+ * @deprecated Please use Algolia\AlgoliaSearch\PersonalizationClient instead
+ */
 final class RecommendationClient
 {
     /**

src/SearchClient.php

@@ -265,7 +265,7 @@ public static function generateSecuredApiKey($parentApiKey, $restrictions)
 
     /**
      * @deprecated endpoint will be deprecated
-     * @see RecommendationClient
+     * @see PersonalizationClient
      */
     public function getPersonalizationStrategy($requestOptions = [])
     {
@@ -274,7 +274,7 @@ public function getPersonalizationStrategy($requestOptions = [])
 
     /**
      * @deprecated endpoint will be deprecated
-     * @see RecommendationClient
+     * @see PersonalizationClient
      */
     public function setPersonalizationStrategy($strategy, $requestOptions = [])
     {

tests/Integration/PersonalizationClientTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Tests\Integration;
+
+use Algolia\AlgoliaSearch\PersonalizationClient;
+
+class PersonalizationClientTest extends BaseTest
+{
+    public function testPersonalizationClient()
+    {
+        $personalizationClient = PersonalizationClient::create(
+            getenv('ALGOLIA_APPLICATION_ID_1'),
+            getenv('ALGOLIA_ADMIN_KEY_1')
+        );
+
+        $strategy = [
+            'eventsScoring' => [
+                ['eventName' => 'Add to cart', 'eventType' => 'conversion', 'score' => 50],
+                ['eventName' => 'Purchase', 'eventType' => 'conversion', 'score' => 100],
+            ],
+            'facetsScoring' => [
+                ['facetName' => 'brand', 'score' => 100],
+                ['facetName' => 'categories', 'score' => 10],
+            ],
+            'personalizationImpact' => 0,
+        ];
+
+        try {
+            $personalizationClient->setPersonalizationStrategy($strategy);
+        } catch (\Exception $e) {
+            $this->assertEquals(429, $e->getCode());
+        }
+
+        $fetchedStrategy = $personalizationClient->getPersonalizationStrategy();
+
+        $this->assertEquals($strategy, $fetchedStrategy);
+    }
+}