Client methods to get and update schema for an engine (#23)

Add client methods to get and create/update engine schema

Author: CorrosiveKid

README.md

@@ -145,6 +145,26 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 [{'id': 'INscMGmhmX4','result': True}]
 ```
 
+### Get Schema
+
+```python
+>>> engine_name = 'favorite-videos'
+>>> client.get_schema(engine_name)
+{'name':'text', 'square_km': 'number', 'square_mi': 'text'}
+```
+
+### Create/Update Schema
+
+```python
+>>> engine_name = 'favorite-videos'
+>>> client.update_schema(engine_name, {'square_km': 'text'})
+{'square_km': 'text'}
+>>> client.update_schema(engine_name, {'square_mi': 'text'})
+{'square_km': 'text', 'square_mi': 'text'}
+>>> client.update_schema(engine_name, {'square_km': 'number'})
+{'square_km': 'number', 'square_mi': 'text'}
+```
+
 ### List Engines
 
 ```python

swiftype_app_search/client.py

@@ -107,6 +107,28 @@ def destroy_documents(self, engine_name, document_ids):
         data = json.dumps(document_ids)
         return self.swiftype_session.request('delete', endpoint, data=data)
 
+    def get_schema(self, engine_name):
+        """
+        Get current schema for an engine.
+
+        :param engine_name: Name of engine.
+        :return: Schema.
+        """
+        endpoint = "engines/{}/schema".format(engine_name)
+        return self.swiftype_session.request('get', endpoint)
+
+    def update_schema(self, engine_name, schema):
+        """
+        Create new schema fields or update the fields if they already exists.
+
+        :param engine_name: Name of engine.
+        :param schema: Schema to be updated as dict.
+        :return: Updated schema.
+        """
+        endpoint = "engines/{}/schema".format(engine_name)
+        data = json.dumps(schema)
+        return self.swiftype_session.request('post', endpoint, data=data)
+
     def list_engines(self, current=1, size=20):
         """
         Lists engines that the api key has access to.

tests/test_client.py

@@ -136,6 +136,39 @@ def test_destroy_documents(self):
             response = self.client.destroy_documents(self.engine_name, [id])
             self.assertEqual(response, expected_return)
 
+    def test_get_schema(self):
+        expected_return = {
+            'square_km': 'text'
+        }
+
+        with requests_mock.Mocker() as m:
+            url = "{}/engines/{}/schema".format(self.client.swiftype_session.base_url, self.engine_name)
+            m.register_uri('GET',
+                url,
+                json=expected_return,
+                status_code=200
+            )
+
+            response = self.client.get_schema(self.engine_name)
+            self.assertEqual(response, expected_return)
+
+    def test_update_schema(self):
+        expected_return = {
+            'square_mi': 'number',
+            'square_km': 'number'
+        }
+
+        with requests_mock.Mocker() as m:
+            url = "{}/engines/{}/schema".format(self.client.swiftype_session.base_url, self.engine_name)
+            m.register_uri('POST',
+                url,
+                json=expected_return,
+                status_code=200
+            )
+
+            response = self.client.update_schema(self.engine_name, expected_return)
+            self.assertEqual(response, expected_return)
+
     def test_list_engines(self):
         expected_return = [
             { 'name': 'myawesomeengine' }