SDK-1718: Add Document Comparison check, remove instructions for running tests: this is in CONTRIBUTING.md

Author: echarrod

README.md

@@ -34,9 +34,6 @@ How to manage users
 1) [Running the examples](#running-the-examples) -
 How to retrieve a Yoti profile using the token
 
-1) [Running the tests](#running-the-tests) -
-Running tests for SDK example
-
 1) [API Coverage](#api-coverage) -
 Attributes defined
 
@@ -196,14 +193,6 @@ To run the Flask or Django container:
 * [Profile - Flask](examples/yoti_example_flask)
 * [Doc Scan](examples/doc_scan)
 
-## Running the Tests
-
-Running the tests is done by the following process, ensuring you are using Python 3.0+:
-
-1. Install dependencies: `pip install -r requirements.txt`
-1. Install the SDK and development dependencies: `pip install .[dev]`
-1. Execute in the main project dir: `pytest`
-
 ## API Coverage
 
 * Activity Details

examples/doc_scan/README.md

@@ -5,4 +5,4 @@
 1. Rename the [.env.example](.env.example) file to `.env` and fill in the required configuration values
 1. Install the dependencies with `pip install -r requirements.txt`
 1. Start the server `flask run --cert=adhoc`
-1. Visit `https://localhost:5000`
+1. Visit `https://localhost:5000`

examples/doc_scan/app.py

@@ -4,12 +4,18 @@
     DocScanClient,
     RequestedDocumentAuthenticityCheckBuilder,
     RequestedFaceMatchCheckBuilder,
+    RequestedIDDocumentComparisonCheckBuilder,
     RequestedLivenessCheckBuilder,
     RequestedTextExtractionTaskBuilder,
     SdkConfigBuilder,
     SessionSpecBuilder,
 )
 from yoti_python_sdk.doc_scan.exception import DocScanException
+from yoti_python_sdk.doc_scan.session.create.filter import (
+    RequiredIdDocumentBuilder,
+    DocumentRestrictionBuilder,
+    DocumentRestrictionsFilterBuilder,
+)
 
 from .settings import YOTI_APP_BASE_URL, YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH
 
@@ -52,18 +58,34 @@ def create_session():
             .build()
         )
         .with_requested_check(
-            RequestedFaceMatchCheckBuilder().with_manual_check_fallback().build()
+            RequestedFaceMatchCheckBuilder().with_manual_check_never().build()
         )
+        .with_requested_check(RequestedIDDocumentComparisonCheckBuilder().build())
         .with_requested_task(
-            RequestedTextExtractionTaskBuilder().with_manual_check_always().build()
+            RequestedTextExtractionTaskBuilder().with_manual_check_never().build()
         )
         .with_sdk_config(sdk_config)
+        .with_required_document(build_required_id_document_restriction("PASSPORT"))
+        .with_required_document(
+            build_required_id_document_restriction("DRIVING_LICENCE")
+        )
         .build()
     )
 
     return doc_scan_client.create_session(session_spec)
 
 
+def build_required_id_document_restriction(document_type):
+    document_restriction = (
+        DocumentRestrictionBuilder().with_document_types([document_type]).build()
+    )
+
+    filter_builder = DocumentRestrictionsFilterBuilder().for_whitelist()
+    filter_builder.with_document_restriction(document_restriction)
+
+    return RequiredIdDocumentBuilder().with_filter(filter_builder.build()).build()
+
+
 @app.route("/")
 def index():
     try:

examples/doc_scan/templates/success.html

@@ -134,6 +134,29 @@ <h3 class="mb-0">
                             </div>
                         </div>
                     {% endif %}
+
+                    {% if session_result.id_document_comparison_checks|length > 0 %}
+                        <div class="card">
+                            <div class="card-header" id="comparison-checks">
+                                <h3 class="mb-0">
+                                    <button aria-controls="collapse-comparison-checks" aria-expanded="true" class="btn btn-link"
+                                            data-target="#collapse-comparison-checks" data-toggle="collapse"
+                                            type="button">
+                                        ID Document Comparison Checks
+                                    </button>
+                                </h3>
+                            </div>
+                            <div aria-labelledby="comparison-checks" class="collapse" id="collapse-comparison-checks">
+                                <div class="card-body">
+                                    {% for check in session_result.id_document_comparison_checks %}
+                                        {% with check=check %}
+                                            {% include "partials/check.html" %}
+                                        {% endwith %}
+                                    {% endfor %}
+                                </div>
+                            </div>
+                        </div>
+                    {% endif %}
                 </div>
             </div>
         </div>

setup.py

