Merge pull request #83 from ipinfo/error-handling

handling error body

Author: UmanShahzad

ipinfo/error.py

@@ -0,0 +1,10 @@
+import json
+
+
+class APIError(Exception):
+    def __init__(self, error_code, error_json):
+        self.error_code = error_code
+        self.error_json = error_json
+
+    def __str__(self):
+        return f"APIError: {self.error_code}\n{json.dumps(self.error_json, indent=2)}"

ipinfo/handler.py

@@ -10,6 +10,7 @@
 
 import requests
 
+from .error import APIError
 from .cache.default import DefaultCache
 from .details import Details
 from .exceptions import RequestQuotaExceededError, TimeoutExceededError
@@ -140,7 +141,10 @@ def getDetails(self, ip_address=None, timeout=None):
         response = requests.get(url, headers=headers, **req_opts)
         if response.status_code == 429:
             raise RequestQuotaExceededError()
-        response.raise_for_status()
+        if response.status_code >= 400:
+            error_response = response.json()
+            error_code = response.status_code
+            raise APIError(error_code, error_response)
         details = response.json()
 
         # format & cache

ipinfo/handler_async.py

@@ -11,6 +11,7 @@
 
 import aiohttp
 
+from .error import APIError
 from .cache.default import DefaultCache
 from .details import Details
 from .exceptions import RequestQuotaExceededError, TimeoutExceededError
@@ -98,10 +99,10 @@ def __init__(self, access_token=None, **kwargs):
             if "ttl" not in cache_options:
                 cache_options["ttl"] = CACHE_TTL
             self.cache = DefaultCache(**cache_options)
-        
+
         # setup custom headers
         self.headers = kwargs.get("headers", None)
-        
+
     async def init(self):
         """
         Initializes internal aiohttp connection pool.
@@ -163,7 +164,10 @@ async def getDetails(self, ip_address=None, timeout=None):
         async with self.httpsess.get(url, headers=headers, **req_opts) as resp:
             if resp.status == 429:
                 raise RequestQuotaExceededError()
-            resp.raise_for_status()
+            if resp.status >= 400:
+                error_response = await resp.json()
+                error_code = resp.status
+                raise APIError(error_code, error_response)
             details = await resp.json()
 
         # format & cache

ipinfo/handler_utils.py

@@ -51,14 +51,14 @@
 def get_headers(access_token, custom_headers):
     """Build headers for request to IPinfo API."""
     headers = {
-       "user-agent": "IPinfoClient/Python{version}/{sdk_version}".format(
-        version=sys.version_info[0], sdk_version=SDK_VERSION
+        "user-agent": "IPinfoClient/Python{version}/{sdk_version}".format(
+            version=sys.version_info[0], sdk_version=SDK_VERSION
         ),
         "accept": "application/json",
     }
 
     if custom_headers:
-        headers = {** headers, ** custom_headers}
+        headers = {**headers, **custom_headers}
 
     if access_token:
         headers["authorization"] = "Bearer {}".format(access_token)
@@ -79,7 +79,9 @@ def format_details(
     """
     details["country_name"] = countries.get(details.get("country"))
     details["isEU"] = details.get("country") in eu_countries
-    details["country_flag_url"] = COUNTRY_FLAGS_URL + details.get("country") + ".svg"
+    details["country_flag_url"] = (
+        COUNTRY_FLAGS_URL + details.get("country") + ".svg"
+    )
     details["country_flag"] = copy.deepcopy(
         countries_flags.get(details.get("country"))
     )

tests/handler_async_test.py

@@ -48,7 +48,10 @@ async def test_get_details():
     assert country_flag["emoji"] == "🇺🇸"
     assert country_flag["unicode"] == "U+1F1FA U+1F1F8"
     country_flag_url = details.country_flag_url
-    assert country_flag_url == "https://cdn.ipinfo.io/static/images/countries-flags/US.svg"
+    assert (
+        country_flag_url
+        == "https://cdn.ipinfo.io/static/images/countries-flags/US.svg"
+    )
     country_currency = details.country_currency
     assert country_currency["code"] == "USD"
     assert country_currency["symbol"] == "$"
@@ -162,4 +165,4 @@ async def test_bogon_details():
     token = os.environ.get("IPINFO_TOKEN", "")
     handler = AsyncHandler(token)
     details = await handler.getDetails("127.0.0.1")
-    assert details.all == {'bogon': True, 'ip': '127.0.0.1'}
+    assert details.all == {"bogon": True, "ip": "127.0.0.1"}

tests/handler_test.py

@@ -45,7 +45,10 @@ def test_get_details():
     assert country_flag["emoji"] == "🇺🇸"
     assert country_flag["unicode"] == "U+1F1FA U+1F1F8"
     country_flag_url = details.country_flag_url
-    assert country_flag_url == "https://cdn.ipinfo.io/static/images/countries-flags/US.svg"
+    assert (
+        country_flag_url
+        == "https://cdn.ipinfo.io/static/images/countries-flags/US.svg"
+    )
     country_currency = details.country_currency
     assert country_currency["code"] == "USD"
     assert country_currency["symbol"] == "$"
@@ -165,4 +168,4 @@ def test_bogon_details():
     handler = Handler(token)
     details = handler.getDetails("127.0.0.1")
     assert isinstance(details, Details)
-    assert details.all == {'bogon': True, 'ip': '127.0.0.1'}
+    assert details.all == {"bogon": True, "ip": "127.0.0.1"}