- add ability to bind non-existent AuthenticityCheckResultItem into RawAuthenticityCheckResultItem;

Aleksey Shundrik · hleb-albau · commit a943f6452380 · 2021-02-24T18:10:31.000+03:00
- add 'abstract' layer for authenticity results
diff --git a/.gitignore b/.gitignore
@@ -69,3 +69,5 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
+
+model.json
diff --git a/example/example.py b/example/example.py
@@ -56,6 +56,14 @@
     doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
     doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
 
+    doc_authenticity = response.authenticity
+
+    doc_ir_b900 = doc_authenticity.ir_b900_checks
+    doc_ir_b900_blank = doc_ir_b900.checks_by_element(SecurityFeatureType.BLANK)
+
+    doc_image_pattern = doc_authenticity.image_pattern_checks
+    doc_image_pattern_blank = doc_image_pattern.checks_by_element(SecurityFeatureType.BLANK)
+
     # images fields example
     document_image = response.images.get_field(GraphicFieldType.DOCUMENT_FRONT).get_value()
     portrait_from_visual = response.images.get_field(GraphicFieldType.PORTRAIT).get_value(Source.VISUAL)
diff --git a/generator-templates/model.mustache b/generator-templates/model.mustache
@@ -190,8 +190,8 @@ class {{classname}}(object):
         """Returns the real base class specified by the discriminator"""
         discriminator_key = self.attribute_map[self.discriminator]
         discriminator_value = data[discriminator_key]
-        from regula.documentreader.webclient.ext.models import RawResultItem
-        return self.discriminator_value_class_map.get(discriminator_value, RawResultItem.__name__)
+        from regula.documentreader.webclient.ext.models import Raw{{classname}}
+        return self.discriminator_value_class_map.get(discriminator_value, Raw{{classname}}.__name__)
 
 {{/discriminator}}
     def to_dict(self):
diff --git a/regula/documentreader/webclient/ext/__init__.py b/regula/documentreader/webclient/ext/__init__.py
@@ -1,4 +1,10 @@
 from regula.documentreader.webclient.ext.api.document_reader_api import DocumentReaderApi
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
 from regula.documentreader.webclient.ext.models.images import Images, ImagesField
 from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest, RecognitionImage
diff --git a/regula/documentreader/webclient/ext/models/__init__.py b/regula/documentreader/webclient/ext/models/__init__.py
@@ -1,4 +1,11 @@
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
 from regula.documentreader.webclient.ext.models.images import Images, ImagesField
