Improve API error messaging (#27)

* passing error messages from the underlying API to the logger instead of using copy from the documentation

* removing GNIP_RESPONSE_CODES as unneeded

* updated version

Author: Aaron Gonzales

searchtweets/api_utils.py

@@ -17,40 +17,10 @@
 
 __all__ = ["gen_rule_payload", "gen_params_from_config",
            "infer_endpoint", "convert_utc_time",
-           "validate_count_api", "GNIP_RESP_CODES", "change_to_count_endpoint"]
+           "validate_count_api", "change_to_count_endpoint"]
 
 logger = logging.getLogger(__name__)
 
-GNIP_RESP_CODES = {
-    '200': ("OK: The request was successful. "
-            "The JSON response will be similar to the following:"),
-
-    '400': ("Bad Request: Generally, this response occurs due "
-            "to the presence of invalid JSON in the request, "
-            "or where the request failed to send any JSON payload."),
-
-    '401': ("Unauthorized: HTTP authentication failed due to invalid "
-            "credentials. Log in to console.gnip.com with your credentials "
-            "to ensure you are using them correctly with your request. "),
-    '404': ("Not Found: The resource was not found at the URL to which the "
-            "request was sent, likely because an incorrect URL was used."),
-
-    '422': ("Unprocessable Entity: This is returned due to invalid parameters "
-            "in a query or when a query is too complex for us to process. "
-            "–e.g. invalid PowerTrack rules or too many phrase operators,"
-            " rendering a query too complex."),
-    '429': ("Unknown Code: Your app has exceeded the limit on connection "
-            "requests. The corresponding JSON message will look "
-            "similar to the following:"),
-    '500': ("Internal Server Error: There was an error on Gnip's side. Retry "
-            "your request using an exponential backoff pattern."),
-    '502': ("Proxy Error: There was an error on Gnip's side. Retry your "
-            "request using an exponential backoff pattern."),
-    '503': ("Service Unavailable: There was an error on Gnip's side. "
-            "Retry your request using an exponential backoff pattern.")
-}
-
-
 def convert_utc_time(datetime_str):
     """
     Handles datetime argument conversion to the GNIP API format, which is

searchtweets/result_stream.py

@@ -21,8 +21,7 @@
 
 from .utils import merge_dicts
 
-from .api_utils import (infer_endpoint, GNIP_RESP_CODES,
-                        change_to_count_endpoint)
+from .api_utils import infer_endpoint, change_to_count_endpoint
 
 
 logger = logging.getLogger(__name__)
@@ -94,10 +93,9 @@ def retried_func(*args, **kwargs):
             break
 
         if resp.status_code != 200:
-            logger.error("HTTP Error code: {}: {}"
-                         .format(resp.status_code,
-                                 GNIP_RESP_CODES[str(resp.status_code)]))
-            logger.error("rule payload: {}".format(kwargs["rule_payload"]))
+            error_message = resp.json()["error"]["message"]
+            logger.error("HTTP Error code: {}: {}".format(resp.status_code, error_message))
+            logger.error("Rule payload: {}".format(kwargs["rule_payload"]))
             raise requests.exceptions.HTTPError
 
         return resp

setup.py

@@ -7,7 +7,7 @@
       long_description=open('README.rst', 'r', encoding="utf-8").read(),
       author_email='agonzales@twitter.com',
       license='MIT',
-      version='1.3.2',
+      version='1.4.0',
       python_requires='>=3.3',
       install_requires=["requests", "tweet_parser", "pyyaml"],
       packages=find_packages(),