SDK-1639: Add support for chip data

Author: davidgrayston

examples/doc_scan/app.py

@@ -66,7 +66,10 @@ def create_session():
         )
         .with_requested_check(RequestedIDDocumentComparisonCheckBuilder().build())
         .with_requested_task(
-            RequestedTextExtractionTaskBuilder().with_manual_check_never().build()
+            RequestedTextExtractionTaskBuilder()
+            .with_manual_check_never()
+            .with_chip_data_desired()
+            .build()
         )
         .with_sdk_config(sdk_config)
         .with_required_document(build_required_id_document_restriction("PASSPORT"))

examples/doc_scan/templates/success.html

@@ -222,6 +222,26 @@ <h5>Media</h5>
                                 </div>
                             </div>
                         {% endif %}
+
+                        {% if document.document_id_photo is not none %}
+                        <div class="card">
+                            <div class="card-header" id="document-id-photo-{{ doc_num }}">
+                                <h4 class="mb-0">
+                                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#collapse-document-id-photo-{{ doc_num }}" aria-expanded="true" aria-controls="collapse-document-id-photo-{{ doc_num }}">
+                                        Document ID Photo
+                                    </button>
+                                </h4>
+                            </div>
+                            <div id="collapse-document-id-photo-{{ doc_num }}" class="collapse" aria-labelledby="document-id-photo-{{ doc_num }}">
+                                <div class="card-body">
+                                    {% if document.document_fields.media is not none %}
+                                    <img class="card-img-top" src="/media?mediaId={{ document.document_id_photo.media.id }}" />
+                                    {% endif %}
+                                </div>
+                            </div>
+                        </div>
+                        {% endif %}
+
                         {% if document.text_extraction_tasks|length > 0 %}
                             <div class="card">
                                 <div class="card-header" id="text-extraction-tasks-{{ doc_num }}">

yoti_python_sdk/doc_scan/constants.py

@@ -26,3 +26,6 @@
 ALWAYS = "ALWAYS"
 FALLBACK = "FALLBACK"
 NEVER = "NEVER"
+
+DESIRED = "DESIRED"
+IGNORE = "IGNORE"

yoti_python_sdk/doc_scan/session/create/task/text_extraction.py

@@ -7,12 +7,13 @@
 
 
 class RequestedTextExtractionTaskConfig(YotiSerializable):
-    def __init__(self, manual_check):
+    def __init__(self, manual_check, chip_data=None):
         """
         :param manual_check: the manual check value
         :type manual_check: str
         """
         self.__manual_check = manual_check
+        self.__chip_data = chip_data
 
     @property
     def manual_check(self):
@@ -23,8 +24,20 @@ def manual_check(self):
         """
         return self.__manual_check
 
+    @property
+    def chip_data(self):
+        """
+        Describes how to use chip data from an ID document if
+        it is available
+
+        :return: the chip data usage
+        """
+        return self.__chip_data
+
     def to_json(self):
-        return remove_null_values({"manual_check": self.manual_check})
+        return remove_null_values(
+            {"manual_check": self.manual_check, "chip_data": self.chip_data}
+        )
 
 
 class RequestedTextExtractionTask(RequestedTask):
@@ -55,6 +68,7 @@ class RequestedTextExtractionTaskBuilder(object):
 
     def __init__(self):
         self.__manual_check = None
+        self.__chip_data = None
 
     def with_manual_check_always(self):
         """
@@ -86,6 +100,28 @@ def with_manual_check_never(self):
         self.__manual_check = constants.NEVER
         return self
 
+    def with_chip_data_desired(self):
+        """
+        The TextExtractionTask will use chip data if it is available
+
+        :return: the builder
+        :rtype: RequestedTextExtractionTaskBuilder
+        """
+        self.__chip_data = constants.DESIRED
+        return self
+
+    def with_chip_data_ignore(self):
+        """
+        The TextExtractionTask will ignore chip data
+
+        :return: the builder
+        :rtype: RequestedTextExtractionTaskBuilder
+        """
+        self.__chip_data = constants.IGNORE
+        return self
+
     def build(self):
