SDK-350: Clarify comments & naming, code tidying up

Author: echarrod

yoti_python_sdk/activity_details.py

@@ -2,15 +2,16 @@
 import collections
 import json
 
-from yoti_python_sdk import config, attribute
+from yoti_python_sdk import config
+from yoti_python_sdk.attribute import Attribute
 from yoti_python_sdk.anchor import Anchor
 from yoti_python_sdk.protobuf.v1.protobuf import Protobuf
 
 
 class ActivityDetails:
     def __init__(self, receipt, decrypted_profile=None):
         self.decrypted_profile = decrypted_profile
-        self.user_profile = {}  # will be deprecated in v3.0.0
+        self.user_profile = {}  # will be removed in v3.0.0
         self.profile = {}
         self.base64_selfie_uri = None
 
@@ -23,8 +24,8 @@ def __init__(self, receipt, decrypted_profile=None):
 
                 anchors = Anchor().parse_anchors(field.anchors)
 
-                self.profile[field.name] = attribute.attribute(field.name, value, anchors)
-                self.user_profile[field.name] = value  # will be deprecated in v3.0.0
+                self.profile[field.name] = Attribute(field.name, value, anchors)
+                self.user_profile[field.name] = value  # will be removed in v3.0.0
 
                 if field.name == config.ATTRIBUTE_SELFIE:
                     self.try_parse_selfie_field(field)
@@ -55,11 +56,11 @@ def try_parse_age_verified_field(self, field, anchors):
             )
             if is_age_verified == 'true':
                 self.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = True
-                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = attribute.attribute(is_age_verified, True, anchors)
+                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = Attribute(is_age_verified, True, anchors)
                 return
             if is_age_verified == 'false':
                 self.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = False
-                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = attribute.attribute(is_age_verified, False, anchors)
+                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = Attribute(is_age_verified, False, anchors)
                 return
 
         raise TypeError("age_verified_field unable to be parsed")
@@ -71,23 +72,25 @@ def try_convert_structured_postal_address_to_dict(self, field, anchors):
             value_to_decode = value_to_decode.decode()
 
         self.user_profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = decoder.decode(value_to_decode)
-        self.profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = attribute.attribute(
+        self.profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = Attribute(
             config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS,
             decoder.decode(value_to_decode),
             anchors)
 
     def set_address_to_be_formatted_address_if_null(self, anchors):
+        # setting in 'user_profile'  - will be removed once user_profile is removed
         if config.ATTRIBUTE_POSTAL_ADDRESS not in self.user_profile and config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS in self.user_profile:
             if config.KEY_FORMATTED_ADDRESS in self.user_profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS]:
                 self.user_profile[config.ATTRIBUTE_POSTAL_ADDRESS] = \
                     self.user_profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS][
                         config.KEY_FORMATTED_ADDRESS]
 
+        # setting in 'profile'
         if config.ATTRIBUTE_POSTAL_ADDRESS not in self.profile and config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS in self.profile:
             if config.KEY_FORMATTED_ADDRESS in self.profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value:
                 formatted_address = self.profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value[
                     config.KEY_FORMATTED_ADDRESS]
-                self.profile[config.ATTRIBUTE_POSTAL_ADDRESS] = attribute.attribute(
+                self.profile[config.ATTRIBUTE_POSTAL_ADDRESS] = Attribute(
                     config.ATTRIBUTE_POSTAL_ADDRESS,
                     formatted_address,
                     anchors)

yoti_python_sdk/anchor.py

@@ -38,6 +38,7 @@ def parse_anchors(anchors):
         parsed_anchors = []
         for anc in anchors:
             if hasattr(anc, 'origin_server_certs'):
+                anchor_type = "Unknown"
                 origin_server_certs_list = list(anc.origin_server_certs)
                 origin_server_certs_item = origin_server_certs_list[0]
 
@@ -53,18 +54,23 @@ def parse_anchors(anchors):
                                 anchor_type = config.ANCHOR_SOURCE
                             elif oid.dotted_string == VERIFIER_EXTENSION:
                                 anchor_type = config.ANCHOR_VERIFIER
-                            else:
-                                continue
-
-                            if hasattr(extensions, 'value'):
-                                extension_value = extensions.value
-                                if hasattr(extension_value, 'value'):
-                                    parsed_anchors.append(Anchor(
-                                        anchor_type,
-                                        anc.sub_type,
-                                        Anchor.decode_asn1_value(extension_value.value),
-                                        anc.signed_time_stamp,
-                                        crypto_cert))
+
+                            if anchor_type != "Unknown":
+                                parsed_anchors = Anchor.get_values_from_extensions(anc, anchor_type, extensions, crypto_cert, parsed_anchors)
+
+        return parsed_anchors
+
+    @staticmethod
+    def get_values_from_extensions(anc, anchor_type, extensions, crypto_cert, parsed_anchors):
+        if hasattr(extensions, 'value'):
+            extension_value = extensions.value
+            if hasattr(extension_value, 'value'):
+                parsed_anchors.append(Anchor(
+                    anchor_type,
+                    anc.sub_type,
+                    Anchor.decode_asn1_value(extension_value.value),
+                    anc.signed_time_stamp,
+                    crypto_cert))
 
         return parsed_anchors
 

yoti_python_sdk/attribute.py

@@ -1,7 +1,7 @@
 from yoti_python_sdk import config
 
 
-class attribute:
+class Attribute:
     def __init__(self, name="", value="", anchors={}):
         self.__name = name
         self.__value = value

yoti_python_sdk/tests/test_attribute.py

@@ -10,7 +10,7 @@
 def test_attribute_get_values():
     parsed_anchors = []
 
-    attribute = yoti_python_sdk.attribute.attribute(NAME, VALUE, parsed_anchors)
+    attribute = yoti_python_sdk.attribute.Attribute(NAME, VALUE, parsed_anchors)
 
     assert attribute.name == NAME
     assert attribute.value == VALUE
@@ -19,7 +19,7 @@ def test_attribute_get_values():
 
 def test_attribute_get_sources():
     anchors = create_source_and_verifier_anchors()
-    attribute = yoti_python_sdk.attribute.attribute(NAME, VALUE, anchors)
+    attribute = yoti_python_sdk.attribute.Attribute(NAME, VALUE, anchors)
     sources = attribute.sources
 
     assert len(sources) == 1
@@ -28,7 +28,7 @@ def test_attribute_get_sources():
 
 def test_attribute_get_verifiers():
     anchors = create_source_and_verifier_anchors()
-    attribute = yoti_python_sdk.attribute.attribute(NAME, VALUE, anchors)
+    attribute = yoti_python_sdk.attribute.Attribute(NAME, VALUE, anchors)
     verifiers = attribute.verifiers
 
     assert len(verifiers) == 1