Evaluate json function in track_user_task (#17)

* Use codes from requests instead of constants

* Add try except block to track_user_task function

* Update Version and Readme

Author: brunoliveira8

README.md

@@ -13,21 +13,26 @@ Python client for [Crossengage's API](https://docs.crossengage.io)
 Library supports next methods:
 
 **User profile management**
- - `update_user(self, user)`
- - `delete_user(self, user)`
- - `delete_user_by_xng_id(self, user)`
+ - `get_user(self, user)` | v2
+ - `update_user(self, user)` | v1
+ - `update_user_async(self, user)` | v2
+ - `delete_user(self, user)` | v1
+ - `delete_user_async(self, user)` | v2
+ - `delete_user_by_xng_id(self, user)` | v1
+ - `track_user_task(self, tracking_id)` | v2
 
 **User attributes management**
-- `add_user_attribute(self, attribute_name, attribute_type, nested_type)`
-- `add_nested_user_attribute(self, parent_name, attribute_name, attribute_type)`
-- `list_user_attributes(self, offset, limit)`
-- `delete_user_attribute(self, attribute_id)`
+- `add_user_attribute(self, attribute_name, attribute_type, nested_type)` | v1
+- `add_nested_user_attribute(self, parent_name, attribute_name, attribute_type)` | v1
+- `list_user_attributes(self, offset, limit)` | v1
+- `delete_user_attribute(self, attribute_id)` | v1
 
 **Bulk user management**
-- `batch_process(self, delete_list=[], update_list=[])`
+- `batch_process(self, delete_list=[], update_list=[])` | v1
+- `batch_process_async(self, delete_list=[], update_list=[])` | v2
 
 **Events management**
-- `send_events(self, events, email=None, user_id=None, business_unit=None)`
+- `send_events(self, events, email=None, user_id=None, business_unit=None)` | v1
 
 ### Owner
 [Alexander Zhilyaev](mailto:azh@hellofresh.com)

crossengage/client.py

@@ -339,7 +339,12 @@ def track_user_task(self, tracking_id):
 
         r = self.requests.get(self.request_url, headers=headers)
 
-        return r.status_code, r.json()
+        try:
+            body = r.json()
+        except ValueError:
+            body = None
+
+        return r.status_code, body
 
     def __create_request(self, payload, request_type, version):
         headers = update_dict(self.default_headers, {self.API_VERSION_HEADER: self.API_VERSIONS[version]})

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 NAME = "crossengage-client"
-VERSION = "0.7.0"
+VERSION = "1.1.1"
 
 REQUIRES = []
 

tests/test_client.py

@@ -2,14 +2,14 @@
 import unittest
 
 from mock import Mock
-from requests import RequestException
+from requests import RequestException, codes
 
 from crossengage.client import CrossengageClient
 
 
 class DummyRequest(object):
     def __init__(self):
-        self.status_code = 200
+        self.status_code = codes.ok
         self.text = 'Some text'
         self.request = Mock()
 
@@ -32,7 +32,7 @@ def json():
 
 class DummyRequestException(object):
     def __init__(self):
-        self.status_code = 200
+        self.status_code = codes.ok
 
     def put(self, request_url, data, headers):
         raise RequestException('Something went wrong')
@@ -81,8 +81,8 @@ def test_init(self):
 
     def test_get_user(self):
         expected_response = self.user.copy()
-        expected_response.update({"status_code": 200})
-        response = Mock(status_code=200)
+        expected_response.update({"status_code": codes.ok})
+        response = Mock(status_code=codes.ok)
         response.json.return_value = expected_response
         requests = Mock()
         requests.get.return_value = response
@@ -104,7 +104,7 @@ def test_update_user(self):
         self.assertEqual(self.client.default_headers['X-XNG-AuthToken'], 'SOME_TOKEN')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 200)
+        self.assertEqual(response['status_code'], codes.ok)
         self.assertEqual(response['errors'], '')
         self.assertEqual(response['success'], True)
 
@@ -121,7 +121,7 @@ def test_update_user_request_exception(self):
 
     def test_update_users_bulk(self):
         response = Mock(
-            status_code=200,
+            status_code=codes.ok,
             text='{"updated": [{"id": "updated_id","xngId": "updated_xngId","success": true}],'
                  '"deleted": [{"id": "deleted_id","xngId": "deleted_xngId","success": true}]}')
 
@@ -146,13 +146,13 @@ def test_update_users_bulk(self):
             }
         )
 