-        config = RequestedTextExtractionTaskConfig(self.__manual_check)
+        config = RequestedTextExtractionTaskConfig(
+            self.__manual_check, self.__chip_data
+        )
         return RequestedTextExtractionTask(config)

yoti_python_sdk/doc_scan/session/retrieve/document_id_photo_response.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from yoti_python_sdk.doc_scan.session.retrieve.media_response import MediaResponse
+
+
+class DocumentIdPhotoResponse(object):
+    """
+    Represents the document ID photo response
+    """
+
+    def __init__(self, data=None):
+        """
+        :param data: the data to parse
+        :type data: dict or None
+        """
+        if data is None:
+            data = dict()
+
+        if "media" in data.keys():
+            self.__media = MediaResponse(data["media"])
+        else:
+            self.__media = None
+
+    @property
+    def media(self):
+        """
+        The media object for the document ID photo
+
+        :return: the media
+        :rtype: MediaResponse or None
+        """
+        return self.__media

yoti_python_sdk/doc_scan/session/retrieve/id_document_resource_response.py

@@ -4,6 +4,9 @@
 from yoti_python_sdk.doc_scan.session.retrieve.document_fields_response import (
     DocumentFieldsResponse,
 )
+from yoti_python_sdk.doc_scan.session.retrieve.document_id_photo_response import (
+    DocumentIdPhotoResponse,
+)
 from yoti_python_sdk.doc_scan.session.retrieve.page_response import PageResponse
 from yoti_python_sdk.doc_scan.session.retrieve.resource_response import ResourceResponse
 from yoti_python_sdk.doc_scan.session.retrieve.task_response import (
@@ -34,6 +37,11 @@ def __init__(self, data=None):
             if "document_fields" in data.keys()
             else None
         )
+        self.__document_id_photo = (
+            DocumentIdPhotoResponse(data["document_id_photo"])
+            if "document_id_photo" in data.keys()
+            else None
+        )
 
     @property
     def document_type(self):
@@ -75,6 +83,16 @@ def document_fields(self):
         """
         return self.__document_fields
 
+    @property
+    def document_id_photo(self):
+        """
+        Returns the associated document ID photo
+
+        :return: the document ID photo
+        :rtype: DocumentIdPhotoResponse
+        """
+        return self.__document_id_photo
+
     @property
     def text_extraction_tasks(self):
         """

yoti_python_sdk/tests/doc_scan/session/create/task/test_text_extraction_task.py

@@ -15,14 +15,18 @@
 
 
 class RequestedTextExtractionTaskTest(unittest.TestCase):
-    def test_should_build_with_manual_check_always(self):
-        result = RequestedTextExtractionTaskBuilder().with_manual_check_always().build()
+    def test_should_build_text_data_extraction_task(self):
+        result = RequestedTextExtractionTaskBuilder().build()
 
         assert isinstance(result, RequestedTask)
         assert isinstance(result, RequestedTextExtractionTask)
         assert isinstance(result.config, RequestedTextExtractionTaskConfig)
 
         assert result.type == "ID_DOCUMENT_TEXT_DATA_EXTRACTION"
+
+    def test_should_build_with_manual_check_always(self):
+        result = RequestedTextExtractionTaskBuilder().with_manual_check_always().build()
+
         assert result.config.manual_check == "ALWAYS"
 
     def test_should_build_with_manual_check_fallback(self):
@@ -37,12 +41,46 @@ def test_should_build_with_manual_check_never(self):
 
         assert result.config.manual_check == "NEVER"
 
