Pull request #14: Feature/EOA-2074 Update functionality

Merge in SDK/python_telesign_enterprise from feature/EOA-2074-Update-functionality to developer

* commit '15a44820c91d3a662d2848d2634112eaa023062b':
  set basic_auth param
  consolidate both retrieve and update functionality
  update comments
  validate conflict
  update the release
  updated comments
  addedupdate functionlity

Author: mmohanty-telesign

RELEASE

@@ -1,10 +1,10 @@
 2.3.0
-- Created OmniVerify class for adding retrieve verification process functionality
+- Created OmniVerify class for adding retrieve and update verification process functionality
 
 - Moved the createVerificationProcess method from the VerifyClient class to the new OmniVerify class, 
   consolidating omnichannel verification responsibilities in one place
 
-- Added unit and integration tests to telesignenterpise.test folder
+- Added unit and integration tests 
 
 2.2.2
 - Added tracking to requests

examples/omni_verify/1_retrieve_verification_process.py

@@ -3,7 +3,7 @@
 import json
 
 customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
-api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
+api_key = "ABC12345yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
 
 phone_number = input("Please enter the phone number (with country code, digits only): ").strip()
 if not phone_number.isdigit():

examples/omni_verify/2_update_verification_process.py

@@ -0,0 +1,61 @@
+from __future__ import print_function
+from telesignenterprise.omniverify import OmniVerify
+import json
+
+customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
+api_key = "ABC12345yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
+
+phone_number = input("Please enter the phone number (with country code, digits only): ").strip()
+if not phone_number.isdigit():
+    print("Error: phone number must contain digits only.")
+    exit(1)
+
+omniverify = OmniVerify(customer_id, api_key)
+
+# Create the verification process
+create_params = {
+    "verification_policy": [{"method": "sms"}]
+}
+create_response = omniverify.createVerificationProcess(phone_number, create_params)
+
+if create_response.ok:
+    reference_id = create_response.json.get("reference_id")
+    print("Verification process created successfully.")
+    print("Reference ID:", reference_id)
+else:
+    print("Failed to create verification process.")
+    print("Status code:", create_response.status_code)
+    print("Response:", create_response.json)
+    exit(1)
+
+# Retrieve the verification process
+retrieve_response = omniverify.getVerificationProcess(reference_id)
+if retrieve_response.ok:
+    print("Verification process retrieved successfully.")
+    print(json.dumps(retrieve_response.json, indent=4))
+else:
+    print("Failed to retrieve verification process.")
+    print("Status code:", retrieve_response.status_code)
+    print("Response:", retrieve_response.json)
+    exit(1)
+
+# Prompt for OTP (security factor) and update the verification process
+security_factor = input("Please enter the OTP (security factor) to finalize the verification: ").strip()
+
+update_params = {
+    "action": "finalize",
+    "security_factor": security_factor
+}
+use_basic_auth = True
+update_response = omniverify.updateVerificationProcess(reference_id, update_params, use_basic_auth=use_basic_auth)
+
+if update_response.ok:
+    print("Verification process updated successfully.")
+    response_json = update_response.json() if callable(update_response.json) else update_response.json
+    print("Response:")
+    print(json.dumps(response_json, indent=4))
+else:
+    print("Failed to update verification process.")
+    print("Status code:", update_response.status_code)
+    response_json = update_response.json() if callable(update_response.json) else update_response.json
+    print("Response:", response_json)

telesignenterprise/omniverify.py

@@ -4,10 +4,12 @@
 from telesignenterprise.constants import SOURCE_SDK
 import telesignenterprise
 import telesign
+import requests, json, base64
 
 BASE_URL_VERIFY_API = "https://verify.telesign.com"
 PATH_VERIFICATION_CREATE = "/verification"
 PATH_VERIFICATION_RETRIEVE = "/verification/{reference_id}"
+PATH_VERIFICATION_UPDATE = "/verification/{reference_id}/state"
 
 class OmniVerify(RestClient):
     """
@@ -48,11 +50,51 @@ def getVerificationProcess(self, reference_id, params={}):
         """
         Retrieve details about the specified verification process.
 
