Remove check for id in document, allow api to autogenerate id

Author: christopherjwang

swiftype_app_search/client.py

@@ -36,8 +36,7 @@ def index_document(self, engine_name, document):
         """
         Create or update a document for an engine. Raises
         :class:`~swiftype_app_search.exceptions.InvalidDocument` when the document
-        is missing required fields, contains unsupported fields, or has
-        processing errors
+        has processing errors
 
         :param engine_name: Name of engine to index documents into.
         :param document: Hash representing a single document.
@@ -56,34 +55,18 @@ def index_document(self, engine_name, document):
 
     def index_documents(self, engine_name, documents):
         """
-        Create or update documents for an engine. Raises
-        :class:`~swiftype_app_search.exceptions.InvalidDocument` when the document
-        is missing required fields or contains unsupported fields
+        Create or update documents for an engine.
 
         :param engine_name: Name of engine to index documents into.
         :param documents: Hashes representing documents.
         :return: Array of document status dictionaries. Errors will be present
         in a document status with a key of `errors`.
         """
-        self._raise_if_documents_invalid(documents)
-
         endpoint = "engines/{}/documents".format(engine_name)
         data = json.dumps(documents)
 
         return self.swiftype_session.request('post', endpoint, data=data)
 
-    def _raise_if_documents_invalid(self, documents):
-        for document in documents:
-            missing_required_keys = set(self.REQUIRED_DOCUMENT_TOP_LEVEL_KEYS) -\
-                                    set(document.keys())
-            if len(missing_required_keys):
-                raise InvalidDocument(
-                    "Missing required fields: {}".format(
-                        ','.join(missing_required_keys)),
-                    document
-                )
-
-
     def destroy_documents(self, engine_name, document_ids):
         """
         Destroys documents by id for an engine.

tests/test_client.py

@@ -4,6 +4,7 @@
 from swiftype_app_search import Client
 from swiftype_app_search.exceptions import InvalidDocument
 
+
 class TestClient(TestCase):
 
     def setUp(self):
@@ -15,13 +16,6 @@ def setUp(self):
             "engines/{}/documents".format(self.engine_name)
         )
 
-    def test_index_document_validation(self):
-        invalid_document = {'does': 'not have the id field'}
-        with self.assertRaises(InvalidDocument) as context:
-            self.client.index_documents(self.engine_name, [invalid_document])
-        self.assertEqual(str(context.exception), 'Missing required fields: id')
-        self.assertEqual(context.exception.document, invalid_document)
-
     def test_index_document_processing_error(self):
         invalid_document = {'id': 'something', 'bad': {'no': 'nested'}}
         error = 'some processing error'
@@ -33,27 +27,28 @@ def test_index_document_processing_error(self):
                 self.client.index_document(self.engine_name, invalid_document)
                 self.assertEqual(str(context.exception), error)
 
-    def test_index_documents_validation(self):
-        invalid_documents = [
-            {
-                'does': 'not have the id field'
-            }
-        ]
-        with self.assertRaises(InvalidDocument) as context:
-            self.client.index_documents(self.engine_name, invalid_documents)
-        self.assertEqual(str(context.exception), 'Missing required fields: id')
-        self.assertEqual(context.exception.document, invalid_documents[0])
+    def test_index_document_no_error_key_in_response(self):
+        document_without_id = {'body': 'some value'}
+        stubbed_return = [{'id': 'auto generated', 'errors': []}]
+
+        with requests_mock.Mocker() as m:
+            m.register_uri('POST', self.document_index_url, json=stubbed_return, status_code=200)
+            response = self.client.index_document(self.engine_name, document_without_id)
+            self.assertEqual(response, {'id': 'auto generated'})
 
     def test_index_documents(self):
         id = 'INscMGmhmX4'
         valid_document = {'id': id}
+        other_document = { 'body': 'some value' }
+
         expected_return = [
-            {'id': id, 'errors': []}
+            {'id': id, 'errors': []},
+            {'id': 'some autogenerated id', 'errors': []}
         ]
 
         with requests_mock.Mocker() as m:
             m.register_uri('POST', self.document_index_url, json=expected_return, status_code=200)
-            response = self.client.index_documents(self.engine_name, [valid_document])
+            response = self.client.index_documents(self.engine_name, [valid_document, other_document])
             self.assertEqual(response, expected_return)
 
     def test_get_documents(self):