[API-7343] Enable scores percentiles in the scores api. (#100)

Enable scores percentiles in the scores api

Author: mjouahri-sift

sift/client.py

@@ -180,8 +180,7 @@ def track(
             params['force_workflow_run'] = 'true'
 
         if include_score_percentiles:
-            field_types = ['SCORE_PERCENTILES']
-            params['fields'] = ','.join(field_types)
+            params['fields'] = 'SCORE_PERCENTILES'
         try:
             response = self.session.post(
                 path,
@@ -193,7 +192,7 @@ def track(
         except requests.exceptions.RequestException as e:
             raise ApiException(str(e), path)
 
-    def score(self, user_id, timeout=None, abuse_types=None, version=None):
+    def score(self, user_id, timeout=None, abuse_types=None, version=None, include_score_percentiles=False):
         """Retrieves a user's fraud score from the Sift Science API.
         This call is blocking.  Check out https://siftscience.com/resources/references/score_api.html
         for more information on our Score response structure.
@@ -210,6 +209,9 @@ def score(self, user_id, timeout=None, abuse_types=None, version=None):
 
             version(optional): Use a different version of the Sift Science API for this call.
 
+            include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
+                if include_score_percentiles is true then add a new parameter called fields in the query parameter
+
         Returns:
             A sift.client.Response object if the score call succeeded, or raises
             an ApiException.
@@ -227,6 +229,9 @@ def score(self, user_id, timeout=None, abuse_types=None, version=None):
         if abuse_types:
             params['abuse_types'] = ','.join(abuse_types)
 
+        if include_score_percentiles:
+            params['fields'] = 'SCORE_PERCENTILES'
+
         url = self._score_url(user_id, version)
 
         try:
@@ -239,7 +244,7 @@ def score(self, user_id, timeout=None, abuse_types=None, version=None):
         except requests.exceptions.RequestException as e:
             raise ApiException(str(e), url)
 
-    def get_user_score(self, user_id, timeout=None, abuse_types=None):
+    def get_user_score(self, user_id, timeout=None, abuse_types=None, include_score_percentiles=False):
         """Fetches the latest score(s) computed for the specified user and abuse types from the Sift Science API.
         As opposed to client.score() and client.rescore_user(), this *does not* compute a new score for the user; it
         simply fetches the latest score(s) which have computed. These scores may be arbitrarily old.
@@ -256,6 +261,9 @@ def get_user_score(self, user_id, timeout=None, abuse_types=None):
                  should be returned (if scores were requested).  If not specified, a score will
                  be returned for every abuse_type to which you are subscribed.
 
+            include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
+                if include_score_percentiles is true then add a new parameter called fields in the query parameter
+
         Returns:
             A sift.client.Response object if the score call succeeded, or raises
             an ApiException.
@@ -271,6 +279,9 @@ def get_user_score(self, user_id, timeout=None, abuse_types=None):
         if abuse_types:
             params['abuse_types'] = ','.join(abuse_types)
 
+        if include_score_percentiles:
+            params['fields'] = 'SCORE_PERCENTILES'
+
         try:
             response = self.session.get(
                 url,

tests/test_client.py

@@ -1411,7 +1411,7 @@ def test_update_psp_merchant_profile(self):
             self.assertIsInstance(response, sift.client.Response)
             assert ('address' in response.body)
 
-    def test_with__include_score_percentiles_ok(self):
+    def test_with_include_score_percentiles_ok(self):
         event = '$transaction'
         mock_response = mock.Mock()
         mock_response.content = '{"status": 0, "error_message": "OK"}'
@@ -1453,6 +1453,51 @@ def test_include_score_percentiles_as_false_ok(self):
             assert (response.api_status == 0)
             assert (response.api_error_message == "OK")
 
+    def test_score_api_include_score_percentiles_ok(self):
+        mock_response = mock.Mock()
+        mock_response.content = score_response_json()
+        mock_response.json.return_value = json.loads(mock_response.content)
+        mock_response.status_code = 200
+        mock_response.headers = response_with_data_header()
+        with mock.patch.object(self.sift_client.session, 'get') as mock_get:
+            mock_get.return_value = mock_response
+            response = self.sift_client.score(user_id='12345', include_score_percentiles=True)
+            mock_get.assert_called_with(
+                'https://api.siftscience.com/v205/score/12345',
+                params={'api_key': self.test_key, 'fields': 'SCORE_PERCENTILES'},
+                headers=mock.ANY,
+                timeout=mock.ANY)
+            self.assertIsInstance(response, sift.client.Response)
+            assert (response.is_ok())
+            assert (response.api_error_message == "OK")
+            assert (response.body['score'] == 0.85)
+            assert (response.body['scores']['content_abuse']['score'] == 0.14)
+            assert (response.body['scores']['payment_abuse']['score'] == 0.97)
+
+    def test_get_user_score_include_score_percentiles_ok(self):
+        """Test the GET /{version}/users/{userId}/score API, i.e. client.get_user_score()
+        """
+        test_timeout = 5
+        mock_response = mock.Mock()
+        mock_response.content = USER_SCORE_RESPONSE_JSON
+        mock_response.json.return_value = json.loads(mock_response.content)
+        mock_response.status_code = 200
+        mock_response.headers = response_with_data_header()
+        with mock.patch.object(self.sift_client.session, 'get') as mock_get:
+            mock_get.return_value = mock_response
+            response = self.sift_client.get_user_score(user_id='12345', timeout=test_timeout, include_score_percentiles=True)
+            mock_get.assert_called_with(
+                'https://api.siftscience.com/v205/users/12345/score',
+                params={'api_key': self.test_key, 'fields': 'SCORE_PERCENTILES'},
+                headers=mock.ANY,
+                timeout=test_timeout)
+            self.assertIsInstance(response, sift.client.Response)
+            assert (response.is_ok())
+            assert (response.api_error_message == "OK")
+            assert (response.body['entity_id'] == '12345')
+            assert (response.body['scores']['content_abuse']['score'] == 0.14)
+            assert (response.body['scores']['payment_abuse']['score'] == 0.97)
+            assert ('latest_decisions' in response.body)
 
 def main():
     unittest.main()