Skip to content

Fix #775: Wrong rate limit returned for search #776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 30, 2018
Merged

Fix #775: Wrong rate limit returned for search #776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb983cb
Fix #775: Wrong rate limit returned for `search`
justfortherec Jan 26, 2018
246b825
Make SearchIterator return rate limits for search
justfortherec Jan 26, 2018
89ac06d
Turn _ratelimit_resource into class attribute
justfortherec Jan 26, 2018
e6246ef
Add tests for remaining rate limit of different resources
justfortherec Jan 26, 2018
b4d7ef8
Remove class GitHubSearch
justfortherec Jan 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion github3/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ class GitHubCore(object):
basic attributes and methods to other sub-classes that are very useful to
have.
"""
_ratelimit_resource = 'core'

def __init__(self, json, session=None):
if hasattr(session, 'session'):
Expand Down Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions github3/structs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ class SearchIterator(GitHubIterator):
class. For other members and methods, check its parent class.

"""
_ratelimit_resource = 'search'

def __init__(self, count, url, cls, session, params=None, etag=None,
headers=None):
Expand Down
1 change: 1 addition & 0 deletions tests/cassettes/GitHubCore_ratelimit_remaining_search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"recorded_with": "betamax/0.8.0", "http_interactions": [{"response": {"body": {"base64_string": "H4sIAAAAAAAAA6tWKkotzi8tSk4tVrKqVkrOL0oF0TmZuZklSlZmBjpA+dzEzLzMvHQYtzgVKGNoamhmaWlibGhcq6NUnJpYlJyBpM8QVR+Ei6TPwNwcpC+9KLEgozAHSSOqPjAP3TqgvqLEEpJdWQsAyulOc+oAAAA=", "encoding": "utf-8", "string": ""}, "url": "https://api.github.com/rate_limit", "headers": {"Cache-Control": "no-cache", "Access-Control-Expose-Headers": "ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Access-Control-Allow-Origin": "*", "Content-Security-Policy": "default-src 'none'", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "Content-Encoding": "gzip", "X-Content-Type-Options": "nosniff", "X-RateLimit-Limit": "60", "X-RateLimit-Reset": "1516994313", "Content-Type": "application/json; charset=utf-8", "X-XSS-Protection": "1; mode=block", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Date": "Fri, 26 Jan 2018 18:18:33 GMT", "X-Runtime-rack": "0.008218", "Transfer-Encoding": "chunked", "X-GitHub-Request-Id": "D196:12414:2B7A313:507FFAA:5A6B70F9", "Status": "200 OK", "Server": "GitHub.com", "X-Frame-Options": "deny", "X-RateLimit-Remaining": "60"}, "status": {"message": "OK", "code": 200}}, "recorded_at": "2018-01-26T18:18:33", "request": {"body": {"encoding": "utf-8", "string": ""}, "method": "GET", "uri": "https://api.github.com/rate_limit", "headers": {"Connection": "keep-alive", "Content-Type": "application/json", "User-Agent": "github3.py/1.0.0a4", "Accept-Charset": "utf-8", "Accept-Encoding": "gzip, deflate", "Accept": "application/vnd.github.v3.full+json"}}}, {"response": {"body": {"base64_string": "H4sIAAAAAAAAA6tWKkotzi8tSk4tVrKqVkrOL0oF0TmZuZklSlZmBjpA+dzEzLzMvHQYtzgVKGNoamhmaWlibGhcq6NUnJpYlJyBpM8QVR+Ei6TPwNwcpC+9KLEgozAHSSOqPjAP3TqgvqLEEpJdWQsAyulOc+oAAAA=", "encoding": "utf-8", "string": ""}, "url": "https://api.github.com/rate_limit", "headers": {"Cache-Control": "no-cache", "Access-Control-Expose-Headers": "ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Access-Control-Allow-Origin": "*", "Content-Security-Policy": "default-src 'none'", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "Content-Encoding": "gzip", "X-Content-Type-Options": "nosniff", "X-RateLimit-Limit": "60", "X-RateLimit-Reset": "1516994313", "Content-Type": "application/json; charset=utf-8", "X-XSS-Protection": "1; mode=block", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Date": "Fri, 26 Jan 2018 18:18:33 GMT", "X-Runtime-rack": "0.010151", "Transfer-Encoding": "chunked", "X-GitHub-Request-Id": "D196:12414:2B7A31F:507FFBB:5A6B70F9", "Status": "200 OK", "Server": "GitHub.com", "X-Frame-Options": "deny", "X-RateLimit-Remaining": "60"}, "status": {"message": "OK", "code": 200}}, "recorded_at": "2018-01-26T18:18:33", "request": {"body": {"encoding": "utf-8", "string": ""}, "method": "GET", "uri": "https://api.github.com/rate_limit", "headers": {"Connection": "keep-alive", "Content-Type": "application/json", "User-Agent": "github3.py/1.0.0a4", "Accept-Charset": "utf-8", "Accept-Encoding": "gzip, deflate", "Accept": "application/vnd.github.v3.full+json"}}}]}
28 changes: 28 additions & 0 deletions tests/integration/test_github_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,31 @@ def test_ratelimit_remaining(self):
cassette_name = self.cassette_name('ratelimit_remaining')
with self.recorder.use_cassette(cassette_name):
assert self.gh.ratelimit_remaining > 0

def test_ratelimit_remaining_search(self):
"""Test if search iterators return search ratelimit"""

def _get_ratelimit(resource):
resources = self.gh.rate_limit().get('resources', {})
rate_limit = resources.get(resource, {})
return rate_limit.get('remaining', -1)

cassette_name = self.cassette_name('ratelimit_remaining_search')

# Run cassette to get correct remaining rate limit from responses.
with self.recorder.use_cassette(cassette_name):
correct_ratelimit_search = _get_ratelimit('search')
correct_ratelimit_core = _get_ratelimit('core')

# Re-run cassette to test functions under test.
with self.recorder.use_cassette(cassette_name):
result_iterator = self.gh.search_code(
'HTTPAdapter in:file language:python'
' repo:kennethreitz/requests'
)
ratelimit_remaining_search = result_iterator.ratelimit_remaining
ratelimit_remaining_core = self.gh.ratelimit_remaining

assert ratelimit_remaining_search != ratelimit_remaining_core
assert ratelimit_remaining_core == correct_ratelimit_core
assert ratelimit_remaining_search == correct_ratelimit_search