Ensure that the response of an HTTP request is a valid string.

Author: JaviCerveraIngram

connect/resources/base.py

@@ -93,19 +93,20 @@ def _fix_request_kwargs(self, path, prev_kwargs, **kwargs):
     @staticmethod
     def _check_and_pack_response(response):
         # type: (requests.Response) -> Tuple[str, int]
-        request_attrs = ('content', 'status_code', 'ok')
+        request_attrs = ('text', 'status_code', 'ok')
         for attr in request_attrs:
             if not hasattr(response, attr):
                 raise AttributeError(
                     'Response does not have attribute `{}`. Check your request params. '
                     'Response status - {}'.format(attr, response.status_code),
                 )
+
         if not response.ok:
-            data, error = ServerErrorResponse.deserialize(response.content)
+            data, error = ServerErrorResponse.deserialize(response.text)
             if data:
                 raise ServerError(data)
 
-        return response.content, response.status_code
+        return response.text, response.status_code
 
 
 class BaseResource(object):

tests/common.py

@@ -6,7 +6,8 @@
 from collections import namedtuple
 from typing import Optional
 
-Response = namedtuple('Response', ('ok', 'content', 'status_code'))
+Response = namedtuple('Response', ('ok', 'text', 'status_code'))
+BinaryResponse = namedtuple('BinaryResponse', ('ok', 'content', 'status_code'))
 
 
 def load_str(filename):

tests/test_models.py

@@ -17,20 +17,20 @@
 def _get_response_ok():
     return Response(
         ok=True,
-        content=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response.json')),
+        text=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response.json')),
         status_code=200)
 
 
 def _get_response_ok2():
     return Response(
         ok=True,
-        content=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response2.json')),
+        text=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response2.json')),
         status_code=200)
 
 
 def _get_response_tier_config_ok():
     return Response(ok=True,
-                    content=load_str(os.path.join(
+                    text=load_str(os.path.join(
                         os.path.dirname(__file__),
                         'data',
                         'response_tier_config_request.json')),
@@ -40,7 +40,7 @@ def _get_response_tier_config_ok():
 def _get_response_migration():
     return Response(
         ok=True,
-        content=load_str(os.path.join(
+        text=load_str(os.path.join(
             os.path.dirname(__file__),
             'data',
             'response_migration.json')),
@@ -62,7 +62,7 @@ def test_resource_urljoin():
 @patch('requests.get', MagicMock(return_value=_get_response_ok()))
 def test_create_model_from_response():
     # Parse JSON data from response file
-    content = json.loads(_get_response_ok().content)[0]
+    content = json.loads(_get_response_ok().text)[0]
 
     # Get requests from response
     resource = FulfillmentAutomation()
@@ -171,7 +171,7 @@ def test_get_tier_config(get_mock):
             'configuration.account.id': 'tier_id'})
 
 
-@patch('requests.get', MagicMock(return_value=Response(ok=True, content='[]', status_code=200)))
+@patch('requests.get', MagicMock(return_value=Response(ok=True, text='[]', status_code=200)))
 def test_get_tier_config_empty():
     config = FulfillmentAutomation().get_tier_config('', '')
     assert not config

tests/test_tier_config.py

@@ -21,7 +21,7 @@
 def _get_response_ok():
     return Response(
         ok=True,
-        content=load_str(os.path.join(
+        text=load_str(os.path.join(
             os.path.dirname(__file__),
             'data',
             'response_tier_config_request.json')),
@@ -32,7 +32,7 @@ def _get_response_ok_invalid_product():
     response_ok = _get_response_ok()
     return Response(
         ok=response_ok.ok,
-        content=response_ok.content.replace('CN-631-322-000', 'PRD-000-000-000'),
+        text=response_ok.text.replace('CN-631-322-000', 'PRD-000-000-000'),
         status_code=response_ok.status_code)
 
 

tests/test_usage.py

@@ -13,20 +13,20 @@
 from connect.exceptions import FileRetrievalError
 from connect.models import Contract, Product, UsageRecord, UsageFile
 from connect.resources import UsageAutomation
-from .common import Response, load_str
+from .common import Response, load_str, BinaryResponse
 
 
 def _get_response_ok():
     return Response(
         ok=True,
-        content=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response_usage.json')),
+        text=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response_usage.json')),
         status_code=200)
 
 
 def _get_response_ok2():
     return Response(
         ok=True,
-        content=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response_usage2.json')),
+        text=load_str(os.path.join(os.path.dirname(__file__), 'data', 'response_usage2.json')),
         status_code=201)
 
 
@@ -47,10 +47,10 @@ def test_process():
 @patch('requests.get')
 def test_get_usage_template_ok(get_mock):
     get_mock.side_effect = [
-        Response(ok=True, content='{"template_link": "..."}', status_code=200),
-        Response(ok=True, content='template_contents', status_code=200)]
+        Response(ok=True, text='{"template_link": "..."}', status_code=200),
+        BinaryResponse(ok=True, content=b'template_contents', status_code=200)]
     resource = UsageAutomation()
-    assert resource.get_usage_template(Product(id='PRD-638-321-603')) == 'template_contents'
+    assert resource.get_usage_template(Product(id='PRD-638-321-603')) == b'template_contents'
     get_mock.assert_has_calls([
         call(
             url='http://localhost:8080/api/public/v1//usage/products/PRD-638-321-603/template/',
@@ -60,16 +60,16 @@ def test_get_usage_template_ok(get_mock):
 
 
 @patch('requests.get', MagicMock(return_value=Response(
-    ok=True, content='{}', status_code=200)))
+    ok=True, text='{}', status_code=200)))
 def test_get_usage_template_no_link():
     resource = UsageAutomation()
     with pytest.raises(FileRetrievalError):
         resource.get_usage_template(Product(id='PRD-638-321-603'))
 
 
 @patch('requests.get', MagicMock(side_effect=[
-    Response(ok=True, content='{"template_link": "..."}', status_code=200),
-    Response(ok=True, content=None, status_code=200)]))
+    Response(ok=True, text='{"template_link": "..."}', status_code=200),
+    BinaryResponse(ok=True, content=None, status_code=200)]))
 def test_get_usage_template_no_file():
     resource = UsageAutomation()
     with pytest.raises(FileRetrievalError):

tests/test_usage_file.py

@@ -19,11 +19,11 @@
 
 # noinspection PyUnusedLocal
 def _get_response_ok(*args, **kwargs):
-    content = load_str(os.path.join(os.path.dirname(__file__), 'data', 'response_usage_file.json'))
+    text = load_str(os.path.join(os.path.dirname(__file__), 'data', 'response_usage_file.json'))
     if current_action:
-        content = content.replace('UF-2018-11-9878764342',
-                                  'UF-2018-11-9878764342-' + current_action)
-    return Response(ok=True, content=content, status_code=200)
+        text = text.replace('UF-2018-11-9878764342',
+                            'UF-2018-11-9878764342-' + current_action)
+    return Response(ok=True, text=text, status_code=200)
 
 
 @patch('requests.get', MagicMock(return_value=_get_response_ok()))