added static_ip_score to the API

Author: dlieou

HISTORY.rst

@@ -16,6 +16,7 @@ History
 * Updated documentation of anonymizer attributes - ``is_anonymous_vpn`` and
   ``is_hosting_provider`` - to be more descriptive.
 * Added support for ``user_count`` trait for the GeoIP2 Precision webservice.
+* Added ``static_ip_score`` property to ``geoip2.record.Traits`` for GeoIP2 Precision Insights.
 
 2.9.0 (2018-05-25)
 ++++++++++++++++++

geoip2/records.py

@@ -684,6 +684,19 @@ class Traits(Record):
 
       :type: unicode
 
+    .. attribute:: static_ip_score
+
+      An indicator of how static or dynamic an IP address is. The value ranges
+      from 0 to 99.99 with higher values meaning a greater static association. 
+      For example, many IP addresses with a user_type of cellular have a 
+      lifetime under one. Static Cable/DSL IPs typically have a lifetime above
+      thirty. 
+
+      This indicator can be useful for deciding whether an IP address represents
+      the same user over time.
+
+      :type: decimal 
+
     .. attribute:: user_count
 
       The estimated number of users sharing the IP/network during the past 24
@@ -738,6 +751,7 @@ def __init__(self,
                  network=None,
                  organization=None,
                  prefix_len=None,
+                 static_ip_score=None,
                  user_count=None,
                  user_type=None,
                  **_):
@@ -755,6 +769,7 @@ def __init__(self,
         self.is_tor_exit_node = is_tor_exit_node
         self.isp = isp
         self.organization = organization
+        self.static_ip_score = static_ip_score
         self.user_type = user_type
         self.user_count = user_count
         self.ip_address = ip_address

tests/models_test.py

@@ -104,6 +104,7 @@ def test_insights_full(self):
                 'isp': 'Comcast',
                 'network_speed': 'cable/DSL',
                 'organization': 'Blorg',
+                'static_ip_score': 1.3,
                 'user_count': 2,
                 'user_type': 'college',
             },
@@ -183,8 +184,8 @@ def test_insights_full(self):
         self.assertIs(model.traits.is_public_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)
+        self.assertEqual(model.traits.static_ip_score, 1.3)
 
     def test_insights_min(self):
         model = geoip2.models.Insights({'traits': {'ip_address': '5.6.7.8'}})

tests/webservice_test.py

@@ -64,6 +64,7 @@ def setUp(self):
     # JSON from the server
     insights = copy.deepcopy(country)
     insights['traits']['user_count'] = 2
+    insights['traits']['static_ip_score'] = 1.3
 
     def _content_type(self, endpoint):
         return ('application/vnd.maxmind.com-' + endpoint +
@@ -290,6 +291,7 @@ def test_insights_ok(self, mock):
                          'return value of client.insights')
         self.assertEqual(insights.traits.network,
                          compat_ip_network('1.2.3.0/24'), 'network')
+        self.assertEqual(insights.traits.static_ip_score, 1.3, 'static_ip_score is 1.3')
         self.assertEqual(insights.traits.user_count, 2, 'user_count is 2')
 
     def test_named_constructor_args(self):