Merge remote-tracking branch 'origin/stable'

Author: regula-bot

.github/workflows/pypi-publish.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install pipenv
         run: |
           python -m pip install --upgrade pip
@@ -27,4 +27,3 @@ jobs:
         working-directory: example
         env:
           API_BASE_PATH: "https://nightly-api.regulaforensics.com"
-          TEST_LICENSE: ${{secrets.TEST_LICENSE}}

.github/workflows/run-smoke-test.yml

@@ -11,3 +11,5 @@ README.md
 .gitignore
 setup.py
 regula/documentreader/webclient/__init__.py
+pyproject.toml
+.github/workflows/python.yml

.openapi-generator-ignore

@@ -1 +1 @@
-5.0.0
+7.13.0

.openapi-generator/FILES

@@ -6,18 +6,22 @@ name = "pypi"
 [packages]
 certifi = ">=2024.07.04"
 six = ">=1.10"
-python-dateutil = ">=2.5.3"
-urllib3 = ">=1.26.19"
+python-dateutil = ">=2.8.2"
+urllib3 = ">=1.25.3, <3.0.0"
 vistir = ">=0.4.0, <=0.6.1"
 idna = "==3.7"
-requests = ">=2.32.3"
+requests = ">=2.32.4"
+pydantic = ">=2"
+typing-extensions = ">=4.7.1"
 
 [dev-packages]
-setuptools = "==74.1.1"
 wheel = "*"
 twine = "*"
 chardet = "*"
 packaging = ">=22.0"
+types-python-dateutil = ">=2.8.19.14"
+mypy = ">=1.5"
+setuptools = "==78.1.1"
 
 [requires]
-python_version = "3.8"
+python_version = "3.9"

.openapi-generator/VERSION

