Merge pull request #127 from Bandwidth/DX-2906

DX-2906 `<Ring>` Verb Refactor

Author: brianluisgomez

bandwidth/model/bxml/verbs/__init__.py

@@ -6,6 +6,7 @@
 from .phone_number import PhoneNumber
 from .play_audio import PlayAudio
 from .record import Record
+from .ring import Ring
 from .send_dtmf import SendDtmf
 from .sip_uri import SipUri
 from .speak_sentence import SpeakSentence

bandwidth/model/bxml/verbs/ring.py

@@ -0,0 +1,32 @@
+"""
+ring.py
+
+Bandwidth's Ring BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class Ring(TerminalVerb):
+
+    def __init__(
+        self, duration: str = None,
+        answer_call: str = None,
+    ):
+        """Initialize a <Ring> verb
+
+        Args:
+            duration (str, optional): How many seconds to play ringing on the call. Default value is 5. Range: decimal values between 0.1 - 86400.
+            answer_call (str, optional): A boolean indicating whether or not to answer the call when Ring is executed on an unanswered incoming call. Default value is 'true'.
+        """
+        self.duration = duration
+        self.answer_call = answer_call
+        super().__init__(tag="Ring")
+
+    @property
+    def _attributes(self):
+        return {
+            "duration": self.duration,
+            "answerCall": self.answer_call,
+        }

test/unit/bxml/test_ring.py

@@ -0,0 +1,35 @@
+"""
+test_ring.py
+
+Unit tests for the <Ring> BXML verb
+
+@copyright Bandwidth Inc.
+"""
+import os
+import pytest
+import unittest
+
+from bandwidth.model.bxml.verb import Verb
+from bandwidth.model.bxml.verbs.ring import Ring
+
+
+class TestRing(unittest.TestCase):
+    
+    def setUp(self):
+        self.ring = Ring(
+            duration="30",
+            answer_call="true",
+        )
+        self.test_verb = Verb(tag="test")
+    
+    def test_to_bxml(self):
+        if os.environ['PYTHON_VERSION'] == '3.7':
+            expected = '<Ring answerCall="true" duration="30" />'
+        else:
+            expected = '<Ring duration="30" answerCall="true" />'
+            
+        assert(expected == self.ring.to_bxml())
+    
+    def test_add_verb(self):
+        with pytest.raises(AttributeError):
+            self.ring.add_verb(self.test_verb)