Fix sigmavirus24#775: Wrong rate limit returned for search

justfortherec · justfortherec · commit fb983cba28d9 · 2018-01-26T10:53:54.000+01:00
This change adds a field which indicates against what rate limit API calls from an object are counted against. GitHub API v3 enforces different rate limits [1] for subsets of API calls. The `search` API has custom rate limts.[2] `GitHubCore` has a property `remaining_ratelimit` which requests rate limit information from endpoint `GET /rate_limit` [3] and caches the number in `GitHubCore._remaining`. The API call returns information about all rate limits but previously `GitHubCore.remaining_ratelimit` only exposed the one for the `core` resources. With this change the resource still defaults to `core` but objects sending search request change this to `search`. [1]: https://developer.github.com/v3/#rate-limiting [2]: https://developer.github.com/v3/search/#rate-limit [3]: https://developer.github.com/v3/rate_limit/
diff --git a/github3/models.py b/github3/models.py
@@ -42,6 +42,7 @@ def __init__(self, json, session=None):
 
         # set a sane default
         self._github_url = 'https://api.github.com'
+        self._ratelimit_resource = 'core'
 
         if json is not None:
             self.etag = json.pop('ETag', None)
@@ -305,7 +306,7 @@ def ratelimit_remaining(self):
         :returns: int
         """
         json = self._json(self._get(self._github_url + '/rate_limit'), 200)
-        core = json.get('resources', {}).get('core', {})
+        core = json.get('resources', {}).get(self._ratelimit_resource, {})
         self._remaining = core.get('remaining', 0)
         return self._remaining
 
@@ -502,3 +503,10 @@ def _update_attributes(self, acct):
 
     def _repr(self):
         return '<{s.type} [{s.login}:{s.name}]>'.format(s=self)
+
+
+class GitHubSearch(GitHubCore):
+    """The base object for all search objects."""
+    def __init__(self, json, session=None):
+        super(GitHubSearch, self).__init__(json, session)
+        self._ratelimit_resource = 'search'
diff --git a/github3/search/code.py b/github3/search/code.py
@@ -5,7 +5,7 @@
 from .. import repos
 
 
-class CodeSearchResult(models.GitHubCore):
+class CodeSearchResult(models.GitHubSearch):
 
     def _update_attributes(self, data):
         self._api = self._get_attribute(data, 'url')
diff --git a/github3/search/issue.py b/github3/search/issue.py
@@ -1,11 +1,11 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from ..models import GitHubCore
+from ..models import GitHubSearch
 from ..issues import ShortIssue
 
 
-class IssueSearchResult(GitHubCore):
+class IssueSearchResult(GitHubSearch):
     def _update_attributes(self, data):
         result = data.copy()
 
diff --git a/github3/search/repository.py b/github3/search/repository.py
@@ -5,7 +5,7 @@
 from .. import repos
 
 
-class RepositorySearchResult(models.GitHubCore):
+class RepositorySearchResult(models.GitHubSearch):
     def _update_attributes(self, data):
         result = data.copy()
 
diff --git a/github3/search/user.py b/github3/search/user.py
@@ -2,10 +2,10 @@
 from __future__ import unicode_literals
 
 from .. import users
-from ..models import GitHubCore
+from ..models import GitHubSearch
 
 
-class UserSearchResult(GitHubCore):
+class UserSearchResult(GitHubSearch):
     def _update_attributes(self, data):
         result = data.copy()
 
