Read paginated results

dopy/manager.py

@@ -7,12 +7,43 @@
 
 import requests
 import json as json_module
+from six import wraps
 
 API_ENDPOINT = 'https://api.digitalocean.com'
 
 class DoError(RuntimeError):
     pass
 
+
+def paginated(func):
+    @wraps(func)
+    def wrapper(self, url, headers=None, params=None, method='GET'):
+        if method != 'GET':
+            return func(self, url, headers, params, method)
+
+        nxt = url
+        out = {}
+
+        while nxt is not None:
+            result = func(self, nxt, headers, params, 'GET')
+            nxt = None
+
+            if isinstance(result, dict):
+                for key, value in result.items():
+                    if key in out and isinstance(out[key], list):
+                        out[key].extend(value)
+                    else:
+                        out[key] = value
+
+                if 'links' in result \
+                        and 'pages' in result['links'] \
+                        and 'next' in result['links']['pages']:
+                    nxt = result['links']['pages']['next']
+
+        return out
+    return wrapper
+
+
 class DoManager(object):
 
     def __init__(self, client_id, api_key, api_version=1):
@@ -451,6 +482,7 @@ def request_v1(self, url, params={}, method='GET'):
 
         return json
 
+    @paginated
     def request_v2(self, url, headers=None, params=None, method='GET'):
         if headers is None:
             headers = {}

requirements.txt

@@ -1 +1,2 @@
 requests>=1.0.4
+six>=1.9.0