SDK-350: Change getters to property decorators, add sources & verifiers to Django example project

Author: echarrod

examples/yoti_example_django/yoti_example/templates/profile.html

@@ -24,12 +24,12 @@ class AuthView(TemplateView):
     def get(self, request, *args, **kwargs):
         client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
         activity_details = client.get_activity_details(request.GET['token'])
-        context = activity_details.user_profile
+        context = activity_details.profile
         context['base64_selfie_uri'] = getattr(activity_details, 'base64_selfie_uri')
 
         selfie = context.get('selfie')
         if selfie is not None:
-            self.save_image(selfie)
+            self.save_image(selfie.value)
         return self.render_to_response(context)
 
     @staticmethod

examples/yoti_example_django/yoti_example/views.py

@@ -65,23 +65,27 @@ def try_parse_age_verified_field(self, field, anchors):
         raise TypeError("age_verified_field unable to be parsed")
 
     def try_convert_structured_postal_address_to_dict(self, field, anchors):
-        decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict)
-        self.user_profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS] = decoder.decode(field.value)
+        decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict, strict=False)
+        value_to_decode = field.value
+        if not isinstance(value_to_decode, str):
+            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(
             config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS,
-            decoder.decode(field.value),
+            decoder.decode(value_to_decode),
             anchors)
 
     def set_address_to_be_formatted_address_if_null(self, anchors):
         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]
+                    self.user_profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS][
+                        config.KEY_FORMATTED_ADDRESS]
 
         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].get_value():
-                formatted_address = self.profile[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].get_value()[
+            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(
                     config.ATTRIBUTE_POSTAL_ADDRESS,

yoti_python_sdk/activity_details.py

@@ -13,16 +13,11 @@
 
 
 class Anchor:
-    anchor_type = "Unknown"
-    sub_type = ""
-    value = ""
-    signed_timestamp = compubapi.SignedTimestamp()
-
-    def __init__(self, anchor_type=None, sub_type=None, value=None, signed_timestamp=None):
-        self.anchor_type = anchor_type
-        self.sub_type = sub_type
-        self.value = value
-        self.signed_timestamp = signed_timestamp
+    def __init__(self, anchor_type="Unknown", sub_type="", value="", signed_timestamp=None):
+        self.__anchor_type = anchor_type
+        self.__sub_type = sub_type
+        self.__value = value
+        self.__signed_timestamp = signed_timestamp
 
     def __iter__(self):
         return self
@@ -39,9 +34,8 @@ def __next__(self):
 
     @staticmethod
     def parse_anchors(anchors):
+        parsed_anchors = []
         for anc in anchors:
-            parsed_anchors = []
-
             if hasattr(anc, 'origin_server_certs'):
                 origin_server_certs_list = list(anc.origin_server_certs)
                 origin_server_certs_item = origin_server_certs_list[0]
@@ -65,9 +59,9 @@ def parse_anchors(anchors):
                                 if hasattr(extension_value, 'value'):
                                     parsed_anchors.append(Anchor(
                                         anchor_type,
-                                        Anchor.get_sub_type(anc),
+                                        anc.sub_type,
                                         Anchor.decode_asn1_value(extension_value.value),
-                                        Anchor.get_signed_timestamp(anc)))
+                                        anc.signed_time_stamp))
 
         return parsed_anchors
 
@@ -85,26 +79,31 @@ def decode_asn1_value(value_to_decode):
         utf8_value = twice_decoded_value.decode('utf-8')
         return utf8_value
 
-    @staticmethod
-    def get_sub_type(anchor):
-        if hasattr(anchor, 'sub_type'):
-            return anchor.sub_type
-        else:
-            return ""
+    @property
+    def anchor_type(self):
+        return self.__anchor_type
 
