add support for cursor based pagination

Signed-off-by: Bruno Vieira <[email protected]>

Author: Bruno Vieira

chartmogul/api/activity.py

@@ -9,7 +9,11 @@ class Activity(Resource):
     """
     _path = "/customers{/uuid}/activities"
     _root_key = 'entries'
-    _many = namedtuple('Activities', [_root_key, "has_more", "per_page", "page"])
+    _many = namedtuple(
+        'Activities',
+        [_root_key, 'has_more', 'per_page', 'page', 'cursor'],
+        defaults=[None, None, None, None]
+    )
 
     class _Schema(Schema):
         id = fields.Int()

chartmogul/api/customer.py

@@ -30,8 +30,11 @@ class Customer(Resource):
     """
     _path = "/customers{/uuid}"
     _root_key = 'entries'
-    _many = namedtuple('Customers',
-                       [_root_key, "has_more", "per_page", "page", "current_page", "total_pages"])
+    _many = namedtuple(
+        'Customers',
+        [_root_key, 'has_more', 'per_page', 'page', 'current_page', 'total_pages', 'cursor'],
+        defaults=[None, None, None, None, None, None]
+    )
 
     class _Schema(Schema):
         # All operations

chartmogul/api/invoice.py

@@ -37,7 +37,11 @@ class Invoice(Resource):
     """
     _path = "/import/customers{/uuid}/invoices"
     _root_key = 'invoices'
-    _many = namedtuple('Invoices', [_root_key, "current_page", "total_pages", "customer_uuid"])
+    _many = namedtuple(
+        'Invoices',
+        [_root_key, 'current_page', 'total_pages', 'cursor', 'has_more', 'customer_uuid'],
+        defaults=[None, None, None, None, None]
+    )
     _many.__new__.__defaults__ = (None,) * len(_many._fields)
 
     class _Schema(Schema):

chartmogul/api/plan.py

@@ -9,7 +9,11 @@ class Plan(Resource):
     """
     _path = "/plans{/uuid}"
     _root_key = 'plans'
-    _many = namedtuple('Plans', [_root_key, "current_page", "total_pages"])
+    _many = namedtuple(
+        'Plans',
+        [_root_key, 'current_page', 'total_pages', 'has_more', 'cursor'],
+        defaults=[None, None, None, None]
+    )
 
     class _Schema(Schema):
         uuid = fields.String()

chartmogul/api/plan_group.py

@@ -10,7 +10,11 @@ class PlanGroup(Resource):
     """
     _path = "/plan_groups{/uuid}"
     _root_key = 'plan_groups'
-    _many = namedtuple('PlanGroups', [_root_key, "current_page", "total_pages"])
+    _many = namedtuple(
+        'PlanGroups',
+        [_root_key, 'current_page', 'total_pages', 'has_more', 'cursor'],
+        defaults=[None, None, None, None]
+    )
 
     class _Schema(Schema):
         uuid = fields.String()

chartmogul/api/plan_group_plans.py

@@ -9,7 +9,11 @@ class PlanGroupPlans(Resource):
     """
     _path = "/plan_groups{/uuid}/plans"
     _root_key = 'plans'
-    _many = namedtuple('PlanGroupPlans', [_root_key, "current_page", "total_pages"])
+    _many = namedtuple(
+        'PlanGroupPlans',
+        [_root_key, 'current_page', 'total_pages', 'has_more', 'cursor'],
+        defaults=[None, None, None, None]
+    )
 
     class _Schema(Schema):
         uuid = fields.String()

chartmogul/api/subscription.py

@@ -10,7 +10,11 @@ class Subscription(Resource):
     """
     _path = "/customers{/uuid}/subscriptions"
     _root_key = 'entries'
-    _many = namedtuple('Subscriptions', [_root_key, "has_more", "per_page", "page"])
+    _many = namedtuple(
+        'Subscriptions',
+        [_root_key, 'has_more', 'per_page', 'page', 'cursor'],
+        defaults=[None, None, None, None]
+    )
 
     class _Schema(Schema):
         id = fields.Int(allow_none=True)
@@ -45,11 +49,16 @@ def make(self, data, **kwargs):
     @classmethod
     def _loadJSON(cls, jsonObj):
         if "subscriptions" in jsonObj:
-            _many = namedtuple('Subscriptions', ["subscriptions", "current_page", "total_pages", "customer_uuid"])
+            _many = namedtuple(
+                'Subscriptions',
+                ["subscriptions", "current_page", "total_pages", "customer_uuid", "has_more", "cursor"]
+            )
             return _many(cls._schema.load(jsonObj["subscriptions"], many=True),
-                         jsonObj["current_page"],
-                         jsonObj["total_pages"],
-                         jsonObj["customer_uuid"])
+                         jsonObj.get("current_page", None),
+                         jsonObj.get("total_pages", None),
+                         jsonObj["customer_uuid"],
+                         jsonObj.get("has_more", None),
+                         jsonObj.get("cursor", None))
         else:
             return super(Subscription, cls)._loadJSON(jsonObj)
 

chartmogul/resource.py

@@ -27,9 +27,16 @@
     'update': 'put'
 }
 
-LIST_PARAMS = ['current_page', 'total_pages',
-               'has_more', 'per_page', 'page',
-               'summary', 'customer_uuid']
+LIST_PARAMS = [
+    'current_page',
+    'total_pages',
+    'has_more',
+    'per_page',
+    'page',
+    'summary',
+    'cursor',
+    'customer_uuid'
+]
 ESCAPED_QUERY_KEYS = {
     'start_date': 'start-date',
     'end_date': 'end-date'

requirements-test.txt

@@ -0,0 +1,8 @@
+-r requirements.txt
+yarl
+mock>=1.0.1
+requests-mock>=1.3.0
+vcrpy<3.0.0
+PyYAML>=5.1.2
+httpretty>=0.9.6
+wrapt>=1.11.2

requirements.txt

@@ -3,3 +3,4 @@ uritemplate>=3.0.0
 promise>=1.0.1
 marshmallow>=3.10.0
 future>=0.16.0
+urllib3<=2.0.0