adding advancedMachineDetection to ncco builder and testing (#259)

* adding advancedMachineDetection to ncco builder and testing

* removing beep_timeout

Author: maxkahan

src/vonage/ncco_builder/ncco.py

@@ -73,6 +73,7 @@ class Connect(Action):
         timeout: Optional[int]
         limit: Optional[conint(le=7200)]
         machineDetection: Optional[Literal['continue', 'hangup']]
+        advancedMachineDetection: Optional[dict]
         eventUrl: Optional[Union[List[str], str]]
         eventMethod: Optional[constr(to_upper=True)]
         ringbackTone: Optional[str]
@@ -103,6 +104,14 @@ def check_from_not_set(cls, v, values):
         def ensure_url_in_list(cls, v):
             return Ncco._ensure_object_in_list(v)
 
+        @validator('advancedMachineDetection')
+        def validate_advancedMachineDetection(cls, v):
+            if 'behavior' in v and v['behavior'] not in ('continue', 'hangup'):
+                raise ValueError('advancedMachineDetection["behavior"] must be one of: "continue", "hangup".')
+            if 'mode' in v and v['mode'] not in ('detect, detect_beep'):
+                raise ValueError('advancedMachineDetection["mode"] must be one of: "detect", "detect_beep".')
+            return v
+
         class Config:
             smart_union = True
 

tests/test_ncco_builder/ncco_samples/ncco_action_samples.py

@@ -22,6 +22,8 @@
 
 connect_full = '{"action": "connect", "endpoint": [{"type": "phone", "number": "447000000000"}], "from": "447400000000", "randomFromNumber": false, "eventType": "synchronous", "timeout": 15, "limit": 1000, "machineDetection": "hangup", "eventUrl": ["http://example.com"], "eventMethod": "PUT", "ringbackTone": "http://example.com"}'
 
+connect_advancedMachineDetection = '{"action": "connect", "endpoint": [{"type": "phone", "number": "447000000000"}], "from": "447400000000", "advancedMachineDetection": {"behavior": "continue", "mode": "detect"}, "eventUrl": ["http://example.com"]}'
+
 talk_basic = '{"action": "talk", "text": "hello"}'
 
 talk_full = '{"action": "talk", "text": "hello", "bargeIn": true, "loop": 3, "level": 0.5, "language": "en-GB", "style": 1, "premium": true}'

tests/test_ncco_builder/ncco_samples/ncco_builder_samples.py

@@ -17,6 +17,12 @@
     ringbackTone='http://example.com',
 )
 
+connect_advancedMachineDetection = Ncco.Connect(
+    endpoint=ConnectEndpoints.PhoneEndpoint(number='447000000000'),
+    advancedMachineDetection={'behavior': 'continue', 'mode': 'detect'},
+)
+
+
 talk_minimal = Ncco.Talk(text='hello')
 
 talk = Ncco.Talk(text='hello', bargeIn=True, loop=3, level=0.5, language='en-GB', style=1, premium=True)
@@ -69,6 +75,16 @@
     {'action': 'talk', 'text': 'hello'},
 ]
 
+three_part_advancedMachineDetection_ncco = [
+    {'action': 'record', 'eventUrl': ['http://example.com/events']},
+    {
+        'action': 'connect',
+        'endpoint': [{'type': 'phone', 'number': '447000000000'}],
+        'advancedMachineDetection': {'behavior': 'continue', 'mode': 'detect'},
+    },
+    {'action': 'talk', 'text': 'hello'},
+]
+
 insane_ncco = [
     {'action': 'record', 'eventUrl': ['http://example.com/events']},
     {'action': 'conversation', 'name': 'my_conversation'},

tests/test_ncco_builder/test_ncco_actions.py

@@ -125,6 +125,18 @@ def test_connect_options():
     assert json.dumps(_action_as_dict(connect)) == nas.connect_full
 
 
+def test_connect_advanced_machine_detection():
+    advancedMachineDetectionParams = {'behavior': 'continue', 'mode': 'detect'}
+    endpoint = ConnectEndpoints.PhoneEndpoint(number='447000000000')
+    connect = Ncco.Connect(
+        endpoint=endpoint,
+        from_='447400000000',
+        advancedMachineDetection=advancedMachineDetectionParams,
+        eventUrl='http://example.com',
+    )
+    assert json.dumps(_action_as_dict(connect)) == nas.connect_advancedMachineDetection
+
+
 def test_connect_random_from_number_error():
     endpoint = ConnectEndpoints.PhoneEndpoint(number='447000000000')
     with pytest.raises(ValueError) as err:
@@ -143,6 +155,10 @@ def test_connect_validation_errors():
         Ncco.Connect(endpoint=endpoint, limit=7201)
     with pytest.raises(ValidationError):
         Ncco.Connect(endpoint=endpoint, machineDetection='do_nothing')
+    with pytest.raises(ValidationError):
+        Ncco.Connect(endpoint=endpoint, advancedMachineDetection={'behavior': 'do_nothing'})
+    with pytest.raises(ValidationError):
+        Ncco.Connect(endpoint=endpoint, advancedMachineDetection={'mode': 'detect_nothing'})
 
 
 def test_talk_basic():

tests/test_ncco_builder/test_ncco_builder.py

@@ -1,4 +1,3 @@
-import pytest
 import json
 
 from vonage import Ncco
@@ -20,13 +19,9 @@ def test_build_ncco_from_args():
 
 
 def test_build_ncco_from_list():
-    action_list = [nbs.record, nbs.talk_minimal]
+    action_list = [nbs.record, nbs.connect_advancedMachineDetection, nbs.talk_minimal]
     ncco = Ncco.build_ncco(actions=action_list)
-    assert ncco == nbs.two_part_ncco
-    assert (
-        json.dumps(ncco)
-        == '[{"action": "record", "eventUrl": ["http://example.com/events"]}, {"action": "talk", "text": "hello"}]'
-    )
+    assert ncco == nbs.three_part_advancedMachineDetection_ncco
 
 
 def test_build_insane_ncco():