Pull request #13: feature/EOA-2073-retrieve-functionality

Merge in SDK/python_telesign_enterprise from feature/EOA-2073-retrieve-functionality to developer

* commit '3761a9bad520deef0a13287df58461d9efe921f9':
  renamed the telesignenterprise.test to tests folder
  updated the comments
  updated the comments
  created OmniVerify class and added retrieve functionality

Author: mmohanty-telesign

RELEASE

@@ -1,3 +1,11 @@
+2.3.0
+- Created OmniVerify class for adding retrieve 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
+
 2.2.2
 - Added tracking to requests
 

examples/omni_verify/1_retrieve_verification_process.py

@@ -0,0 +1,39 @@
+from __future__ import print_function
+from telesignenterprise.omniverify import OmniVerify
+import json
+
+customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
+api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+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.")
+else:
+    omniverify = OmniVerify(customer_id, api_key)
+
+    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 = input("Do you want to retrieve the verification process details now? (y/n): ").strip().lower()
+    if retrieve == 'y':
+        retrieve_response = omniverify.getVerificationProcess(reference_id)
+        if retrieve_response.ok:
+            print("Verification process details:")
+            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)

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-version = "2.2.2"
+version = "2.3.0"
 
 try:
     with open("README") as f:
@@ -25,12 +25,13 @@
           "Programming Language :: Python :: 3.4",
           "Programming Language :: Python :: 3.5",
           "Programming Language :: Python :: 3.6",
+          "Programming Language :: Python :: 3.7",
       ],
       long_description=readme_content,
       keywords='telesign, sms, voice, mobile, authentication, identity, messaging',
       author='TeleSign Corp.',
       author_email='support@telesign.com',
       url="https://github.com/telesign/python_telesign",
-      install_requires=['telesign >=2.2.1, <2.3'],
+      install_requires=['telesign >=2.2.1, <=2.3'],
       packages=find_packages(exclude=['test', 'test.*', 'examples', 'examples.*']),
       )

telesignenterprise/omniverify.py

@@ -0,0 +1,58 @@
+from __future__ import unicode_literals
+
+from telesign.rest import RestClient
+from telesignenterprise.constants import SOURCE_SDK
+import telesignenterprise
+import telesign
+
+BASE_URL_VERIFY_API = "https://verify.telesign.com"
+PATH_VERIFICATION_CREATE = "/verification"
+PATH_VERIFICATION_RETRIEVE = "/verification/{reference_id}"
+
+class OmniVerify(RestClient):
+    """
+    OmniVerify class to handle omnichannel verification API calls.
+    """
+
+    def __init__(self, customer_id, api_key, rest_endpoint=BASE_URL_VERIFY_API, **kwargs):
+        """
+        Initializes the OmniVerify client with SDK versioning for traceability.
+        """
+        sdk_version_origin = telesignenterprise.__version__
+        sdk_version_dependency = telesign.__version__
+
+        super(OmniVerify, self).__init__(
+            customer_id,
+            api_key,
+            rest_endpoint=rest_endpoint,
+            source=SOURCE_SDK,
+            sdk_version_origin=sdk_version_origin,
+            sdk_version_dependency=sdk_version_dependency,
+            **kwargs
+        )
+
+    def createVerificationProcess(self, phone_number, params={}):
+        """
+        Create a verification process for the specified phone number.
+
+        See https://developer.telesign.com/enterprise/reference/createverificationprocess for detailed API documentation.
+        """
+        params["recipient"] = {"phone_number": phone_number}
+
+        if "verification_policy" not in params:
+            params["verification_policy"] = [{"method": "sms"}]
+
+        return self.post(PATH_VERIFICATION_CREATE, json_fields=params)    
+
+    def getVerificationProcess(self, reference_id, params={}):
+        """
+        Retrieve details about the specified verification process.
+
+        :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)    

telesignenterprise/verify.py

@@ -4,6 +4,7 @@
 from telesignenterprise.constants import SOURCE_SDK
 import telesignenterprise
 import telesign
+from telesignenterprise.omniverify import OmniVerify
 
 VERIFY_SMS_RESOURCE = "/v1/verify/sms"
 VERIFY_VOICE_RESOURCE = "/v1/verify/call"
@@ -35,20 +36,14 @@ def __init__(
             sdk_version_dependency=sdk_version_dependency,
             **kwargs
         )
+        # Instantiate OmniVerify for omnichannel methods
+        self.omniverify = OmniVerify(customer_id, api_key)
 
     def createVerificationProcess(self, phone_number, params={}):
         """
