Added mute/muteall functionality (#192)

Co-authored-by: Tonya Camille <[email protected]>

Author: dragonmantank

opentok/endpoints.py

@@ -7,6 +7,7 @@ class Endpoints(object):
     Class that provides the endpoint urls
     """
 
+
     def __init__(self, api_url, api_key):
         self.api_url = api_url
         self.api_key = api_key
@@ -130,3 +131,15 @@ def get_broadcast_url(self, broadcast_id=None, stop=False, layout=False):
         if layout:
             url = url + "/layout"
         return url
+
+    def get_mute_all_url(self, session_id):
+        """ this method returns the urls for muting every stream in a session """
+        url = (
+             self.api_url  
+            + "/v2/project/" 
+            + self.api_key
+            + "/session/"
+            + session_id
+            + "/mute"
+
+        )

opentok/opentok.py

@@ -14,6 +14,7 @@
 import random  # _create_jwt_auth_header
 import logging  # logging
 import warnings  # Native. Used for notifying deprecations
+import os
 
 
 # compat
@@ -81,8 +82,6 @@ class ArchiveModes(Enum):
 
 logger = logging.getLogger("opentok")
 
-
-
 class Client(object):
 
     """Use this SDK to create tokens and interface with the server-side portion
@@ -402,6 +401,7 @@ def create_session(
                 proxies=self.proxies,
                 timeout=self.timeout,
             )
+           
             response.encoding = "utf-8"
 
             if response.status_code == 403:
@@ -1343,6 +1343,8 @@ def _create_jwt_auth_header(self):
         }
 
         return jwt.encode(payload, self.api_secret, algorithm="HS256")
+                
+  
 
 class OpenTok(Client):
     def __init__(
@@ -1365,3 +1367,45 @@ def __init__(
             timeout=timeout,
             app_version=app_version
         )
+
+    
+
+
+    def mute(self, session_id: str, stream_id: str= "", options: dict = {}) -> requests.Response:
+        """
+        Use this method so the moderator can mute all streams or a specific stream for OpenTok.
+        Please note that a client is able to unmute themselves.
+        This function stays in the OpenTok class and inherits from the Client class.
+
+        :param session_id gets the session id from another function called get_session()
+
+        :param stream_id gets the stream id from another function called get_stream(). Note
+        that this variable is set to an empty string in the function definition as a specific
+        stream may not be chosen.
+   
+        """
+        
+        try:
+            if not stream_id:
+                url = self.endpoints.get_mute_all_url(session_id)
+                data = {'excludedStream': stream_id}
+            else:
+                url = self.endpoints.get_stream_url(session_id, stream_id) + "/mute"
+                data = None
+            
+            
+            response = requests.post(url, headers=self.get_headers(), data=data)
+
+            if response:
+                return response
+            elif response.status_code == 400:
+                raise GetStreamError("Invalid request. This response may indicate that data in your request data is invalid JSON. Or it may indicate that you do not pass in a session ID or you passed in an invalid stream ID.")
+            elif response.status_code == 403:
+                raise AuthError("Failed to create session, invalid credentials")
+            elif response.status_code == 404:
+                raise NotFoundError("Mute not found")
+        except Exception as e:
+            raise OpenTokException(
+                ("There was an error thrown by the OpenTok SDK, please check that your session_id {0} and stream_id (if exists) {1} are valid").format(
+                    session_id, stream_id))
+

test_requirements.txt

@@ -3,4 +3,5 @@ httpretty
 expects
 wheel
 twine
-bump2version
+bump2version
+sure

tests/test_opentok.py

@@ -0,0 +1,75 @@
+import unittest
+from requests.models import Response
+
+from six import text_type, u, b, PY2, PY3
+from nose.tools import raises
+
+import requests
+import httpretty
+from sure import expect
+import random
+import string
+
+import json
+
+import opentok
+from opentok import Client, OpenTok
+
+
+class OpenTokTest(unittest.TestCase):  
+    def setUp(self):
+        self.api_key = "123456"
+        self.api_secret = "1234567890abcdef1234567890abcdef1234567890"
+        self.session_id = "SESSIONID"
+        self.opentok = Client(self.api_key, self.api_secret)
+        token = string.ascii_letters+string.digits
+        self.jwt_token_string = ''.join(random.choice(token[:100]))
+        self.stream_id_1 = "Stream1"
+
+    @httpretty.activate
+    def test_mute_all_response(self):
+        self.url = "https://api.opentok.com/v2/project/{0}/session/{1}/mute".format(
+                                                                                self.api_key, 
+                                                                                self.session_id)
+
+        httpretty.register_uri(httpretty.POST, 
+                                        self.url, 
+                                        responses=[
+                                            httpretty.Response(body="Testing text matches inside of the JSON file", 
+                                                               content_type="application/json",
+                                                               adding_headers= {"x-opentok-auth": self.jwt_token_string},
+                                                               status=201)
+                                        ])
+
+    
+        response = requests.post(self.url)
+
+        response.status_code.should.equal(201)
+        response.text.should.equal("Testing text matches inside of the JSON file")
+        response.headers["x-opentok-auth"].should.equal(self.jwt_token_string)
+        response.headers["Content-Type"].should.equal("application/json")
+
+    @httpretty.activate
+    def test_mute_stream_response(self):
+        self.url = "https://api.opentok.com/v2/project/${0}/session/${1}/stream/${2}/mute".format(
+                                                                                                self.api_key, 
+                                                                                                self.session_id,
+                                                                                                self.stream_id_1)
+
+        httpretty.register_uri(httpretty.POST, 
+                                        self.url, 
+                                        responses=[
+                                            httpretty.Response(body="Testing body of the JSON file", 
+                                                               content_type="application/json",
+                                                               adding_headers= {"x-opentok-auth": self.jwt_token_string},
+                                                               status=201)
+                                        ])
+
+    
+        response = requests.post(self.url)
+
+        response.status_code.should.equal(201)
+        response.text.should.equal("Testing body of the JSON file")
+        response.headers["x-opentok-auth"].should.equal(self.jwt_token_string)
+        response.headers["Content-Type"].should.equal("application/json")
+