+from regula.documentreader.webclient.ext.models.raw_authenticity_result_item import RawAuthenticityCheckResultItem
 from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionImage
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest
diff --git a/regula/documentreader/webclient/ext/models/authenticity/__init__.py b/regula/documentreader/webclient/ext/models/authenticity/__init__.py
@@ -0,0 +1,6 @@
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
diff --git a/regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py b/regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py
@@ -0,0 +1,78 @@
+from typing import Optional
+
+from regula.documentreader.webclient import gen, AuthenticityResultType
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
+
+
+class AuthenticityCheckList(gen.AuthenticityCheckList):
+
+    @property
+    def uv_luminescence_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.UV_LUMINESCENCE, SecurityFeatureChecks)
+
+    @property
+    def ir_b900_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.IR_B900, SecurityFeatureChecks)
+
+    @property
+    def image_pattern_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.IMAGE_PATTERN, IdentChecks)
+
+    @property
+    def axial_protection_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.AXIAL_PROTECTION, SecurityFeatureChecks)
+
+    @property
+    def uv_fiber_checks(self) -> Optional[FiberChecks]:
+        return self.__result_by_type(AuthenticityResultType.UV_FIBERS, FiberChecks)
+
+    @property
+    def ir_visibility_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.IR_VISIBILITY, IdentChecks)
+
+    @property
+    def ocr_security_text_checks(self) -> Optional[OCRSecurityTextChecks]:
+        return self.__result_by_type(AuthenticityResultType.OCR_SECURITY_TEXT, OCRSecurityTextChecks)
+
+    @property
+    def ipi_checks(self) -> Optional[ImageIdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.IPI, ImageIdentChecks)
+
+    @property
+    def embed_image_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.PHOTO_EMBED_TYPE, SecurityFeatureChecks)
+
+    @property
+    def holograms_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.HOLOGRAMS, SecurityFeatureChecks)
+
+    @property
+    def photo_area_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.PHOTO_AREA, SecurityFeatureChecks)
+
+    @property
+    def portrait_comparison_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.PORTRAIT_COMPARISON, IdentChecks)
+
+    @property
+    def barcode_format_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.BARCODE_FORMAT_CHECK, SecurityFeatureChecks)
+
+    @property
+    def kinegram_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.KINEGRAM, IdentChecks)
+
+    @property
+    def letter_screen_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.LETTER_SCREEN, IdentChecks)
+
+    def __result_by_type(self, authenticity_type: int, parent_class: type) -> Optional[gen.AuthenticityCheckResult]:
+        for result in self.list:
+            if result.type == authenticity_type:
+                result.__class__ = parent_class
+                return result
+        return None
diff --git a/regula/documentreader/webclient/ext/models/authenticity/fiber.py b/regula/documentreader/webclient/ext/models/authenticity/fiber.py
@@ -0,0 +1,11 @@
+from typing import List
+
+from regula.documentreader.webclient import gen
+
+
+class FiberChecks(gen.AuthenticityCheckResult):
+
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.FiberResult]:
+        # noinspection PyTypeChecker
+        return super().list
diff --git a/regula/documentreader/webclient/ext/models/authenticity/ident.py b/regula/documentreader/webclient/ext/models/authenticity/ident.py
@@ -0,0 +1,14 @@
+from typing import List, Optional
+
+from regula.documentreader.webclient import gen
+
+
+class IdentChecks(gen.AuthenticityCheckResult):
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.IdentResult]:
+        # noinspection PyTypeChecker
+        return super().list
+
+    # element_type is SecurityFeatureType
+    def checks_by_element(self, element_type: int) -> List[gen.IdentResult]:
+        return [check for check in self.list if check.element_type == element_type]
diff --git a/regula/documentreader/webclient/ext/models/authenticity/image_ident.py b/regula/documentreader/webclient/ext/models/authenticity/image_ident.py
@@ -0,0 +1,10 @@
+from typing import List
+
+from regula.documentreader.webclient import gen
+
+
+class ImageIdentChecks(gen.AuthenticityCheckResult):
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.PhotoIdentResult]:
+        # noinspection PyTypeChecker
+        return super().list
diff --git a/regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py b/regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py
@@ -0,0 +1,11 @@
+from typing import List
+
+from regula.documentreader.webclient import gen
+
+
+class OCRSecurityTextChecks(gen.AuthenticityCheckResult):
+
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.OCRSecurityTextResult]:
+        # noinspection PyTypeChecker
+        return super().list
diff --git a/regula/documentreader/webclient/ext/models/authenticity/security_feature.py b/regula/documentreader/webclient/ext/models/authenticity/security_feature.py
@@ -0,0 +1,13 @@
+from typing import List, Optional
+
+from regula.documentreader.webclient import gen
+
+
+class SecurityFeatureChecks(gen.AuthenticityCheckResult):
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.SecurityFeatureResult]:
+        return super().list
+
+    # element_type is SecurityFeatureType
+    def checks_by_element(self, element_type: int) -> List[gen.SecurityFeatureResult]:
+        return [check for check in self.list if check.element_type == element_type]
diff --git a/regula/documentreader/webclient/ext/models/raw_authenticity_result_item.py b/regula/documentreader/webclient/ext/models/raw_authenticity_result_item.py
@@ -0,0 +1,27 @@
+from copy import copy
+
+from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
+
+
+class RawAuthenticityCheckResultItem(AuthenticityCheckResultItem):
+    openapi_types = copy(AuthenticityCheckResultItem.openapi_types)
+    openapi_types["raw"] = "dict"
+
+    attribute_map = copy(AuthenticityCheckResultItem.attribute_map)
+    attribute_map["raw"] = "raw"
+
+    def __init__(self, type=0, element_result=None, element_diagnose=None, raw=None, local_vars_configuration=None):
+        super().__init__(type, element_result, element_diagnose, local_vars_configuration)
+        self.__raw = raw
+
+    @property
+    def raw(self):
+        return self.__raw
+
+    def to_dict(self):
+        result = super(RawAuthenticityCheckResultItem, self).to_dict()
+        result["raw"] = self.__raw
+        return result
+
+    def get_real_child_model(self, data):
+        return None
diff --git a/regula/documentreader/webclient/ext/models/recognition_response.py b/regula/documentreader/webclient/ext/models/recognition_response.py
@@ -1,5 +1,6 @@
 from typing import Optional, List
 
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
 from regula.documentreader.webclient.ext.models.images import Images
 from regula.documentreader.webclient.ext.models.text import Text
 from regula.documentreader.webclient.gen import ResultItem