-    @staticmethod
-    def get_signed_timestamp(anchor):
-        if hasattr(anchor, 'signed_time_stamp'):
-            signed_timestamp_object = compubapi.SignedTimestamp()
-            signed_timestamp_object.MergeFromString(anchor.signed_time_stamp)
-
-            try:
-                signed_timestamp_parsed = datetime.datetime.fromtimestamp(
-                    signed_timestamp_object.timestamp / float(1000000))
-            except OSError:
-                print("Unable to parse timestamp from integer: '{0}'".format(signed_timestamp_object.timestamp))
-                return ""
-
-            return signed_timestamp_parsed
-        else:
+    @property
+    def value(self):
+        return self.__value
+
+    @property
+    def sub_type(self):
+        return self.__sub_type
+
+    @property
+    def signed_timestamp(self):
+        if self.__signed_timestamp is None:
+            return None
+
+        signed_timestamp_object = compubapi.SignedTimestamp()
+        signed_timestamp_object.MergeFromString(self.__signed_timestamp)
+
+        try:
+            signed_timestamp_parsed = datetime.datetime.fromtimestamp(
+                signed_timestamp_object.timestamp / float(1000000))
+        except OSError:
+            print("Unable to parse timestamp from integer: '{0}'".format(signed_timestamp_object.timestamp))
             return ""
+
+        return signed_timestamp_parsed

yoti_python_sdk/anchor.py

@@ -2,26 +2,27 @@
 
 
 class attribute:
-    name = ""
-    value = ""
-    anchors = {}
-
-    def __init__(self, name, value, anchors):
-        self.name = name
-        self.value = value
-        self.anchors = anchors
-
-    def get_name(self):
-        return self.name
-
-    def get_value(self):
-        return self.value
-
-    def get_anchors(self):
-        return self.anchors
-
-    def get_sources(self):
-        return list(filter(lambda a: a.anchor_type == config.ANCHOR_SOURCE, self.anchors))
-
-    def get_verifiers(self):
-        return list(filter(lambda a: a.anchor_type == config.ANCHOR_VERIFIER, self.anchors))
+    def __init__(self, name="", value="", anchors={}):
+        self.__name = name
+        self.__value = value
+        self.__anchors = anchors
+
+    @property
+    def name(self):
+        return self.__name
+
+    @property
+    def value(self):
+        return self.__value
+
+    @property
+    def anchors(self):
+        return self.__anchors
+
+    @property
+    def sources(self):
+        return list(filter(lambda a: a.anchor_type == config.ANCHOR_SOURCE, self.__anchors))
+
+    @property
+    def verifiers(self):
+        return list(filter(lambda a: a.anchor_type == config.ANCHOR_VERIFIER, self.__anchors))

yoti_python_sdk/attribute.py

@@ -109,7 +109,7 @@ def test_try_parse_age_verified_field_age_over():
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field, None)
     assert activity_details.user_profile['is_age_verified'] is True
-    assert activity_details.profile['is_age_verified'].get_value() is True
+    assert activity_details.profile['is_age_verified'].value is True
 
 
 def test_try_parse_age_verified_field_age_under():
@@ -118,7 +118,7 @@ def test_try_parse_age_verified_field_age_under():
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field, None)
     assert activity_details.user_profile['is_age_verified'] is False
-    assert activity_details.profile['is_age_verified'].get_value() is False
+    assert activity_details.profile['is_age_verified'].value is False
 
 
 def test_try_parse_age_verified_field_non_bool_value_throws_error():
@@ -160,7 +160,7 @@ def test_try_parse_structured_postal_address_uk():
     assert actual_structured_postal_address_user_profile[FORMATTED_ADDRESS_KEY] == FORMATTED_ADDRESS_VALUE
 
     actual_structured_postal_address_profile = activity_details.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].get_value()
+        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == ADDRESS_FORMAT_VALUE
@@ -214,7 +214,7 @@ def test_try_parse_structured_postal_address_india():
     assert actual_structured_postal_address_user_profile[FORMATTED_ADDRESS_KEY] == INDIA_FORMATTED_ADDRESS_VALUE
 
     actual_structured_postal_address_profile = activity_details.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].get_value()
