Merge pull request #69 from algolia/add-synonyms-api

add synonyms api

Author: maxiloc

README.md

@@ -113,6 +113,39 @@ You can propagate (save) the settings to algolia using the `setSetting` method:
 Contact::setSettings();
 ```
 
+#### Synonyms
+
+Synonyms are used to tell the engine about words or expressions that should be considered equal in regard to the textual relevance.
+
+Our [synonyms API](https://www.algolia.com/doc/relevance/synonyms) has been designed to manage as easily as possible a large set of synonyms for an index and its slaves.
+
+You can use the synonyms API by adding a `synonyms` in `$algoliaSettings` class property like this:
+
+```php
+use Illuminate\Database\Eloquent\Model;
+
+class Contact extends Model
+{
+    use AlgoliaEloquentTrait;
+
+    public $algoliaSettings = [
+        'synonyms' => [
+            [
+                'objectID' => 'red-color',
+                'type'     => 'synonym',
+                'synonyms' => ['red', 'another red', 'yet another red']
+            ]
+        ]
+    ];
+}
+```
+
+You can propagate (save) the settings to algolia using the `setSetting` method:
+
+```php
+Contact::setSettings();
+```
+
 ## Frontend Search (realtime experience)
 
 Traditional search implementations tend to have search logic and functionality on the backend. This made sense when the search experience consisted of a user entering a search query, executing that search, and then being redirected to a search result page.

src/AlgoliaEloquentTrait.php

@@ -170,6 +170,10 @@ public function _setSettings($setToTmpIndices = false)
                 }, $settings['slaves']);
             }
 
+            if (isset($settings['synonyms'])) {
+                $index->batchSynonyms($settings['synonyms'], true, true);
+            }
+
             if (count(array_keys($settings)) > 0) {
                 $index->setSettings($settings);
             }

tests/AlgoliaEloquentTraitTest.php

@@ -5,6 +5,7 @@
 use AlgoliaSearch\Tests\Models\Model2;
 use AlgoliaSearch\Tests\Models\Model4;
 use AlgoliaSearch\Tests\Models\Model6;
+use AlgoliaSearch\Tests\Models\Model10;
 use Illuminate\Support\Facades\App;
 use Mockery;
 use Orchestra\Testbench\TestCase;
@@ -86,6 +87,38 @@ public function testSetSettings()
         $model6->setSettings();
     }
 
+    public function testSetSynonyms()
+    {
+        $index = Mockery::mock('\AlgoliaSearch\Index');
+        $index->shouldReceive('batchSynonyms')->with(
+            [
+                [
+                    'objectID' => 'red-color',
+                    'type'     => 'synonym',
+                    'synonyms' => [
+                        'red',
+                        'really red',
+                        'much red'
+                    ]
+                ]
+            ],
+            true,
+            true
+        );
+        $index->shouldReceive('setSettings');
+
+        /** @var \AlgoliaSearch\Laravel\ModelHelper $realModelHelper */
+        $realModelHelper = App::make('\AlgoliaSearch\Laravel\ModelHelper');
+        $modelHelper = Mockery::mock('\AlgoliaSearch\Laravel\ModelHelper');
+        App::instance('\AlgoliaSearch\Laravel\ModelHelper', $modelHelper);
+        $model10 = new Model10();
+        $modelHelper->shouldReceive('getSettings')->andReturn($realModelHelper->getSettings($model10));
+        $modelHelper->shouldReceive('getIndices')->andReturn([$index]);
+        $modelHelper->shouldReceive('getSlavesSettings')->andReturn($realModelHelper->getSlavesSettings($model10));
+
+        $this->assertEquals(null, $model10->setSettings());
+    }
+
     public function tearDown()
     {
         Mockery::close();

tests/Models/Model10.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace AlgoliaSearch\Tests\Models;
+use AlgoliaSearch\Laravel\AlgoliaEloquentTrait;
+use Illuminate\Database\Eloquent\Model;
+
+class Model10 extends Model
+{
+    use AlgoliaEloquentTrait;
+    public $algoliaSettings = [
+        'synonyms' => [
+            [
+                'objectID' => 'red-color',
+                'type'     => 'synonym',
+                'synonyms' => [
+                    'red',
+                    'really red',
+                    'much red'
+                ]
+            ]
+        ]
+    ];
+}