Fix: exists method (#582)

* fix(index): add requestOptions to exist method

* fix(exists-method): add unit tests

Author: chloelbn

src/SearchIndex.php

@@ -624,10 +624,17 @@ public function delete($requestOptions = array())
         return new IndexingResponse($response, $this);
     }
 
-    public function exists()
+    /**
+     * Check whether an index exists or not.
+     *
+     * @param array<string, int|string|array>|RequestOptions $requestOptions array of options or RequestOptions object
+     *
+     * @return bool
+     */
+    public function exists($requestOptions = array())
     {
         try {
-            $this->getSettings();
+            $this->getSettings($requestOptions);
         } catch (NotFoundException $exception) {
             return false;
         }

tests/Integration/ExistsTest.php

@@ -15,9 +15,33 @@ protected function setUp()
         }
     }
 
+    public function testIndexDoesNotExist()
+    {
+        $index = static::getClient()->initIndex(static::$indexes['main']);
+
+        self::assertFalse($index->exists());
+    }
+
+    public function testIndexExists()
+    {
+        $index = static::getClient()->initIndex(static::$indexes['main']);
+
+        $index
+            ->saveObject(
+                array(
+                    'firstname' => 'Jimmie',
+                ),
+                array('autoGenerateObjectIDIfNotExist' => true)
+            )
+            ->wait();
+
+        self::assertTrue($index->exists());
+    }
+
     public function testFindObject()
     {
         $index = static::getClient()->initIndex(static::$indexes['main']);
+        $index->clearObjects();
         $index->saveObjects($this->companies);
 
         $res = $index->search('Algolia');

tests/Integration/SearchIndexTest.php

@@ -10,11 +10,20 @@
 
 class SearchIndexTest extends TestCase
 {
-    public function testFindObject()
+    /** @var SearchConfig */
+    protected $config;
+
+    /** @var RequestOptionsFactory */
+    protected $requestOptionsFactory;
+
+    public function setUp()
     {
-        $config = SearchConfig::create('foo', 'bar');
-        $requestOptionsFactory = new RequestOptionsFactory($config);
+        $this->config = SearchConfig::create('foo', 'bar');
+        $this->requestOptionsFactory = new RequestOptionsFactory($this->config);
+    }
 
+    public function testFindObject()
+    {
         // Test without requestOptions
         $apiWrapperMock = $this->getMock('Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface');
         $apiWrapperMock->method('read')
@@ -29,7 +38,7 @@ public function testFindObject()
                 'nbPages' => 1,
             ));
 
-        $client = new SearchClient($apiWrapperMock, $config);
+        $client = new SearchClient($apiWrapperMock, $this->config);
         $client->initIndex('foo')->findObject(
             function () { return true; }
         );
@@ -48,7 +57,7 @@ function () { return true; }
                 'nbPages' => 1,
             ));
 
-        $client = new SearchClient($apiWrapperMock, $config);
+        $client = new SearchClient($apiWrapperMock, $this->config);
         $client->initIndex('foo')->findObject(
             function () { return true; },
             array('query' => 'foo', 'hitsPerPage' => 5)
@@ -69,10 +78,50 @@ function () { return true; },
                 'nbPages' => 1,
             ));
 
-        $client = new SearchClient($apiWrapperMock, $config);
+        $client = new SearchClient($apiWrapperMock, $this->config);
         $client->initIndex('foo')->findObject(
             function () { return true; },
-            $requestOptionsFactory->create(array('User-Agent' => 'blabla'))
+            $this->requestOptionsFactory->create(array('User-Agent' => 'blabla'))
         );
     }
+
+    public function testExistsWithRequestOptions()
+    {
+        $requestOptions = $this->requestOptionsFactory->create(array('X-Algolia-User-ID' => 'foo'));
+        $apiWrapperMock = $this->getMock('Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface');
+
+        $apiWrapperMock->method('read')
+            ->with($this->anything(), $this->anything(), $this->callback(function ($requestOptions) {
+                Assert::assertInstanceOf('Algolia\AlgoliaSearch\RequestOptions\RequestOptions', $requestOptions);
+                Assert::assertArraySubset(array('X-Algolia-User-ID' => 'foo'), $requestOptions->getHeaders());
+
+                return $requestOptions;
+            }))
+            ->willReturn(array(
+                'hitsPerPage' => 31,
+                'userData' => 'API SearchClient copy test',
+            ));
+        $client = new SearchClient($apiWrapperMock, $this->config);
+        $client->initIndex('foo')->exists($requestOptions);
+    }
+
+    public function testExistsWithoutRequestOptions()
+    {
+        $apiWrapperMock = $this->getMock('Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface');
+
+        // getVersion is added by default in requestOptions
+        $apiWrapperMock->method('read')
+            ->with($this->anything(), $this->anything(), $this->callback(function ($requestOptions) {
+                Assert::assertInternalType('array', $requestOptions);
+                Assert::assertArraySubset(array('getVersion' => 2), $requestOptions);
+
+                return $requestOptions;
+            }))
+            ->willReturn(array(
+                'hitsPerPage' => 31,
+                'userData' => 'API SearchClient copy test',
+            ));
+        $client = new SearchClient($apiWrapperMock, $this->config);
+        $client->initIndex('foo')->exists();
+    }
 }