SDK-2530-python-create-helper-methods-for-the-idv-sdk

Author: mehmet-yoti

yoti_python_sdk/doc_scan/session/retrieve/get_session_result.py

@@ -249,3 +249,21 @@ def biometric_consent_timestamp(self):
         :rtype: datetime.datetime or None
         """
         return self.__biometric_consent_timestamp
+
+    def get_resources_for_check(self, check_id):
+        """
+        Returns the resources used by the check with the given check ID
+
+        :param check_id: the ID of the check to find resources for
+        :type check_id: str
+        :return: a ResourceContainer containing only the resources used by the check
+        :rtype: ResourceContainer
+        :raises ValueError: if no check exists with the given check_id
+        """
+        check = next(
+            (check for check in self.__checks if check.id == check_id), None
+        )
+        if check is None:
+            raise ValueError("Check not found for check_id: {0}".format(check_id))
+
+        return self.__resources.filter_for_check(check)

yoti_python_sdk/doc_scan/session/retrieve/resource_container.py

@@ -140,3 +140,34 @@ def share_codes(self):
         :rtype: list[ShareCodeResourceResponse]
         """
         return self.__share_codes
+
+    def filter_for_check(self, check_response):
+        """
+        Returns a new ResourceContainer containing only the resources
+        referenced by the given check's resources_used
+
+        :param check_response: the check to filter resources for
+        :type check_response: yoti_python_sdk.doc_scan.session.retrieve.check_response.CheckResponse
+        :return: a ResourceContainer containing only the resources used by the check
+        :rtype: ResourceContainer
+        """
+        resource_ids = set(check_response.resources_used)
+
+        filtered = ResourceContainer()
+        filtered.__id_documents = self.__filter_resources(
+            self.__id_documents, resource_ids
+        )
+        filtered.__supplementary_documents = self.__filter_resources(
+            self.__supplementary_documents, resource_ids
+        )
+        filtered.__liveness_capture = self.__filter_resources(
+            self.__liveness_capture, resource_ids
+        )
+        filtered.__share_codes = self.__filter_resources(
+            self.__share_codes, resource_ids
+        )
+        return filtered
+
+    @staticmethod
+    def __filter_resources(resources, resource_ids):
+        return [resource for resource in resources if resource.id in resource_ids]

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

@@ -2,6 +2,7 @@
 
 from datetime import datetime
 
+import pytest
 import pytz
 
 from yoti_python_sdk.doc_scan.session.retrieve.check_response import (
@@ -116,6 +117,49 @@ def test_should_filter_checks(self):
             SupplementaryDocumentTextDataCheckResponse,
         )
 
+    def test_get_resources_for_check_should_return_only_resources_used_by_check(self):
+        data = {
+            "checks": [
+                {
+                    "id": "check-1",
+                    "type": "ID_DOCUMENT_AUTHENTICITY",
+                    "resources_used": ["id-doc-1"],
+                },
+                {
+                    "id": "check-2",
+                    "type": "LIVENESS",
+                    "resources_used": ["liveness-1"],
+                },
+            ],
+            "resources": {
+                "id_documents": [{"id": "id-doc-1"}, {"id": "id-doc-2"}],
+                "liveness_capture": [
+                    {"id": "liveness-1", "liveness_type": "ZOOM"},
+                    {"id": "liveness-2", "liveness_type": "ZOOM"},
+                ],
+            },
+        }
+
+        result = GetSessionResult(data)
+
+        resources_for_check = result.get_resources_for_check("check-1")
+
+        assert isinstance(resources_for_check, ResourceContainer)
+        assert [d.id for d in resources_for_check.id_documents] == ["id-doc-1"]
+        assert resources_for_check.liveness_capture == []
+
+    def test_get_resources_for_check_should_raise_for_unknown_check_id(self):
+        data = {
+            "checks": [{"id": "check-1", "type": "ID_DOCUMENT_AUTHENTICITY"}],
+            "resources": {},
+        }
+        result = GetSessionResult(data)
+
+        with pytest.raises(ValueError) as ex:
+            result.get_resources_for_check("someUnknownCheckId")
+
+        assert "someUnknownCheckId" in str(ex.value)
+
 
 if __name__ == "__main__":
     unittest.main()

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

@@ -1,5 +1,6 @@
 import unittest
 
+from yoti_python_sdk.doc_scan.session.retrieve.check_response import CheckResponse
 from yoti_python_sdk.doc_scan.session.retrieve.liveness_resource_response import (
     LivenessResourceResponse,
 )
@@ -113,6 +114,68 @@ def test_should_parse_with_missing_share_codes(self):
 
         assert len(result.share_codes) == 0
 
+    def test_filter_for_check_should_return_only_referenced_resources(self):
+        data = {
+            "id_documents": [{"id": "id-doc-1"}, {"id": "id-doc-2"}],
+            "supplementary_documents": [
+                {"id": "supp-doc-1"},
+                {"id": "supp-doc-2"},
+            ],
+            "liveness_capture": [
+                {"id": "liveness-1", "liveness_type": "ZOOM"},
+                {"id": "liveness-2", "liveness_type": "ZOOM"},
+            ],
+            "share_codes": [
+                {"id": "share-code-1", "source": "END_USER", "tasks": []},
+                {"id": "share-code-2", "source": "END_USER", "tasks": []},
+            ],
+        }
+        container = ResourceContainer(data)
+        check = CheckResponse(
+            {
+                "resources_used": [
+                    "id-doc-1",
+                    "supp-doc-1",
+                    "liveness-1",
+                    "share-code-1",
+                ]
+            }
+        )
+
+        result = container.filter_for_check(check)
+
+        assert isinstance(result, ResourceContainer)
+        assert [d.id for d in result.id_documents] == ["id-doc-1"]
+        assert [d.id for d in result.supplementary_documents] == ["supp-doc-1"]
+        assert [d.id for d in result.liveness_capture] == ["liveness-1"]
+        assert [d.id for d in result.share_codes] == ["share-code-1"]
+
+    def test_filter_for_check_should_return_empty_lists_when_no_matches(self):
+        data = {
+            "id_documents": [{"id": "id-doc-1"}],
+            "share_codes": [{"id": "share-code-1", "source": "END_USER", "tasks": []}],
+        }
+        container = ResourceContainer(data)
+        check = CheckResponse({"resources_used": ["someOtherResourceId"]})
+
+        result = container.filter_for_check(check)
+
+        assert result.id_documents == []
+        assert result.supplementary_documents == []
+        assert result.liveness_capture == []
+        assert result.share_codes == []
+
+    def test_filter_for_check_should_return_empty_lists_when_check_has_no_resources_used(
+        self,
+    ):
+        data = {"id_documents": [{"id": "id-doc-1"}]}
+        container = ResourceContainer(data)
+        check = CheckResponse({})
+
+        result = container.filter_for_check(check)
+
+        assert result.id_documents == []
+
 
 if __name__ == "__main__":
     unittest.main()