add checks for silent auth workflow parameters

Author: maxkahan

CHANGES.md

@@ -1,3 +1,6 @@
+# 3.11.1
+- Add checks for silent auth workflow optional parameters `redirect_url` and `sandbox`
+
 # 3.11.0
 - Add method to check JWT signatures of Voice API webhooks: `vonage.Voice.verify_signature`
 

src/vonage/verify2.py

@@ -84,6 +84,8 @@ def check_valid_workflow(cls, v):
                 Verify2._check_app_hash(workflow)
                 if workflow['channel'] == 'whatsapp' and 'from' in workflow:
                     Verify2._check_whatsapp_sender(workflow)
+                if workflow['channel'] == 'silent_auth':
+                    Verify2._check_silent_auth_workflow(workflow)
 
     def _check_valid_channel(workflow):
         if 'channel' not in workflow or workflow['channel'] not in Verify2.valid_channels:
@@ -113,4 +115,12 @@ def _check_app_hash(workflow):
 
     def _check_whatsapp_sender(workflow):
         if not re.search(r'^[1-9]\d{6,14}$', workflow['from']):
-            raise Verify2Error(f'You must specify a valid "from" value if included.')
+            raise Verify2Error('You must specify a valid "from" value if included.')
+
+    def _check_silent_auth_workflow(workflow):
+        if 'redirect_url' in workflow:
+            if type(workflow['redirect_url']) != str:
+                raise Verify2Error('"redirect_url" must be a string if specified.')
+        if 'sandbox' in workflow:
+            if type(workflow['sandbox']) != bool:
+                raise Verify2Error('"sandbox" must be a boolean if specified.')

tests/test_verify2.py

@@ -396,7 +396,17 @@ def test_new_request_silent_auth():
         status_code=202,
     )
 
-    params = {'brand': 'ACME, Inc', 'workflow': [{'channel': 'silent_auth', 'to': '447700900000'}]}
+    params = {
+        'brand': 'ACME, Inc',
+        'workflow': [
+            {
+                'channel': 'silent_auth',
+                'to': '447000000000',
+                'redirect_url': 'https://acme-app.com/sa/redirect',
+                'sandbox': False,
+            }
+        ],
+    }
     verify_request = verify2.new_request(params)
 
     assert verify_request['request_id'] == 'b3a2f4bd-7bda-4e5e-978a-81514702d2ce'
@@ -406,6 +416,38 @@ def test_new_request_silent_auth():
     )
 
 
+def test_silent_auth_redirect_url_error():
+    params = {
+        'brand': 'ACME, Inc',
+        'workflow': [
+            {
+                'channel': 'silent_auth',
+                'to': '447000000000',
+                'redirect_url': ['https://acme-app.com/sa/redirect'],
+            }
+        ],
+    }
+    with raises(Verify2Error) as err:
+        verify2.new_request(params)
+    assert str(err.value) == '"redirect_url" must be a string if specified.'
+
+
+def test_silent_auth_sandbox_error():
+    params = {
+        'brand': 'ACME, Inc',
+        'workflow': [
+            {
+                'channel': 'silent_auth',
+                'to': '447000000000',
+                'sandbox': 'true',
+            }
+        ],
+    }
+    with raises(Verify2Error) as err:
+        verify2.new_request(params)
+    assert str(err.value) == '"sandbox" must be a boolean if specified.'
+
+
 @responses.activate
 def test_new_request_error_conflict():
     stub(