Merge pull request #82 from maxmind/dlieou/static-ip-score

added static_ip_score to the API

Author: horgh

HISTORY.rst

@@ -15,7 +15,10 @@ History
 * Python 3.3 and 3.4 are no longer supported.
 * 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 support for the ``user_count`` trait for the GeoIP2 Precision webservice.
+* Added the ``static_ip_score`` attribute to ``geoip2.record.Traits`` for
+  GeoIP2 Precision Insights. This is a float which indicates how static or dynamic
+  an IP address is.
 
 2.9.0 (2018-05-25)
 ++++++++++++++++++

docs/conf.py

@@ -47,7 +47,7 @@
 
 # General information about the project.
 project = 'geoip2'
-copyright = '2013-2018, MaxMind, Inc.'
+copyright = '2013-2019, MaxMind, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/index.rst

@@ -38,6 +38,6 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-:copyright: (c) 2013-2018 by MaxMind, Inc.
+:copyright: (c) 2013-2019 by MaxMind, Inc.
 :license: Apache License, Version 2.0
 

geoip2/__init__.py

@@ -4,4 +4,4 @@
 __version__ = '2.9.0'
 __author__ = 'Gregory Oschwald'
 __license__ = 'Apache License, Version 2.0'
-__copyright__ = 'Copyright (c) 2013-2018 Maxmind, Inc.'
+__copyright__ = 'Copyright (c) 2013-2019 Maxmind, Inc.'

geoip2/records.py

@@ -684,6 +684,20 @@ 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. This attribute is only available from GeoIP2
+      Precision Insights.
+
+      :type: float
+
     .. attribute:: user_count
 
       The estimated number of users sharing the IP/network during the past 24
@@ -738,6 +752,7 @@ def __init__(self,
                  network=None,
                  organization=None,
                  prefix_len=None,
+                 static_ip_score=None,
                  user_count=None,
                  user_type=None,
                  **_):
@@ -755,6 +770,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,8 @@ 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):