SDK-594: Refactor image handling

Author: echarrod

yoti_python_sdk/activity_details.py

@@ -26,10 +26,11 @@ def __init__(self, receipt, decrypted_profile=None):
                         field.content_type
                     )
 
-                    self.user_profile[field.name] = value
-
                     if field.name == config.ATTRIBUTE_SELFIE:
                         self.try_parse_selfie_field(field)
+                        value = field.value
+
+                    self.user_profile[field.name] = value
 
                     if field.name.startswith(config.ATTRIBUTE_AGE_OVER) or field.name.startswith(
                             config.ATTRIBUTE_AGE_UNDER):

yoti_python_sdk/image.py

@@ -3,12 +3,16 @@
 
 class Image:
     def __init__(self, image_bytes, image_content_type):
-        if image_content_type == Protobuf.CT_JPEG or image_content_type == Protobuf.CT_PNG:
+        if image_content_type in Image.allowed_types():
             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))
 
+    @staticmethod
+    def allowed_types():
+        return [Protobuf.CT_PNG, Protobuf.CT_JPEG]
+
     @property
     def data(self):
         return self.__data

yoti_python_sdk/profile.py

@@ -20,11 +20,10 @@ 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)
+                    # this will be removed in v3.0.0, so selfie also returns an Image object
+                    if field.content_type in Image.allowed_types():
+                        if field.name == config.ATTRIBUTE_SELFIE:
+                            value = field.value
 
                     anchors = Anchor().parse_anchors(field.anchors)
 

yoti_python_sdk/protobuf/protobuf.py

@@ -45,15 +45,15 @@ def anchor(data):
         return anchor
 
     def value_based_on_content_type(self, value, content_type=None):
+        from yoti_python_sdk.image import Image
         if content_type == self.CT_STRING:
             return value.decode('utf-8')
         elif value == b'':
             raise ValueError("Content type: '{0}' should not have an empty value".format(content_type))
         elif content_type == self.CT_DATE:
             return value.decode('utf-8')
-        elif content_type == self.CT_JPEG \
-                or content_type == self.CT_PNG:
-            return value
+        elif content_type in Image.allowed_types():
+            return Image(value, content_type)
         elif content_type == self.CT_JSON:
             return self.convert_to_dict(value)
         elif content_type == self.CT_INT:

yoti_python_sdk/tests/test_protobuf.py

@@ -5,32 +5,27 @@
 
 from yoti_python_sdk.protobuf import protobuf
 
+string_value = "123"
+byte_value = str.encode(string_value)
+int_value = int(string_value)
+
 
 @pytest.fixture(scope='module')
 def proto():
     return protobuf.Protobuf()
 
 
-def test_protobuf_value_based_on_content_type(proto):
-    string_value = "123"
-    byte_value = str.encode(string_value)
-    int_value = int(string_value)
-
-    result = proto.value_based_on_content_type(byte_value, proto.CT_STRING)
-    assert result == string_value
-
-    result = proto.value_based_on_content_type(byte_value, proto.CT_DATE)
-    assert result == string_value
+@pytest.mark.parametrize(
+    "content_type, expected_value",
+    [(proto().CT_STRING, string_value),
+     (proto().CT_DATE, string_value),
+     (proto().CT_INT, int_value)])
+def test_protobuf_values_based_on_content_type(content_type, expected_value):
+    result = proto().value_based_on_content_type(byte_value, content_type)
+    assert result == expected_value
 
-    result = proto.value_based_on_content_type(byte_value, proto.CT_JPEG)
-    assert result == byte_value
-
-    result = proto.value_based_on_content_type(byte_value, proto.CT_PNG)
-    assert result == byte_value
-
-    result = proto.value_based_on_content_type(byte_value, proto.CT_INT)
-    assert result == int_value
 
+def test_warning_protobuf_values_based_on_content_type(proto):
     # disable logging for the below types: warning shown as type is not recognized
     logger = logging.getLogger()
     logger.propagate = False
@@ -47,6 +42,16 @@ def test_protobuf_value_based_on_content_type(proto):
     logger.propagate = True
 
 
+@pytest.mark.parametrize(
+    "content_type",
+    (proto().CT_JPEG,
+     proto().CT_PNG))
+def test_image_value_based_on_content_type(proto, content_type):
+    result = proto.value_based_on_content_type(byte_value, content_type)
+    assert result.data == byte_value
+    assert result.content_type == content_type
+
+
 def test_protobuf_image_uri_based_on_content_type(proto):
     value = b'test string'