verify logic, models and tests

Author: maxkahan

http_client/src/vonage_http_client/http_client.py

@@ -224,7 +224,6 @@ def _parse_response(self, response: Response) -> Union[dict, None]:
             f'Response received from {response.url} with status code: {response.status_code}; headers: {response.headers}'
         )
         self._last_response = response
-        content_type = response.headers['Content-Type'].split(';', 1)[0]
         if 200 <= response.status_code < 300:
             if response.status_code == 204:
                 return None
@@ -233,6 +232,7 @@ def _parse_response(self, response: Response) -> Union[dict, None]:
             except JSONDecodeError:
                 return None
         if response.status_code >= 400:
+            content_type = response.headers['Content-Type'].split(';', 1)[0]
             logger.warning(
                 f'Http Response Error! Status code: {response.status_code}; content: {repr(response.text)}; from url: {response.url}'
             )

verify/src/vonage_verify/language_codes.py

@@ -43,7 +43,7 @@ class LanguageCode(str, Enum):
     zh_tw = 'zh-tw'
 
 
-class Psd2LanguageCode(Enum):
+class Psd2LanguageCode(str, Enum):
     en_gb = 'en-gb'
     bg_bg = 'bg-bg'
     cs_cz = 'cs-cz'

verify_v2/src/vonage_verify_v2/__init__.py

@@ -1,28 +1,26 @@
+from .enums import ChannelType, Locale
 from .errors import VerifyError
-from .enums import VerifyChannel, VerifyLocale
 from .requests import (
+    EmailChannel,
+    SilentAuthChannel,
+    SmsChannel,
     VerifyRequest,
-    SilentAuthWorkflow,
-    SmsWorkflow,
-    WhatsappWorkflow,
-    VoiceWorkflow,
-    EmailWorkflow,
+    VoiceChannel,
+    WhatsappChannel,
 )
-from .responses import (
-    StartVerificationResponse,
-)
-from .verify_v2 import Verify
+from .responses import StartVerificationResponse
+from .verify_v2 import VerifyV2
 
 __all__ = [
-    'Verify',
+    'VerifyV2',
     'VerifyError',
-    'VerifyChannel',
-    'VerifyLocale',
+    'ChannelType',
+    'Locale',
     'VerifyRequest',
-    'SilentAuthWorkflow',
-    'SmsWorkflow',
-    'WhatsappWorkflow',
-    'VoiceWorkflow',
-    'EmailWorkflow',
+    'SilentAuthChannel',
+    'SmsChannel',
+    'WhatsappChannel',
+    'VoiceChannel',
+    'EmailChannel',
     'StartVerificationResponse',
 ]

verify_v2/src/vonage_verify_v2/enums.py

@@ -1,15 +1,15 @@
 from enum import Enum
 
 
-class VerifyChannel(Enum):
+class ChannelType(str, Enum):
     SILENT_AUTH = 'silent_auth'
     SMS = 'sms'
     WHATSAPP = 'whatsapp'
     VOICE = 'voice'
     EMAIL = 'email'
 
 
-class VerifyLocale(Enum):
+class Locale(str, Enum):
     EN_US = 'en-us'
     EN_GB = 'en-gb'
     ES_ES = 'es-es'

verify_v2/src/vonage_verify_v2/requests.py

@@ -1,33 +1,29 @@
-from typing import List, Optional, Union
 from re import search
+from typing import List, Optional, Union
 
-from pydantic import (
-    BaseModel,
-    Field,
-    field_validator,
-    model_validator,
-)
+from pydantic import BaseModel, Field, field_validator, model_validator
 from vonage_utils.types.phone_number import PhoneNumber
 
-from .enums import VerifyChannel, VerifyLocale
+from .enums import ChannelType, Locale
 from .errors import VerifyError
 
 
-class Workflow(BaseModel):
-    channel: VerifyChannel
+class Channel(BaseModel):
     to: PhoneNumber
 
 
-class SilentAuthWorkflow(Workflow):
+class SilentAuthChannel(Channel):
     redirect_url: Optional[str] = None
     sandbox: Optional[bool] = None
