Merge pull request #131 from Bandwidth/DX-2895

DX-2895 `<Conference>` Verb Refactored

Author: brianluisgomez

bandwidth/model/bxml/verbs/__init__.py

@@ -1,4 +1,5 @@
 from .bridge import Bridge
+from .conference import Conference
 from .hangup import Hangup
 from .gather import Gather
 from .pause import Pause

bandwidth/model/bxml/verbs/conference.py

@@ -0,0 +1,97 @@
+"""
+conference.py
+
+Bandwidth's Conference BXML verb
+
+@copyright Bandwidth INC
+"""
+from typing import Union, List
+from ..verb import Verb
+from .play_audio import PlayAudio
+from .speak_sentence import SpeakSentence
+from .start_recording import StartRecording
+from .stop_recording import StopRecording
+from .pause_recording import PauseRecording
+from .resume_recording import ResumeRecording
+
+
+class Conference(Verb):
+
+    def __init__(
+        self, name: str,
+        audio_and_recording_verbs: List[Union[PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording]] = [], mute: str=None, 
+        hold: str=None, call_ids_to_coach: str=None, 
+        conference_event_url: str=None, conference_event_method: str=None, 
+        conference_event_fallback_url: str=None, conference_event_fallback_method: str=None, 
+        username: str=None, password: str=None,
+        fallback_username: str=None, fallback_password: str=None, 
+        tag: str=None, callback_timeout: str=None,
+    ):
+        """Initialize a <Conference> verb
+
+        Args:
+            name (str): The name of the conference. Can contain up to 100 characters of letters, numbers, and the symbols -, _, and .
+            mute (str, optional): A boolean value to indicate whether the member should be on mute in the conference. When muted, a member can hear others speak, but others cannot hear them speak. Defaults to false.
+            hold (str, optional): A boolean value to indicate whether the member should be on hold in the conference. When on hold, a member cannot hear others, and they cannot be heard. Defaults to false.
+            call_ids_to_coach (str, optional): A comma-separated list of call ids to coach. When a call joins a conference with this attribute set, it will coach the listed calls. 
+                Those calls will be able to hear and be heard by the coach, but other calls in the conference will not hear the coach.
+            conference_event_url (str, optional): URL to send Conference events to. The URL, method, username, and password are set by the BXML document that creates the conference, 
+                and all events related to that conference will be delivered to that same endpoint. If more calls join afterwards and also have this property (or any other webhook related properties like username and password), 
+                they will be ignored and the original webhook information will be used. This URL may be a relative endpoint.
+            conference_event_method (str, optional): The HTTP method to use for the request to conferenceEventUrl. GET or POST. Default value is POST.
+            conference_event_fallback_url (str, optional): A fallback url which, if provided, will be used to retry the conference webhook deliveries in case conferenceEventUrl fails to respond.
+            conference_event_fallback_method (str, optional): The HTTP method to use to deliver the conference webhooks to conferenceEventFallbackUrl. GET or POST. Default value is POST.
+            username (str, optional):The username to send in the HTTP request to conferenceEventUrl.
+            password (str, optional): The password to send in the HTTP request to conferenceEventUrl.
+            fallback_username (str, optional): The username to send in the HTTP request to conferenceEventFallbackUrl.
+            fallback_password (str, optional): The password to send in the HTTP request to conferenceEventFallbackUrl.
+            tag (str, optional): A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". 
+                Max length 256 characters. Defaults to None.
+            callback_timeout (str, optional): This is the timeout (in seconds) to use when delivering webhooks for the conference. 
+                If not set, it will inherit the webhook timeout from the call that creates the conference. Can be any numeric value (including decimals) between 1 and 25.
+
+        Nested Verbs:
+            PlayAudio: (optional) 
+            SpeakSentence: (optional) 
+            StartRecording: (optional) 
+            StopRecording: (optional)
+            PauseRecording: (optional) 
+            ResumeRecording: (optional)
+        """
+        self.name = name
+        self.mute = mute
+        self.hold = hold
+        self.call_ids_to_coach = call_ids_to_coach
+        self.conference_event_url = conference_event_url
+        self.conference_event_method = conference_event_method
+        self.conference_event_fallback_url = conference_event_fallback_url
+        self.conference_event_fallback_method = conference_event_fallback_method
+        self.username = username
+        self.password = password
+        self.fallback_username = fallback_username
+        self.fallback_password = fallback_password
+        self.tag = tag
+        self.callback_timeout = callback_timeout
+        self.audio_and_recording_verbs = audio_and_recording_verbs
+        super().__init__(
+            tag="Conference", 
+            content=self.name,
+            nested_verbs=self.audio_and_recording_verbs)
+
+    @property
+    def _attributes(self):
+        return {
+            "mute": self.mute,
+            "hold": self.hold,
+            "callIdsToCoach": self.call_ids_to_coach,
+            "conferenceEventUrl": self.conference_event_url,
+            "conferenceEventMethod": self.conference_event_method,
+            "conferenceEventFallbackUrl": self.conference_event_fallback_url,
+            "conferenceEventFallbackMethod": self.conference_event_fallback_method,
+            "username": self.username,
+            "password": self.password,
+            "fallbackUsername": self.fallback_username,
+            "fallbackPassword": self.fallback_password,
+            "tag": self.tag,
+            "callbackTimeout": self.callback_timeout,
+        }