+        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == INDIA_FORMAT_VALUE
@@ -263,7 +263,7 @@ def test_try_parse_structured_postal_address_usa():
     assert actual_structured_postal_address_user_profile[FORMATTED_ADDRESS_KEY] == USA_FORMATTED_ADDRESS_VALUE
 
     actual_structured_postal_address_profile = activity_details.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].get_value()
+        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == USA_FORMAT_VALUE
@@ -319,7 +319,7 @@ def test_try_parse_structured_postal_address_nested_json():
     assert actual_structured_postal_address_user_profile[FORMATTED_ADDRESS_KEY] == formatted_address_json
 
     actual_structured_postal_address_profile = activity_details.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].get_value()
+        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == ADDRESS_FORMAT_VALUE
@@ -348,4 +348,4 @@ def test_set_address_to_be_formatted_address():
     ActivityDetails.set_address_to_be_formatted_address_if_null(activity_details, None)
 
     assert activity_details.user_profile[config.ATTRIBUTE_POSTAL_ADDRESS] == FORMATTED_ADDRESS_VALUE
-    assert activity_details.profile[config.ATTRIBUTE_POSTAL_ADDRESS].get_value() == FORMATTED_ADDRESS_VALUE
+    assert activity_details.profile[config.ATTRIBUTE_POSTAL_ADDRESS].value == FORMATTED_ADDRESS_VALUE

yoti_python_sdk/tests/test_activity_details.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import datetime
+import yoti_python_sdk
 
 from yoti_python_sdk import config
 from yoti_python_sdk.tests import anchor_parser
@@ -30,3 +31,12 @@ def test_parse_yoti_admin():
     assert parsed_anchor.signed_timestamp == datetime.datetime(2018, 4, 11, 13, 13, 4, 95238)
     assert parsed_anchor.sub_type == ""
     assert parsed_anchor.value == "YOTI_ADMIN"
+
+
+def test_anchor_returns_correct_default_values():
+    anchor = yoti_python_sdk.anchor.Anchor()
+
+    assert anchor.anchor_type == "Unknown"
+    assert anchor.signed_timestamp is None
+    assert anchor.sub_type == ""
+    assert anchor.value == ""

yoti_python_sdk/tests/test_anchor.py

@@ -12,15 +12,15 @@ def test_attribute_get_values():
 
     attribute = yoti_python_sdk.attribute.attribute(NAME, VALUE, parsed_anchors)
 
-    assert attribute.get_name() == NAME
-    assert attribute.get_value() == VALUE
-    assert attribute.get_anchors() == parsed_anchors
+    assert attribute.name == NAME
+    assert attribute.value == VALUE
+    assert attribute.anchors == parsed_anchors
 
 
 def test_attribute_get_sources():
     anchors = create_source_and_verifier_anchors()
     attribute = yoti_python_sdk.attribute.attribute(NAME, VALUE, anchors)
-    sources = attribute.get_sources()
+    sources = attribute.sources
 
     assert len(sources) == 1
     assert sources[0].anchor_type == config.ANCHOR_SOURCE
@@ -29,7 +29,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)
-    verifiers = attribute.get_verifiers()
+    verifiers = attribute.verifiers
 
     assert len(verifiers) == 1
     assert verifiers[0].anchor_type == config.ANCHOR_VERIFIER

yoti_python_sdk/tests/test_attribute.py

@@ -144,7 +144,7 @@ def test_requesting_activity_details_with_correct_data(
     selfie_user_profile = activity_details.user_profile.get('selfie')
     assert isinstance(selfie_user_profile, basestring)
 
-    selfie_profile = activity_details.profile.get('selfie').get_value()
+    selfie_profile = activity_details.profile.get('selfie').value
     assert isinstance(selfie_profile, basestring)
 
     base64_selfie_uri = getattr(activity_details, 'base64_selfie_uri')