Merge pull request #50 from maxmind/greg/is-in-eu

Add is_in_european_union support

Author: horgh

HISTORY.rst

@@ -3,6 +3,15 @@
 History
 -------
 
+2.7.0
+++++++++++++++++++
+
+- The ``is_in_european_union`` attribute was added to
+  ``geoip2.record.Country`` and ``geoip2.record.RepresentedCountry``. This
+  attribute is ``True`` if the country is a member state of the European
+  Union.
+
+
 2.6.0 (2017-10-27)
 ++++++++++++++++++
 
@@ -55,7 +64,7 @@ History
 2.2.0 (2015-06-29)
 ++++++++++++++++++
 
-* The ``geoip2.records.Location` class has been updated to add attributes for
+* The ``geoip2.records.Location`` class has been updated to add attributes for
   the ``average_income`` and ``population_density`` fields provided by the
   Insights web service.
 * The ``is_anonymous_proxy`` and ``is_satellite_provider`` properties on

geoip2/records.py

@@ -159,6 +159,12 @@ class Country(PlaceRecord):
 
       :type: int
 
+    .. attribute:: is_in_european_union
+
+      This is true if the country is a member state of the European Union.
+
+      :type: bool
+
     .. attribute:: iso_code
 
       The two-character `ISO 3166-1
@@ -183,7 +189,14 @@ class Country(PlaceRecord):
 
     """
 
-    _valid_attributes = set(['confidence', 'geoname_id', 'iso_code', 'names'])
+    _valid_attributes = set([
+        'confidence', 'geoname_id', 'is_in_european_union', 'iso_code', 'names'
+    ])
+
+    def __init__(self, locales=None, **kwargs):
+        if 'is_in_european_union' not in kwargs:
+            kwargs['is_in_european_union'] = False
+        super(Country, self).__init__(locales, **kwargs)
 
 
 class RepresentedCountry(Country):
@@ -210,6 +223,12 @@ class RepresentedCountry(Country):
 
       :type: int
 
+    .. attribute:: is_in_european_union
+
+      This is true if the country is a member state of the European Union.
+
+      :type: bool
+
     .. attribute:: iso_code
 
       The two-character `ISO 3166-1
@@ -242,8 +261,10 @@ class RepresentedCountry(Country):
 
     """
 
-    _valid_attributes = set(
-        ['confidence', 'geoname_id', 'iso_code', 'names', 'type'])
+    _valid_attributes = set([
+        'confidence', 'geoname_id', 'is_in_european_union', 'iso_code',
+        'names', 'type'
+    ])
 
 
 class Location(Record):

tests/data

@@ -101,9 +101,11 @@ def test_city(self):
 
         self.assertEqual(record.country.name, 'United Kingdom',
                          'The default locale is en')
-
+        self.assertEqual(record.country.is_in_european_union, True)
         self.assertEqual(record.location.accuracy_radius, 100,
                          'The accuracy_radius is populated')
+        self.assertEqual(record.registered_country.is_in_european_union, False)
+
         reader.close()
 
     def test_connection_type(self):
@@ -130,6 +132,8 @@ def test_country(self):
         record = reader.country('81.2.69.160')
         self.assertEqual(record.traits.ip_address, '81.2.69.160',
                          'IP address is added to model')
+        self.assertEqual(record.country.is_in_european_union, True)
+        self.assertEqual(record.registered_country.is_in_european_union, False)
         reader.close()
 
     def test_domain(self):
@@ -158,7 +162,10 @@ def test_enterprise(self):
             self.assertEqual(record.city.confidence, 11)
             self.assertEqual(record.country.confidence, 99)
             self.assertEqual(record.country.geoname_id, 6252001)
+            self.assertEqual(record.country.is_in_european_union, False)
             self.assertEqual(record.location.accuracy_radius, 27)
+            self.assertEqual(record.registered_country.is_in_european_union,
+                             False)
             self.assertEqual(record.traits.connection_type, 'Cable/DSL')
             self.assertTrue(record.traits.is_legitimate_proxy)
             self.assertEqual(record.traits.ip_address, ip_address)

tests/database_test.py

@@ -79,6 +79,7 @@ def test_insights_full(self):
             },
             'represented_country': {
                 'geoname_id': 3,
+                'is_in_european_union': True,
                 'iso_code': 'GB',
                 'names': {
                     'en': 'United Kingdom'
@@ -173,13 +174,17 @@ def test_insights_full(self):
         self.assertEqual(model.location, eval(repr(model.location)),
                          "Location repr can be eval'd")
 
-        self.assertTrue(model.traits.is_anonymous)
-        self.assertTrue(model.traits.is_anonymous_proxy)
-        self.assertTrue(model.traits.is_anonymous_vpn)
-        self.assertTrue(model.traits.is_hosting_provider)
-        self.assertTrue(model.traits.is_public_proxy)
-        self.assertTrue(model.traits.is_satellite_provider)
-        self.assertTrue(model.traits.is_tor_exit_node)
+        self.assertIs(model.country.is_in_european_union, False)
+        self.assertIs(model.registered_country.is_in_european_union, False)
+        self.assertIs(model.represented_country.is_in_european_union, True)
+
+        self.assertIs(model.traits.is_anonymous, True)
+        self.assertIs(model.traits.is_anonymous_proxy, True)
+        self.assertIs(model.traits.is_anonymous_vpn, True)
+        self.assertIs(model.traits.is_hosting_provider, True)
+        self.assertIs(model.traits.is_public_proxy, True)
+        self.assertIs(model.traits.is_satellite_provider, True)
+        self.assertIs(model.traits.is_tor_exit_node, True)
 
     def test_insights_min(self):
         model = geoip2.models.Insights({'traits': {'ip_address': '5.6.7.8'}})

tests/models_test.py

@@ -44,6 +44,14 @@ def setUp(self):
         'maxmind': {
             'queries_remaining': 11
         },
+        'registered_country': {
+            'geoname_id': 2,
+            'is_in_european_union': True,
+            'iso_code': 'DE',
+            'names': {
+                'en': 'Germany'
+            }
+        },
         'traits': {
             'ip_address': '1.2.3.4'
         },
@@ -73,6 +81,8 @@ def test_country_ok(self, mock):
                          'continent name is North America')
         self.assertEqual(country.country.geoname_id, 1,
                          'country geoname_id is 1')
+        self.assertIs(country.country.is_in_european_union, False,
+                      'country is_in_european_union is False')
         self.assertEqual(country.country.iso_code, 'US',
                          'country iso_code is US')
         self.assertEqual(country.country.names,
@@ -81,6 +91,8 @@ def test_country_ok(self, mock):
                          'country name is United States of America')
         self.assertEqual(country.maxmind.queries_remaining, 11,
                          'queries_remaining is 11')
+        self.assertIs(country.registered_country.is_in_european_union, True,
+                      'registered_country is_in_european_union is True')
         self.assertEqual(country.raw, self.country, 'raw response is correct')
 
     @requests_mock.mock()