introduced PaginatedResultSet when querying for entities and tests for attributes

Author: Rasmus Lager

ganapi/api.py

@@ -50,11 +50,11 @@ def call(self, method, resource_path, payload=None):
             payload = json.dumps(payload)
 
         if method == 'GET':
-            response = requests.get(uri, headers=self.headers, data=payload)
+            response = requests.get(uri, headers=self.headers)
         elif method == 'POST':
             response = requests.post(uri, headers=self.headers, data=payload)
         elif method == 'DELETE':
-            response = requests.delete(uri, headers=self.headers, data=payload)
+            response = requests.delete(uri, headers=self.headers)
         elif method == 'PUT':
             response = requests.put(uri, headers=self.headers, data=payload)
         elif method == 'PATCH':

ganapi/entity_manager.py

@@ -1,4 +1,5 @@
 import urllib
+from helpers import PaginatedResultSet
 
 
 class EntityManager(object):
@@ -16,12 +17,12 @@ class EntityManager(object):
     """
     base_path = None
     """
-    The class of the entity (e.g. 'Gan\Contact').
+    The class of the entity (e.g. 'Contact').
     :var entity_class string
     """
     entity_class = None
     """
-    List listing all writable fields. It is required by the default normalizeEntity()
+    List listing all writable fields. It is required by the default normalize_entity()
     method that is used to clean up the entity before sending it to the API.
     :var writable_fields list
     """
@@ -40,7 +41,7 @@ def get_path(self, id):
         Method used by the entity manager to construct the resource path.
 
         This method would simply concatenate the lookup id at the end of
-        the base path: presource/<id>/. You may have to override it if you
+        the base path: resource/<id>/. You may have to override it if you
         have an unusual resource path scheme (for example the the subscribers'
         endpoint: lists/<hash>/subscribers/<email>/).
 
@@ -102,7 +103,6 @@ def normalize_entity(self, entity):
         data = {}
         for property in self.writable_fields:
             if getattr(entity, property):
-                # setattr(entity, property, data[property])
                 data[property] = getattr(entity, property)
         return data
 
@@ -170,18 +170,13 @@ def query(self, filters=dict()):
         page and paginate_by which are common.
 
         :param filters dict of query parameters (e.g. {'search_email': 'test@', 'page': 2})
-        :returns array The result array of entities.
+        :returns class PaginatedResultSet which can iterate over pages PaginatedResultSet.entities is the current page array of entities.
         :raises RequestException if there is an error from the API.
         """
         uri = u'{base_path}/?{encoded_filters}'.format(base_path=str.rstrip(self.base_path),
                                                        encoded_filters=urllib.urlencode(filters))
-
         response = self.api.call('GET', uri)
