Add is_residential_proxy

Author: oschwald

HISTORY.rst

@@ -3,6 +3,12 @@
 History
 -------
 
+4.1.0
+++++++++++++++++++
+
+* Added the ``is_residential_proxy`` attribute to ``geoip2.model.AnonymousIP``
+  and ``geoip2.record.Traits``.
+
 4.0.2 (2020-07-28)
 ++++++++++++++++++
 

README.rst

@@ -229,6 +229,8 @@ Anonymous IP Database
     False
     >>>     response.is_public_proxy
     False
+    >>>     response.is_residential_proxy
+    False
     >>>     response.is_tor_exit_node
     True
     >>>     response.ip_address

geoip2/models.py

@@ -396,6 +396,13 @@ class AnonymousIP(SimpleModel):
 
       :type: bool
 
+    .. attribute:: is_residential_proxy
+
+      This is true if the IP address is on a suspected anonymizing network
+      and belongs to a residential ISP.
+
+      :type: bool
+
     .. attribute:: is_tor_exit_node
 
       This is true if the IP address is a Tor exit node.
@@ -421,6 +428,7 @@ class AnonymousIP(SimpleModel):
     is_anonymous_vpn: bool
     is_hosting_provider: bool
     is_public_proxy: bool
+    is_residential_proxy: bool
     is_tor_exit_node: bool
 
     def __init__(self, raw: Dict[str, bool]) -> None:
@@ -429,6 +437,7 @@ def __init__(self, raw: Dict[str, bool]) -> None:
         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_residential_proxy = raw.get("is_residential_proxy", False)
         self.is_tor_exit_node = raw.get("is_tor_exit_node", False)
 
 

geoip2/records.py

@@ -693,6 +693,14 @@ class Traits(Record):
 
       :type: bool
 
+    .. attribute:: is_residential_proxy
+
+      This is true if the IP address is on a suspected anonymizing network
+      and belongs to a residential ISP.
+
+      :type: bool
+
+
     .. attribute:: is_satellite_provider
 
       This is true if the IP address is from a satellite provider that
@@ -798,6 +806,7 @@ class Traits(Record):
     is_hosting_provider: bool
     is_legitimate_proxy: bool
     is_public_proxy: bool
+    is_residential_proxy: bool
     is_satellite_provider: bool
     is_tor_exit_node: bool
     isp: Optional[str]
@@ -821,6 +830,7 @@ def __init__(
         is_hosting_provider: bool = False,
         is_legitimate_proxy: bool = False,
         is_public_proxy: bool = False,
+        is_residential_proxy: bool = False,
         is_satellite_provider: bool = False,
         is_tor_exit_node: bool = False,
         isp: Optional[str] = None,
@@ -843,6 +853,7 @@ def __init__(
         self.is_hosting_provider = is_hosting_provider
         self.is_legitimate_proxy = is_legitimate_proxy
         self.is_public_proxy = is_public_proxy
+        self.is_residential_proxy = is_residential_proxy
         self.is_satellite_provider = is_satellite_provider
         self.is_tor_exit_node = is_tor_exit_node
         self.isp = isp

tests/data

@@ -66,11 +66,29 @@ def test_anonymous_ip(self) -> None:
         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_residential_proxy, False)
         self.assertEqual(record.is_tor_exit_node, False)
         self.assertEqual(record.ip_address, ip_address)
         self.assertEqual(record.network, ipaddress.ip_network("1.2.0.0/16"))
         reader.close()
 
+    def test_anonymous_ip_all_set(self) -> None:
+        reader = geoip2.database.Reader(
+            "tests/data/test-data/GeoIP2-Anonymous-IP-Test.mmdb"
+        )
+        ip_address = "81.2.69.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, True)
+        self.assertEqual(record.is_public_proxy, True)
+        self.assertEqual(record.is_residential_proxy, True)
+        self.assertEqual(record.is_tor_exit_node, True)
+        self.assertEqual(record.ip_address, ip_address)
+        self.assertEqual(record.network, ipaddress.ip_network("81.2.69.0/24"))
+        reader.close()
+
     def test_asn(self) -> None:
         reader = geoip2.database.Reader("tests/data/test-data/GeoLite2-ASN-Test.mmdb")
 

tests/database_test.py

@@ -79,6 +79,7 @@ def test_insights_full(self) -> None:
                 "is_anonymous_vpn": True,
                 "is_hosting_provider": True,
                 "is_public_proxy": True,
+                "is_residential_proxy": True,
                 "is_satellite_provider": True,
                 "is_tor_exit_node": True,
                 "isp": "Comcast",
@@ -194,6 +195,7 @@ def test_insights_full(self) -> None:
         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_residential_proxy, True)
         self.assertIs(model.traits.is_satellite_provider, True)
         self.assertIs(model.traits.is_tor_exit_node, True)
         self.assertEqual(model.traits.user_count, 2)