Merge pull request #142 from maxmind/horgh/static-ip-score

Add static IP score support

Author: oschwald

CHANGELOG.md

@@ -13,6 +13,13 @@ CHANGELOG
   same value.
 * Updated documentation of anonymizer properties - `isAnonymousVpn`
   and `isHostingProvider` - to be more descriptive.
+* The `userCount` property was added to `GeoIp2\Record\Traits`. This is an
+  integer which indicates the estimated number of users sharing the
+  IP/network during the past 24 hours. This output is available from GeoIP2
+  Precision Insights.
+* The `staticIpScore` property was added to `GeoIp2\Record\Traits`. This is
+  a float which indicates how static or dynamic an IP address is. This
+  output is available from GeoIP2 Precision Insights.
 
 2.9.0 (2018-04-10)
 ------------------

src/Record/Traits.php

@@ -71,6 +71,9 @@
  * @property-read string|null $organization The name of the organization associated
  * with the IP address. This attribute is only available from the City and
  * Insights web services and the GeoIP2 Enterprise database.
+ * @property-read float|null $staticIPScore An indicator of how static or
+ * dynamic an IP address is. This property is only available from GeoIP2
+ * Precision Insights.
  * @property-read int|null $userCount The estimated number of users sharing
  * the IP/network during the past 24 hours. For IPv4, the count is for the
  * individual IP. For IPv6, the count is for the /64 network. This property is
@@ -121,6 +124,7 @@ class Traits extends AbstractRecord
         'isTorExitNode',
         'network',
         'organization',
+        'staticIpScore',
         'userCount',
         'userType',
     ];

tests/GeoIp2/Test/Model/InsightsTest.php

@@ -74,6 +74,7 @@ public function testFull()
                 'is_tor_exit_node' => true,
                 'isp' => 'Comcast',
                 'organization' => 'Blorg',
+                'static_ip_score' => 1.3,
                 'user_count' => 2,
                 'user_type' => 'college',
             ],
@@ -182,6 +183,12 @@ public function testFull()
             '$model->traits->isAnonymousProxy is false'
         );
 
+        $this->assertSame(
+            1.3,
+            $model->traits->staticIpScore,
+            'staticIPScore is correct'
+        );
+
         $this->assertSame(
             22,
             $model->maxmind->queriesRemaining,

tests/GeoIp2/Test/WebService/ClientTest.php

@@ -33,6 +33,7 @@ private function getResponse($service, $ipAddress)
     {
         if ($service === 'Insights') {
             $insights = unserialize(serialize($this->country));
+            $insights['traits']['static_ip_score'] = 1.3;
             $insights['traits']['user_count'] = 2;
 
             $responses = [
@@ -253,6 +254,12 @@ public function testInsights()
             'network'
         );
 
+        $this->assertSame(
+            1.3,
+            $record->traits->staticIpScore,
+            'staticIPScore is 1.3'
+        );
+
         $this->assertSame(
             2,
             $record->traits->userCount,