-        self.assertEqual(response['status_code'], 200)
+        self.assertEqual(response['status_code'], codes.ok)
         self.assertEqual(response['updated'][0]['id'], 'updated_id')
         self.assertEqual(response['updated'][0]['success'], True)
 
     def test_update_users_bulk_bad_request(self):
         response = Mock(
-            status_code=400,
+            status_code=codes.bad_request,
             text='{"updated": [{"id": "updated_id","xngId": "updated_xngId","success": false,'
                  '"errors": [{"field": "id","type": "NOT_NULL"},{"field": "email","type": "WRONG_FORMAT"}]}],'
                  '"deleted": [{"id": "deleted_id","xngId": "deleted_xngId","success": false,'
@@ -179,7 +179,7 @@ def test_update_users_bulk_bad_request(self):
             }
         )
 
-        self.assertEqual(response['status_code'], 400)
+        self.assertEqual(response['status_code'], codes.bad_request)
         self.assertEqual(response['updated'][0]['id'], 'updated_id')
         self.assertEqual(response['updated'][0]['success'], False)
         self.assertEqual(response['success'], False)
@@ -189,7 +189,7 @@ def test_delete_user(self):
             'id': '1',
         }
         dummy_request = DummyRequest()
-        dummy_request.status_code = 204
+        dummy_request.status_code = codes.no_content
         self.client.requests = dummy_request
         response = self.client.delete_user(user)
 
@@ -198,14 +198,14 @@ def test_delete_user(self):
         self.assertEqual(self.client.default_headers['X-XNG-ApiVersion'], '1')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 204)
+        self.assertEqual(response['status_code'], codes.no_content)
 
     def test_delete_user_by_xng_id(self):
         user = {
             'xngId': '1',
         }
         dummy_request = DummyRequest()
-        dummy_request.status_code = 204
+        dummy_request.status_code = codes.no_content
         self.client.requests = dummy_request
         response = self.client.delete_user_by_xng_id(user)
 
@@ -214,11 +214,11 @@ def test_delete_user_by_xng_id(self):
         self.assertEqual(self.client.default_headers['X-XNG-ApiVersion'], '1')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 204)
+        self.assertEqual(response['status_code'], codes.no_content)
 
     def test_add_user_attribute(self):
         dummy_request = DummyRequest()
-        dummy_request.status_code = 200
+        dummy_request.status_code = codes.ok
         self.client.requests = dummy_request
         response = self.client.add_user_attribute(
             attribute_name='attr_name',
@@ -231,13 +231,13 @@ def test_add_user_attribute(self):
         self.assertEqual(self.client.default_headers['X-XNG-ApiVersion'], '1')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 200)
+        self.assertEqual(response['status_code'], codes.ok)
         self.assertEqual(response['errors'], '')
         self.assertEqual(response['success'], True)
 
     def test_add_nested_user_attribute(self):
         dummy_request = DummyRequest()
-        dummy_request.status_code = 200
+        dummy_request.status_code = codes.ok
         self.client.requests = dummy_request
         response = self.client.add_nested_user_attribute(
             parent_name='parent_attribute',
@@ -250,13 +250,13 @@ def test_add_nested_user_attribute(self):
         self.assertEqual(self.client.default_headers['X-XNG-ApiVersion'], '1')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 200)
+        self.assertEqual(response['status_code'], codes.ok)
         self.assertEqual(response['errors'], '')
         self.assertEqual(response['success'], True)
 
     def test_list_user_attributes(self):
         dummy_request = DummyRequest()