test/unit/bxml/test_conference.py

@@ -0,0 +1,66 @@
+"""
+test_conference.py
+
+Unit tests for the <Conference> BXML verb
+
+@copyright Bandwidth Inc.
+"""
+import os
+import pytest
+import unittest
+
+from bandwidth.model.bxml.verb import Verb
+from bandwidth.model.bxml.verbs import *
+
+class TestGather(unittest.TestCase):
+    
+    def setUp(self):
+        self.play_audio = PlayAudio(
+            audio_uri="https://audio.url/audio1.wav"
+        )
+
+        self.speak_sentence = SpeakSentence(
+            text='Hello there.'
+        )
+        self.start_recording = StartRecording(
+            recording_available_url = "example.com",
+            recording_available_method = "POST",
+            username = "user",
+            password = "pass",
+            tag = "tag",
+            file_format = "wav",
+            multi_channel = "true"
+        )
+
+        self.conference = Conference(
+            name="conf1",
+            mute = "true",
+            hold = "false",
+            call_ids_to_coach = "example-call-id",
+            conference_event_url = "example.com/eventurl",
+            conference_event_method = "POST",
+            conference_event_fallback_url = "backupexample.com/eventurl",
+            conference_event_fallback_method = "POST",
+            username = "user",
+            password = "pass",
+            fallback_username = "user",
+            fallback_password = "pass",
+            tag = "tag",
+            callback_timeout = "5",
+            audio_and_recording_verbs=[self.play_audio, self.start_recording]
+        )
+    
+    def test_to_bxml(self):
+        if os.environ['PYTHON_VERSION'] == '3.7':
+            expected = '<Conference callIdsToCoach="example-call-id" callbackTimeout="5" conferenceEventFallbackMethod="POST" conferenceEventFallbackUrl="backupexample.com/eventurl" conferenceEventMethod="POST" conferenceEventUrl="example.com/eventurl" fallbackPassword="pass" fallbackUsername="user" hold="false" mute="true" password="pass" tag="tag" username="user">conf1<PlayAudio>https://audio.url/audio1.wav</PlayAudio><StartRecording fileFormat="wav" multiChannel="true" password="pass" recordingAvailableMethod="POST" recordingAvailableUrl="example.com" tag="tag" username="user" /></Conference>'
+        else:
+            expected = '<Conference mute="true" hold="false" callIdsToCoach="example-call-id" conferenceEventUrl="example.com/eventurl" conferenceEventMethod="POST" conferenceEventFallbackUrl="backupexample.com/eventurl" conferenceEventFallbackMethod="POST" username="user" password="pass" fallbackUsername="user" fallbackPassword="pass" tag="tag" callbackTimeout="5">conf1<PlayAudio>https://audio.url/audio1.wav</PlayAudio><StartRecording recordingAvailableUrl="example.com" recordingAvailableMethod="POST" username="user" password="pass" tag="tag" fileFormat="wav" multiChannel="true" /></Conference>'
+        assert(expected == self.conference.to_bxml())
+    
+    def test_add_verb(self):
+        if os.environ['PYTHON_VERSION'] == '3.7':
+            expected = '<Conference callIdsToCoach="example-call-id" callbackTimeout="5" conferenceEventFallbackMethod="POST" conferenceEventFallbackUrl="backupexample.com/eventurl" conferenceEventMethod="POST" conferenceEventUrl="example.com/eventurl" fallbackPassword="pass" fallbackUsername="user" hold="false" mute="true" password="pass" tag="tag" username="user">conf1<PlayAudio>https://audio.url/audio1.wav</PlayAudio><StartRecording fileFormat="wav" multiChannel="true" password="pass" recordingAvailableMethod="POST" recordingAvailableUrl="example.com" tag="tag" username="user" /><SpeakSentence>Hello there.</SpeakSentence></Conference>'
+        else:
+            expected = '<Conference mute="true" hold="false" callIdsToCoach="example-call-id" conferenceEventUrl="example.com/eventurl" conferenceEventMethod="POST" conferenceEventFallbackUrl="backupexample.com/eventurl" conferenceEventFallbackMethod="POST" username="user" password="pass" fallbackUsername="user" fallbackPassword="pass" tag="tag" callbackTimeout="5">conf1<PlayAudio>https://audio.url/audio1.wav</PlayAudio><StartRecording recordingAvailableUrl="example.com" recordingAvailableMethod="POST" username="user" password="pass" tag="tag" fileFormat="wav" multiChannel="true" /><SpeakSentence>Hello there.</SpeakSentence></Conference>'
+        self.conference.add_verb(self.speak_sentence)
+        assert(expected == self.conference.to_bxml())