+        See https://developer.telesign.com/enterprise/reference/getverificationprocess for detailed API documentation.
+        
         :param reference_id: The unique identifier of the verification process.
         :param params: Optional query parameters as a dictionary.
         :return: Response object from the GET request.
         """
         endpoint = PATH_VERIFICATION_RETRIEVE.format(reference_id=reference_id)
         headers = {"Content-Type": "application/json", "Accept": "application/json"}
 
-        return self.get(endpoint, json_fields=params, headers=headers)    
+        return self.get(endpoint, json_fields=params, headers=headers)    
+    
+    def updateVerificationProcess(self, reference_id, params, use_basic_auth=False):
+        """
+        Update a verification process.
+
+        See https://developer.telesign.com/enterprise/reference/updateverificationprocess for detailed API documentation.
+
+        :param reference_id: The unique identifier of the verification process.
+        :param params: Dictionary of parameters for the update (must include 'action' and 'security_factor').
+        :param use_basic_auth: Boolean indicating whether to use manual Basic Auth.
+        :return: Response object.
+        """
+        endpoint_path = PATH_VERIFICATION_UPDATE.format(reference_id=reference_id)
+
+        if use_basic_auth:
+            endpoint = self.api_host.rstrip('/') + endpoint_path
+
+            json_body = json.dumps(params)
+
+            auth_str = f"{self.customer_id}:{self.api_key}"
+            auth_bytes = auth_str.encode('utf-8')
+            auth_b64 = base64.b64encode(auth_bytes).decode('utf-8')
+            headers = {
+                "Authorization": f"Basic {auth_b64}",
+                "Content-Type": "application/json",
+                "Accept": "application/json"
+            }
+            response = requests.patch(endpoint, data=json_body, headers=headers)
+            return type('Response', (), {
+                'status_code': response.status_code,
+                'headers': response.headers,
+                'body': response.text,
+                'ok': response.ok,
+                'json': response.json
+            })()
+        else:
+            headers = {"Content-Type": "application/json", "Accept": "application/json"}
+            return self.patch(endpoint_path, json_fields=params, headers=headers)

telesignenterprise/verify.py

@@ -40,9 +40,7 @@ def __init__(
         self.omniverify = OmniVerify(customer_id, api_key)
 
     def createVerificationProcess(self, phone_number, params={}):
-        """
-        Proxy method to OmniVerify.createVerificationProcess for streamlined integration.
-        """
+        
         return self.omniverify.createVerificationProcess(phone_number, params)  
 
     def sms(self, phone_number, **params):

tests/test_integration_omniverify.py

@@ -3,7 +3,7 @@
 
 # Replace with actual credentials for successful test response
 CUSTOMER_ID = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
-API_KEY = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
+API_KEY = "ABC12345yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
 
 @pytest.fixture(scope="module")
 def omniverify():
@@ -30,3 +30,44 @@ def test_create_and_retrieve_verification_process(omniverify):
 
     data = retrieve_response.json
     assert "reference_id" in data and data["reference_id"] == reference_id
+
+def test_create_update_and_retrieve_verification_process(omniverify):
+    phone_number = "11234567890"  # Replace with a valid test phone number including country code
+
+    # Create verification process
+    create_params = {
+        "verification_policy": [{"method": "sms"}]
+    }
+    create_response = omniverify.createVerificationProcess(phone_number, create_params)
+    assert create_response.ok, f"Failed to create verification process: {create_response.json}"
+    reference_id = create_response.json.get("reference_id")
+    assert reference_id and len(reference_id) == 32, "Invalid reference_id returned"
+
+    # Simulate user entering the OTP (replace '123456' with an actual OTP for a successful response)
+    otp_code = "123456"
+    update_params = {
+        "action": "finalize",
+        "security_factor": otp_code
+    }
+    # Test both SDK-internal and manual Basic Auth PATCH
+    for use_basic_auth in (False, True):
+        update_response = omniverify.updateVerificationProcess(reference_id, update_params, use_basic_auth=use_basic_auth)
+        # Acceptable error codes: 400 (bad request), 401 (unauthorized), 3904/3909 (Telesign verification errors: Rate Eimit Exceeded/Invalid code entered), 3400 (Telesign not authorized)
+        allowed_status_codes = (400, 401, 3904, 3909)
+        allowed_telesign_codes = (3400)
+        telesign_code = (
+            update_response.json.get("status", {}).get("code")
+            if update_response.json and isinstance(update_response.json, dict)
+            else None
+        )
+        assert (
+            update_response.ok
+            or update_response.status_code in allowed_status_codes
+            or telesign_code in allowed_telesign_codes
+        ), f"Unexpected update response: {update_response.json}"
+
+    # Retrieve verification process details
+    retrieve_response = omniverify.getVerificationProcess(reference_id)
+    assert retrieve_response.ok, f"Failed to retrieve verification process: {retrieve_response.json}"
+    data = retrieve_response.json
+    assert "reference_id" in data and data["reference_id"] == reference_id

tests/test_omniverify.py

@@ -5,7 +5,7 @@
 @pytest.fixture
 def omniverify():
     customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
-    api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
+    api_key = "ABC12345yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
     return OmniVerify(customer_id, api_key)
 
 def test_create_verification_process_success(omniverify):
@@ -67,4 +67,55 @@ def test_get_verification_process_invalid_reference_id(omniverify):
         assert called_url == f"/verification/{invalid_reference_id}"
         assert not response.ok
         assert response.status_code == 400
-        assert response.json["status"]["code"] == 3400
+        assert response.json["status"]["code"] == 3400
+
+def test_update_verification_process_success(omniverify):
+    reference_id = "a" * 32
+    params = {
+        "action": "finalize",
+        "security_factor": "123456"
+    }
+
+    with patch.object(OmniVerify, 'patch') as mock_patch:
+        mock_response = MagicMock()
+        mock_response.ok = True
+        mock_response.json = {
+            "status": {"code": 3900, "description": "Verified"},
+            "reference_id": reference_id
+        }
+        mock_patch.return_value = mock_response
+
+        response = omniverify.updateVerificationProcess(reference_id, params)
+
+        mock_patch.assert_called_once()
+        called_url = mock_patch.call_args[0][0]
+        called_json = mock_patch.call_args[1]['json_fields']
+
+        assert called_url == f"/verification/{reference_id}/state"
+        assert called_json["action"] == "finalize"
+        assert called_json["security_factor"] == "123456"
+        assert response.ok
+        assert response.json["status"]["code"] == 3900
+
+def test_update_verification_process_invalid_code(omniverify):
+    reference_id = "a" * 32
+    params = {
+        "action": "finalize",
+        "security_factor": "wrongcode"
+    }
+
+    with patch.object(OmniVerify, 'patch') as mock_patch:
+        mock_response = MagicMock()
+        mock_response.ok = False
+        mock_response.status_code = 400
+        mock_response.json = {
+            "status": {"code": 3904, "description": "Verification Failed"}
+        }
+        mock_patch.return_value = mock_response
+
+        response = omniverify.updateVerificationProcess(reference_id, params)
+
+        mock_patch.assert_called_once()
+        assert not response.ok
+        assert response.status_code == 400
+        assert response.json["status"]["code"] == 3904