fix(saveObjects-error-msg): refine the error thrown by the method

src/Exceptions/InvalidArgumentObjectsException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Exceptions;
+
+use Throwable;
+
+final class InvalidArgumentObjectsException extends AlgoliaException
+{
+    /**
+     * InvalidArgumentObjectsException constructor.
+     *
+     * @param string    $message  The Exception message to throw
+     * @param int       $code     The Exception code
+     * @param Throwable $previous The previous throwable used for the exception chaining
+     */
+    public function __construct($message = '', $code = 0, $previous = null)
+    {
+        if ('' === $message) {
+            $message = 'Please provide an array of objects instead of a single object.';
+        }
+
+        parent::__construct($message, $code, $previous);
+    }
+}

src/SearchIndex.php

@@ -3,6 +3,7 @@
 namespace Algolia\AlgoliaSearch;
 
 use Algolia\AlgoliaSearch\Config\SearchConfig;
+use Algolia\AlgoliaSearch\Exceptions\InvalidArgumentObjectsException;
 use Algolia\AlgoliaSearch\Exceptions\MissingObjectId;
 use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
 use Algolia\AlgoliaSearch\Exceptions\ObjectNotFoundException;
@@ -311,6 +312,10 @@ protected function splitIntoBatches($action, $objects, $requestOptions = array()
         $count = 0;
 
         foreach ($objects as $object) {
+            if (!Helpers::isIterable($object)) {
+                throw new InvalidArgumentObjectsException();
+            }
+
             $batch[] = $object;
             $count++;
 

src/Support/Helpers.php

@@ -126,4 +126,16 @@ public static function mapObjectIDs($objectIDKey, $objects)
             return $object;
         }, $objects);
     }
+
+    /**
+     * Checks if a variable can be iterated through.
+     *
+     * @param mixed $object
+     *
+     * @return bool
+     */
+    public static function isIterable($object)
+    {
+        return is_array($object) || $object instanceof \Traversable;
+    }
 }

tests/Integration/SearchIndexTest.php

@@ -6,27 +6,27 @@
 
 class SearchIndexTest extends AlgoliaIntegrationTestCase
 {
+    protected $index;
+
     protected function setUp()
     {
         parent::setUp();
 
         if (!isset(static::$indexes['main'])) {
             static::$indexes['main'] = self::safeName('general-index-mgmt');
         }
+
+        $this->index = static::getClient()->initIndex(static::$indexes['main']);
     }
 
     public function testIndexDoesNotExist()
     {
-        $index = static::getClient()->initIndex(static::$indexes['main']);
-
-        self::assertFalse($index->exists());
+        self::assertFalse($this->index->exists());
     }
 
     public function testIndexExists()
     {
-        $index = static::getClient()->initIndex(static::$indexes['main']);
-
-        $index
+        $this->index
             ->saveObject(
                 array(
                     'firstname' => 'Jimmie',
@@ -35,27 +35,26 @@ public function testIndexExists()
             )
             ->wait();
 
-        self::assertTrue($index->exists());
+        self::assertTrue($this->index->exists());
     }
 
     public function testFindObject()
     {
-        $index = static::getClient()->initIndex(static::$indexes['main']);
-        $index->clearObjects();
-        $index->saveObjects($this->companies);
+        $this->index->clearObjects();
+        $this->index->saveObjects($this->companies);
 
-        $res = $index->search('Algolia');
+        $res = $this->index->search('Algolia');
         $this->assertEquals(SearchIndex::getObjectPosition($res, 'nicolas-dessaigne'), 0);
         $this->assertEquals(SearchIndex::getObjectPosition($res, 'julien-lemoine'), 1);
         $this->assertEquals(SearchIndex::getObjectPosition($res, ''), -1);
 
         try {
-            $index->findObject(function () { return false; });
+            $this->index->findObject(function () { return false; });
         } catch (\Exception $e) {
             $this->assertInstanceOf('Algolia\AlgoliaSearch\Exceptions\ObjectNotFoundException', $e);
         }
 
-        $found = $index->findObject(function () { return true; });
+        $found = $this->index->findObject(function () { return true; });
         $this->assertEquals($found['position'], 0);
         $this->assertEquals($found['page'], 0);
 
@@ -64,19 +63,28 @@ public function testFindObject()
         };
 
         try {
-            $index->findObject($callback, array('query' => 'algolia'));
+            $this->index->findObject($callback, array('query' => 'algolia'));
         } catch (\Exception $e) {
             $this->assertInstanceOf('Algolia\AlgoliaSearch\Exceptions\ObjectNotFoundException', $e);
         }
 
         try {
-            $index->findObject($callback, array('query' => '', 'paginate' => false, 'hitsPerPage' => 5));
+            $this->index->findObject($callback, array('query' => '', 'paginate' => false, 'hitsPerPage' => 5));
         } catch (\Exception $e) {
             $this->assertInstanceOf('Algolia\AlgoliaSearch\Exceptions\ObjectNotFoundException', $e);
         }
 
-        $obj = $index->findObject($callback, array('query' => '', 'paginate' => true, 'hitsPerPage' => 5));
+        $obj = $this->index->findObject($callback, array('query' => '', 'paginate' => true, 'hitsPerPage' => 5));
         $this->assertEquals($obj['position'], 0);
         $this->assertEquals($obj['page'], 2);
     }
+
+    public function testSaveObjectsFails()
+    {
+        try {
+            $this->index->saveObjects($this->companies[0]);
+        } catch (\Exception $e) {
+            $this->assertInstanceOf('Algolia\AlgoliaSearch\Exceptions\InvalidArgumentObjectsException', $e);
+        }
+    }
 }