SDK-594: new Image type

Author: echarrod

yoti_python_sdk/activity_details.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import collections
 import json
+import logging
 from datetime import datetime
 
 from yoti_python_sdk import config
@@ -19,22 +20,34 @@ def __init__(self, receipt, decrypted_profile=None):
             self.profile = Profile(decrypted_profile_attributes)
 
             for field in decrypted_profile_attributes:  # will be removed in v3.0.0
-                value = Protobuf().value_based_on_content_type(
-                    field.value,
-                    field.content_type
-                )
-
-                self.user_profile[field.name] = value
-
-                if field.name == config.ATTRIBUTE_SELFIE:
-                    self.try_parse_selfie_field(field)
-
-                if field.name.startswith(config.ATTRIBUTE_AGE_OVER) or field.name.startswith(
-                        config.ATTRIBUTE_AGE_UNDER):
-                    self.try_parse_age_verified_field(field)
-
-                if field.name == config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS:
-                    self.try_convert_structured_postal_address_to_dict(field)
+                try:
+                    value = Protobuf().value_based_on_content_type(
+                        field.value,
+                        field.content_type
+                    )
+
+                    self.user_profile[field.name] = value
+
+                    if field.name == config.ATTRIBUTE_SELFIE:
+                        self.try_parse_selfie_field(field)
+
+                    if field.name.startswith(config.ATTRIBUTE_AGE_OVER) or field.name.startswith(
+                            config.ATTRIBUTE_AGE_UNDER):
+                        self.try_parse_age_verified_field(field)
+
+                    if field.name == config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS:
+                        self.try_convert_structured_postal_address_to_dict(field)
+
+                except ValueError as ve:
+                    if logging.getLogger().propagate:
+                        logging.warning(ve)
+                except Exception as exc:
+                    if logging.getLogger().propagate:
+                        logging.warning(
+                            'Error parsing profile attribute:{0}, exception: {1} - {2}'.format(
+                                field.name,
+                                type(exc).__name__,
+                                exc))
 
             self.ensure_postal_address()
 

yoti_python_sdk/image.py

@@ -0,0 +1,32 @@
+from yoti_python_sdk.protobuf.protobuf import Protobuf
+
+
+class Image:
+    def __init__(self, image_bytes, image_content_type):
+        if image_content_type == Protobuf.CT_JPEG or image_content_type == Protobuf.CT_PNG:
+            self.__data = image_bytes
+            self.__content_type = image_content_type
+        else:
+            raise TypeError("Content type '{0}' is not a supported image type".format(image_content_type))
+
+    @property
+    def data(self):
+        return self.__data
+
+    @property
+    def content_type(self):
+        return self.__content_type
+
+    def mime_type(self):
+        if self.__content_type == Protobuf.CT_JPEG:
+            return "image/jpeg"
+        elif self.__content_type == Protobuf.CT_PNG:
+            return "image/png"
+        else:
+            return ""
+
+    def base64_content(self):
+        return Protobuf().image_uri_based_on_content_type(
+            # TODO: move image_uri_based_on_content_type method to this class
+            self.__data,
+            self.__content_type)

yoti_python_sdk/profile.py

@@ -4,6 +4,7 @@
 from yoti_python_sdk import config
 from yoti_python_sdk.anchor import Anchor
 from yoti_python_sdk.attribute import Attribute
+from yoti_python_sdk.image import Image
 from yoti_python_sdk.protobuf.protobuf import Protobuf
 
 
@@ -19,6 +20,12 @@ def __init__(self, profile_attributes):
                         field.content_type
                     )
 
+                    # first condition will be removed in v3.0.0, so selfie also returns an Image object
+                    if field.name != config.ATTRIBUTE_SELFIE and \
+                            (field.content_type == Protobuf.CT_JPEG \
+                             or field.content_type == Protobuf.CT_PNG):
+                        value = Image(field.value, field.content_type)
+
                     anchors = Anchor().parse_anchors(field.anchors)
 
                     self.attributes[field.name] = Attribute(field.name, value, anchors)

yoti_python_sdk/tests/test_image.py

@@ -0,0 +1,26 @@
+import pytest
+
+from yoti_python_sdk.image import Image
+from yoti_python_sdk.protobuf.protobuf import Protobuf
+
+
+def test_image_with_unsupported_type():
+    with pytest.raises(TypeError):
+        Image(b'', Protobuf.CT_UNDEFINED)
+
+
+@pytest.mark.parametrize("content_type, expected_mime_type",
+                         [(Protobuf.CT_JPEG, 'image/jpeg'),
+                          (Protobuf.CT_PNG, 'image/png')])
+def test_image_mime_type(content_type, expected_mime_type):
+    image = Image(b'', content_type)
+
+    assert image.mime_type() == expected_mime_type
+
+
+@pytest.mark.parametrize("content_type, expected_base64_content",
+                         [(Protobuf.CT_JPEG, 'data:image/jpeg;base64,dGVzdCBzdHJpbmc='),
+                          (Protobuf.CT_PNG, 'data:image/png;base64,dGVzdCBzdHJpbmc=')])
+def test_image_base64_content(content_type, expected_base64_content):
+    image = Image(b'test string', content_type)
+    assert image.base64_content() == expected_base64_content