Merge pull request #62 from ipinfo/umar/isEU

refactored isEU logic

Author: UmanShahzad

README.md

@@ -232,7 +232,7 @@ Request behavior can be modified by setting the `request_options` keyword argume
 
 ### Internationalization
 
-When looking up an IP address, the response object includes a `details.country_name` and `details.isEU` attributes which includes the country name and true if the country is a member of EU, based on American English. It is possible to return the country name in other languages by setting the `countries_file` keyword argument when creating the `IPinfo` object.
+When looking up an IP address, the response object includes a `details.country_name` and `details.isEU` 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` and remove or add EU countries by setting `eu_countries_file` keyword argument when creating the `IPinfo` object.
 
 The file must be a `.json` file with the following structure:
 

ipinfo/countries.json

@@ -0,0 +1 @@
+["IE","AT","LT","LU","LV","DE","DK","SE","SI","SK","CZ","CY","NL","FI","FR","MT","ES","IT","EE","PL","PT","HU","HR","GR","RO","BG","BE"]

ipinfo/eu.json

@@ -16,6 +16,7 @@
 from .handler_utils import (
     API_URL,
     COUNTRY_FILE_DEFAULT,
+    COUNTRY_EU_FILE_DEFAULT,
     BATCH_MAX_SIZE,
     CACHE_MAXSIZE,
     CACHE_TTL,
@@ -42,6 +43,15 @@ def __init__(self, access_token=None, **kwargs):
         # load countries file
         self.countries = handler_utils.read_country_names(
             kwargs.get("countries_file")
+            if kwargs.get("countries_file")
+            else COUNTRY_FILE_DEFAULT
+        )
+
+        # load eu countries file
+        self.eu_countries = handler_utils.read_country_names(
+            kwargs.get("eu_countries_file")
+            if kwargs.get("eu_countries_file")
+            else COUNTRY_EU_FILE_DEFAULT
         )
 
         # setup req opts
@@ -99,7 +109,9 @@ def getDetails(self, ip_address=None, timeout=None):
         details = response.json()
 
         # format & cache
-        handler_utils.format_details(details, self.countries)
+        handler_utils.format_details(
+            details, self.countries, self.eu_countries
+        )
         self.cache[cache_key(ip_address)] = details
 
         return Details(details)
@@ -215,7 +227,9 @@ def getBatchDetails(
             # format all
             for detail in result.values():
                 if isinstance(detail, dict):
-                    handler_utils.format_details(detail, self.countries)
+                    handler_utils.format_details(
+                        detail, self.countries, self.eu_countries
+                    )
 
         return result
 

ipinfo/handler.py

@@ -16,6 +16,7 @@
 from .exceptions import RequestQuotaExceededError, TimeoutExceededError
 from .handler_utils import (
     API_URL,
+    COUNTRY_EU_FILE_DEFAULT,
     COUNTRY_FILE_DEFAULT,
     BATCH_MAX_SIZE,
     CACHE_MAXSIZE,
@@ -43,6 +44,15 @@ def __init__(self, access_token=None, **kwargs):
         # load countries file
         self.countries = handler_utils.read_country_names(
             kwargs.get("countries_file")
+            if kwargs.get("countries_file")
+            else COUNTRY_FILE_DEFAULT
+        )
+
+        # load eu countries file
+        self.eu_countries = handler_utils.read_country_names(
+            kwargs.get("eu_countries_file")
+            if kwargs.get("eu_countries_file")
+            else COUNTRY_EU_FILE_DEFAULT
         )
 
         # setup req opts
@@ -122,7 +132,9 @@ async def getDetails(self, ip_address=None, timeout=None):
             details = await resp.json()
 
         # format & cache
-        handler_utils.format_details(details, self.countries)
+        handler_utils.format_details(
+            details, self.countries, self.eu_countries
+        )
         self.cache[cache_key(ip_address)] = details
 
         return Details(details)
@@ -272,7 +284,9 @@ async def _do_batch_req(
         # format & fill up cache
         for ip_address, details in json_resp.items():
             if isinstance(details, dict):
-                handler_utils.format_details(details, self.countries)
+                handler_utils.format_details(
+                    details, self.countries, self.eu_countries
+                )
                 self.cache[cache_key(ip_address)] = details
 
         # merge cached results with new lookup

ipinfo/handler_async.py

@@ -15,6 +15,8 @@
 # expanded country name, e.g. "PK" -> "Pakistan".
 COUNTRY_FILE_DEFAULT = "countries.json"
 
+COUNTRY_EU_FILE_DEFAULT = "eu.json"
+
 # The max amount of IPs allowed by the API per batch request.
 BATCH_MAX_SIZE = 1000
 
@@ -50,15 +52,14 @@ def get_headers(access_token):
     return headers
 
 
-def format_details(details, countries):
+def format_details(details, countries, eu_countries):
     """
     Format details given a countries object.
 
     The countries object can be retrieved from read_country_names.
     """
-    json_details = countries.get(details.get("country"))
-    details["country_name"] = json_details["name"] if json_details else None
-    details["isEU"] = json_details["isEU"] if json_details else False
+    details["country_name"] = countries.get(details.get("country"))
+    details["isEU"] = details.get("country") in eu_countries
     details["latitude"], details["longitude"] = read_coords(details.get("loc"))
 
 
@@ -76,15 +77,12 @@ def read_coords(location):
     return lat, lon
 
 
-def read_country_names(countries_file=None):
+def read_country_names(countries_file):
     """
     Read list of countries from specified country file or
     default file.
     """
-    if not countries_file:
-        countries_file = os.path.join(
-            os.path.dirname(__file__), COUNTRY_FILE_DEFAULT
-        )
+    countries_file = os.path.join(os.path.dirname(__file__), countries_file)
     with open(countries_file) as f:
         countries_json = f.read()
 

ipinfo/handler_utils.py

@@ -4,7 +4,7 @@ cachetools==4.2.0
 aiohttp>=3.0.0,<=4
 
 # dev
-pytest==6.2.1
-pytest-asyncio==0.14.0
-pip-tools==5.4.0
-black==20.8b1
+pytest==7.1.2
+pytest-asyncio==0.19.0
+pip-tools==6.8.0
+black==22.6.0

requirements.in

@@ -1,83 +1,89 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
+# This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
 #    pip-compile --no-emit-index-url --no-emit-trusted-host
 #
-aiohttp==3.7.4.post0
+aiohttp==3.8.1
     # via -r requirements.in
-appdirs==1.4.4
-    # via black
-async-timeout==3.0.1
+aiosignal==1.2.0
+    # via aiohttp
+async-timeout==4.0.2
     # via aiohttp
-attrs==21.2.0
+attrs==22.1.0
     # via
     #   aiohttp
     #   pytest
-black==20.8b1
+black==22.6.0
     # via -r requirements.in
+build==0.8.0
+    # via pip-tools
 cachetools==4.2.0
     # via -r requirements.in
-certifi==2021.5.30
+certifi==2022.6.15
     # via requests
-chardet==4.0.0
+charset-normalizer==2.1.1
     # via
     #   aiohttp
     #   requests
-click==8.0.1
+click==8.1.3
     # via
     #   black
     #   pip-tools
-idna==2.10
+frozenlist==1.3.1
+    # via
+    #   aiohttp
+    #   aiosignal
+idna==3.3
     # via
     #   requests
     #   yarl
 iniconfig==1.1.1
     # via pytest
-multidict==5.1.0
+multidict==6.0.2
     # via
     #   aiohttp
     #   yarl
 mypy-extensions==0.4.3
     # via black
-packaging==21.0
-    # via pytest
-pathspec==0.8.1
+packaging==21.3
+    # via
+    #   build
+    #   pytest
+pathspec==0.9.0
     # via black
-pip-tools==5.4.0
+pep517==0.13.0
+    # via build
+pip-tools==6.8.0
     # via -r requirements.in
-pluggy==0.13.1
+platformdirs==2.5.2
+    # via black
+pluggy==1.0.0
     # via pytest
-py==1.10.0
+py==1.11.0
     # via pytest
-pyparsing==2.4.7
+pyparsing==3.0.9
     # via packaging
-pytest==6.2.1
+pytest==7.1.2
     # via
     #   -r requirements.in
     #   pytest-asyncio
-pytest-asyncio==0.14.0
+pytest-asyncio==0.19.0
     # via -r requirements.in
-regex==2021.7.6
-    # via black
-requests==2.25.1
+requests==2.28.1
     # via -r requirements.in
-six==1.16.0
-    # via pip-tools
-toml==0.10.2
+tomli==2.0.1
     # via
     #   black
+    #   build
     #   pytest
-typed-ast==1.4.3
-    # via black
-typing-extensions==3.10.0.0
-    # via
-    #   aiohttp
-    #   black
-urllib3==1.26.6
+urllib3==1.26.11
     # via requests
-yarl==1.6.3
+wheel==0.37.1
+    # via pip-tools
+yarl==1.8.1
     # via aiohttp
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip
+# setuptools

requirements.txt

@@ -42,6 +42,7 @@ async def test_get_details():
     assert details.region == "California"
     assert details.country == "US"
     assert details.country_name == "United States"
+    assert details.isEU == False
     assert details.loc == "37.4056,-122.0775"
     assert details.latitude == "37.4056"
     assert details.longitude == "-122.0775"

tests/handler_async_test.py

@@ -39,6 +39,7 @@ def test_get_details():
     assert details.region == "California"
     assert details.country == "US"
     assert details.country_name == "United States"
+    assert details.isEU == False
     assert details.loc == "37.4056,-122.0775"
     assert details.latitude == "37.4056"
     assert details.longitude == "-122.0775"