+    channel: ChannelType = ChannelType.SILENT_AUTH
 
 
-class SmsWorkflow(Workflow):
+class SmsChannel(Channel):
     from_: Optional[Union[PhoneNumber, str]] = Field(None, serialization_alias='from')
     entity_id: Optional[str] = Field(None, pattern=r'^[0-9]{1,20}$')
     content_id: Optional[str] = Field(None, pattern=r'^[0-9]{1,20}$')
     app_hash: Optional[str] = Field(None, min_length=11, max_length=11)
+    channel: ChannelType = ChannelType.SMS
 
     @field_validator('from_')
     @classmethod
@@ -37,45 +33,71 @@ def check_valid_from_field(cls, v):
             and type(v) is not PhoneNumber
             and not search(r'^[a-zA-Z0-9]{1,15}$', v)
         ):
-            raise VerifyError(f'You must specify a valid "from" value if included.')
+            raise VerifyError(
+                'You must specify a valid "from_" value if included. '
+                'It must be a valid phone number without the leading +, or a string of 1-15 alphanumeric characters. '
+                f'You set "from_": "{v}".'
+            )
+        return v
 
 
-class WhatsappWorkflow(Workflow):
+class WhatsappChannel(Channel):
     from_: Union[PhoneNumber, str] = Field(..., serialization_alias='from')
+    channel: ChannelType = ChannelType.WHATSAPP
 
     @field_validator('from_')
     @classmethod
     def check_valid_sender(cls, v):
         if type(v) is not PhoneNumber and not search(r'^[a-zA-Z0-9]{1,15}$', v):
-            raise VerifyError(f'You must specify a valid "from" value.')
+            raise VerifyError(
+                f'You must specify a valid "from_" value. '
+                'It must be a valid phone number without the leading +, or a string of 1-15 alphanumeric characters. '
+                f'You set "from_": "{v}".'
+            )
+        return v
 
 
-class VoiceWorkflow(Workflow):
-    @model_validator(mode='after')
-    def remove_from_field_from_voice(self):
-        self.from_ = None
-        return self
+class VoiceChannel(Channel):
+    channel: ChannelType = ChannelType.VOICE
 
 
-class EmailWorkflow(Workflow):
+class EmailChannel(Channel):
     to: str
     from_: Optional[str] = Field(None, serialization_alias='from')
+    channel: ChannelType = ChannelType.EMAIL
 
 
 class VerifyRequest(BaseModel):
     brand: str = Field(..., min_length=1, max_length=16)
-    workflow: List[Workflow]
-    locale: Optional[VerifyLocale] = None
+    workflow: List[
+        Union[
+            SilentAuthChannel,
+            SmsChannel,
+            WhatsappChannel,
+            VoiceChannel,
+            EmailChannel,
+        ]
+    ]
+    locale: Optional[Locale] = None
     channel_timeout: Optional[int] = Field(None, ge=60, le=900)
     client_ref: Optional[str] = Field(None, min_length=1, max_length=16)
     code_length: Optional[int] = Field(None, ge=4, le=10)
     code: Optional[str] = Field(None, pattern=r'^[a-zA-Z0-9]{4,10}$')
 
     @model_validator(mode='after')
     def remove_fields_if_only_silent_auth(self):
-        if len(self.workflow) == 1 and isinstance(self.workflow[0], SilentAuthWorkflow):
+        if len(self.workflow) == 1 and isinstance(self.workflow[0], SilentAuthChannel):
             self.locale = None
-            self.client_ref = None
             self.code_length = None
             self.code = None
         return self
+
+    @model_validator(mode='after')
+    def check_silent_auth_first_if_present(self):
+        if len(self.workflow) > 1:
+            for i in range(1, len(self.workflow)):
+                if isinstance(self.workflow[i], SilentAuthChannel):
+                    raise VerifyError(
+                        'If using Silent Authentication, it must be the first channel in the "workflow" list.'
+                    )
+        return self

verify_v2/src/vonage_verify_v2/responses.py

@@ -6,3 +6,8 @@
 class StartVerificationResponse(BaseModel):
     request_id: str
     check_url: Optional[str] = None