-        result = []
-        for data in response.json().get('results'):
-            result.append(self.construct_entity(data).set_persisted())
-
-        return result
+        return PaginatedResultSet(self, response.json())
 
     def delete(self, entity):
         """

ganapi/helpers.py

@@ -0,0 +1,55 @@
+import urlparse
+
+
+class PaginatedResultSet():
+    """
+        Class to iterate result pages when searching for entities by query.
+
+        :param manager EntityManager of Entity queried.
+        :param data json data to populate class with entities and previous/next
+        :raises
+    """
+    def __init__(self, manager, data):
+        self.manager = manager
+        self.entities = []
+        for result in data.get('results'):
+            self.entities.append(self.manager.construct_entity(result).set_persisted())
+        self.count = data.get('count')
+        self.next_link = data.get('next')
+        self.previous_link = data.get('previous')
+
+    def __iter__(self):
+        return self
+
+    def url_params_to_dict(self, url):
+        """
+        :param url: url to get parameters from
+        :return: parsed parameters as dict
+        """
+        params = urlparse.urlparse(url).query
+        parsed = urlparse.parse_qsl(params)
+        return dict(parsed)
+
+    def next(self):
+        """
+        Get next page of entity results
+        :return: PaginatedResultSet of next result page
+        :raises: StopIteration if no next is available
+        """
+        if self.next_link:
+            query_dict = self.url_params_to_dict(self.next_link)
+            return self.manager.query(filters=query_dict)
+        else:
+            raise StopIteration
+
+    def previous(self):
+        """
+        Get next page of entity results
+        :return: PaginatedResultSet of previous result page
+        :raises: StopIteration if no previous is available
+        """
+        if self.previous_link:
+            query_dict = self.url_params_to_dict(self.previous_link)
+            return self.manager.query(filters=query_dict)
+        else:
+            raise StopIteration

ganapi/test_attribute_manager.py

@@ -78,4 +78,29 @@ def test_delete_attribute(self):
         attribute = Attribute()
         attribute.code = 'changed-attribute'
         with HTTMock(self.delete_attribute_mock):
-            self.attribute_manager.delete(attribute)
+            self.attribute_manager.delete(attribute)
+
+    @all_requests
+    def get_paginated_attributes_mock(self, url, request):
+        content = '{"count":16,"next":"https://api.getanewsletter.com/v3/attributes/?page=2","previous":null,"results":[{"url":"https://api.getanewsletter.com/v3/attributes/attribute/","name":"attribute","code":"attribute","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/attribute2/","name":"Attribute2","code":"attribute2","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu/","name":"bu","code":"bu","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu1/","name":"bu1","code":"bu1","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu2/","name":"bu2","code":"bu2","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu3/","name":"bu3","code":"bu3","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu4/","name":"bu4","code":"bu4","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu5/","name":"bu5","code":"bu5","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu6/","name":"bu6","code":"bu6","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu7/","name":"bu7","code":"bu7","usage_count":0}]}'
+        status_code = 200
+        return {'content': content,
+                'status_code': status_code}
+
+    def get_paginated_attributes_page2_mock(self, url, request):
+        content = '{"count":16,"next":null,"previous":"https://api.getanewsletter.com/v3/attributes/","results":[{"url":"https://api.getanewsletter.com/v3/attributes/bu8/","name":"bu8","code":"bu8","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu9/","name":"bu9","code":"bu9","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu10/","name":"bu10","code":"bu10","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu11/","name":"bu11","code":"bu11","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu12/","name":"bu12","code":"bu12","usage_count":0},{"url":"https://api.getanewsletter.com/v3/attributes/bu13/","name":"bu13","code":"bu13","usage_count":0}]}'
+        status_code = 200
+        return {'content': content,
+                'status_code': status_code}
+
+    def test_get_paginated_attributes(self):
+        with HTTMock(self.get_paginated_attributes_mock):
+            paginated_result_set = self.attribute_manager.query({})
+        self.assertEqual(len(paginated_result_set.entities), 10)
+        self.assertTrue(isinstance(paginated_result_set.entities[0], Attribute))
+
+        with HTTMock(self.get_paginated_attributes_page2_mock):
+            next_result_set = paginated_result_set.next()
+        self.assertEqual(len(next_result_set.entities), 6)
+
+        self.assertRaises(StopIteration, next_result_set.next)

ganapi/test_contact_manager.py

@@ -1,7 +1,6 @@
 import unittest
 from api import Api
 from contact import Contact
-
 from contact_manager import ContactManager
 from httmock import HTTMock, all_requests
 
@@ -118,8 +117,9 @@ def test_find_contact_by_query(self):
         }
         with HTTMock(self.find_contact_by_query_mock):
             result = self.contact_manager.query(filters=query)
-        self.assertEqual(len(result), 1)
-        self.assertEqual(result[0].email, 'test@example.com')
+            contacts = result.entities
+        self.assertEqual(len(contacts), 1)
+        self.assertEqual(contacts[0].email, 'test@example.com')
 
     @all_requests
     def delete_contact_mock(self, url, request):