Merge pull request #46 from maxmind/greg/anonymizer

Add new anonymizer outputs for Insights

Author: oalders

HISTORY.rst

@@ -3,6 +3,14 @@
 History
 -------
 
+2.6.0 (2017-XX-XX)
+++++++++++++++++++
+
+* The following new anonymizer outputs were added to ``geoip2.record.Traits``
+  for use with GeoIP2 Precision Insights: ``is_anonymous``,
+  ``is_anonymous_vpn``, ``is_hosting_provider``, ``is_public_proxy``, and
+  ``is_tor_exit_node``.
+
 2.5.0 (2017-05-08)
 ++++++++++++++++++
 

geoip2/records.py

@@ -517,6 +517,13 @@ class Traits(Record):
 
       :type: unicode
 
+    .. attribute:: is_anonymous
+
+      This is true if the IP address belongs to any sort of anonymous network.
+      This attribute is only available from GeoIP2 Precision Insights.
+
+      :type: bool
+
     .. attribute:: is_anonymous_proxy
 
       This is true if the IP is an anonymous
@@ -530,6 +537,20 @@ class Traits(Record):
         <https://www.maxmind.com/en/geoip2-anonymous-ip-database GeoIP2>`_
         instead.
 
+    .. attribute:: is_anonymous_vpn
+
+      This is true if the IP address belongs to an anonymous VPN system.
+      This attribute is only available from GeoIP2 Precision Insights.
+
+      :type: bool
+
+    .. attribute:: is_hosting_provider
+
+      This is true if the IP address belongs to a hosting provider.
+      This attribute is only available from GeoIP2 Precision Insights.
+
+      :type: bool
+
     .. attribute:: is_legitimate_proxy
 
       This attribute is true if MaxMind believes this IP address to be a
@@ -538,6 +559,13 @@ class Traits(Record):
 
       :type: bool
 
+    .. attribute:: is_public_proxy
+
+      This is true if the IP address belongs to a public proxy. This attribute
+      is only available from GeoIP2 Precision Insights.
+
+      :type: bool
+
     .. attribute:: is_satellite_provider
 
       This is true if the IP address is from a satellite provider that
@@ -551,6 +579,13 @@ class Traits(Record):
         output does not provide sufficiently relevant data for us to maintain
         it.
 
+    .. attribute:: is_tor_exit_node
+
+      This is true if the IP address is a Tor exit node.  This attribute is
+      only available from GeoIP2 Precision Insights.
+
+      :type: bool
+
     .. attribute:: isp
 
       The name of the ISP associated with the IP address. This attribute is
@@ -597,15 +632,23 @@ class Traits(Record):
 
     _valid_attributes = set([
         'autonomous_system_number', 'autonomous_system_organization',
-        'connection_type', 'domain', 'is_anonymous_proxy',
-        'is_legitimate_proxy', 'is_satellite_provider', 'isp', 'ip_address',
-        'organization', 'user_type'
+        'connection_type', 'domain', 'is_anonymous', 'is_anonymous_proxy',
+        'is_anonymous_vpn', 'is_hosting_provider', 'is_legitimate_proxy',
+        'is_public_proxy', 'is_satellite_provider', 'is_tor_exit_node',
+        'is_satellite_provider', 'isp', 'ip_address', 'organization',
+        'user_type'
     ])
 
     def __init__(self, **kwargs):
         for k in [
-                'is_anonymous_proxy', 'is_legitimate_proxy',
-                'is_satellite_provider'
+                'is_anonymous',
+                'is_anonymous_proxy',
+                'is_anonymous_vpn',
+                'is_hosting_provider',
+                'is_legitimate_proxy',
+                'is_public_proxy',
+                'is_satellite_provider',
+                'is_tor_exit_node',
         ]:
             kwargs[k] = bool(kwargs.get(k, False))
         super(Traits, self).__init__(**kwargs)

tests/models_test.py

@@ -90,8 +90,13 @@ def test_insights_full(self):
                 'autonomous_system_organization': 'AS Organization',
                 'domain': 'example.com',
                 'ip_address': '1.2.3.4',
-                'is_anonymous_proxy': 0,
-                'is_us_military': 1,
+                'is_anonymous': True,
+                'is_anonymous_proxy': True,
+                'is_anonymous_vpn': True,
+                'is_hosting_provider': True,
+                'is_public_proxy': True,
+                'is_satellite_provider': True,
+                'is_tor_exit_node': True,
                 'isp': 'Comcast',
                 'network_speed': 'cable/DSL',
                 'organization': 'Blorg',
@@ -169,6 +174,14 @@ def test_insights_full(self):
                          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)
+
     def test_insights_min(self):
         model = geoip2.models.Insights({'traits': {'ip_address': '5.6.7.8'}})
         self.assertEqual(