Add support for is_residential_proxy

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+2.11.0
+-------------------
+
+* Added the `isResidentialProxy` property to `GeoIp2\Model\AnonymousIP` and
+  `GeoIp2\Record\Traits`.
+
 2.10.0 (2019-12-12)
 -------------------
 

maxmind-db

@@ -17,6 +17,8 @@
  *     to a hosting or VPN provider (see description of isAnonymousVpn property).
  * @property-read bool $isPublicProxy This is true if the IP address belongs to
  *     a public proxy.
+ * @property-read bool $isResidentialProxy This is true if the IP address is
+ *     on a suspected anonymizing network and belongs to a residential ISP.
  * @property-read bool $isTorExitNode This is true if the IP address is a Tor
  *     exit node.
  * @property-read string $ipAddress The IP address that the data in the model is
@@ -31,6 +33,7 @@ class AnonymousIp extends AbstractModel
     protected $isAnonymousVpn;
     protected $isHostingProvider;
     protected $isPublicProxy;
+    protected $isResidentialProxy;
     protected $isTorExitNode;
     protected $ipAddress;
     protected $network;
@@ -48,6 +51,7 @@ public function __construct($raw)
         $this->isAnonymousVpn = $this->get('is_anonymous_vpn');
         $this->isHostingProvider = $this->get('is_hosting_provider');
         $this->isPublicProxy = $this->get('is_public_proxy');
+        $this->isResidentialProxy = $this->get('is_residential_proxy');
         $this->isTorExitNode = $this->get('is_tor_exit_node');
         $ipAddress = $this->get('ip_address');
         $this->ipAddress = $ipAddress;

src/Model/AnonymousIp.php

@@ -56,6 +56,9 @@
  * @property-read bool $isPublicProxy This is true if the IP address belongs to
  * a public proxy. This property is only available from GeoIP2 Precision
  * Insights.
+ * @property-read bool $isResidentialProxy This is true if the IP address is
+ * on a suspected anonymizing network and belongs to a residential ISP. This
+ * property is only available from GeoIP2 Precision Insights.
  * @property-read bool $isSatelliteProvider *Deprecated.* Due to the
  * increased coverage by mobile carriers, very few satellite providers now
  * serve multiple countries. As a result, the output does not provide
@@ -120,6 +123,7 @@ class Traits extends AbstractRecord
         'isLegitimateProxy',
         'isp',
         'isPublicProxy',
+        'isResidentialProxy',
         'isSatelliteProvider',
         'isTorExitNode',
         'network',

src/Record/Traits.php

@@ -136,12 +136,30 @@ public function testAnonymousIp()
         $this->assertTrue($record->isAnonymousVpn);
         $this->assertFalse($record->isHostingProvider);
         $this->assertFalse($record->isPublicProxy);
+        $this->assertFalse($record->isResidentialProxy);
         $this->assertFalse($record->isTorExitNode);
         $this->assertSame($ipAddress, $record->ipAddress);
         $this->assertSame('1.2.0.0/16', $record->network);
         $reader->close();
     }
 
+    public function testAnonymousIpAllTrue()
+    {
+        $reader = new Reader('maxmind-db/test-data/GeoIP2-Anonymous-IP-Test.mmdb');
+        $ipAddress = '81.2.69.1';
+
+        $record = $reader->anonymousIp($ipAddress);
+        $this->assertTrue($record->isAnonymous);
+        $this->assertTrue($record->isAnonymousVpn);
+        $this->assertTrue($record->isHostingProvider);
+        $this->assertTrue($record->isPublicProxy);
+        $this->assertTrue($record->isResidentialProxy);
+        $this->assertTrue($record->isTorExitNode);
+        $this->assertSame($ipAddress, $record->ipAddress);
+        $this->assertSame('81.2.69.0/24', $record->network);
+        $reader->close();
+    }
+
     public function testAsn()
     {
         $reader = new Reader('maxmind-db/test-data/GeoLite2-ASN-Test.mmdb');

tests/GeoIp2/Test/Database/ReaderTest.php

@@ -70,6 +70,7 @@ public function testFull()
                 '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',
@@ -168,6 +169,11 @@ public function testFull()
             '$model->traits->isPublicProxy is true'
         );
 
+        $this->assertTrue(
+            $model->traits->isResidentialProxy,
+            '$model->traits->isResidentialProxy is true'
+        );
+
         $this->assertTrue(
             $model->traits->isSatelliteProvider,
             '$model->traits->isSatelliteProvider is true'