+    def test_should_build_with_chip_data_desired(self):
+        result = RequestedTextExtractionTaskBuilder().with_chip_data_desired().build()
+
+        assert result.config.chip_data == "DESIRED"
+
+    def test_should_build_with_chip_data_ignore(self):
+        result = RequestedTextExtractionTaskBuilder().with_chip_data_ignore().build()
+
+        assert result.config.chip_data == "IGNORE"
+
     def test_should_serialize_to_json_without_error(self):
         result = RequestedTextExtractionTaskBuilder().with_manual_check_never().build()
 
         s = json.dumps(result, cls=YotiEncoder)
         assert s is not None and s != ""
 
+    def test_to_json_should_return_correct_properties(self):
+        result = (
+            RequestedTextExtractionTaskBuilder()
+            .with_manual_check_always()
+            .with_chip_data_desired()
+            .build()
+        )
+
+        json = result.to_json()
+        assert json is not None
+
+        json_config = json.get("config").to_json()
+        assert json_config.get("manual_check") == "ALWAYS"
+        assert json_config.get("chip_data") == "DESIRED"
+
+    def test_to_json_should_not_include_null_config_values(self):
+        result = RequestedTextExtractionTaskBuilder().build()
+
+        json = result.to_json()
+        assert json is not None
+
+        json_config = json.get("config").to_json()
+        assert json_config == {}
+
 
 if __name__ == "__main__":
     unittest.main()

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

@@ -0,0 +1,22 @@
+import unittest
+
+from yoti_python_sdk.doc_scan.session.retrieve.document_id_photo_response import (
+    DocumentIdPhotoResponse,
+)
+from yoti_python_sdk.doc_scan.session.retrieve.media_response import MediaResponse
+
+
+class DocumentIdPhotoResponseTest(unittest.TestCase):
+    def test_should_parse_correctly(self):
+        data = {"media": {}}
+
+        result = DocumentIdPhotoResponse(data)
+        assert isinstance(result.media, MediaResponse)
+
+    def test_should_not_throw_exception_for_none(self):
+        result = DocumentIdPhotoResponse(None)
+        assert result.media is None
+
+
+if __name__ == "__main__":
+    unittest.main()

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

@@ -3,6 +3,9 @@
 from yoti_python_sdk.doc_scan.session.retrieve.document_fields_response import (
     DocumentFieldsResponse,
 )
+from yoti_python_sdk.doc_scan.session.retrieve.document_id_photo_response import (
+    DocumentIdPhotoResponse,
+)
 from yoti_python_sdk.doc_scan.session.retrieve.id_document_resource_response import (
     IdDocumentResourceResponse,
 )
@@ -22,6 +25,7 @@ class IdDocumentResourceResponseTest(unittest.TestCase):
     ]
     SOME_PAGES = [{"first": "page"}, {"second": "page"}]
     SOME_DOCUMENT_FIELDS = {"media": {}}
+    SOME_DOCUMENT_ID_PHOTO = {"media": {}}
 
     def test_should_parse_correctly(self):
         data = {
@@ -31,6 +35,7 @@ def test_should_parse_correctly(self):
             "tasks": self.SOME_TASKS,
             "pages": self.SOME_PAGES,
             "document_fields": self.SOME_DOCUMENT_FIELDS,
+            "document_id_photo": self.SOME_DOCUMENT_ID_PHOTO,
         }
 
         result = IdDocumentResourceResponse(data)
@@ -41,6 +46,7 @@ def test_should_parse_correctly(self):
         assert len(result.tasks) == 2
         assert len(result.pages) == 2
         assert isinstance(result.document_fields, DocumentFieldsResponse)
+        assert isinstance(result.document_id_photo, DocumentIdPhotoResponse)
 
     def test_should_parse_when_none(self):
         result = IdDocumentResourceResponse(None)
@@ -51,6 +57,7 @@ def test_should_parse_when_none(self):
         assert len(result.tasks) == 0
         assert len(result.pages) == 0
         assert result.document_fields is None
+        assert result.document_id_photo is None
 
     def test_should_parse_tasks_with_type(self):
         data = {