-        dummy_request.status_code = 200
+        dummy_request.status_code = codes.ok
         self.client.requests = dummy_request
         response = self.client.list_user_attributes(offset=0, limit=10)
 
@@ -265,13 +265,13 @@ def test_list_user_attributes(self):
         self.assertEqual(self.client.default_headers['X-XNG-ApiVersion'], '1')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 200)
+        self.assertEqual(response['status_code'], codes.ok)
         self.assertEqual(response['errors'], '')
         self.assertEqual(response['success'], True)
 
     def test_delete_user_attributes(self):
         dummy_request = DummyRequest()
-        dummy_request.status_code = 204
+        dummy_request.status_code = codes.no_content
         self.client.requests = dummy_request
         response = self.client.delete_user_attribute(attribute_id=123)
 
@@ -280,10 +280,10 @@ def test_delete_user_attributes(self):
         self.assertEqual(self.client.default_headers['X-XNG-ApiVersion'], '1')
         self.assertEqual(self.client.default_headers['Content-Type'], 'application/json')
 
-        self.assertEqual(response['status_code'], 204)
+        self.assertEqual(response['status_code'], codes.no_content)
 
     def test_send_events_with_user_id(self):
-        response = Mock(status_code=202, text='{"success": true, "errors": ""}')
+        response = Mock(status_code=codes.accepted, text='{"success": true, "errors": ""}')
         response.json.return_value = {'success': True, 'errors': ''}
 
         events = [{'foo': 'bar'}, {'xpto': 123}]
@@ -305,10 +305,10 @@ def test_send_events_with_user_id(self):
             'Content-Type': 'application/json',
         })
 
-        self.assertEqual(response['status_code'], 202)
+        self.assertEqual(response['status_code'], codes.accepted)
 
     def test_send_events_with_email(self):
-        response = Mock(status_code=202, text='{"success": true, "errors": ""}')
+        response = Mock(status_code=codes.accepted, text='{"success": true, "errors": ""}')
         response.json.return_value = {'success': True, 'errors': ''}
 
         events = [{'foo': 'bar'}, {'xpto': 123}]
@@ -329,15 +329,15 @@ def test_send_events_with_email(self):
             'Content-Type': 'application/json',
         })
 
-        self.assertEqual(response['status_code'], 202)
+        self.assertEqual(response['status_code'], codes.accepted)
 
     def test_send_events_value_error(self):
         events = [{'foo': 'bar'}, {'xpto': 123}]
         self.client.requests = Mock()
         self.assertRaises(ValueError, self.client.send_events, events=events)
 
     def test_send_events_request_exception_raised(self):
-        response = Mock(status_code=202, text='{"success": true, "errors": ""}')
+        response = Mock(status_code=codes.accepted, text='{"success": true, "errors": ""}')
         response.json.return_value = {'success': True, 'errors': ''}
 
         events = [{'foo': 'bar'}, {'xpto': 123}]
@@ -362,7 +362,7 @@ def test_send_events_request_exception_raised(self):
         self.assertEqual(response['errors'], {'connection_error': 'exception raised'})
 
     def test_send_events_exception_raised(self):
-        response = Mock(status_code=202, text='{???}')
+        response = Mock(status_code=codes.accepted, text='{???}')
         response.json.return_value = {'success': True, 'errors': ''}
 
         events = [{'foo': 'bar'}, {'xpto': 123}]
@@ -387,7 +387,7 @@ def test_send_events_exception_raised(self):
         self.assertEqual(response['errors'], {'client_error': 'exception raised'})
 
     def test_send_events_internal_server_error_response(self):
-        response = Mock(status_code=500, text='Something went wrong')
+        response = Mock(status_code=codes.server_error, text='Something went wrong')
         response.json.return_value = {}
 
         events = [{'foo': 'bar'}, {'xpto': 123}]
@@ -412,7 +412,7 @@ def test_send_events_internal_server_error_response(self):
         self.assertEqual(response['errors'], {'server_error': 'error on crossengage side'})
 
     def test_send_events_bad_request_error_response(self):
