added(index): implements exists method

Added a method to check if index exists

algoliasearch/search_index.py

@@ -7,7 +7,7 @@
 from typing import Optional, List, Union, Iterator
 
 from algoliasearch.configs import SearchConfig
-from algoliasearch.exceptions import MissingObjectIdException
+from algoliasearch.exceptions import RequestException, MissingObjectIdException
 from algoliasearch.helpers import (
     assert_object_id,
     build_raw_response_batch,
@@ -45,6 +45,15 @@ def __init__(self, transporter, config, name):
         self._config = config
         self._name = name
 
+    def exists(self):
+        try:
+            self.get_settings()
+        except RequestException as e:
+            if (e.status_code == 404):
+                return False
+            raise e
+        return True
+
     def save_object(self, obj, request_options=None):
         # type: (dict, Optional[Union[dict, RequestOptions]]) -> IndexingResponse # noqa: E501
 

tests/unit/test_search_index.py

@@ -2,7 +2,7 @@
 
 import mock
 
-from algoliasearch.exceptions import MissingObjectIdException
+from algoliasearch.exceptions import RequestException, MissingObjectIdException
 from algoliasearch.http.request_options import RequestOptions
 from algoliasearch.responses import Response
 from algoliasearch.search_index import SearchIndex
@@ -29,6 +29,24 @@ def test_app_id_getter(self):
     def test_name_getter(self):
         self.assertEqual(self.index.name, 'index-name')
 
+    def test_index_does_not_exist(self):
+        with mock.patch.object(self.index, 'get_settings') as submethod_mock:
+            submethod_mock.side_effect = RequestException("Index does not exist", 404)
+
+            indexExists = self.index.exists()
+
+            self.index.get_settings.assert_called_once()
+            self.assertEqual(indexExists, False);
+
+    def test_index_exists(self):
+        with mock.patch.object(self.index, 'get_settings') as submethod_mock:
+            submethod_mock.return_value = {'hitsPerPage': 20, 'maxValuesPerFacet': 100}
+
+            indexExists = self.index.exists()
+
+            self.index.get_settings.assert_called_once()
+            self.assertEqual(indexExists, True);
+
     def test_save_objects(self):
         # Saving an object without object id
         with self.assertRaises(MissingObjectIdException) as _: