Merge pull request #49 from gene1wood/pagination

Add support for GitHub pagination and ratelimiting

Author: gene1wood

agithub/GitHub.py

@@ -1,14 +1,16 @@
 # Copyright 2012-2016 Jonathan Paugh and contributors
 # See COPYING for license details
 import base64
+import time
+import re
 
-from agithub.base import API, ConnectionProperties, Client
+from agithub.base import API, ConnectionProperties, Client, RequestBody, ResponseBody
 
 
 class GitHub(API):
     """
     The agnostic GitHub API. It doesn't know, and you don't care.
-    >>> from agithub import GitHub
+    >>> from agithub.GitHub import GitHub
     >>> g = GitHub('user', 'pass')
     >>> status, data = g.issues.get(filter='subscribed')
     >>> data
@@ -33,7 +35,7 @@ class GitHub(API):
     it automatically supports the full API--so why should you care?
     """
     def __init__(self, username=None, password=None, token=None,
-                 *args, **kwargs):
+                 paginate=False, *args, **kwargs):
         extraHeaders = {'accept': 'application/vnd.github.v3+json'}
         auth = self.generateAuthHeader(username, password, token)
         if auth is not None:
@@ -44,7 +46,7 @@ def __init__(self, username=None, password=None, token=None,
             extra_headers=extraHeaders
         )
 
-        self.setClient(Client(*args, **kwargs))
+        self.setClient(GitHubClient(paginate=paginate, *args, **kwargs))
         self.setConnectionProperties(props)
 
     def generateAuthHeader(self, username=None, password=None, token=None):
@@ -66,3 +68,88 @@ def generateAuthHeader(self, username=None, password=None, token=None):
     def hash_pass(self, password):
         auth_str = ('%s:%s' % (self.username, password)).encode('utf-8')
         return 'Basic '.encode('utf-8') + base64.b64encode(auth_str).strip()
+
+class GitHubClient(Client):
+    def __init__(self, username=None, password=None, token=None,
+                 connection_properties=None, paginate=False):
+        super(GitHubClient, self).__init__()
+        self.paginate = paginate
+
+    def request(self, method, url, bodyData, headers):
+        '''Low-level networking. All HTTP-method methods call this'''
+
+        headers = self._fix_headers(headers)
+        url = self.prop.constructUrl(url)
+
+        if bodyData is None:
+            # Sending a content-type w/o the body might break some
+            # servers. Maybe?
+            if 'content-type' in headers:
+                del headers['content-type']
+
+        #TODO: Context manager
+        requestBody = RequestBody(bodyData, headers)
+
+        if self.no_ratelimit_remaining():
+            time.sleep(self.ratelimit_seconds_remaining())
+
+        while True:
+            conn = self.get_connection()
+            conn.request(method, url, requestBody.process(), headers)
+            response = conn.getresponse()
+            status = response.status
+            content = ResponseBody(response)
+            self.headers = response.getheaders()
+
+            conn.close()
+            if status == '403' and self.no_ratelimit_remaining():
+                time.sleep(self.ratelimit_seconds_remaining())
+            else:
+                data = content.processBody()
+                if self.paginate and type(data) == list:
+                    data.extend(self.get_additional_pages())
+                return status, data
+
+    def get_additional_pages(self):
+        data = []
+        url = self.get_next_link_url()
+        if url:
+            status, data = self.get(url)
+            data.extend(self.get_additional_pages())
+        return data
+
+    def no_ratelimit_remaining(self):
+        headers = dict(self.headers if self.headers is not None else [])
+        return int(headers.get('X-RateLimit-Remaining', 1)) == 0
+
+    def ratelimit_seconds_remaining(self):
+        ratelimit_reset = int(dict(self.headers).get(
+            'X-RateLimit-Reset', 0))
+        return max(0, ratelimit_reset - time.time())
+
+    def get_next_link_url(self):
+        '''Given a set of HTTP headers find the RFC 5988 Link header field,
+        determine if it contains a relation type indicating a next resource and if
+        so return the URL of the next resource, otherwise return an empty string.
+        '''
+        # From https://github.com/requests/requests/blob/master/requests/utils.py
+        for value in [x[1] for x in self.headers if x[0].lower() == 'link']:
+            replace_chars = ' \'"'
+            value = value.strip(replace_chars)
+            if not value:
+                return ''
+            for val in re.split(', *<', value):
+                try:
+                    url, params = val.split(';', 1)
+                except ValueError:
+                    url, params = val, ''
+                link = {'url': url.strip('<> \'"')}
+                for param in params.split(';'):
+                    try:
+                        key, value = param.split('=')
+                    except ValueError:
+                        break
+                    link[key.strip(replace_chars)] = value.strip(replace_chars)
+                if link.get('rel') == 'next':
+                    return link['url']
+        return ''