Merge pull request #112 from ipinfo/silvano/st-1613-ticket-no-268595-null-and-404-values-for-lite-api-response-w

Fix Lite API `Details` response object

Author: silvanocerza

ipinfo/handler_utils.py

@@ -2,10 +2,10 @@
 Utilities used in handlers.
 """
 
+import copy
 import json
 import os
 import sys
-import copy
 
 from .version import SDK_VERSION
 
@@ -68,21 +68,26 @@ def format_details(
     """
     Format details given a countries object.
     """
-    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") or "") + ".svg"
-    )
-    details["country_flag"] = copy.deepcopy(
-        countries_flags.get(details.get("country"))
-    )
-    details["country_currency"] = copy.deepcopy(
-        countries_currencies.get(details.get("country"))
-    )
-    details["continent"] = copy.deepcopy(
-        continents.get(details.get("country"))
-    )
-    details["latitude"], details["longitude"] = read_coords(details.get("loc"))
+    country_code = ""
+    # Core and Lite API return the country_code in differently named fields
+    if "country_code" in details:
+        country_code = details.get("country_code")
+    elif "country" in details:
+        country_code = details.get("country")
+
+    # country_code = details.get("country")
+    if country_name := countries.get(country_code):
+        details["country_name"] = country_name
+    details["isEU"] = country_code in eu_countries
+    details["country_flag_url"] = COUNTRY_FLAGS_URL + country_code + ".svg"
+    if flag := countries_flags.get(country_code):
+        details["country_flag"] = copy.deepcopy(flag)
+    if currency := countries_currencies.get(country_code):
+        details["country_currency"] = copy.deepcopy(currency)
+    if continent := continents.get(country_code):
+        details["continent"] = copy.deepcopy(continent)
+    if location := details.get("loc"):
+        details["latitude"], details["longitude"] = read_coords(location)
 
 
 def read_coords(location):

tests/handler_async_test.py

@@ -87,9 +87,9 @@ async def test_get_details():
     continent = details.continent
     assert continent["code"] == "NA"
     assert continent["name"] == "North America"
-    assert details.loc == "38.0088,-122.1175"
-    assert details.latitude == "38.0088"
-    assert details.longitude == "-122.1175"
+    assert details.loc is not None
+    assert details.latitude is not None
+    assert details.longitude is not None
     assert details.postal == "94043"
     assert details.timezone == "America/Los_Angeles"
     if token:

tests/handler_lite_async_test.py

@@ -1,13 +1,13 @@
 import json
 import os
 
+import aiohttp
+import pytest
+
+from ipinfo import handler_utils
 from ipinfo.cache.default import DefaultCache
 from ipinfo.details import Details
-from ipinfo import handler_utils
 from ipinfo.error import APIError
-import pytest
-import aiohttp
-
 from ipinfo.handler_lite_async import AsyncHandlerLite
 
 
@@ -73,17 +73,17 @@ async def test_get_details():
     assert details.country_code == "US"
     assert details.country == "United States"
     assert details.continent_code == "NA"
-    assert details.continent is None
-    assert details.country_name is None
+    assert details.continent == {"code": "NA", "name": "North America"}
+    assert details.country_name == "United States"
     assert not details.isEU
     assert (
         details.country_flag_url
-        == "https://cdn.ipinfo.io/static/images/countries-flags/United States.svg"
+        == "https://cdn.ipinfo.io/static/images/countries-flags/US.svg"
     )
-    assert details.country_flag is None
-    assert details.country_currency is None
-    assert details.latitude is None
-    assert details.longitude is None
+    assert details.country_flag == {"emoji": "🇺🇸", "unicode": "U+1F1FA U+1F1F8"}
+    assert details.country_currency == {"code": "USD", "symbol": "$"}
+    assert not hasattr(details, "latitude")
+    assert not hasattr(details, "longitude")
 
     await handler.deinit()
 

tests/handler_lite_test.py

@@ -1,6 +1,7 @@
 import os
 
 import pytest
+
 from ipinfo import handler_utils
 from ipinfo.cache.default import DefaultCache
 from ipinfo.details import Details
@@ -42,17 +43,17 @@ def test_get_details():
     assert details.country_code == "US"
     assert details.country == "United States"
     assert details.continent_code == "NA"
-    assert details.continent is None
-    assert details.country_name is None
+    assert details.continent == {"code": "NA", "name": "North America"}
+    assert details.country_name == "United States"
     assert not details.isEU
     assert (
         details.country_flag_url
-        == "https://cdn.ipinfo.io/static/images/countries-flags/United States.svg"
+        == "https://cdn.ipinfo.io/static/images/countries-flags/US.svg"
     )
-    assert details.country_flag is None
-    assert details.country_currency is None
-    assert details.latitude is None
-    assert details.longitude is None
+    assert details.country_flag == {"emoji": "🇺🇸", "unicode": "U+1F1FA U+1F1F8"}
+    assert details.country_currency == {"code": "USD", "symbol": "$"}
+    assert not hasattr(details, "latitude")
+    assert not hasattr(details, "longitude")
 
 
 #############

tests/handler_test.py

@@ -56,9 +56,9 @@ def test_get_details():
     continent = details.continent
     assert continent["code"] == "NA"
     assert continent["name"] == "North America"
-    assert details.loc == "38.0088,-122.1175"
-    assert details.latitude == "38.0088"
-    assert details.longitude == "-122.1175"
+    assert details.loc is not None
+    assert details.latitude is not None
+    assert details.longitude is not None
     assert details.postal == "94043"
     assert details.timezone == "America/Los_Angeles"
     if token: