Merge pull request #344 from getyoti/feat/session_deadline

[SDK-1980] Add support for Session Deadline

Author: MichalMilewiczYoti

yoti_python_sdk/doc_scan/session/create/session_spec.py

@@ -21,6 +21,7 @@ def __init__(
         requested_tasks=None,
         required_documents=None,
         block_biometric_consent=None,
+        session_deadline=None,
     ):
         """
         :param client_session_token_ttl: the client session token TTL
@@ -41,6 +42,8 @@ def __init__(
         :type required_documents: list[RequiredDocument] or None
         :param block_biometric_consent: block the collection of biometric consent
         :type block_biometric_consent: bool
+        :param session_deadline: session deadline using a Zoned timestamp
+        "type session_deadline: str
         """
         if requested_tasks is None:
             requested_tasks = []
@@ -58,6 +61,7 @@ def __init__(
         self.__requested_tasks = requested_tasks
         self.__required_documents = required_documents
         self.__block_biometric_consent = block_biometric_consent
+        self.__session_deadline = session_deadline
 
     @property
     def client_session_token_ttl(self):
@@ -152,6 +156,16 @@ def block_biometric_consent(self):
         """
         return self.__block_biometric_consent
 
+    @property
+    def session_deadline(self):
+        """
+        Session deadline used by IDV
+
+        :return: session deadline
+        :rtype: str
+        """
+        return self.__session_deadline
+
     def to_json(self):
         return remove_null_values(
             {
@@ -164,6 +178,7 @@ def to_json(self):
                 "sdk_config": self.sdk_config,
                 "required_documents": self.required_documents,
                 "block_biometric_consent": self.block_biometric_consent,
+                "session_deadline": self.session_deadline,
             }
         )
 
@@ -183,6 +198,7 @@ def __init__(self):
         self.__requested_tasks = []
         self.__required_documents = []
         self.__block_biometric_consent = None
+        self.__session_deadline = None
 
     def with_client_session_token_ttl(self, value):
         """
@@ -196,6 +212,19 @@ def with_client_session_token_ttl(self, value):
         self.__client_session_token_ttl = value
         return self
 
+    def with_session_deadline(self, value):
+        """
+        Sets the deadline that the session needs to be completed by.
+        Can be used as an alternative to with_client_session_token_ttl.
+
+        :param value: the session deadline
+        :type value: str
+        :return: the builder
+        :rtype: SessionSpecBuilder
+        """
+        self.__session_deadline = value
+        return self
+
     def with_resources_ttl(self, value):
         """
         Sets the resources TTL (time-to-live)
@@ -309,4 +338,5 @@ def build(self):
             self.__requested_tasks,
             self.__required_documents,
             self.__block_biometric_consent,
+            self.__session_deadline,
         )

yoti_python_sdk/doc_scan/session/retrieve/create_session_result.py

@@ -16,6 +16,7 @@ def __init__(self, data=None):
             data = dict()
 
         self.__client_session_token_ttl = data.get("client_session_token_ttl", None)
+        self.__session_deadline = data.get("session_deadline", None)
         self.__session_id = data.get("session_id", None)
         self.__client_session_token = data.get("client_session_token", None)
 
@@ -49,3 +50,13 @@ def session_id(self):
         :rtype: str or None
         """
         return self.__session_id
+
+    @property
+    def session_deadline(self):
+        """
+        The deadline that the session needs to be completed by.
+
+        :return: the session deadline
+        :rtype: str or None
+        """
+        return self.__session_deadline

yoti_python_sdk/tests/doc_scan/session/create/test_session_spec.py

@@ -21,6 +21,7 @@ class SessionSpecTest(unittest.TestCase):
     SOME_CLIENT_SESSION_TOKEN_TTL = 300
     SOME_RESOURCES_TTL = 100000
     SOME_USER_TRACKING_ID = "someUserTrackingId"
+    SOME_SESSION_DEADLINE = "2021-09-03T11:40:54.727619+02:00"
 
     def test_should_build_correctly(self):
         sdk_config_mock = Mock(spec=SdkConfig)
@@ -31,6 +32,7 @@ def test_should_build_correctly(self):
         result = (
             SessionSpecBuilder()
             .with_client_session_token_ttl(self.SOME_CLIENT_SESSION_TOKEN_TTL)
+            .with_session_deadline(self.SOME_SESSION_DEADLINE)
             .with_resources_ttl(self.SOME_RESOURCES_TTL)
             .with_user_tracking_id(self.SOME_USER_TRACKING_ID)
             .with_notifications(notification_mock)
@@ -49,6 +51,7 @@ def test_should_build_correctly(self):
         assert requested_check_mock in result.requested_checks
         assert len(result.requested_tasks) == 1
         assert requested_task_mock in result.requested_tasks
+        assert result.session_deadline == self.SOME_SESSION_DEADLINE
 
     def test_should_serialize_to_json_without_error(self):
         sdk_config_mock = Mock(spec=SdkConfig)
@@ -66,6 +69,7 @@ def test_should_serialize_to_json_without_error(self):
         result = (
             SessionSpecBuilder()
             .with_client_session_token_ttl(self.SOME_CLIENT_SESSION_TOKEN_TTL)
+            .with_session_deadline(self.SOME_SESSION_DEADLINE)
             .with_resources_ttl(self.SOME_RESOURCES_TTL)
             .with_user_tracking_id(self.SOME_USER_TRACKING_ID)
             .with_notifications(notification_mock)