renaming webhook -> websocket

Author: maxkahan

README.rst

@@ -551,6 +551,15 @@ For more information about OpenTok live streaming broadcasts, see the
 `Broadcast developer guide <https://tokbox.com/developer/guides/broadcast/>`_.
 
 
+Streaming audio to a websocket
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+You can stream audio to a websocket with the ``opentok.stream_audio_to_websocket`` method.
+
+.. code:: python
+
+  websocket_options = {"uri": "wss://service.com/ws-endpoint"}
+  websocketopentok.stream_audio_to_websocket(session_id, opentok_token, websocket_options)
+
 Configuring Timeout
 -------------------
 Timeout is passed in the Client constructor:

opentok/__init__.py

@@ -15,4 +15,4 @@
 from .sip_call import SipCall
 from .broadcast import Broadcast, BroadcastStreamModes
 from .render import Render, RenderList
-from .webhook_audio_connection import WebhookAudioConnection
+from .websocket_audio_connection import WebsocketAudioConnection

opentok/opentok.py

@@ -32,7 +32,7 @@
 from .streamlist import StreamList
 from .sip_call import SipCall
 from .broadcast import Broadcast, BroadcastStreamModes
-from .webhook_audio_connection import WebhookAudioConnection
+from .websocket_audio_connection import WebsocketAudioConnection
 from .exceptions import (
     ArchiveStreamModeError,
     BroadcastHLSOptionsError,
@@ -1806,7 +1806,7 @@ def list_renders(self, offset=0, count=50):
 
     def stream_audio_to_websocket(self, session_id: str, opentok_token: str, websocket_options: dict):
         """
-        Connects audio streams to a specified webhook URI.
+        Connects audio streams to a specified websocket URI.
         For more information, see the `Audio Streamer developer guide <https://tokbox.com/developer/guides/audio-streamer/>`.
 
         :param String 'session_id': The OpenTok session ID that includes the OpenTok streams you want to include in the WebSocket stream. The Audio Streamer feature is only supported in routed sessions (sessions that use the OpenTok Media Router).
@@ -1841,7 +1841,7 @@ def stream_audio_to_websocket(self, session_id: str, opentok_token: str, websock
         )
 
         if response and response.status_code == 200:
-            return WebhookAudioConnection(response.json())
+            return WebsocketAudioConnection(response.json())
         elif response.status_code == 400:
             """
             The HTTP response has a 400 status code in the following cases:
@@ -1860,7 +1860,7 @@ def validate_websocket_options(self, options):
         if type(options) is not dict:
             raise InvalidWebsocketOptionsError('Must pass websocket options as a dictionary.')
         if 'uri' not in options:
-            raise InvalidWebsocketOptionsError('Provide a webhook URI.')
+            raise InvalidWebsocketOptionsError('Provide a websocket URI.')
 
     def _sign_string(self, string, secret):
         return hmac.new(

opentok/webhook_audio_connection.py

@@ -6,7 +6,7 @@
 
 from six import u, PY2, PY3
 from expects import *
-from opentok import Client, WebhookAudioConnection, __version__
+from opentok import Client, WebsocketAudioConnection, __version__
 from opentok.exceptions import InvalidWebsocketOptionsError, InvalidMediaModeError
 from .validate_jwt import validate_jwt_header
 
@@ -43,7 +43,7 @@ def test_stream_audio_to_websocket(self):
             "uri": "wss://service.com/ws-endpoint"
         }
 
-        webhook_audio_connection = self.opentok.stream_audio_to_websocket(self.session_id, self.token, websocket_options)
+        websocket_audio_connection = self.opentok.stream_audio_to_websocket(self.session_id, self.token, websocket_options)
 
         validate_jwt_header(self, httpretty.last_request().headers[u("x-opentok-auth")])
         expect(httpretty.last_request().headers[u("user-agent")]).to(
@@ -60,11 +60,11 @@ def test_stream_audio_to_websocket(self):
             body = json.loads(httpretty.last_request().body.decode("utf-8"))
 
         expect(body).to(have_key(u("token")))
-        expect(webhook_audio_connection).to(be_a(WebhookAudioConnection))
-        expect(webhook_audio_connection).to(
+        expect(websocket_audio_connection).to(be_a(WebsocketAudioConnection))
+        expect(websocket_audio_connection).to(
             have_property(u("id"), u("b0a5a8c7-dc38-459f-a48d-a7f2008da853"))
         )
-        expect(webhook_audio_connection).to(
+        expect(websocket_audio_connection).to(
             have_property(u("connectionId"), u("e9f8c166-6c67-440d-994a-04fb6dfed007"))
         )
 
@@ -86,7 +86,7 @@ def test_stream_audio_to_websocket_custom_options(self):
             }
         }
 
-        webhook_audio_connection = self.opentok.stream_audio_to_websocket(self.session_id, self.token, websocket_options)
+        websocket_audio_connection = self.opentok.stream_audio_to_websocket(self.session_id, self.token, websocket_options)
 
         validate_jwt_header(self, httpretty.last_request().headers[u("x-opentok-auth")])
         expect(httpretty.last_request().headers[u("user-agent")]).to(
@@ -103,11 +103,11 @@ def test_stream_audio_to_websocket_custom_options(self):
             body = json.loads(httpretty.last_request().body.decode("utf-8"))
 
         expect(body).to(have_key(u("token")))
-        expect(webhook_audio_connection).to(be_a(WebhookAudioConnection))
-        expect(webhook_audio_connection).to(
+        expect(websocket_audio_connection).to(be_a(WebsocketAudioConnection))
+        expect(websocket_audio_connection).to(
             have_property(u("id"), u("b0a5a8c7-dc38-459f-a48d-a7f2008da853"))
         )
-        expect(webhook_audio_connection).to(
+        expect(websocket_audio_connection).to(
             have_property(u("connectionId"), u("e9f8c166-6c67-440d-994a-04fb6dfed007"))
         )
 
@@ -149,4 +149,4 @@ def test_stream_audio_to_websocket_missing_uri_error(self):
         websocket_options = {}
         with self.assertRaises(InvalidWebsocketOptionsError) as context:
             self.opentok.stream_audio_to_websocket(self.session_id, self.token, websocket_options)
-        self.assertTrue("Provide a webhook URI." in str(context.exception))
+        self.assertTrue("Provide a websocket URI." in str(context.exception))