SWI-5041 (#193)

* Rename `test.yaml` -> 'test.yml`

* Update test.yml

* Remove notify action for now

* Remove all BXML default values

* One too many `=None`'s

* Revert "Remove all BXML default values"

This reverts commit 464fc82.

* Dont make non-strings strings

* Do the string conversion later

* Add gather tests back

* Replace %lt; and > in the xml

* Only do regex replacement on SpeakSentence

* SWI-5041 Remove Notify action on release workflow

* SWI-5041 Apply Regex to Root Verb as well

* Fix gather test and re-enable slack notifications

Author: ajrice6713

.github/workflows/deploy.yml

@@ -68,13 +68,13 @@ jobs:
         env:
           PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
           PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-
-#      - uses: Bandwidth/build-notify-slack-action@v1.0.0
-#        if: always()
-#        with:
-#          job-status: ${{ job.status }}
-#          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
-#          slack-channel: ${{ secrets.SLACK_CHANNEL }}
+          
+      - uses: Bandwidth/build-notify-slack-action@v2.0.0
+        if: always()
+        with:
+          job-status: ${{ job.status }}
+          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+          slack-channel: ${{ secrets.SLACK_CHANNEL }}
 
   deploy:
     name: Deploy `main` to PYPI
@@ -136,9 +136,9 @@ jobs:
         env:
           PYPI_API_KEY: ${{ secrets.PYPI_API_KEY }}
 
-#      - uses: Bandwidth/build-notify-slack-action@v1.0.0
-#        if: always()
-#        with:
-#          job-status: ${{ job.status }}
-#          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
-#          slack-channel: ${{ secrets.SLACK_CHANNEL }}
+      - uses: Bandwidth/build-notify-slack-action@v2.0.0
+        if: always()
+        with:
+          job-status: ${{ job.status }}
+          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+          slack-channel: ${{ secrets.SLACK_CHANNEL }}

.github/workflows/test.yml

@@ -78,10 +78,10 @@ jobs:
           echo "Log level: WARNING"
           pytest -v --log-cli-level=WARNING
 
-#      - name: Notify Slack of Failures
-#        uses: Bandwidth/[email protected]
-#        if: failure() && !github.event.pull_request.draft
-#        with:
-#          job-status: ${{ job.status }}
-#          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
-#          slack-channel: ${{ secrets.SLACK_CHANNEL }}
+      - name: Notify Slack of Failures
+        uses: Bandwidth/[email protected]
+        if: failure() && !github.event.pull_request.draft
+        with:
+          job-status: ${{ job.status }}
+          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+          slack-channel: ${{ secrets.SLACK_CHANNEL }}

bandwidth/models/bxml/root.py

@@ -5,6 +5,7 @@
 
 @copyright Bandwidth INC
 """
+import re
 from typing import List
 import xml.etree.ElementTree as ET
 
@@ -14,6 +15,7 @@
 class Root:
     """Base class for BXML roots
     """
+    ssml_regex = r"<([a-zA-Z//].*?)>"
 
     def __init__(self, tag: str, nested_verbs: List[Verb] = None):
         """Initialize instance of class
@@ -74,4 +76,4 @@ def to_bxml(self) -> str:
             str: Serialized BXML string
         """
         xml_document = self._generate_xml()
-        return ET.tostring(xml_document._root, encoding='UTF-8', method='xml', xml_declaration=True).decode("utf8")
+        return re.sub(self.ssml_regex, r"<\1>", ET.tostring(xml_document._root, encoding='UTF-8', method='xml', xml_declaration=True).decode("utf8"))

bandwidth/models/bxml/terminal_verb.py

@@ -11,6 +11,7 @@
 class TerminalVerb(Verb):
     """Base class for BXML verbs
     """
+    ssml_regex = r"<([a-zA-Z//].*?)>"
 
     def __init__(self, tag: str, content: str = None):
         """Initialize the verb model

bandwidth/models/bxml/verb.py

@@ -6,6 +6,7 @@
 @copyright Bandwidth INC
 """
 from __future__ import annotations
+import re
 from typing import Union
 import xml.etree.ElementTree as ET
 
@@ -107,6 +108,8 @@ def to_bxml(self) -> str:
         Returns:
             str: Serialized BXML string
         """
+        ssml_regex = r"<([a-zA-Z//].*?)>"
 
         xml_document = self._generate_xml()
-        return ET.tostring(xml_document._root).decode('utf8')
+        # if the root name is speakSentence, replace content with the SSML regex
+        return re.sub(ssml_regex, r"<\1>", ET.tostring(xml_document._root).decode('utf8'))

bandwidth/models/bxml/verbs/speak_sentence.py

@@ -43,10 +43,8 @@ def _attributes(self):
             "voice": self.voice,
             "gender": self.gender,
             "locale": self.locale,
-        }        
+        }
 
     def to_bxml(self) -> str:
