SDK-1076: Implement YotiResponse to standardise the response object used in the SDK:

Author: MrBurtyyy

yoti_python_sdk/client.py

@@ -9,7 +9,7 @@
 from yoti_python_sdk.activity_details import ActivityDetails
 from yoti_python_sdk.crypto import Crypto
 from yoti_python_sdk.endpoint import Endpoint
-from yoti_python_sdk.http import SignedRequest
+from yoti_python_sdk.http import SignedRequest, YotiResponse
 from yoti_python_sdk.protobuf import protobuf
 
 NO_KEY_FILE_SPECIFIED_ERROR = (
@@ -53,6 +53,10 @@ def make_request(self, http_method, endpoint, body):
         )
 
         response = signed_request.execute()
+
+        if not isinstance(response, YotiResponse):
+            raise TypeError("Response must be of type YotiResponse")
+
         return response
 
     def get_activity_details(self, encrypted_request_token):
@@ -94,6 +98,9 @@ def perform_aml_check(self, aml_profile):
 
         response = self.__make_aml_check_request(aml_profile)
 
+        if not isinstance(response, YotiResponse):
+            raise TypeError("Response must be of type YotiResponse")
+
         return aml.AmlResult(response.text)
 
     @property
@@ -161,6 +168,8 @@ def __make_aml_check_request(self, aml_profile):
         )
 
         response = signed_request.execute()
+        if not isinstance(response, YotiResponse):
+            raise TypeError("Response must be of type YotiResponse")
 
         self.http_error_handler(
             response, {"default": "Unsuccessful Yoti API call: {} {}"}

yoti_python_sdk/http.py

@@ -25,11 +25,17 @@
 HTTP_SUPPORTED_METHODS = ["POST", "PUT", "PATCH", "GET", "DELETE"]
 
 
+class YotiResponse(object):
+    def __init__(self, status_code, text):
+        self.status_code = status_code
+        self.text = text
+
+
 class RequestHandler:
     """
     Default request handler for signing requests using the requests library.
     This type can be inherited and the execute method overridden to use any
-    preferred HTTP library.
+    preferred HTTP library.  Must return type YotiResponse for use in the SDK.
     """
 
     __metaclass__ = ABCMeta  # Python 2 compatability
@@ -49,13 +55,15 @@ def execute(request):
         if not isinstance(request, SignedRequest):
             raise TypeError("RequestHandler expects instance of SignedRequest")
 
-        return requests.request(
+        response = requests.request(
             url=request.url,
             method=request.method,
             data=request.data,
             headers=request.headers,
         )
 
+        return YotiResponse(status_code=response.status_code, text=response.text)
+
 
 class SignedRequest(object):
     def __init__(self, url, http_method, payload, headers, request_handler=None):