SDK-1739: Add biometric consent support

Author: davidgrayston

yoti_python_sdk/doc_scan/session/create/session_spec.py

@@ -20,6 +20,7 @@ def __init__(
         requested_checks=None,
         requested_tasks=None,
         required_documents=None,
+        block_biometric_consent=None,
     ):
         """
         :param client_session_token_ttl: the client session token TTL
@@ -38,6 +39,8 @@ def __init__(
         :type requested_tasks: list[RequestedTask] or None
         :param required_documents: the list of required documents
         :type required_documents: list[RequiredDocument] or None
+        :param block_biometric_consent: block the collection of biometric consent
+        :type block_biometric_consent: bool
         """
         if requested_tasks is None:
             requested_tasks = []
@@ -54,6 +57,7 @@ def __init__(
         self.__requested_checks = requested_checks
         self.__requested_tasks = requested_tasks
         self.__required_documents = required_documents
+        self.__block_biometric_consent = block_biometric_consent
 
     @property
     def client_session_token_ttl(self):
@@ -138,6 +142,16 @@ def required_documents(self):
         """
         return self.__required_documents
 
+    @property
+    def block_biometric_consent(self):
+        """
+        Whether or not to block the collection of biometric consent.
+
+        :return: block biometric consent
+        :rtype: bool
+        """
+        return self.__block_biometric_consent
+
     def to_json(self):
         return remove_null_values(
             {
@@ -149,6 +163,7 @@ def to_json(self):
                 "requested_tasks": self.requested_tasks,
                 "sdk_config": self.sdk_config,
                 "required_documents": self.required_documents,
+                "block_biometric_consent": self.block_biometric_consent,
             }
         )
 
@@ -167,6 +182,7 @@ def __init__(self):
         self.__requested_checks = []
         self.__requested_tasks = []
         self.__required_documents = []
+        self.__block_biometric_consent = None
 
     def with_client_session_token_ttl(self, value):
         """
@@ -264,6 +280,18 @@ def with_required_document(self, required_document):
         self.__required_documents.append(required_document)
         return self
 
+    def with_block_biometric_consent(self, block_biometric_consent):
+        """
+        Sets whether or not to block the collection of biometric consent
+
+        :param block_biometric_consent: block biometric consent
+        :type block_biometric_consent: bool
+        :return: the builder
+        :rtype: SessionSpecBuilder
+        """
+        self.__block_biometric_consent = block_biometric_consent
+        return self
+
     def build(self):
         """
         Builds a :class:`SessionSpec` using the supplied values
@@ -280,4 +308,5 @@ def build(self):
             self.__requested_checks,
             self.__requested_tasks,
             self.__required_documents,
+            self.__block_biometric_consent,
         )

yoti_python_sdk/doc_scan/session/retrieve/get_session_result.py

@@ -1,6 +1,11 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+from iso8601 import (
+    ParseError,
+    iso8601,
+)
+
 from yoti_python_sdk.doc_scan import constants
 from .check_response import AuthenticityCheckResponse
 from .check_response import CheckResponse
@@ -29,10 +34,32 @@ def __init__(self, data):
         self.__state = data.get("state", None)
         self.__client_session_token = data.get("client_session_token", None)
         self.__checks = [self.__parse_check(check) for check in data.get("checks", [])]
+        self.__biometric_consent_timestamp = self.__parse_date(
+            data.get("biometric_consent", None)
+        )
 
         resources = data.get("resources", None)
         self.__resources = ResourceContainer(resources) or None
 
+    @staticmethod
+    def __parse_date(date):
+        """
+        Attempts to parse a date from string using the
+        iso8601 library.  Returns None if there was an error
+
+        :param date: the datestring to parse
+        :type date: str
+        :return: the parsed date
+        :rtype: datetime.datetime or None
+        """
+        if date is None:
+            return date
+
+        try:
+            return iso8601.parse_date(date)
+        except ParseError:
+            return None
+
     @staticmethod
     def __parse_check(check):
         """
@@ -184,3 +211,13 @@ def resources(self):
         :rtype: ResourceContainer or None
         """
         return self.__resources
+
+    @property
+    def biometric_consent_timestamp(self):
+        """
+        The biometric constent timestamp
+
+        :return: the biometric constent timestamp
+        :rtype: datetime.datetime or None
+        """
+        return self.__biometric_consent_timestamp

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

@@ -104,6 +104,21 @@ def test_should_default_empty_arrays(self):
         assert len(result.requested_tasks) == 0
         assert len(result.required_documents) == 0
 
+    def test_should_build_correctly_with_block_biometric_consent_true(self):
+        result = SessionSpecBuilder().with_block_biometric_consent(True).build()
+
+        assert result.block_biometric_consent is True
+
+    def test_should_build_correctly_with_block_biometric_consent_false(self):
+        result = SessionSpecBuilder().with_block_biometric_consent(False).build()
+
+        assert result.block_biometric_consent is False
+
+    def test_should_build_correctly_without_block_biometric_consent_false(self):
+        result = SessionSpecBuilder().build()
+
+        assert result.block_biometric_consent is None
+
 
 if __name__ == "__main__":
     unittest.main()

yoti_python_sdk/tests/doc_scan/session/retrieve/test_get_session_result.py

@@ -1,5 +1,9 @@
 import unittest
 
+from datetime import datetime
+
+import pytz
+
 from yoti_python_sdk.doc_scan.session.retrieve.check_response import (
     AuthenticityCheckResponse,
 )
@@ -29,6 +33,7 @@ class GetSessionResultTest(unittest.TestCase):
     SOME_USER_TRACKING_ID = "someUserTrackingId"
     SOME_STATE = "someState"
     SOME_CLIENT_SESSION_TOKEN = "someClientSessionToken"
+    SOME_BIOMETRIC_CONSENT = "2019-05-01T05:01:48.000Z"
     SOME_CHECKS = [
         {"type": "ID_DOCUMENT_AUTHENTICITY"},
         {"type": "ID_DOCUMENT_TEXT_DATA_CHECK"},
@@ -37,6 +42,17 @@ class GetSessionResultTest(unittest.TestCase):
         {"type": "ID_DOCUMENT_COMPARISON"},
     ]
 
+    EXPECTED_BIOMETRIC_CONSENT_DATETIME = datetime(
+        year=2019,
+        month=5,
+        day=1,
+        hour=5,
+        minute=1,
+        second=48,
+        microsecond=0,
+        tzinfo=pytz.utc,
+    )
+
     def test_should_parse_different_checks(self):
         data = {
             "client_session_token_ttl": self.SOME_CLIENT_SESSION_TOKEN_TTL,
@@ -46,6 +62,7 @@ def test_should_parse_different_checks(self):
             "user_tracking_id": self.SOME_USER_TRACKING_ID,
             "checks": self.SOME_CHECKS,
             "resources": {},
+            "biometric_consent": self.SOME_BIOMETRIC_CONSENT,
         }
 
         result = GetSessionResult(data)
@@ -65,6 +82,12 @@ def test_should_parse_different_checks(self):
 
         assert isinstance(result.resources, ResourceContainer)
 
+        assert isinstance(result.biometric_consent_timestamp, datetime)
+        assert (
+            result.biometric_consent_timestamp
+            == self.EXPECTED_BIOMETRIC_CONSENT_DATETIME
+        )
+
     def test_should_filter_checks(self):
         data = {"checks": self.SOME_CHECKS}