Ignore services endpoint (#98)

* Ignore calls to services endpoint

* Add changelog

* Remove type ignore

* Bump version

* Revert request version

* Add deprecation warning

* Add test for deprecation warning when validate_id_params

* Add tests for deprecation warnings

Author: ayinloya

.pre-commit-config.yaml

@@ -36,6 +36,8 @@ repos:
     rev: v1.4.1
     hooks:
     -   id: mypy
+        additional_dependencies:
+          - "types-requests"
 -   repo: https://github.com/pycqa/isort
     rev: 5.12.0
     hooks:

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- Ignore `use_validation_api` in `submit_job`, method deprecated and will be removed
+- Ignore `use_validation_api` and `sid_server` in `Utilities.validate_id_params`, methods deprecated and will be removed
 ### Added
 - Add git commit hook with pre-commit
 

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "smile-id-core"
-version = "2.1.2"
+version = "2.1.3"
 description = "The official Smile Identity package exposes four classes namely; the WebApi class, the IDApi class, the Signature class and the Utilities class."
 license = "MIT"
 authors = ["Smile Identity <[email protected]>"]

pyproject.toml

@@ -1,5 +1,6 @@
 """ID API class for kyc services."""
 from typing import Any, Dict, Optional, Union
+from warnings import warn
 
 from requests import Response
 
@@ -38,7 +39,7 @@ def submit_job(
         self,
         partner_params: Dict[str, Any],
         id_params: Dict[str, str],
-        use_validation_api: bool = True,
+        use_validation_api: bool = False,
         options_params: Optional[OptionsParams] = None,
     ) -> Response:
         """Validate data params & query id_verification endpoint for KYC jobs.
@@ -57,6 +58,13 @@ def submit_job(
         Returns: https post request output of type Response. Alternatively,
         raises a server or value error if there's an exception.
         """
+        if use_validation_api:
+            warn(
+                "The field use_validation_api is deprecated and "
+                "will be removed in the future.",
+                category=DeprecationWarning,
+                stacklevel=2,
+            )
         if not options_params:
             options_params = OptionsParams(
                 return_job_status=False,
@@ -80,7 +88,7 @@ def submit_job(
             self.url,
             id_params,
             partner_params,
-            use_validation_api,
+            False,
         )
 
         if partner_params.get("job_type") != JobType.ENHANCED_KYC:

smile_id_core/IdApi.py

@@ -6,6 +6,7 @@
 import json
 import sys
 from typing import Any, Dict, Optional, Union
+from warnings import warn
 
 import requests
 from requests import Response
@@ -229,6 +230,14 @@ def validate_id_params(
         partner_params:
         use_validation_api:
         """
+        if use_validation_api:
+            warn(
+                "The field use_validation_api is deprecated and "
+                "will be removed in the future.",
+                category=DeprecationWarning,
+                stacklevel=2,
+            )
+
         job_type = partner_params.get("job_type")
         if (
             job_type != JobType.DOCUMENT_VERIFICATION
@@ -247,50 +256,6 @@ def validate_id_params(
                 raise ValueError(f"key {field} cannot be empty")
             else:
                 raise ValueError(f"key {field} cannot be empty")
-        if not use_validation_api:
-            return
-
-        response = Utilities.get_smile_id_services(sid_server)
-        if response.status_code != 200:
-            raise ServerError(
-                f"Failed to get to /services, status={response.status_code},"
-                f" response={response.json()}"
-            )
-        response_json = response.json()
-        if job_type == JobType.DOCUMENT_VERIFICATION:
-            doc_verification = response_json["hosted_web"]["doc_verification"]
-            if id_info_params["country"] not in doc_verification:
-                raise ValueError(
-                    f"country {id_info_params['country']} is invalid"
-                )
-            selected_country = doc_verification[id_info_params["country"]][
-                "id_types"
-            ]
-            if id_info_params["id_type"] not in selected_country:
-                raise ValueError(
-                    f"id_type {id_info_params['id_type']} is invalid"
-                )
-        else:
-            id_types_by_country = response_json["id_types"]
-            if id_info_params["country"] not in id_types_by_country:
-                raise ValueError(
-                    f"country {id_info_params['country']} is invalid"
-                )
-            selected_country = response_json["id_types"][
-                id_info_params["country"]
-            ]
-            if id_info_params["id_type"] not in selected_country:
-                raise ValueError(
-                    f"id_type {id_info_params['id_type']} is invalid"
-                )
-            id_params = selected_country[id_info_params["id_type"]]
-            for key in id_params:
-                if key not in id_info_params and key not in partner_params:
-                    raise ValueError(f"key {key} is required")
-                if key in id_info_params and not id_info_params[key]:
-                    raise ValueError(f"key {key} cannot be empty")
-                if key in partner_params and not partner_params.get(key):
-                    raise ValueError(f"key {key} cannot be empty")
 
     @staticmethod
     def get_smile_id_services(sid_server: Union[str, int]) -> Response:

smile_id_core/Utilities.py

@@ -3,6 +3,7 @@
 import time
 from datetime import datetime
 from typing import Any, Dict, List, Optional, Union
+from warnings import warn
 
 import requests
 from requests import Response
@@ -78,9 +79,16 @@ def submit_job(
         images_params: List[ImageParams],
         id_info_params: Dict[str, Any],
         options_params: OptionsParams,
-        use_validation_api: bool = True,
+        use_validation_api: bool = False,
     ) -> Union[Response, Dict[str, Any]]:
         """Perform key/parameter validation, creates zipped file and uploads."""
+        if use_validation_api:
+            warn(
+                "The field use_validation_api is deprecated and"
+                " will be removed in the future.",
+                category=DeprecationWarning,
+                stacklevel=2,
+            )
         Utilities.validate_partner_params(partner_params)
         job_type = partner_params.get("job_type")
 
@@ -100,7 +108,7 @@ def submit_job(
                     self.url,
                     id_info_params,
                     partner_params,
-                    use_validation_api,
+                    False,
                 )
                 id_info_params = {
                     "first_name": None,
@@ -129,7 +137,7 @@ def submit_job(
             return self.__call_id_api(
                 partner_params,
                 id_info_params,
-                use_validation_api,
+                False,
                 options_params,
             )
 
@@ -145,7 +153,7 @@ def submit_job(
             job_type=job_type,
         )
         Utilities.validate_id_params(
-            self.url, id_info_params, partner_params, use_validation_api
+            self.url, id_info_params, partner_params, False
         )
         self.__validate_return_data(options_params)
 

smile_id_core/WebApi.py

@@ -322,6 +322,32 @@ def test_validate_return_data(
         )
 
 
+def test_show_deprecation_warning_for_use_validation_api(
+    kyc_partner_params: Dict[str, Any],
+    kyc_id_info: Dict[str, str],
+    signature_fixture: Signature,
+    client: IdApi,
+) -> None:
+    """Uses mocked examples for payload responses; checks that
+    response status code is 200 and response body is not empty"""
+    partner_params, id_info_params = (
+        kyc_partner_params,
+        kyc_id_info,
+    )
+    with patch("requests.post") as mocked_post:
+        mocked_post.return_value.status_code = 200
+        mocked_post.return_value.ok = True
+        mocked_post.return_value.text.return_value = get_id_response(
+            signature_fixture,
+        )
+        mocked_post.return_value.json.return_value = get_id_response(
+            signature_fixture,
+        )
+
+        with pytest.deprecated_call():
+            client.submit_job(partner_params, id_info_params, True)
+
+
 def test_validate_return_data_business_verification(
     kyc_partner_params: Dict[str, Any],
     kyc_id_info: Dict[str, str],

tests/test_id_api.py

@@ -141,6 +141,31 @@ def get_smile_services_response() -> Dict[str, Any]:
     }
 
 
+def test_show_deprecation_when_use_validation_is_true(
+    setup_client: Tuple[str, str, str]
+) -> None:
+    api_key, partner_id, _ = setup_client
+    id_info_params = {
+        "first_name": "",
+        "last_name": "",
+        "country": "",
+        "id_type": "",
+        "id_number": "",
+        "dob": "",
+        "entered": None,
+    }
+    partner_params = {
+        "job_id": f"job-{uuid.uuid4()}",
+        "user_id": f"user-{uuid.uuid4()}",
+        "job_type": JobType.BUSINESS_VERIFICATION,
+    }
+    utilities = Utilities(partner_id, api_key, 0)
+    with pytest.deprecated_call():
+        utilities.validate_id_params(
+            0, id_info_params, partner_params, use_validation_api=True
+        )
+
+
 def test_validate_id_params(
     setup_client: Tuple[str, str, str], signature_fixture: Signature
 ) -> None:
@@ -305,7 +330,6 @@ def test_validate_id_params_should_raise_when_provided_with_invalid_input(
     """Validate id parameters using the smile services endpoint which
     checks the provided id params, and partner params"""
 
-    stub_service("https://testapi.smileidentity.com/v1")
     kyc_id_info["country"] = ""
     with pytest.raises(ValueError) as value_error:
         Utilities.validate_id_params(
@@ -332,59 +356,6 @@ def test_validate_id_params_should_raise_when_provided_with_invalid_input(
             kyc_partner_params,
         )
     assert str(value_error.value) == "key id_number cannot be empty"
-    kyc_id_info["id_number"] = "A00000000"
-    kyc_id_info["country"] = "ZW"
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            kyc_partner_params,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "country ZW is invalid"
-
-    kyc_id_info["country"] = "NG"
-    kyc_id_info["id_type"] = "Not_Supported"
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            kyc_partner_params,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "id_type Not_Supported is invalid"
-    kyc_id_info["id_type"] = "PASSPORT"
-    kyc_partner_params["user_id"] = None
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            kyc_partner_params,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "key user_id cannot be empty"
-
-    kyc_partner_params["user_id"] = "kyb_test_user_008"
-    kyc_id_info["first_name"] = ""
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            kyc_partner_params,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "key first_name cannot be empty"
-    kyc_id_info["first_name"] = "FirstName"
-    updated_partner_params = dict(kyc_partner_params)
-    del updated_partner_params["user_id"]
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            updated_partner_params,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "key user_id is required"
 
 
 @responses.activate
@@ -414,28 +385,6 @@ def test_validate_id_params_raise_when_given_invalid_input_for_jt6(
         )
     assert str(value_error.value) == "key id_type cannot be empty"
 
-    kyc_id_info["id_type"] = "PASSPORT"
-    kyc_id_info["country"] = "ZW"
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            partner_params_jt6,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "country ZW is invalid"
-
-    kyc_id_info["country"] = "NG"
-    kyc_id_info["id_type"] = "Not_Supported"
-    with pytest.raises(ValueError) as value_error:
-        Utilities.validate_id_params(
-            client_utilities.url,
-            kyc_id_info,
-            partner_params_jt6,
-            use_validation_api=True,
-        )
-    assert str(value_error.value) == "id_type Not_Supported is invalid"
-
 
 @responses.activate
 def test_get_job_status(