Add example code from webinar

Author: aaronbassett

README.md

@@ -0,0 +1,32 @@
+Sentiment analysis of voice calls using IBM Watson
+==================================================
+
+This is the companion code for the ["Add Sentiment Analysis to Your Inbound Call Flow with IBM Watson and Nexmo" webinar](https://attendee.gotowebinar.com/recording/7952180850491069704). Please view the webinar
+recording for full details on how to run this example.
+
+Quickstart
+----------
+
+There are several environment variables in `call_objects.py` and `ws_server.py` which should be
+set to the correct values in your environment.
+
+    NEXMO_APPLICATION_ID
+    TEST_HANDSET
+    NEXMO_FROM_NUMBER
+    TONE_ANALYZER_USERNAME
+    TONE_ANALYZER_PASSWORD
+    TRANSCRIBER_USERNAME
+    TRANSCRIBER_PASSWORD
+
+You should also update all urls within `call_objects.py` to point to your ngrok address.
+
+    # This code has been tested with Python 3.6.3
+    # Install dependencies
+    pip install -r requirements.txt
+
+    # Run Hug server
+    hug -f call_objects.py
+
+    # Run Tornado server
+    python ws_server.py
+

bensound-acousticbreeze.mp3

@@ -0,0 +1,80 @@
+import os
+import uuid
+import hug
+import nexmo
+
+
+class CallObjectServer():
+
+    def __init__(self):
+        self.conversation_name = str(uuid.uuid4())
+        self.nexmo_client = nexmo.Client(
+            application_id=os.environ['NEXMO_APPLICATION_ID'],
+            private_key='private.key'
+        )
+
+    def start(self):
+
+        self.nexmo_client.create_call({
+            'to': [{'type': 'phone', 'number': os.environ['TEST_HANDSET']}],
+            'from': {'type': 'phone', 'number': os.environ['NEXMO_FROM_NUMBER']},
+            'answer_url': ['https://nexmo-sentiment.ngrok.io/moderator']
+        })
+
+        self.ws_call = self.nexmo_client.create_call({
+            'to': [
+                {
+                    "type": "websocket",
+                    "uri": "ws://nexmo-sentiment-sockets.ngrok.io/audio",
+                    "content-type": "audio/l16;rate=16000",
+                    "headers": {}
+                }
+            ],
+            'from': {'type': 'phone', 'number': os.environ['NEXMO_FROM_NUMBER']},
+            'answer_url': ['https://nexmo-sentiment.ngrok.io/attendee']
+        })
+
+        return [
+            {
+                "action": "talk",
+                "text": "Please wait while we connect you"
+            },
+            {
+                "action": "conversation",
+                "name": self.conversation_name,
+                "startOnEnter": "false",
+                "musicOnHoldUrl": ["https://nexmo-sentiment.ngrok.io/hold.mp3"]
+            }
+        ]
+
+    def moderator(self):
+        return [
+            {
+                "action": "conversation",
+                "name": self.conversation_name,
+                "record": "true",
+                "endOnExit": "true"
+            }
+        ]
+
+    def attendee(self):
+        return [
+            {
+                "action": "conversation",
+                "name": self.conversation_name,
+                "startOnEnter": "false",
+                "musicOnHoldUrl": ["https://nexmo-sentiment.ngrok.io/hold.mp3"]
+            }
+        ]
+
+    def static(self):
+        return open('bensound-acousticbreeze.mp3', mode='rb')
+
+
+server = CallObjectServer()
+
+router = hug.route.API(__name__)
+router.get('/')(server.start)
+router.get('/hold.mp3', output=hug.output_format.file)(server.static)
+router.get('/moderator')(server.moderator)
+router.get('/attendee')(server.attendee)

call_objects.py

@@ -0,0 +1,21 @@
+asn1crypto==0.24.0
+certifi==2018.1.18
+cffi==1.11.4
+chardet==3.0.4
+cryptography==2.1.4
+falcon==1.3.0
+hug==2.3.2
+idna==2.6
+logzero==1.3.1
+nexmo==2.0.0
+pycparser==2.18
+PyJWT==1.5.3
+pyOpenSSL==17.5.0
+pysolr==3.7.0
+python-dateutil==2.6.1
+python-mimeparse==1.6.0
+requests==2.18.4
+six==1.11.0
+tornado==4.5.3
+urllib3==1.22
+watson-developer-cloud==1.0.2

requirements.txt

@@ -0,0 +1,114 @@
+import os
+import json
+
+from watson_developer_cloud import ToneAnalyzerV3
+import tornado.httpserver
+import tornado.ioloop
+import tornado.web
+import tornado.websocket
+from tornado import gen
+import requests
+from logzero import logger
+
+
+class DashboardHandler(tornado.websocket.WebSocketHandler):
+
+    waiters = set()
+
+    def check_origin(self, origin):
+        return True
+
+    def open(self):
+        logger.warning('Dashboard socket open')
+        DashboardHandler.waiters.add(self)
+
+    def on_close(self):
+        logger.warning('Dashboard socket closed')
+        DashboardHandler.waiters.remove(self)
+
+    @classmethod
+    def send_updates(cls, tones):
+        logger.warning('Sending update')
+        logger.warning(tones)
+
+        for waiter in cls.waiters:
+            try:
+                waiter.write_message(tones)
+            except:
+                pass
+
+
+class AudioHandler(tornado.websocket.WebSocketHandler):
+
+    def initialize(self, **kwargs):
+        pass
+
+    def open(self):
+        logger.warning('Audio socket open')
+        self.transcriber = tornado.websocket.websocket_connect(
+            'wss://stream.watsonplatform.net/speech-to-text/api/v1/recognize?watson-token={token}&model={model}'.format(
+                token=self.transcriber_token(),
+                model='en-UK_NarrowbandModel'
+            ),
+            on_message_callback=self.on_transcriber_message
+        )
+
+        self.tone_analyzer = ToneAnalyzerV3(
+            username=os.environ['TONE_ANALYZER_USERNAME'],
+            password=os.environ['TONE_ANALYZER_PASSWORD'],
+            version='2016-05-19'
+        )
+
+    def transcriber_token(self):
+        resp = requests.get(
+            'https://stream.watsonplatform.net/authorization/api/v1/token',
+            auth=(os.environ['TRANSCRIBER_USERNAME'], os.environ['TRANSCRIBER_PASSWORD']),
+            params={'url': "https://stream.watsonplatform.net/speech-to-text/api"}
+        )
+
+        return resp.content.decode('utf-8')
+
+    @gen.coroutine
+    def on_message(self, message):
+        transcriber = yield self.transcriber
+
+        if type(message) != str:
+            transcriber.write_message(message, binary=True)
+        else:
+            logger.error(message)
+            data = json.loads(message)
+            data['action'] = "start"
+            data['continuous'] = True
+            data['interim_results'] = True
+            transcriber.write_message(json.dumps(data), binary=False)
+
+    @gen.coroutine
+    def on_close(self):
+        logger.warning('Audio socket closed')
+
+        transcriber = yield self.transcriber
+        data = {'action': 'stop'}
+        transcriber.write_message(json.dumps(data), binary=False)
+        transcriber.close()
+
+    def on_transcriber_message(self, message):
+        if message:
+            message = json.loads(message)
+            if 'results' in message:
+                transcript = message['results'][0]['alternatives'][0]['transcript']
+                tone_results = self.tone_analyzer.tone(text=transcript)
+                tones = tone_results['document_tone']['tone_categories'][0]['tones']
+
+                DashboardHandler.send_updates(json.dumps(tones))
+
+
+
+if __name__ == "__main__":
+    application = tornado.web.Application([
+        (r"/audio", AudioHandler),
+        (r"/dashboard", DashboardHandler),
+    ])
+    http_server = tornado.httpserver.HTTPServer(application)
+    port = int(os.environ.get("PORT", 3000))
+    http_server.listen(port)
+    tornado.ioloop.IOLoop.instance().start()