SDK-1718: Move remove_null_values to be called in each to_json method, rather than adding on an exposed method

echarrod · echarrod · commit 5be853f1d62e · 2020-09-16T09:49:56.000+01:00
diff --git a/yoti_python_sdk/doc_scan/session/create/check/document_authenticity.py b/yoti_python_sdk/doc_scan/session/create/check/document_authenticity.py
@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from yoti_python_sdk.doc_scan.constants import ID_DOCUMENT_AUTHENTICITY
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 from .requested_check import RequestedCheck
 
 
@@ -12,10 +12,7 @@ class RequestedDocumentAuthenticityCheckConfig(YotiSerializable):
     """
 
     def to_json(self):
-        return {}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({})
 
 
 class RequestedDocumentAuthenticityCheck(RequestedCheck):
diff --git a/yoti_python_sdk/doc_scan/session/create/check/face_match.py b/yoti_python_sdk/doc_scan/session/create/check/face_match.py
@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from yoti_python_sdk.doc_scan import constants
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 from .requested_check import RequestedCheck
 
 
@@ -30,10 +30,7 @@ def manual_check(self):
         return self.__manual_check
 
     def to_json(self):
-        return {"manual_check": self.manual_check}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({"manual_check": self.manual_check})
 
 
 class RequestedFaceMatchCheck(RequestedCheck):
diff --git a/yoti_python_sdk/doc_scan/session/create/check/liveness.py b/yoti_python_sdk/doc_scan/session/create/check/liveness.py
@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from yoti_python_sdk.doc_scan import constants
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 from .requested_check import RequestedCheck
 
 
@@ -40,10 +40,9 @@ def max_retries(self):
         return self.__max_retries
 
     def to_json(self):
-        return {"liveness_type": self.liveness_type, "max_retries": self.max_retries}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {"liveness_type": self.liveness_type, "max_retries": self.max_retries}
+        )
 
 
 class RequestedLivenessCheck(RequestedCheck):
diff --git a/yoti_python_sdk/doc_scan/session/create/check/requested_check.py b/yoti_python_sdk/doc_scan/session/create/check/requested_check.py
@@ -1,7 +1,7 @@
 from abc import ABCMeta
 from abc import abstractmethod
 
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 
 
 class RequestedCheck(YotiSerializable):
@@ -33,7 +33,4 @@ def config(self):
         raise NotImplementedError
 
     def to_json(self):
-        return {"type": self.type, "config": self.config}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({"type": self.type, "config": self.config})
diff --git a/yoti_python_sdk/doc_scan/session/create/filter/document_filter.py b/yoti_python_sdk/doc_scan/session/create/filter/document_filter.py
@@ -1,6 +1,6 @@
 from abc import ABCMeta
 
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 
 
 class DocumentFilter(YotiSerializable):
@@ -14,7 +14,4 @@ def type(self):
         return self.__filter_type
 
     def to_json(self):
-        return {"type": self.type}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({"type": self.type})
diff --git a/yoti_python_sdk/doc_scan/session/create/filter/document_restrictions_filter.py b/yoti_python_sdk/doc_scan/session/create/filter/document_restrictions_filter.py
@@ -3,7 +3,7 @@
     INCLUSION_BLACKLIST,
     INCLUSION_WHITELIST,
 )
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 from .document_filter import DocumentFilter
 
 
@@ -21,13 +21,12 @@ def document_types(self):
         return self.__document_types
 
     def to_json(self):
-        return {
-            "country_codes": self.country_codes,
-            "document_types": self.document_types,
-        }
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {
+                "country_codes": self.country_codes,
+                "document_types": self.document_types,
+            }
+        )
 
 
 class DocumentRestrictionBuilder(object):
@@ -88,10 +87,7 @@ def to_json(self):
         parent = DocumentFilter.to_json(self)
         parent["inclusion"] = self.inclusion
         parent["documents"] = self.documents
-        return parent
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(parent)
 
 
 class DocumentRestrictionsFilterBuilder(object):
diff --git a/yoti_python_sdk/doc_scan/session/create/filter/orthogonal_restrictions_filter.py b/yoti_python_sdk/doc_scan/session/create/filter/orthogonal_restrictions_filter.py
@@ -1,7 +1,7 @@
 from yoti_python_sdk.doc_scan.constants import INCLUSION_BLACKLIST
 from yoti_python_sdk.doc_scan.constants import INCLUSION_WHITELIST
 from yoti_python_sdk.doc_scan.constants import ORTHOGONAL_RESTRICTIONS
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 from .document_filter import DocumentFilter
 
 
@@ -31,10 +31,9 @@ def country_codes(self):
         return self.__country_codes
 
     def to_json(self):
-        return {"inclusion": self.inclusion, "country_codes": self.country_codes}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {"inclusion": self.inclusion, "country_codes": self.country_codes}
+        )
 
 
 class TypeRestriction(YotiSerializable):
@@ -63,10 +62,9 @@ def document_types(self):
         return self.__document_types
 
     def to_json(self):
-        return {"inclusion": self.inclusion, "document_types": self.document_types}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {"inclusion": self.inclusion, "document_types": self.document_types}
+        )
 
 
 class OrthogonalRestrictionsFilter(DocumentFilter):
@@ -100,10 +98,7 @@ def to_json(self):
         parent = DocumentFilter.to_json(self)
         parent["country_restriction"] = self.country_restriction
         parent["type_restriction"] = self.type_restriction
-        return parent
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(parent)
 
 
 class OrthogonalRestrictionsFilterBuilder(object):
diff --git a/yoti_python_sdk/doc_scan/session/create/filter/required_id_document.py b/yoti_python_sdk/doc_scan/session/create/filter/required_id_document.py
@@ -1,4 +1,5 @@
 from yoti_python_sdk.doc_scan.constants import ID_DOCUMENT
+from yoti_python_sdk.utils import remove_null_values
 from .document_filter import DocumentFilter  # noqa: F401
 from .required_document import RequiredDocument
 
@@ -20,10 +21,7 @@ def filter(self):
         return self.__doc_filter
 
     def to_json(self):
-        return {"type": self.type, "filter": self.__doc_filter}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({"type": self.type, "filter": self.__doc_filter})
 
 
 class RequiredIdDocumentBuilder(object):
diff --git a/yoti_python_sdk/doc_scan/session/create/notification_config.py b/yoti_python_sdk/doc_scan/session/create/notification_config.py
@@ -5,7 +5,7 @@
 from yoti_python_sdk.doc_scan.constants import RESOURCE_UPDATE
 from yoti_python_sdk.doc_scan.constants import SESSION_COMPLETION
 from yoti_python_sdk.doc_scan.constants import TASK_COMPLETION
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 
 
 class NotificationConfig(YotiSerializable):
@@ -63,14 +63,13 @@ def topics(self):
         return self.__topics
 
     def to_json(self):
-        return {
-            "auth_token": self.auth_token,
-            "endpoint": self.endpoint,
-            "topics": self.topics,
-        }
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {
+                "auth_token": self.auth_token,
+                "endpoint": self.endpoint,
+                "topics": self.topics,
+            }
+        )
 
 
 class NotificationConfigBuilder(object):
diff --git a/yoti_python_sdk/doc_scan/session/create/sdk_config.py b/yoti_python_sdk/doc_scan/session/create/sdk_config.py
@@ -3,7 +3,7 @@
 
 from yoti_python_sdk.doc_scan.constants import CAMERA
 from yoti_python_sdk.doc_scan.constants import CAMERA_AND_UPLOAD
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 
 
 class SdkConfig(YotiSerializable):
@@ -122,19 +122,18 @@ def error_url(self):
         return self.__error_url
 
     def to_json(self):
-        return {
-            "allowed_capture_methods": self.allowed_capture_methods,
-            "primary_colour": self.primary_colour,
-            "secondary_colour": self.secondary_colour,
-            "font_colour": self.font_colour,
-            "locale": self.locale,
-            "preset_issuing_country": self.preset_issuing_country,
-            "success_url": self.success_url,
-            "error_url": self.error_url,
-        }
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {
+                "allowed_capture_methods": self.allowed_capture_methods,
+                "primary_colour": self.primary_colour,
+                "secondary_colour": self.secondary_colour,
+                "font_colour": self.font_colour,
+                "locale": self.locale,
+                "preset_issuing_country": self.preset_issuing_country,
+                "success_url": self.success_url,
+                "error_url": self.error_url,
+            }
+        )
 
 
 class SdkConfigBuilder(object):
diff --git a/yoti_python_sdk/doc_scan/session/create/session_spec.py b/yoti_python_sdk/doc_scan/session/create/session_spec.py
@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from .filter.required_document import RequiredDocument  # noqa: F401
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 
 
 class SessionSpec(YotiSerializable):
@@ -139,19 +139,18 @@ def required_documents(self):
         return self.__required_documents
 
     def to_json(self):
-        return {
-            "client_session_token_ttl": self.client_session_token_ttl,
-            "resources_ttl": self.resources_ttl,
-            "user_tracking_id": self.user_tracking_id,
-            "notifications": self.notifications,
-            "requested_checks": self.requested_checks,
-            "requested_tasks": self.requested_tasks,
-            "sdk_config": self.sdk_config,
-            "required_documents": self.required_documents,
-        }
-
-    def include_null_values(self):
-        return False
+        return remove_null_values(
+            {
+                "client_session_token_ttl": self.client_session_token_ttl,
+                "resources_ttl": self.resources_ttl,
+                "user_tracking_id": self.user_tracking_id,
+                "notifications": self.notifications,
+                "requested_checks": self.requested_checks,
+                "requested_tasks": self.requested_tasks,
+                "sdk_config": self.sdk_config,
+                "required_documents": self.required_documents,
+            }
+        )
 
 
 class SessionSpecBuilder(object):
diff --git a/yoti_python_sdk/doc_scan/session/create/task/requested_task.py b/yoti_python_sdk/doc_scan/session/create/task/requested_task.py
@@ -1,7 +1,7 @@
 from abc import ABCMeta
 from abc import abstractmethod
 
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 
 
 class RequestedTask(YotiSerializable):
@@ -33,7 +33,4 @@ def config(self):
         raise NotImplementedError
 
     def to_json(self):
-        return {"type": self.type, "config": self.config}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({"type": self.type, "config": self.config})
diff --git a/yoti_python_sdk/doc_scan/session/create/task/text_extraction.py b/yoti_python_sdk/doc_scan/session/create/task/text_extraction.py
@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from yoti_python_sdk.doc_scan import constants
-from yoti_python_sdk.utils import YotiSerializable
+from yoti_python_sdk.utils import YotiSerializable, remove_null_values
 from .requested_task import RequestedTask
 
 
@@ -24,10 +24,7 @@ def manual_check(self):
         return self.__manual_check
 
     def to_json(self):
-        return {"manual_check": self.manual_check}
-
-    def include_null_values(self):
-        return False
+        return remove_null_values({"manual_check": self.manual_check})
 
 
 class RequestedTextExtractionTask(RequestedTask):
diff --git a/yoti_python_sdk/utils.py b/yoti_python_sdk/utils.py
@@ -16,16 +16,10 @@ class YotiSerializable(object):
     def to_json(self):
         raise NotImplementedError
 
-    def include_null_values(self):
-        return True
-
 
 class YotiEncoder(JSONEncoder):
     def default(self, o):
         if isinstance(o, YotiSerializable):
-            if not o.include_null_values():
-                return remove_null_values(o.to_json())
-
             return o.to_json()
         return JSONEncoder.default(self, o)
 
