Adding rate limit information to resolve #17

jasdev · jasdev · commit 6635a698531d · 2014-11-05T22:23:16.000-08:00
diff --git a/README.md b/README.md
@@ -102,6 +102,18 @@ except ImgurClientError as e
 
 * ImgurClientRateLimitError - Rate limit error
 
+### Credits
+
+To view client and user credit information, use the `credits` attribute of `ImgurClient`.
+`credits` holds a dictionary with the following keys:
+* UserLimit
+* UserRemaining
+* UserReset
+* ClientLimit
+* ClientRemaining
+
+For more information about rate-limiting, please see the note in our [docs](http://api.imgur.com/#limits)!
+
 ## ImgurClient Functions
 
 ### Account
diff --git a/imgurpython/client.py b/imgurpython/client.py
@@ -80,12 +80,17 @@ def __init__(self, client_id, client_secret, access_token=None, refresh_token=No
         if refresh_token is not None:
             self.auth = AuthWrapper(access_token, refresh_token, client_id, client_secret)
 
+        self.credits = self.get_credits()
+
     def set_user_auth(self, access_token, refresh_token):
         self.auth = AuthWrapper(access_token, refresh_token, self.client_id, self.client_secret)
 
     def get_client_id(self):
         return self.client_id
 
+    def get_credits(self):
+        return self.make_request('GET', 'credits', None, True)
+
     def get_auth_url(self, response_type='pin'):
         return '%soauth2/authorize?client_id=%s&response_type=%s' % (API_URL, self.client_id, response_type)
 
@@ -126,6 +131,14 @@ def make_request(self, method, route, data=None, force_anon=False):
             else:
                 response = method_to_call(url, headers=header, data=data)
 
+        self.credits = {
+            'UserLimit': response.headers.get('X-RateLimit-UserLimit'),
+            'UserRemaining': response.headers.get('X-RateLimit-UserRemaining'),
+            'UserReset': response.headers.get('X-RateLimit-UserReset'),
+            'ClientLimit': response.headers.get('X-RateLimit-ClientLimit'),
+            'ClientRemaining': response.headers.get('X-RateLimit-ClientRemaining')
+        }
+
         # Rate-limit check
         if response.status_code == 429:
             raise ImgurClientRateLimitError()
