SDK-900: Parse all JSON attributes, disable logging in specific tests

Author: echarrod

yoti_python_sdk/profile.py

@@ -1,6 +1,4 @@
 # -*- coding: utf-8 -*-
-import collections
-import json
 import logging
 
 from yoti_python_sdk import config
@@ -25,12 +23,10 @@ def __init__(self, profile_attributes):
 
                     self.attributes[field.name] = Attribute(field.name, value, anchors)
 
-                    if field.name == config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS:
-                        self.try_convert_structured_postal_address_to_dict(field, anchors)
-
                 except Exception as exc:
                     error = 'Error parsing profile attribute: "{0}"'.format(field.name)
-                    logging.warning('error: {0}, exception: {1} - {2}'.format(error, type(exc).__name__, exc))
+                    if logging.getLogger().propagate:
+                        logging.warning('error: {0}, exception: {1} - {2}'.format(error, type(exc).__name__, exc))
 
             self.ensure_postal_address()
 
@@ -84,15 +80,6 @@ def get_attribute(self, attribute_name):
         else:
             return None
 
-    def try_convert_structured_postal_address_to_dict(self, field, anchors):
-        decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict, strict=False)
-        value_to_decode = field.value.decode()
-
-        self.attributes[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = Attribute(
-            config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS,
-            decoder.decode(value_to_decode),
-            anchors)
-
     def ensure_postal_address(self):
         if config.ATTRIBUTE_POSTAL_ADDRESS not in self.attributes and config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS in self.attributes:
             structured_postal_address = self.attributes[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS]

yoti_python_sdk/protobuf/protobuf.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+import collections
+import json
 import logging
 
 from cryptography.fernet import base64
@@ -50,12 +52,16 @@ def value_based_on_content_type(self, value, content_type=None):
         elif content_type == self.CT_JPEG \
                 or content_type == self.CT_PNG:
             return value
+        elif content_type == self.CT_JSON:
+            return self.convert_to_dict(value)
         elif content_type == self.CT_INT:
             string_value = value.decode('utf-8')
             int_value = int(string_value)
             return int_value
 
-        logging.warning("Unknown type '{0}', attempting to parse it as a String".format(content_type))
+        if logging.getLogger().propagate:
+            logging.warning("Unknown type '{0}', attempting to parse it as a String".format(content_type))
+
         return value.decode('utf-8')
 
     def image_uri_based_on_content_type(self, value, content_type=None):
@@ -66,3 +72,10 @@ def image_uri_based_on_content_type(self, value, content_type=None):
             data = base64.b64encode(value).decode('utf-8')
             return 'data:image/png;base64,{0}'.format(data)
         return value
+
+    @staticmethod
+    def convert_to_dict(byte_value):
+        decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict, strict=False)
+        value_to_decode = byte_value.decode()
+
+        return decoder.decode(value_to_decode)

yoti_python_sdk/tests/test_profile.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import collections
 import json
+import logging
 
 import pytest
 
@@ -122,8 +123,14 @@ def test_error_parsing_attribute_has_none_value():
         anchors=None,
         content_type=Protobuf.CT_INT)
 
+    # disable logging for the below call: warning shown as int is invalid
+    logger = logging.getLogger()
+    logger.propagate = False
+
     profile = Profile(attribute_list)
 
+    logger.propagate = True
+
     assert profile.get_attribute(int_attribute_name) is None
 
 
@@ -146,8 +153,14 @@ def test_error_parsing_attribute_does_not_affect_other_attribute():
         anchors=None,
         content_type=Protobuf.CT_INT))
 
+    # disable logging for the below call: warning shown as int is invalid
+    logger = logging.getLogger()
+    logger.propagate = False
+
     profile = Profile(attribute_list)
 
+    logger.propagate = True
+
     assert len(profile.attributes) == 1
 
     retrieved_string_attribute = profile.get_attribute(string_attribute_name)
@@ -182,6 +195,33 @@ def test_try_parse_structured_postal_address_uk():
     assert actual_structured_postal_address_profile[config.KEY_FORMATTED_ADDRESS] == FORMATTED_ADDRESS_VALUE
 
 
+def test_other_json_type_is_parsed():
+    json_attribute_name = "other_json"
+    key_a = "keyA"
+    key_b = "keyB"
+    value_a = "valueA"
+    value_b = "valueB"
+    json_value = {key_a: value_a,
+                  key_b: value_b}
+
+    encoded_json = json.dumps(json_value).encode()
+
+    attribute_list = create_single_attribute_list(
+        name=json_attribute_name,
+        value=encoded_json,
+        anchors=None,
+        content_type=Protobuf.CT_JSON)
+
+    profile = Profile(attribute_list)
+
+    retrieved_attribute = profile.get_attribute(json_attribute_name)
+
+    assert retrieved_attribute.name == json_attribute_name
+    assert type(retrieved_attribute.value) is collections.OrderedDict
+    assert retrieved_attribute.value[key_a] == value_a
+    assert retrieved_attribute.value[key_b] == value_b
+
+
 def test_try_parse_structured_postal_address_india():
     structured_postal_address = {ADDRESS_FORMAT_KEY: INDIA_FORMAT_VALUE,
                                  CARE_OF_KEY: CARE_OF_VALUE,

yoti_python_sdk/tests/test_protobuf.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+import logging
+
 import pytest
 
 from yoti_python_sdk.protobuf import protobuf
@@ -14,9 +16,6 @@ def test_protobuf_value_based_on_content_type(proto):
     byte_value = str.encode(string_value)
     int_value = int(string_value)
 
-    result = proto.value_based_on_content_type(byte_value, proto.CT_UNDEFINED)
-    assert result == string_value
-
     result = proto.value_based_on_content_type(byte_value, proto.CT_STRING)
     assert result == string_value
 
@@ -32,9 +31,21 @@ def test_protobuf_value_based_on_content_type(proto):
     result = proto.value_based_on_content_type(byte_value, proto.CT_INT)
     assert result == int_value
 
+    # disable logging for the below types: warning shown as type is not recognized
+    logger = logging.getLogger()
+    logger.propagate = False
+
+    result = proto.value_based_on_content_type(byte_value, proto.CT_UNDEFINED)
+    assert result == string_value
+
     result = proto.value_based_on_content_type(byte_value)
     assert result == string_value
 
+    result = proto.value_based_on_content_type(byte_value, 100)
+    assert result == string_value
+
+    logger.propagate = True
+
 
 def test_protobuf_image_uri_based_on_content_type(proto):
     value = b'test string'