SDK-1098: Add initial support for getting application profile details from activity details

Author: MrBurtyyy

yoti_python_sdk/activity_details.py

@@ -6,14 +6,15 @@
 from datetime import datetime
 
 from yoti_python_sdk import attribute_parser, config
-from yoti_python_sdk.profile import Profile
+from yoti_python_sdk.profile import Profile, ApplicationProfile
 
 
 class ActivityDetails:
-    def __init__(self, receipt, decrypted_profile=None):
+    def __init__(self, receipt, decrypted_profile=None, decrypted_application_profile=None):
         self.decrypted_profile = decrypted_profile
         self.user_profile = {}  # will be removed in v3.0.0
         self.base64_selfie_uri = None
+        self.application_profile = None
 
         if decrypted_profile and hasattr(decrypted_profile, "attributes"):
             decrypted_profile_attributes = decrypted_profile.attributes
@@ -55,6 +56,11 @@ def __init__(self, receipt, decrypted_profile=None):
                         )
 
             self.ensure_postal_address()
+                    
+
+        if decrypted_application_profile and hasattr(decrypted_application_profile, "attributes"):
+            decrypted_application_profile_attributes = decrypted_application_profile.attributes
+            self.application_profile = ApplicationProfile(decrypted_application_profile_attributes)
 
         self.__remember_me_id = receipt.get("remember_me_id")
         self.parent_remember_me_id = receipt.get("parent_remember_me_id")

yoti_python_sdk/client.py

@@ -78,6 +78,7 @@ def get_activity_details(self, encrypted_request_token):
         receipt = json.loads(response.text).get("receipt")
 
         encrypted_data = proto.current_user(receipt)
+        encrypted_application_profile = proto.current_application(receipt)
 
         if not encrypted_data:
             return ActivityDetails(receipt)
@@ -86,8 +87,12 @@ def get_activity_details(self, encrypted_request_token):
         decrypted_data = self.__crypto.decipher(
             unwrapped_key, encrypted_data.iv, encrypted_data.cipher_text
         )
+        decrypted_application_data = self.__crypto.decipher(
+            unwrapped_key, encrypted_application_profile.iv, encrypted_application_profile.cipher_text
+        )
+
         attribute_list = proto.attribute_list(decrypted_data)
-        return ActivityDetails(receipt, attribute_list)
+        return ActivityDetails(receipt, attribute_list, decrypted_application_profile=decrypted_application_data)
 
     def perform_aml_check(self, aml_profile):
         if aml_profile is None:

yoti_python_sdk/config.py

@@ -16,6 +16,10 @@
 ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS = "structured_postal_address"
 ATTRIBUTE_DOCUMENT_IMAGES = "document_images"
 ATTRIBUTE_DOCUMENT_DETAILS = "document_details"
+ATTRIBUTE_APPLICATION_NAME = "application_name"
+ATTRIBUTE_APPLICATION_LOGO = "application_logo"
+ATTRIBUTE_APPLICATION_URL = "application_url"
+ATTRIBUTE_APPLICATION_RECEIPT_BGCOLOR = "application_receipt_bgcolor"
 ANCHOR_SOURCE = "SOURCE"
 ANCHOR_VERIFIER = "VERIFIER"
 KEY_AGE_VERIFIED = "is_age_verified"

yoti_python_sdk/profile.py

@@ -7,8 +7,8 @@
 from yoti_python_sdk.image import Image
 from yoti_python_sdk import document_details
 
+class BaseProfile:
 
-class Profile:
     def __init__(self, profile_attributes):
         self.attributes = {}
 
@@ -44,7 +44,21 @@ def __init__(self, profile_attributes):
                             )
                         )
 
-            self.ensure_postal_address()
+    def get_attribute(self, attribute_name):
+        """retrieves an attribute based on its name
+        :param attribute_name:
+        :return: Attribute
+        """
+        if attribute_name in self.attributes:
+            return self.attributes.get(attribute_name)
+        else:
+            return None
+
+
+class Profile(BaseProfile):
+    def __init__(self, profile_attributes):
+        super(Profile, self).__init__(profile_attributes)
+        self.ensure_postal_address()
 
     @property
     def date_of_birth(self):
@@ -145,15 +159,6 @@ def document_images(self):
     def document_details(self):
         return self.get_attribute(config.ATTRIBUTE_DOCUMENT_DETAILS)
 
-    def get_attribute(self, attribute_name):
-        """retrieves an attribute based on its name
-        :param attribute_name:
-        :return: Attribute
-        """
-        if attribute_name in self.attributes:
-            return self.attributes.get(attribute_name)
-        else:
-            return None
 
     def ensure_postal_address(self):
         if (
@@ -173,3 +178,28 @@ def ensure_postal_address(self):
                     formatted_address,
                     structured_postal_address.anchors,
                 )
+
+def ApplicationProfile(BaseProfile):
+
+    def __init__(self, profile_attributes):
+        super(ApplicationProfile, self).__init__(profile_attributes)
+        
+    @property
+    def application_name(self):
+        """
+        application_name is the name of the application set in Yoti Hub
+        :return: Attribute(str)
+        """
+        return self.get_attribute(config.ATTRIBUTE_APPLICATION_NAME)
+
+    @property
+    def application_url(self):
+        return self.get_attribute(config.ATTRIBUTE_APPLICATION_URL)
+
+    @property
+    def application_logo(self):
+        return self.get_attribute(config.ATTRIBUTE_APPLICATION_LOGO)
+
+    @property
+    def application_receipt_bg_color(self):
+        return self.get_attribute(config.ATTRIBUTE_APPLICATION_RECEIPT_BGCOLOR)

yoti_python_sdk/protobuf/protobuf.py

@@ -28,6 +28,19 @@ def current_user(receipt):
         merged_user.MergeFromString(decoded_profile_content)
         return merged_user
 
+    @staticmethod
+    def current_application(receipt):
+        if receipt.get("profile_content") is None or receipt.get("profile_content") == '':
+            return None
+
+        application_content = receipt["profile_content"]
+        decoded_application_content = base64.b64decode(application_content)
+
+        merged_application = EncryptedData_pb2.EncryptedData()
+        merged_application.MergeFromString(decoded_application_content)
+
+        return merged_application
+
     @staticmethod
     def attribute_list(data):
         attribute_list = List_pb2.AttributeList()