Add support for engine list pagination

Author: Brian Stevenson

README.rst

@@ -2,8 +2,6 @@
 Python Client for Swiftype App Search API
 =========================================
 
-**Note: Swiftype App Search is currently in beta**
-
 About
 =====
 

swiftype_app_search/__version__.py

@@ -1,6 +1,6 @@
 __title__ = 'swiftype_app_search'
 __description__ = 'An API client for Swiftype App Search'
 __url__ = 'https://github.com/swiftype/swiftype-app-search-python'
-__version__ = '0.1.2'
+__version__ = '0.1.3'
 __author__ = 'Swiftype'
 __author_email__ = 'eng@swiftype.com'

swiftype_app_search/client.py

@@ -78,13 +78,17 @@ def destroy_documents(self, engine_name, document_ids):
         data = json.dumps(document_ids)
         return self.swiftype_session.request('delete', endpoint, data=data)
 
-    def list_engines(self):
+    def list_engines(self, current=1, size=20):
         """
         Lists engines that the api key has access to.
+
+        :param current: Page of engines
+        :param size: Number of engines to return per page
         :return: List of dictionaries with key value pair corresponding to the
         name of the engine.
         """
-        return self.swiftype_session.request('get', 'engines')
+        data = { 'page': { 'current': current, 'size': size } }
+        return self.swiftype_session.request('get', 'engines', data=data)
 
     def get_engine(self, engine_name):
         """

tests/test_client.py

@@ -78,17 +78,6 @@ def test_destroy_documents(self):
             response = self.client.destroy_documents(self.engine_name, [id])
             self.assertEqual(response, expected_return)
 
-    def test_list_engines(self):
-        expected_return = [
-            { 'name': 'myawesomeengine' }
-        ]
-
-        with requests_mock.Mocker() as m:
-            url = "{}/{}".format(self.client.swiftype_session.base_url, 'engines')
-            m.register_uri('GET', url, json=expected_return, status_code=200)
-            response = self.client.list_engines()
-            self.assertEqual(response, expected_return)
-
     def test_get_engine(self):
         engine_name = 'myawesomeengine'
         expected_return = [