@@ -34,6 +35,13 @@ def images(self) -> Optional[Images]:
             return result.images
         return None
 
+    @property
+    def authenticity(self) -> Optional[AuthenticityCheckList]:
+        result = self.result_by_type(Result.AUTHENTICITY)
+        if result:
+            return result.authenticity_check_list
+        return None
+
     def result_by_type(self, result_type) -> Optional[ResultItem]:
         for i in self.low_lvl_response.container_list.list:
             if i.result_type == result_type:
diff --git a/regula/documentreader/webclient/gen/configuration.py b/regula/documentreader/webclient/gen/configuration.py
@@ -374,7 +374,7 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 5.5.0\n"\
+               "Version of the API: 5.4.0\n"\
                "SDK Package Version: 1.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 
diff --git a/regula/documentreader/webclient/gen/models/authenticity_check_result_item.py b/regula/documentreader/webclient/gen/models/authenticity_check_result_item.py
@@ -151,8 +151,8 @@ def get_real_child_model(self, data):
         """Returns the real base class specified by the discriminator"""
         discriminator_key = self.attribute_map[self.discriminator]
         discriminator_value = data[discriminator_key]
-        from regula.documentreader.webclient.ext.models import RawResultItem
-        return self.discriminator_value_class_map.get(discriminator_value, RawResultItem.__name__)
+        from regula.documentreader.webclient.ext.models import RawAuthenticityCheckResultItem
+        return self.discriminator_value_class_map.get(discriminator_value, RawAuthenticityCheckResultItem.__name__)
 
     def to_dict(self):
         """Returns the model properties as a dict"""
diff --git a/regula/documentreader/webclient/gen/models/authenticity_result_type.py b/regula/documentreader/webclient/gen/models/authenticity_result_type.py
@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.documentreader.webclient.gen.configuration import Configuration
+# this line was added to enable pycharm type hinting
+from regula.documentreader.webclient.gen.models import *
+
+
+"""
+Enumeration describes available authenticity checks
+"""
+class AuthenticityResultType(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    UV_LUMINESCENCE = int("1")
+
+    IR_B900 = int("2")
+
+    IMAGE_PATTERN = int("4")
+
+    AXIAL_PROTECTION = int("8")
+
+    UV_FIBERS = int("16")
+
+    IR_VISIBILITY = int("32")
+
+    OCR_SECURITY_TEXT = int("64")
+
+    IPI = int("128")
+
+    PHOTO_EMBED_TYPE = int("512")
+
+    HOLOGRAMS = int("4096")
+
+    PHOTO_AREA = int("8192")
+
+    PORTRAIT_COMPARISON = int("32768")
+
+    BARCODE_FORMAT_CHECK = int("65536")
+
+    KINEGRAM = int("131072")
+
+    LETTER_SCREEN = int("262144")
+
+    allowable_values = [UV_LUMINESCENCE, IR_B900, IMAGE_PATTERN, AXIAL_PROTECTION, UV_FIBERS, IR_VISIBILITY, OCR_SECURITY_TEXT, IPI, PHOTO_EMBED_TYPE, HOLOGRAMS, PHOTO_AREA, PORTRAIT_COMPARISON, BARCODE_FORMAT_CHECK, KINEGRAM, LETTER_SCREEN]  # noqa: E501
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self, local_vars_configuration=None):  # noqa: E501
+        """AuthenticityResultType - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+        self.discriminator = None
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, AuthenticityResultType):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, AuthenticityResultType):
+            return True
+
+        return self.to_dict() != other.to_dict()