@@ -1,4 +1,4 @@
-# Regula Document Reader web API Python 3.8+ client
+# Regula Document Reader web API Python 3.9+ client
 
 [![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
 [![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)

Pipfile

@@ -1,7 +1,31 @@
 # Development
 
-To regenerate models, clone [latest OpenAPI definitions](https://github.com/regulaforensics/DocumentReader-web-openapi)
-and use next command from the project root:
+Models generation based on [openapi spec](https://github.com/regulaforensics/DocumentReader-api-openapi).
+
+## Generation
+
+To regenerate models from openapi definition, 
+clone [latest open api definitions](https://github.com/regulaforensics/DocumentReader-api-openapi)
+and use next command from the project root.
 ```bash
 ./update-models.sh
 ```
+
+## Generator configuration Features
+
+1. When generating oneOf schemas, the generator creates its 
+own abstract class, which does not look like it would like. 
+The problem was solved by replacing the abstract generator 
+class with ours using typeMappings in the generator config.
+2. The generator treats the discriminator value as a string, 
+but in our case it's numbers. To solve this problem, changes 
+have been made to the model_generic.mustache template.
+
+## Problem solving 
+
+To solve new problems, use the generator 
+settings ([python](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md), 
+[common](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md)) 
+and [templates](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/python).
+
+**Do not edit the generated files! They will be overwritten after generation!**

Pipfile.lock

@@ -1,4 +1,4 @@
-# Regula Document Reader web API Python 3.5+ client
+# Regula Document Reader web API Python 3.9+ client
 
 :bulb: Before you start: if you just want to play with an online demo, visit our [playground](https://api.regulaforensics.com).
 
@@ -10,15 +10,15 @@ you agree with our [Privacy Policy](https://regulaforensics.com/en/company/priva
 and [License Agreement](https://downloads.regulaforensics.com/work/SDK/doc/Eula.pdf).
 
 Requirements:
-- installed python 3.5 or higher
+- installed python 3.9 or higher
 - installed [pip](https://pip.pypa.io/en/stable/installing/)
 
 Verify Python and pip versions:
 ```bash
 python --version  
-> Python 3.8.2
+> Python 3.9.2
 pip --version     
-> pip 20.2.1 from /home/user/.local/lib/python3.8/site-packages/pip (python 3.8)
+> pip 22.0.4 from /home/user/.local/lib/python3.9/site-packages/pip (python 3.9)
 ```
 
 Cloning example:
@@ -54,16 +54,29 @@ API_BASE_PATH="http://127.0.0.1:8080" python example.py
 ```
 
 ### Output 
+
 This sample generates the following text output:
+
 ```text
     ---------------------------------------------------------------------------
-                   Document Overall Status: not valid
-                    Document Number Visual: OO0000000
-                       Document Number MRZ: OO0000000
-        Validity Of Document Number Visual: 0
-           Validity Of Document Number MRZ: 0
-              MRZ-Visual values comparison: 1
+                        Web API version: 7.5.308602.1848
     ---------------------------------------------------------------------------
+                    Document Overall Status: not valid
+                    Document Number Visual: C01YPTNHM
+                    Document Type: Germany - ePassport (2017) Service
+                    Validity Of Document Number Visual: 2
+    
+-----------------------All Text Fields------------------------
+Source: Surname, Value: MUSTERMANN
+Source: Surname And Given Names, Value: MUSTERMANN ERIKA
+Source: Document Status, Value: SPECIMEN
+Source: Surname, Value: MUSTERMANN
+Source: Surname And Given Names, Value: MUSTERMANN ERIKA
+Source: Document Number Checkdigit, Value: 1
+Source: Document Class Code, Value: PO
+
+...
 ```
+
 Also, it stores [portrait](portrait.jpg) and [document image](document-image.jpg) images in the current folder.
 You can modify [this example](../example/example.py) and re-run it to get your own results.

README.md

@@ -4,12 +4,6 @@
 
 host = os.getenv("API_BASE_PATH", "https://api.regulaforensics.com")
 
-# read optional local license file
-if os.path.isfile('regula.license') and os.access('regula.license', os.R_OK):
-    with open("regula.license", "rb") as f:
-        print("Found local license file. Using it for performing request...")
-        regula_license = f.read()
-
 with open("WHITE.jpg", "rb") as f:
     white_page_0 = f.read()
 
@@ -24,12 +18,7 @@
         "X-CLIENT-KEY": "123",
         "Authorization": "Bearer 123"
     }
-    params = ProcessParams(already_cropped=True, scenario=Scenario.FULL_PROCESS)
-
-    # Add license to request
-    # request = RecognitionRequest(system_info=ProcessSystemInfo(license=base64.b64encode(regula_license).decode()), process_params=params, images=[
-    #     RecognitionImage(image=white_page_0, light_index=Light.WHITE, page_index=0),
-    # ])
+    params = ProcessParams(alreadyCropped=True, scenario=Scenario.FULL_PROCESS)
 
     request = RecognitionRequest(process_params=params, images=[
         RecognitionImage(image=white_page_0, light_index=Light.WHITE, page_index=0),
@@ -38,8 +27,8 @@
     ])
     response = api.process(request)
 
-    request_json = request.json   # example for request & response raw json
-    response_json = response.json
+    request_json = request.to_json()   # example for request & response raw json
+    response_json = response.to_json()
 
     # status examples
     response_status = response.status
@@ -63,13 +52,13 @@
     #                                                      if FULL_PROCESS then auth is None
 
     doc_ir_b900_blank = doc_ir_b900.checks_by_element(SecurityFeatureType.BLANK) \
-        if doc_authenticity is not None else None
+        if doc_ir_b900 is not None else None
 
     doc_image_pattern = doc_authenticity.image_pattern_checks \
         if doc_authenticity is not None else None
 
     doc_image_pattern_blank = doc_image_pattern.checks_by_element(SecurityFeatureType.BLANK) \
-        if doc_authenticity is not None else None
+        if doc_image_pattern is not None else None
 
     # images fields example
     document_image = response.images.get_field(GraphicFieldType.DOCUMENT_FRONT).get_value()

dev.md

@@ -1,4 +1,8 @@
 {
   "packageName": "regula.documentreader.webclient.gen",
-  "extPackageName": "regula.documentreader.webclient.ext"
+  "extPackageName": "regula.documentreader.webclient.ext",
+  "typeMappings" : {
+    "ContainerListListInner": "ResultItem",
+    "AuthenticityCheckResultListInner": "AuthenticityCheckResultItem"
+  }
 }