-        SSML_REGEX = r"<([a-zA-Z//].*?)>"
-
         xml_document = self._generate_xml()
-        return re.sub(SSML_REGEX, r"<\1>", ET.tostring(xml_document._root).decode('utf8'))
+        return re.sub(self.ssml_regex, r"<\1>", ET.tostring(xml_document._root).decode('utf8'))

test/unit/bxml/test_gather.py

@@ -53,6 +53,6 @@ def test_to_bxml(self):
         assert(expected == self.gather.to_bxml())
 
     def test_add_verb(self):
-        expected = '<Gather gatherUrl="test.com" gatherMethod="POST" gatherFallbackUrl="fallback-test.com" gatherFallbackMethod="GET" username="user" password="pass" fallbackUsername="user" fallbackPassword="pass" tag="tag" terminatingDigits="2" maxDigits="5" interDigitTimeout="1" firstDigitTimeout="3" repeatCount="2"><PlayAudio username="user" password="pass">https://audio.url/audio1.wav</PlayAudio><SpeakSentence>Hello. Your number is &lt;say-as interpret-as="telephone"&gt;asdf&lt;/say-as&gt;, lets play a game. What is 10 + 3. Press the pound key when finished.</SpeakSentence></Gather>'
+        expected = '<Gather gatherUrl="test.com" gatherMethod="POST" gatherFallbackUrl="fallback-test.com" gatherFallbackMethod="GET" username="user" password="pass" fallbackUsername="user" fallbackPassword="pass" tag="tag" terminatingDigits="2" maxDigits="5" interDigitTimeout="1" firstDigitTimeout="3" repeatCount="2"><PlayAudio username="user" password="pass">https://audio.url/audio1.wav</PlayAudio><SpeakSentence>Hello. Your number is <say-as interpret-as="telephone">asdf</say-as>, lets play a game. What is 10 + 3. Press the pound key when finished.</SpeakSentence></Gather>'
         self.gather.add_verb(self.speak_sentence)
         assert(expected == self.gather.to_bxml())

test/unit/bxml/test_speak_sentence.py

@@ -8,7 +8,7 @@
 import unittest
 
 from bandwidth.models.bxml import Verb
-from bandwidth.models.bxml import SpeakSentence
+from bandwidth.models.bxml import SpeakSentence, Response
 
 
 class TestSpeakSentence(unittest.TestCase):
@@ -24,3 +24,9 @@ def setUp(self):
     def test_to_bxml(self):
         expected = '<SpeakSentence voice="julie">Hello. Your number is <say-as interpret-as="telephone">asdf</say-as>, lets play a game. What is 10 + 3. Press the pound key when finished.</SpeakSentence>'
         assert(expected == self.speak_sentence.to_bxml())
+
+    def test_to_bxml_within_response(self):
+        expected = '<?xml version=\'1.0\' encoding=\'UTF-8\'?>\n<Response><SpeakSentence voice="julie">Hello. Your number is <say-as interpret-as="telephone">asdf</say-as>, lets play a game. What is 10 + 3. Press the pound key when finished.</SpeakSentence></Response>'
+        response = Response()
+        response.add_verb(self.speak_sentence)
+        assert(expected == response.to_bxml())