Merge pull request #74 from jvanasco/master

Enhanced debugging support courtesy of jvanasco.

twython/twitter_endpoints.py

@@ -328,3 +328,18 @@ api_table = {
         'method': 'POST',
     },
 }
+
+# from https://dev.twitter.com/docs/error-codes-responses
+twitter_http_status_codes= {
+	200 : ('OK','Success!'),
+	304	: ('Not Modified','There was no new data to return.'),
+	400	: ('Bad Request','The request was invalid. An accompanying error message will explain why. This is the status code will be returned during rate limiting.'),
+	401	: ('Unauthorized','Authentication credentials were missing or incorrect.'),
+	403	: ('Forbidden','The request is understood, but it has been refused. An accompanying error message will explain why. This code is used when requests are being denied due to update limits.'),
+	404	: ('Not Found','The URI requested is invalid or the resource requested, such as a user, does not exists.'),
+	406	: ('Not Acceptable','Returned by the Search API when an invalid format is specified in the request.'),
+	420	: ('Enhance Your Calm','Returned by the Search and Trends API when you are being rate limited.'),
+	500	: ('Internal Server Error','Something is broken. Please post to the group so the Twitter team can investigate.'),
+	502	: ('Bad Gateway','Twitter is down or being upgraded.'),
+	503	: ('Service Unavailable','The Twitter servers are up, but overloaded with requests. Try again later.'),
+}

twython/twython.py

@@ -27,7 +27,7 @@ except ImportError:
 
 # Twython maps keyword based arguments to Twitter API endpoints. The endpoints
 # table is a file with a dictionary of every API endpoint that Twython supports.
-from twitter_endpoints import base_url, api_table
+from twitter_endpoints import base_url, api_table , twitter_http_status_codes
 
 
 # There are some special setups (like, oh, a Django application) where
@@ -191,6 +191,9 @@ class Twython(object):
         for key in api_table.keys():
             self.__dict__[key] = setFunc(key)
 
+        # create stash for last call intel
+        self._last_call= None
+
     def _constructFunc(self, api_call, **kwargs):
         # Go through and replace any mustaches that are in our API url.
         fn = api_table[api_call]
@@ -213,8 +216,58 @@ class Twython(object):
 
         func = getattr(self.client, method)
         response = func(url, data=myargs)
+        content= response.content.decode('utf-8')
 
-        return simplejson.loads(response.content.decode('utf-8'))
+        # create stash for last function intel
+        self._last_call= {
+            'api_call':api_call,
+            'api_error':None,
+            'cookies':response.cookies,
+            'error':response.error,
+            'headers':response.headers,
+            'status_code':response.status_code,
+            'url':response.url,
+            'content':content,
+        }
+        
+        if response.status_code not in ( 200 , 304 ):
+            # handle rate limiting first
+            if response.status_code == 420 :
+                raise TwythonAPILimit( "420 || %s || %s" % twitter_http_status_codes[420] )
+            if content:
+                try:
+                    as_json= simplejson.loads(content)
+                    if 'error' in as_json:
+                        self._last_call['api_error']= as_json['error']
+                except:
+                    pass
+            raise TwythonError( "%s || %s || %s" % ( response.status_code , twitter_http_status_codes[response.status_code][0] , twitter_http_status_codes[response.status_code][1] ) , error_code=response.status_code )
+            
+        try:
+            # sometimes this causes an error, and i haven't caught it yet!
+            return simplejson.loads(content)
+        except:
+            raise
+
+    def get_lastfunction_header(self,header):
+        """
+            get_lastfunction_header(self)
+
+            returns the header in the last function
+            this must be called after an API call, as it returns header based information.
+            this will return None if the header is not present
+            
+            most useful for the following header information:
+                x-ratelimit-limit
+                x-ratelimit-remaining
+                x-ratelimit-class
+                x-ratelimit-reset
+        """
+        if self._last_call is None:
+            raise TwythonError('This function must be called after an API call.  It delivers header information.')
+        if header in self._last_call['headers']:
+            return self._last_call['headers'][header]
+        return None
 
     def get_authentication_tokens(self):
         """