Merge pull request #81 from ipinfo/awais/be-837

Added link to country's flag image

Author: UmanShahzad

CHANGELOG.md

@@ -1,5 +1,10 @@
 # IPInfo Changelog
 
+## 4.4.3
+
+- Added `CountryFlagURL` to the details object.
+- Allowed custom headers
+
 ## 4.4.2
 
 - Patch fix for empty `ip_address` crash.

README.md

@@ -240,7 +240,7 @@ You can add custom headers or modify default headers by setting the `headers` ke
 
 ### Internationalization
 
-When looking up an IP address, the response object includes a `details.country_name`, `details.isEU`, `details.country_flag` and `details.country_currency` attributes which includes the country based on American English. It is possible to return the country name in other languages by setting the `countries_file`, remove or add EU countries by setting the keyword argument `eu_countries_file`, change the country flag emoji or unicode by setting the keyword argument `countries_flags_file` or change country's currency code or currency symbol by setting the `countries_currencies` when creating the `IPinfo` object. Moreover the response object includes a `details.continent` which includes continent code and name of IP. The default file can be changed by setting the `continent_file` while creating the `IPinfo` object.
+When looking up an IP address, the response object includes a `details.country_name`, `details.isEU`, `details.country_flag`, `details.country_flag_url` and `details.country_currency` attributes which includes the country based on American English. It is possible to return the country name in other languages by setting the `countries_file`, remove or add EU countries by setting the keyword argument `eu_countries_file`, change the country flag emoji or unicode by setting the keyword argument `countries_flags_file` or change country's currency code or currency symbol by setting the `countries_currencies` when creating the `IPinfo` object. Moreover the response object includes a `details.continent` which includes continent code and name of IP. The default file can be changed by setting the `continent_file` while creating the `IPinfo` object.
 
 The file must be a `.json` file with the following structure:
 

ipinfo/handler_utils.py

@@ -12,6 +12,10 @@
 # Base URL to make requests against.
 API_URL = "https://ipinfo.io"
 
+# Base URL to get country flag image link.
+# "PK" -> "https://cdn.ipinfo.io/static/images/countries-flags/PK.svg"
+COUNTRY_FLAGS_URL = "https://cdn.ipinfo.io/static/images/countries-flags/"
+
 # Used to transform incoming responses with country abbreviations into the full
 # expanded country name, e.g. "PK" -> "Pakistan".
 COUNTRY_FILE_DEFAULT = "countries.json"
@@ -75,6 +79,7 @@ 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"] = copy.deepcopy(
         countries_flags.get(details.get("country"))
     )

ipinfo/version.py

@@ -1 +1 @@
-SDK_VERSION = "4.4.2"
+SDK_VERSION = "4.4.3"

tests/handler_async_test.py

@@ -47,6 +47,8 @@ async def test_get_details():
     country_flag = details.country_flag
     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"
     country_currency = details.country_currency
     assert country_currency["code"] == "USD"
     assert country_currency["symbol"] == "$"

tests/handler_test.py

@@ -44,6 +44,8 @@ def test_get_details():
     country_flag = details.country_flag
     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"
     country_currency = details.country_currency
     assert country_currency["code"] == "USD"
     assert country_currency["symbol"] == "$"