Added support for listing documents

Author: JasonStoltz

README.md

@@ -102,6 +102,24 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 [{'id': 'INscMGmhmX4','url': 'https://www.youtube.com/watch?v=INscMGmhmX4','title': 'The Original Grumpy Cat','body': 'A wonderful video of a magnificent cat.'}]
 ```
 
+### List Documents
+```python
+>>> engine_name = 'favorite-videos'
+>>> client.list_documents(engine_name, current=1, size=20)
+{
+    'meta': {
+        'page': {
+        'current': 1,
+        'total_pages': 1,
+        'total_results': 2,
+        'size': 20
+        }
+    },
+    'results': [{'id': 'INscMGmhmX4','url': 'https://www.youtube.com/watch?v=INscMGmhmX4','title': 'The Original Grumpy Cat','body': 'A wonderful video of a magnificent cat.'}]
+}
+```
+
+
 ### Destroy Documents
 
 ```python

swiftype_app_search/client.py

@@ -35,6 +35,17 @@ def get_documents(self, engine_name, document_ids):
         data = json.dumps(document_ids)
         return self.swiftype_session.request('get', endpoint, data=data)
 
+    def list_documents(self, engine_name, current=1, size=20):
+        """
+        Lists all documents in engine.
+
+        :param current: Page of documents
+        :param size: Number of documents to return per page
+        :return: List of documemts.
+        """
+        data = { 'page': { 'current': current, 'size': size } }
+        return self.swiftype_session.request('get', "engines/{}/documents/list".format(engine_name), json=data)
+
     def index_document(self, engine_name, document):
         """
         Create or update a document for an engine. Raises

tests/test_client.py

@@ -87,6 +87,29 @@ def test_get_documents(self):
             response = self.client.get_documents(self.engine_name, [id])
             self.assertEqual(response, expected_return)
 
+    def test_list_documents(self):
+        expected_return = {
+            'meta': {
+                'page': {'current': 1, 'total_results': 1, 'total_pages': 1, 'size': 20},
+                'results': [
+                    {'body': 'this is a test', 'id': '1'},
+                    {'body': 'this is also a test', 'id': '2'}
+                ]
+            }
+        }
+
+        with requests_mock.Mocker() as m:
+            url = "{}/engines/{}/documents/list".format(self.client.swiftype_session.base_url, self.engine_name)
+            m.register_uri('GET',
+                url,
+                additional_matcher=lambda x: x.text == '{"page": {"current": 1, "size": 20}}',
+                json=expected_return,
+                status_code=200
+            )
+
+            response = self.client.list_documents(self.engine_name)
+            self.assertEqual(response, expected_return)
+
     def test_destroy_documents(self):
         id = 'INscMGmhmX4'
         expected_return = [