(Gary L.) Adding Content-level decisions, incrementing version number (#56)

* Squashed commits, added get content decision status, and incremented python version

* Added updated content decision status request

* Updated README

* Removed a new line

Author: admiral-akk

CHANGES.md

@@ -1,3 +1,9 @@
+4.0.0.0 2018-02-23
+==================
+
+-   V205 APIs are now called by default -- this is an incompatible change
+    (use version='204' to call the previous API version)
+
 3.2.0.0 2018-02-12
 ==================
 

README.md

@@ -143,6 +143,14 @@ try:
 except sift.client.ApiException:
   # request failed
 
+
+
+# Get the latest decisions for a piece of content
+try:
+  response = client.get_content_decisions('example_user', 'example_content');
+except sift.client.ApiException:
+  # request failed
+
 ```
 
 

sift/client.py

@@ -318,7 +318,7 @@ def get_decisions(self, entity_type, limit=None, start_from=None, abuse_types=No
         """Get decisions available to customer
 
         Args:
-            entity_type: only return decisions applicable to entity type {USER|ORDER|SESSION}
+            entity_type: only return decisions applicable to entity type {USER|ORDER|SESSION|CONTENT}
             limit: number of query results (decisions) to return [optional, default: 100]
             start_from: result set offset for use in pagination [optional, default: 0]
             abuse_types: comma-separated list of abuse_types used to filter returned decisions (optional)
@@ -334,8 +334,8 @@ def get_decisions(self, entity_type, limit=None, start_from=None, abuse_types=No
         params = {}
 
         if not isinstance(entity_type, self.UNICODE_STRING) or len(entity_type.strip()) == 0 \
-                or entity_type.lower() not in ['user', 'order', 'session']:
-            raise ApiException("entity_type must be one of {user, order, session}")
+                or entity_type.lower() not in ['user', 'order', 'session', 'content']:
+            raise ApiException("entity_type must be one of {user, order, session, content}")
 
         params['entity_type'] = entity_type
 
@@ -502,6 +502,38 @@ def get_order_decisions(self, order_id, timeout=None):
             raise ApiException(str(e))
 
 
+    def get_content_decisions(self, user_id, content_id, timeout=None):
+        """Gets the decisions for a piece of content.
+
+        Args:
+            user_id: The ID of the owner of the content.
+            content_id: The ID of a piece of content.
+
+        Returns:
+            A sift.client.Response object if the call succeeded.
+            Otherwise, raises an ApiException.
+
+        """
+        if not isinstance(content_id, self.UNICODE_STRING) or len(content_id.strip()) == 0:
+            raise ApiException("content_id must be a string")
+
+        if not isinstance(user_id, self.UNICODE_STRING) or len(user_id.strip()) == 0:
+            raise ApiException("user_id must be a string")
+
+        if timeout is None:
+            timeout = self.timeout
+
+        try:
+            return Response(requests.get(
+                self._content_decisions_url(self.account_id, user_id, content_id),
+                auth=requests.auth.HTTPBasicAuth(self.api_key, ''),
+                headers={'User-Agent': self._user_agent()},
+                timeout=timeout))
+
+        except requests.exceptions.RequestException as e:
+            raise ApiException(str(e))
+
+
     def apply_session_decision(self, user_id, session_id, properties, timeout=None):
         """Apply decision to session
 
@@ -542,6 +574,46 @@ def apply_session_decision(self, user_id, session_id, properties, timeout=None):
             raise ApiException(str(e))
 
 
+    def apply_content_decision(self, user_id, content_id, properties, timeout=None):
+        """Apply decision to content
+
+        Args:
+            user_id: id of user
+            content_id: id of content
+            properties:
+                decision_id: decision to apply to session
+                source: {one of MANUAL_REVIEW | AUTOMATED_RULE | CHARGEBACK}
+                analyst: id or email, required if 'source: MANUAL_REVIEW'
+                description: free form text (optional)
+                time: in millis when decision was applied (optional)
+        Returns
+            A sift.client.Response object if the call succeeded, else raises an ApiException
+        """
+
+        if timeout is None:
+            timeout = self.timeout
+
+
+        if content_id is None or not isinstance(content_id, self.UNICODE_STRING) or \
+                        len(content_id.strip()) == 0:
+            raise ApiException("content_id must be a string")
+
+        self._validate_apply_decision_request(properties, user_id)
+
+        try:
+            return Response(requests.post(
+                self._content_apply_decisions_url(self.account_id, user_id, content_id),
+                data=json.dumps(properties),
+                auth=requests.auth.HTTPBasicAuth(self.api_key, ''),
+                headers={'Content-type': 'application/json',
+                         'Accept': '*/*',
+                         'User-Agent': self._user_agent()},
+                timeout=timeout))
+
+        except requests.exceptions.RequestException as e:
+            raise ApiException(str(e))
+
+
     def _user_agent(self):
         return 'SiftScience/v%s sift-python/%s' % (sift.version.API_VERSION, sift.version.VERSION)
 
@@ -566,12 +638,18 @@ def _user_decisions_url(self, account_id, user_id):
     def _order_decisions_url(self, account_id, order_id):
         return API3_URL + '/v3/accounts/%s/orders/%s/decisions' % (account_id, order_id)
 
+    def _content_decisions_url(self, account_id, user_id, content_id):
+        return API3_URL + '/v3/accounts/%s/users/%s/content/%s/decisions' % (account_id, user_id, content_id)
+
     def _order_apply_decisions_url(self, account_id, user_id, order_id):
         return API3_URL + '/v3/accounts/%s/users/%s/orders/%s/decisions' % (account_id, user_id, order_id)
 
     def _session_apply_decisions_url(self, account_id, user_id, session_id):
         return API3_URL + '/v3/accounts/%s/users/%s/sessions/%s/decisions' % (account_id, user_id, session_id)
 
+    def _content_apply_decisions_url(self, account_id, user_id, content_id):
+        return API3_URL + '/v3/accounts/%s/users/%s/content/%s/decisions' % (account_id, user_id, content_id)
+
 class Response(object):
 
     HTTP_CODES_WITHOUT_BODY = [204, 304]

sift/version.py

@@ -1,2 +1,2 @@
-VERSION = '3.2.0.0'
-API_VERSION = '204'
+VERSION = '4.0.0.0'
+API_VERSION = '205'

tests/test_client.py

@@ -189,7 +189,7 @@ def test_event_ok(self):
             mock_post.return_value = mock_response
             response = self.sift_client.track(event, valid_transaction_properties())
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/events',
+                'https://api.siftscience.com/v205/events',
                 data=mock.ANY,
                 headers=mock.ANY,
                 timeout=mock.ANY,
@@ -212,7 +212,7 @@ def test_event_with_timeout_param_ok(self):
             response = self.sift_client.track(
                 event, valid_transaction_properties(), timeout=test_timeout)
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/events',
+                'https://api.siftscience.com/v205/events',
                 data=mock.ANY,
                 headers=mock.ANY,
                 timeout=test_timeout,
@@ -232,7 +232,7 @@ def test_score_ok(self):
             mock_post.return_value = mock_response
             response = self.sift_client.score('12345')
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/score/12345',
+                'https://api.siftscience.com/v205/score/12345',
                 params={'api_key': self.test_key},
                 headers=mock.ANY,
                 timeout=mock.ANY)
@@ -254,7 +254,7 @@ def test_score_with_timeout_param_ok(self):
             mock_post.return_value = mock_response
             response = self.sift_client.score('12345', test_timeout)
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/score/12345',
+                'https://api.siftscience.com/v205/score/12345',
                 params={'api_key': self.test_key},
                 headers=mock.ANY,
                 timeout=test_timeout)
@@ -281,7 +281,7 @@ def test_sync_score_ok(self):
                 return_score=True,
                 abuse_types=['payment_abuse', 'content_abuse', 'legacy'])
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/events',
+                'https://api.siftscience.com/v205/events',
                 data=mock.ANY,
                 headers=mock.ANY,
                 timeout=mock.ANY,
@@ -452,6 +452,12 @@ def test_apply_decision_to_session_fails_with_no_session_id(self):
         except Exception as e:
             assert(isinstance(e, sift.client.ApiException))
 
+    def test_apply_decision_to_content_fails_with_no_content_id(self):
+        try:
+            self.sift_client.apply_content_decision("user_id", None, {})
+        except Exception as e:
+            assert(isinstance(e, sift.client.ApiException))
+
     def test_validate_apply_decision_request_no_analyst_fails(self):
         apply_decision_request = {
             'decision_id': 'user_looks_ok_legacy',
@@ -610,6 +616,42 @@ def test_apply_decision_to_session_ok(self):
             assert(response.http_status_code == 200)
             assert(response.body['entity']['type'] == 'login')
 
+    def test_apply_decision_to_content_ok(self):
+        user_id = '54321'
+        content_id = 'listing-1231'
+        mock_response = mock.Mock()
+        apply_decision_request = {
+                'decision_id': 'content_looks_bad_content_abuse',
+                'source': 'AUTOMATED_RULE',
+                'time': 1481569575
+            }
+
+        apply_decision_response_json = '{' \
+                                    '"entity": {' \
+                                        '"id": "54321",' \
+                                        '"type": "create_content"'    \
+                                    '},' \
+                                    '"decision": {' \
+                                        '"id":"content_looks_bad_content_abuse"' \
+                                    '},' \
+                                    '"time":"1481569575"}'
+
+        mock_response.content = apply_decision_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('requests.post') as mock_post:
+            mock_post.return_value = mock_response
+            response = self.sift_client.apply_content_decision(user_id, content_id, apply_decision_request)
+            data = json.dumps(apply_decision_request)
+            mock_post.assert_called_with(
+                'https://api3.siftscience.com/v3/accounts/ACCT/users/%s/content/%s/decisions' % (user_id,content_id),
+                auth=mock.ANY, data=data, headers=mock.ANY, timeout=mock.ANY)
+            assert(isinstance(response, sift.client.Response))
+            assert(response.is_ok())
+            assert(response.http_status_code == 200)
+            assert(response.body['entity']['type'] == 'create_content')
+
     def test_label_user_ok(self):
         user_id = '54321'
         mock_response = mock.Mock()
@@ -630,7 +672,7 @@ def test_label_user_ok(self):
             properties.update({'$api_key': self.test_key, '$type': '$label'})
             data = json.dumps(properties)
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/users/%s/labels' % user_id,
+                'https://api.siftscience.com/v205/users/%s/labels' % user_id,
                 data=data, headers=mock.ANY, timeout=mock.ANY, params={})
             assert(isinstance(response, sift.client.Response))
             assert(response.is_ok())
@@ -659,7 +701,7 @@ def test_label_user_with_timeout_param_ok(self):
             properties.update({'$api_key': self.test_key, '$type': '$label'})
             data = json.dumps(properties)
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/users/%s/labels' % user_id,
+                'https://api.siftscience.com/v205/users/%s/labels' % user_id,
                 data=data, headers=mock.ANY, timeout=test_timeout, params={})
             assert(isinstance(response, sift.client.Response))
             assert(response.is_ok())
@@ -674,7 +716,7 @@ def test_unlabel_user_ok(self):
             mock_delete.return_value = mock_response
             response = self.sift_client.unlabel(user_id, abuse_type='account_abuse')
             mock_delete.assert_called_with(
-                'https://api.siftscience.com/v204/users/%s/labels' % user_id,
+                'https://api.siftscience.com/v205/users/%s/labels' % user_id,
                 headers=mock.ANY,
                 timeout=mock.ANY,
                 params={'api_key': self.test_key, 'abuse_type': 'account_abuse'})
@@ -714,7 +756,7 @@ def test_unlabel_user_with_special_chars_ok(self):
             mock_delete.return_value = mock_response
             response = self.sift_client.unlabel(user_id)
             mock_delete.assert_called_with(
-                'https://api.siftscience.com/v204/users/%s/labels' % urllib.quote(user_id),
+                'https://api.siftscience.com/v205/users/%s/labels' % urllib.quote(user_id),
                 headers=mock.ANY,
                 timeout=mock.ANY,
                 params={'api_key': self.test_key})
@@ -742,7 +784,7 @@ def test_label_user__with_special_chars_ok(self):
             properties.update({'$api_key': self.test_key, '$type': '$label'})
             data = json.dumps(properties)
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/users/%s/labels' % urllib.quote(user_id),
+                'https://api.siftscience.com/v205/users/%s/labels' % urllib.quote(user_id),
                 data=data,
                 headers=mock.ANY,
                 timeout=mock.ANY,
@@ -763,7 +805,7 @@ def test_score__with_special_user_id_chars_ok(self):
             mock_post.return_value = mock_response
             response = self.sift_client.score(user_id, abuse_types=['legacy'])
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/score/%s' % urllib.quote(user_id),
+                'https://api.siftscience.com/v205/score/%s' % urllib.quote(user_id),
                 params={'api_key': self.test_key, 'abuse_types': 'legacy'},
                 headers=mock.ANY,
                 timeout=mock.ANY)
@@ -820,7 +862,7 @@ def test_return_actions_on_track(self):
             response = self.sift_client.track(
                 event, valid_transaction_properties(), return_action=True)
             mock_post.assert_called_with(
-                'https://api.siftscience.com/v204/events',
+                'https://api.siftscience.com/v205/events',
                 data=mock.ANY,
                 headers=mock.ANY,
                 timeout=mock.ANY,
@@ -895,6 +937,24 @@ def test_get_order_decisions(self):
             assert(response.body['decisions']['payment_abuse']['decision']['id'] == 'decision7')
             assert(response.body['decisions']['promotion_abuse']['decision']['id'] == 'good_order')
 
+    def test_get_content_decisions(self):
+        mock_response = mock.Mock()
+        mock_response.content = '{"decisions":{"content_abuse":{"decision":{"id":"content_looks_bad_content_abuse"},"time":1468517407135,"webhook_succeeded":true}}}'
+        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('requests.get') as mock_get:
+            mock_get.return_value = mock_response
+
+            response = self.sift_client.get_content_decisions('example_user', 'example_content')
+            mock_get.assert_called_with(
+                'https://api3.siftscience.com/v3/accounts/ACCT/users/example_user/content/example_content/decisions',
+                headers=mock.ANY, auth=mock.ANY, timeout=mock.ANY)
+
+            assert(isinstance(response, sift.client.Response))
+            assert(response.is_ok())
+            assert(response.body['decisions']['content_abuse']['decision']['id'] == 'content_looks_bad_content_abuse')
 
 def main():
     unittest.main()