-        response = Mock(status_code=400, text='{}')
+        response = Mock(status_code=codes.bad_request, text='{}')
         response.json.return_value = {
             'id': 'some_id',
             'xngId': 'some_xngid',
@@ -455,7 +455,7 @@ def test_send_events_bad_request_error_response(self):
 
     def test_batch_process(self):
         response = Mock(
-            status_code=200,
+            status_code=codes.ok,
             text='{"updated": [{"id": "updated_id","xngId": "updated_xngId","success": true}],'
                  '"deleted": [{"id": "deleted_id","xngId": "deleted_xngId","success": true}]}')
 
@@ -480,11 +480,11 @@ def test_batch_process(self):
             headers=self.default_headers_api_v1
         )
 
-        self.assertEqual(result, (200, json.loads(response.text)))
+        self.assertEqual(result, (codes.ok, json.loads(response.text)))
 
     def test_update_user_async(self):
-        expected_response = {"status_code": 202, "trackingId": "2e312089-a987-45c6-adbd-b904bc4dfc97"}
-        response = Mock(status_code=202)
+        expected_response = {"status_code": codes.accepted, "trackingId": "2e312089-a987-45c6-adbd-b904bc4dfc97"}
+        response = Mock(status_code=codes.accepted)
         response.json.return_value = expected_response
         requests = Mock()
         requests.put.return_value = response
@@ -500,8 +500,8 @@ def test_update_user_async(self):
         self.assertEqual(expected_response, result)
 
     def test_delete_user_async(self):
-        expected_response = {"status_code": 202, "trackingId": "2e312089-a987-45c6-adbd-b904bc4dfc97"}
-        response = Mock(status_code=202)
+        expected_response = {"status_code": codes.accepted, "trackingId": "2e312089-a987-45c6-adbd-b904bc4dfc97"}
+        response = Mock(status_code=codes.accepted)
         response.json.return_value = expected_response
         requests = Mock()
         requests.delete.return_value = response
@@ -518,7 +518,7 @@ def test_delete_user_async(self):
 
     def test_batch_process_async(self):
         expected_body = {"trackingId": "2e312089-a987-45c6-adbd-b904bc4dfc97"}
-        response = Mock(status_code=202)
+        response = Mock(status_code=codes.accepted)
 
         response.json.return_value = expected_body
 
@@ -541,23 +541,48 @@ def test_batch_process_async(self):
             headers=self.default_headers_api_v2
         )
 
-        self.assertEqual(result, (202, expected_body))
+        self.assertEqual(result, (codes.accepted, expected_body))
 
-    def test_track_user_task(self):
+    def test_track_user_task_ok(self):
+        """Crossengage returns status code 200"""
+        # GIVEN
         expected_body = {"stage": "PROCESSED", "total": 2, "success": 1, "error": 1}
-        response = Mock(status_code=200)
 
+        response = Mock(status_code=codes.ok)
         response.json.return_value = expected_body
 
         requests = Mock()
         requests.get.return_value = response
         self.client.requests = requests
 
+        # WHEN
         result = self.client.track_user_task("trackingId")
 
+        # THEN
         requests.get.assert_called_once_with(
             self.CROSSENGAGE_URL + 'users/track/trackingId',
             headers=self.default_headers_api_v2
         )
 
-        self.assertEqual(result, (200, expected_body))
+        self.assertEqual(result, (codes.ok, expected_body))
+
+    def test_track_user_task_not_found(self):
+        """Crossengage returns status code 404"""
+        # GIVEN
+        response = Mock(status_code=codes.not_found)
+        response.json.side_effect = ValueError
+
+        requests = Mock()
+        requests.get.return_value = response
+        self.client.requests = requests
+
+        # WHEN
+        result = self.client.track_user_task("trackingId")
+
+        # THEN
+        requests.get.assert_called_once_with(
+            self.CROSSENGAGE_URL + 'users/track/trackingId',
+            headers=self.default_headers_api_v2
+        )
+
+        self.assertEqual(result, (codes.not_found, None))