+
+
+class CheckCodeResponse(BaseModel):
+    request_id: str
+    status: str

verify_v2/src/vonage_verify_v2/verify_v2.py

@@ -1,26 +1,11 @@
-from typing import List, Optional, Union
-
 from pydantic import validate_call
 from vonage_http_client.http_client import HttpClient
 
-from .errors import VerifyError
-from .requests import (
-    VerifyRequest,
-    SilentAuthWorkflow,
-    SmsWorkflow,
-    WhatsappWorkflow,
-    VoiceWorkflow,
-    EmailWorkflow,
-)
-from .responses import (
-    CheckCodeResponse,
-    StartVerificationResponse,
-    VerifyControlStatus,
-    VerifyStatus,
-)
+from .requests import VerifyRequest
+from .responses import CheckCodeResponse, StartVerificationResponse
 
 
-class Verify:
+class VerifyV2:
     """Calls Vonage's Verify V2 API."""
 
     def __init__(self, http_client: HttpClient) -> None:
@@ -47,14 +32,6 @@ def start_verification(
 
         return StartVerificationResponse(**response)
 
-    ####################################################################################################
-
-    ####################################################################################################
-
-    ####################################################################################################
-
-    ####################################################################################################
-
     @validate_call
     def check_code(self, request_id: str, code: str) -> CheckCodeResponse:
         """Check a verification code.
@@ -67,55 +44,26 @@ def check_code(self, request_id: str, code: str) -> CheckCodeResponse:
             CheckCodeResponse: The response object containing the verification result.
         """
         response = self._http_client.post(
-            self._http_client.api_host,
-            '/verify/check/json',
-            {'request_id': request_id, 'code': code},
-            self._auth_type,
-            self._sent_data_type,
+            self._http_client.api_host, f'/v2/verify/{request_id}', {'code': code}
         )
-        self._check_for_error(response)
         return CheckCodeResponse(**response)
 
     @validate_call
-    def cancel_verification(self, request_id: str) -> VerifyControlStatus:
+    def cancel_verification(self, request_id: str) -> None:
         """Cancel a verification request.
 
         Args:
             request_id (str): The request ID.
-
-        Returns:
-            VerifyControlStatus: The response object containing details of the submitted
-                verification control.
         """
-        response = self._http_client.post(
-            self._http_client.api_host,
-            '/verify/control/json',
-            {'request_id': request_id, 'cmd': 'cancel'},
-            self._auth_type,
-            self._sent_data_type,
-        )
-        self._check_for_error(response)
-
-        return VerifyControlStatus(**response)
+        self._http_client.delete(self._http_client.api_host, f'/v2/verify/{request_id}')
 
     @validate_call
-    def trigger_next_workflow(self, request_id: str) -> VerifyControlStatus:
+    def trigger_next_workflow(self, request_id: str) -> None:
         """Trigger the next workflow event in the verification process.
 
         Args:
             request_id (str): The request ID.
-
-        Returns:
-            VerifyControlStatus: The response object containing details of the submitted
-                verification control.
         """
         response = self._http_client.post(
-            self._http_client.api_host,
-            '/verify/control/json',
-            {'request_id': request_id, 'cmd': 'trigger_next_event'},
-            self._auth_type,
-            self._sent_data_type,
+            self._http_client.api_host, f'/v2/verify/{request_id}'
         )
-        self._check_for_error(response)
-
-        return VerifyControlStatus(**response)

verify_v2/tests/BUILD

@@ -0,0 +1 @@
+python_tests(dependencies=['verify_v2', 'testutils'])

verify_v2/tests/data/check_code.json

@@ -0,0 +1,4 @@
+{
+    "request_id": "36e7060d-2b23-4257-bad0-773ab47f85ef",
+    "status": "completed"
+}

verify_v2/tests/data/check_code_400.json

@@ -0,0 +1,6 @@
+{
+    "type": "https://developer.nexmo.com/api-errors#bad-request",
+    "title": "Invalid Code",
+    "detail": "The code you provided does not match the expected value.",
+    "instance": "475343c0-9239-4715-aed1-72b4a18379d1"
+}