@@ -37,7 +37,7 @@
         ],
         "dev": [
             "pre-commit==1.17.0",
-            "pytest>=4.6.0",
+            "pytest>=4.6.11",
             "pytest-cov>=2.7.1",
             "pylint==1.9.4",
             "pylint-exit>=1.1.0",

yoti_python_sdk/doc_scan/__init__.py

@@ -1,6 +1,9 @@
 from .session.create.check.document_authenticity import (
     RequestedDocumentAuthenticityCheckBuilder,
 )
+from .session.create.check.document_comparison import (
+    RequestedIDDocumentComparisonCheckBuilder,
+)
 from .session.create.check.face_match import RequestedFaceMatchCheckBuilder
 from .session.create.check.liveness import RequestedLivenessCheckBuilder
 from .session.create.task.text_extraction import RequestedTextExtractionTaskBuilder
@@ -13,6 +16,7 @@
     RequestedDocumentAuthenticityCheckBuilder,
     RequestedLivenessCheckBuilder,
     RequestedFaceMatchCheckBuilder,
+    RequestedIDDocumentComparisonCheckBuilder,
     RequestedTextExtractionTaskBuilder,
     SessionSpecBuilder,
     NotificationConfigBuilder,

yoti_python_sdk/doc_scan/constants.py

@@ -2,6 +2,7 @@
 from __future__ import unicode_literals
 
 ID_DOCUMENT_AUTHENTICITY = "ID_DOCUMENT_AUTHENTICITY"
+ID_DOCUMENT_COMPARISON = "ID_DOCUMENT_COMPARISON"
 ID_DOCUMENT_TEXT_DATA_CHECK = "ID_DOCUMENT_TEXT_DATA_CHECK"
 ID_DOCUMENT_TEXT_DATA_EXTRACTION = "ID_DOCUMENT_TEXT_DATA_EXTRACTION"
 ID_DOCUMENT_FACE_MATCH = "ID_DOCUMENT_FACE_MATCH"

yoti_python_sdk/doc_scan/session/create/check/__init__.py

@@ -1,9 +1,11 @@
 from .document_authenticity import RequestedDocumentAuthenticityCheckBuilder
+from .document_comparison import RequestedIDDocumentComparisonCheckBuilder
 from .face_match import RequestedFaceMatchCheckBuilder
 from .liveness import RequestedLivenessCheckBuilder
 
 __all__ = [
     RequestedDocumentAuthenticityCheckBuilder,
+    RequestedIDDocumentComparisonCheckBuilder,
     RequestedFaceMatchCheckBuilder,
     RequestedLivenessCheckBuilder,
 ]

yoti_python_sdk/doc_scan/session/create/check/document_comparison.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from yoti_python_sdk.doc_scan.constants import ID_DOCUMENT_COMPARISON
+from yoti_python_sdk.utils import YotiSerializable
+from .requested_check import RequestedCheck
+
+
+class RequestedIDDocumentComparisonCheckConfig(YotiSerializable):
+    """
+    The configuration applied when creating a Document Comparison Check
+    """
+
+    def to_json(self):
+        return {}
+
+
+class RequestedIDDocumentComparisonCheck(RequestedCheck):
+    """
+    Requests creation of a Document Comparison Check
+    """
+
+    def __init__(self, config):
+        """
+        :param config: the requested document Comparison check configuration
+        :type config: RequestedIDDocumentComparisonCheckConfig
+        """
+        self.__config = config
+
+    @property
+    def type(self):
+        return ID_DOCUMENT_COMPARISON
+
+    @property
+    def config(self):
+        return self.__config
+
+
+class RequestedIDDocumentComparisonCheckBuilder(object):
+    """
+    Builder to assist creation of :class:`RequestedIDDocumentComparisonCheck`
+    """
+
+    @staticmethod
+    def build():
+        config = RequestedIDDocumentComparisonCheckConfig()
+        return RequestedIDDocumentComparisonCheck(config)

yoti_python_sdk/doc_scan/session/retrieve/check_response.py

@@ -148,15 +148,15 @@ class AuthenticityCheckResponse(CheckResponse):
 
 class FaceMatchCheckResponse(CheckResponse):
     """
-    Represents a FaceMatch Check for a given session
+    Represents a FaceMatch check for a given session
     """
 
     pass
 
 
 class LivenessCheckResponse(CheckResponse):
     """
-    Represents a Liveness Check for a given session
+    Represents a Liveness check for a given session
     """
 
     pass
@@ -168,3 +168,11 @@ class TextDataCheckResponse(CheckResponse):
     """
 
     pass
+
+
+class IDDocumentComparisonCheckResponse(CheckResponse):
+    """
+    Represents an Identity Document Comparison check for a given session
+    """
+
+    pass