Merge pull request maxmind#17 from maxmind/greg/anonymous-ip

Add support for Anonymous IP databases

Author: autarch

README.rst

@@ -151,6 +151,33 @@ City Database
     -93.2323
     >>> reader.close()
 
+Anonymous IP Database
+^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: pycon
+
+    >>> import geoip2.database
+    >>>
+    >>> # This creates a Reader object. You should use the same object
+    >>> # across multiple requests as creation of it is expensive.
+    >>> reader = geoip2.database.Reader('/path/to/GeoIP2-Anonymous-IP.mmdb')
+    >>>
+    >>> response = reader.anonymous_ip('85.25.43.84')
+    >>>
+    >>> response.is_anonymous
+    True
+    >>> response.is_anonymous_vpn
+    False
+    >>> response.is_hosting_provider
+    False
+    >>> response.is_public_proxy
+    False
+    >>> response.is_tor_exit_node
+    True
+    >>> response.ip_address
+    '128.101.101.101'
+    >>> reader.close()
+
 Connection-Type Database
 ^^^^^^^^^^^^^^^^^^^^^^^^
 

geoip2/database.py

@@ -67,6 +67,18 @@ def city(self, ip_address):
         """
         return self._model_for(geoip2.models.City, 'City', ip_address)
 
+    def anonymous_ip(self, ip_address):
+        """Get the AnonymousIP object for the IP address
+
+        :param ip_address: IPv4 or IPv6 address as a string.
+
+        :returns: :py:class:`geoip2.models.AnonymousIP` object
+
+        """
+        return self._flat_model_for(geoip2.models.AnonymousIP,
+                                    'GeoIP2-Anonymous-IP',
+                                    ip_address)
+
     def connection_type(self, ip_address):
         """Get the ConnectionType object for the IP address
 

geoip2/models.py

@@ -254,6 +254,60 @@ def __repr__(self):
             data=str(self.raw))
 
 
+class AnonymousIP(SimpleModel):
+
+    """Model class for the GeoIP2 Anonymous IP
+
+    This class provides the following attribute:
+
+    .. attribute:: is_anonymous
+
+      This is true if the IP address belongs to any sort of anonymous network.
+
+      :type: bool
+
+    .. attribute:: is_anonymous_vpn
+
+      This is true if the IP address belongs to an anonymous VPN system.
+
+      :type: bool
+
+    .. attribute:: is_hosting_provider
+
+      This is true if the IP address belongs to a hosting provider.
+
+      :type: bool
+
+    .. attribute:: is_public_proxy
+
+      This is true if the IP address belongs to a public proxy.
+
+      :type: bool
+
+    .. attribute:: is_tor_exit_node
+
+      This is true if the IP address is a Tor exit node.
+
+      :type: bool
+
+    .. attribute:: ip_address
+
+      The IP address used in the lookup.
+
+      :type: unicode
+    """
+
+    def __init__(self, raw):
+        self.is_anonymous = raw.get('is_anonymous', False)
+        self.is_anonymous_vpn = raw.get('is_anonymous_vpn', False)
+        self.is_hosting_provider = raw.get('is_hosting_provider', False)
+        self.is_public_proxy = raw.get('is_public_proxy', False)
+        self.is_tor_exit_node = raw.get('is_tor_exit_node', False)
+
+        self.ip_address = raw.get('ip_address')
+        self.raw = raw
+
+
 class ConnectionType(SimpleModel):
 
     """Model class for the GeoIP2 Connection-Type

tests/data

@@ -71,6 +71,20 @@ def test_invalid_address(self):
             reader.city('invalid')
         reader.close()
 
+    def test_anonymous_ip(self):
+        reader = geoip2.database.Reader(
+            'tests/data/test-data/GeoIP2-Anonymous-IP-Test.mmdb')
+        ip_address = '1.2.0.1'
+
+        record = reader.anonymous_ip(ip_address)
+        self.assertEqual(record.is_anonymous, True)
+        self.assertEqual(record.is_anonymous_vpn, True)
+        self.assertEqual(record.is_hosting_provider, False)
+        self.assertEqual(record.is_public_proxy, False)
+        self.assertEqual(record.is_tor_exit_node, False)
+        self.assertEqual(record.ip_address, ip_address)
+        reader.close()
+
     def test_connection_type(self):
         reader = geoip2.database.Reader(
             'tests/data/test-data/GeoIP2-Connection-Type-Test.mmdb')