-        Use this action to create a verification process for the specified phone number.
-
-        See https://developer.telesign.com/enterprise/reference/createverificationprocess for detailed API documentation.
+        Proxy method to OmniVerify.createVerificationProcess for streamlined integration.
         """
-        params["recipient"] = {"phone_number": phone_number}
-
-        if "verification_policy" not in params:
-            params["verification_policy"] = [{"method": "sms"}]
-
-        self.set_endpoint(BASE_URL_VERIFY_API)
-        return self.post(PATH_VERIFICATION, json_fields=params)
+        return self.omniverify.createVerificationProcess(phone_number, params)  
 
     def sms(self, phone_number, **params):
         """

tests/test_integration_omniverify.py

@@ -0,0 +1,32 @@
+import pytest
+from telesignenterprise.omniverify import OmniVerify
+
+# Replace with actual credentials for successful test response
+CUSTOMER_ID = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
+API_KEY = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
+
+@pytest.fixture(scope="module")
+def omniverify():
+    if not CUSTOMER_ID or not API_KEY:
+        pytest.skip("TELESIGN_CUSTOMER_ID and TELESIGN_API_KEY environment variables are required for integration tests.")
+    return OmniVerify(CUSTOMER_ID, API_KEY)
+
+def test_create_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"
+    
+    # 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

@@ -0,0 +1,70 @@
+import pytest
+from unittest.mock import patch, MagicMock
+from telesignenterprise.omniverify import OmniVerify
+
+@pytest.fixture
+def omniverify():
+    customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
+    api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
+    return OmniVerify(customer_id, api_key)
+
+def test_create_verification_process_success(omniverify):
+    phone_number = "11234567890"
+    reference_id = "a" * 32
+
+    with patch.object(OmniVerify, 'post') as mock_post:
+        mock_response = MagicMock()
+        mock_response.ok = True
+        mock_response.json = {"reference_id": reference_id}
+        mock_post.return_value = mock_response
+
+        params = {"verification_policy": [{"method": "sms"}]}
+        response = omniverify.createVerificationProcess(phone_number, params)
+
+        mock_post.assert_called_once()
+        called_url = mock_post.call_args[0][0]
+        called_json = mock_post.call_args[1]['json_fields']
+
+        assert called_url == "/verification"
+        assert "recipient" in called_json
+        assert called_json["recipient"]["phone_number"] == phone_number
+        assert response.ok
+        assert response.json["reference_id"] == reference_id
+
+def test_get_verification_process_success(omniverify):
+    reference_id = "a" * 32
+
+    with patch.object(OmniVerify, 'get') as mock_get:
+        mock_response = MagicMock()
+        mock_response.ok = True
+        mock_response.json = {"status": "completed"}
+        mock_get.return_value = mock_response
+
+        response = omniverify.getVerificationProcess(reference_id)
+
+        mock_get.assert_called_once()
+        called_url = mock_get.call_args[0][0]
+
+        assert called_url == f"/verification/{reference_id}"
+        assert response.ok
+        assert response.json["status"] == "completed"
+
+def test_get_verification_process_invalid_reference_id(omniverify):
+    invalid_reference_id = "invalid_id"
+    
+    with patch.object(OmniVerify, 'get') as mock_get:
+        mock_response = MagicMock()
+        mock_response.ok = False
+        mock_response.status_code = 400
+        mock_response.json = {"status": {"code": 3400, "description": "Invalid reference_id format"}}
+        mock_get.return_value = mock_response
+
+        response = omniverify.getVerificationProcess(invalid_reference_id)
+        
+        mock_get.assert_called_once()
+        called_url = mock_get.call_args[0][0]
+        
+        assert called_url == f"/verification/{invalid_reference_id}"
+        assert not response.ok
+        assert response.status_code == 400
+        assert response.json["status"]["code"] == 3400