Merge pull request #332 from getyoti/feature/handoff_flag

[SDK-1998] adding handoff flag

Author: MichalMilewiczYoti

.gitignore

@@ -105,3 +105,4 @@ examples/yoti_example_django/*.pem
 examples/yoti_example_flask/*.pem
 
 .scannerwork
+.venv/

yoti_python_sdk/doc_scan/session/create/sdk_config.py

@@ -21,6 +21,7 @@ def __init__(
         preset_issuing_country,
         success_url,
         error_url,
+        allow_handoff=None,
         privacy_policy_url=None,
     ):
         """
@@ -42,6 +43,8 @@ def __init__(
         :type error_url: str
         :param privacy_policy_url: the privacy policy url
         :type privacy_policy_url: str
+        :param allow_handoff: boolean flag for allow_handoff
+        :type allow_handoff: bool
         """
         self.__allowed_capture_methods = allowed_capture_methods
         self.__primary_colour = primary_colour
@@ -52,6 +55,7 @@ def __init__(
         self.__success_url = success_url
         self.__error_url = error_url
         self.__privacy_policy_url = privacy_policy_url
+        self.__allow_handoff = allow_handoff
 
     @property
     def allowed_capture_methods(self):
@@ -134,6 +138,16 @@ def privacy_policy_url(self):
         """
         return self.__privacy_policy_url
 
+    @property
+    def allow_handoff(self):
+        """
+        Flag to enable/disable relying business to handoff
+        support when creating a session.
+
+        :return: the allow_handoff
+        """
+        return self.__allow_handoff
+
     def to_json(self):
         return remove_null_values(
             {
@@ -146,6 +160,7 @@ def to_json(self):
                 "success_url": self.success_url,
                 "error_url": self.error_url,
                 "privacy_policy_url": self.privacy_policy_url,
+                "allow_handoff": self.allow_handoff,
             }
         )
 
@@ -165,6 +180,7 @@ def __init__(self):
         self.__success_url = None
         self.__error_url = None
         self.__privacy_policy_url = None
+        self.__allow_handoff = None
 
     def with_allowed_capture_methods(self, allowed_capture_methods):
         """
@@ -292,6 +308,18 @@ def with_privacy_policy_url(self, url):
         self.__privacy_policy_url = url
         return self
 
+    def with_allow_handoff(self, flag):
+        """
+        Sets the allow handoff flag
+
+        :param flag: boolean value for flag
+        :type flag: bool
+        :return: the builder
+        :rtype: SdkConfigBuilder
+        """
+        self.__allow_handoff = flag
+        return self
+
     def build(self):
         return SdkConfig(
             self.__allowed_capture_methods,
@@ -302,5 +330,6 @@ def build(self):
             self.__preset_issuing_country,
             self.__success_url,
             self.__error_url,
+            self.__allow_handoff,
             self.__privacy_policy_url,
         )

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

@@ -15,6 +15,7 @@ class SdkConfigTest(unittest.TestCase):
     SOME_SUCCESS_URL = "https://mysite.com/yoti/success"
     SOME_ERROR_URL = "https://mysite.com/yoti/error"
     SOME_PRIVACY_POLICY_URL = "https://mysite.com/privacy"
+    SOME_ALLOW_HANDOFF = True
 
     def test_should_build_correctly(self):
         result = (
@@ -28,6 +29,7 @@ def test_should_build_correctly(self):
             .with_success_url(self.SOME_SUCCESS_URL)
             .with_error_url(self.SOME_ERROR_URL)
             .with_privacy_policy_url(self.SOME_PRIVACY_POLICY_URL)
+            .with_allow_handoff(self.SOME_ALLOW_HANDOFF)
             .build()
         )
 
@@ -41,12 +43,23 @@ def test_should_build_correctly(self):
         assert result.success_url is self.SOME_SUCCESS_URL
         assert result.error_url is self.SOME_ERROR_URL
         assert result.privacy_policy_url is self.SOME_PRIVACY_POLICY_URL
+        assert result.allow_handoff is True
 
     def test_should_allows_camera(self):
         result = SdkConfigBuilder().with_allows_camera().build()
 
         assert result.allowed_capture_methods == "CAMERA"
 
+    def test_not_passing_allow_handoff(self):
+        result = SdkConfigBuilder().with_allows_camera().build()
+
+        assert result.allow_handoff is None
+
+    def test_passing_allow_handoff_false_value(self):
+        result = SdkConfigBuilder().with_allow_handoff(False).build()
+
+        assert result.allow_handoff is False
+
     def test_should_serialize_to_json_without_error(self):
         result = (
             SdkConfigBuilder()

yoti_python_sdk/tests/test_anchor.py

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
 import logging
+import pytz
 import time
 from datetime import datetime
 
-from yoti_python_sdk.protobuf.attribute_public_api import Attribute_pb2
-
 import yoti_python_sdk
 from yoti_python_sdk import config
 from yoti_python_sdk.anchor import Anchor
+from yoti_python_sdk.protobuf.attribute_public_api import Attribute_pb2
 from yoti_python_sdk.tests import anchor_fixture_parser
 
 
@@ -118,8 +118,8 @@ def test_processing_unknown_anchor_data():
         (anchor.value, anchor.anchor_type, anchor.sub_type) for anchor in anchors
     ]
 
-    expected_timestamp = datetime(2019, 3, 5, 10, 45, 11, 840037)
-    actual_timestamp = anchors[0].signed_timestamp
+    expected_timestamp = datetime(2019, 3, 5, 10, 45, 11, 840037).replace(tzinfo=None)
+    actual_timestamp = anchors[0].signed_timestamp.astimezone(pytz.utc).replace(tzinfo=None)
 
     assert expected_timestamp == actual_timestamp