change p2p to media router, and take out unused tests

Author: aoberoi

opentok/__init__.py

@@ -1,6 +1,5 @@
-from .opentok import OpenTok, Roles
+from .opentok import OpenTok, Roles, MediaModes
 from .session import Session
 from .archives import Archive, ArchiveList
 from .exceptions import OpenTokException
 from .version import __version__
-

opentok/opentok.py

@@ -32,6 +32,10 @@ class Roles(Enum):
     Session object.
     """
 
+class MediaModes(Enum):
+    routed = u('disabled')
+    relayed = u('enabled')
+
 class OpenTok(object):
     """Use this SDK to create tokens and interface with the server-side portion
     of the Opentok API.
@@ -128,7 +132,7 @@ def generate_token(self, session_id, role=Roles.publisher, expire_time=None, dat
 
         sig = self._sign_string(data_string, self.api_secret)
         decoded_base64_bytes = u('partner_id={api_key}&sig={sig}:{payload}').format(
-            api_key = self.api_key, 
+            api_key = self.api_key,
             sig     = sig,
             payload = data_string
         )
@@ -140,58 +144,57 @@ def generate_token(self, session_id, role=Roles.publisher, expire_time=None, dat
         )
         return token
 
-    def create_session(self, location=None, p2p=False):
+    def create_session(self, location=None, media_mode=MediaModes.routed):
         """
         Creates a new OpenTok session and returns the session ID, which uniquely identifies
         the session.
-        
+
         For example, when using the OpenTok JavaScript library, use the session ID when calling the
         OT.initSession() method (to initialize an OpenTok session).
-        
+
         OpenTok sessions do not expire. However, authentication tokens do expire (see the
         generateToken() method). Also note that sessions cannot explicitly be destroyed.
-        
+
         A session ID string can be up to 255 characters long.
-        
+
         Calling this method results in an OpenTokException in the event of an error.
         Check the error message for details.
-        
+
         You can also create a session using the OpenTok REST API (see
         http://www.tokbox.com/opentok/api/#session_id_production) or the OpenTok dashboard
         (see https://dashboard.tokbox.com/projects).
-        
+
         :param String p2p: The session's streams will be transmitted directly between
             peers (true) or using the OpenTok Media Router (false). By default, sessions use
             the OpenTok Media Router.
-            
+
             The OpenTok Media Router provides benefits not available in peer-to-peer sessions.
-            For example, the OpenTok Media Router can decrease bandwidth usage in multiparty 
+            For example, the OpenTok Media Router can decrease bandwidth usage in multiparty
             sessions. Also, the OpenTok Media Router can improve the quality of the user experience
             through dynamic traffic shaping. For more information, see
             http://www.tokbox.com/blog/mantis-next-generation-cloud-technology-for-webrtc and
             http://www.tokbox.com/blog/quality-of-experience-and-traffic-shaping-the-next-step-with-mantis.
-            
+
             For peer-to-peer sessions, the session will attempt to transmit streams directly
             between clients. If clients cannot connect due to firewall restrictions, the session
             uses the OpenTok TURN server to relay audio-video streams.
-            
+
             You will be billed for streamed minutes if you use the OpenTok Media Router or if the
             peer-to-peer session uses the OpenTok TURN server to relay streams. For information on
             pricing, see the OpenTok pricing page (http://www.tokbox.com/pricing).
-        
+
         :param String location: An IP address that the OpenTok servers will use to
             situate the session in its global network. If you do not set a location hint,
             the OpenTok servers will be based on the first client connecting to the session.
-        
+
         :rtype: The Session object. The session_id property of the object is the session ID.
         """
 
         # build options
         options = {}
-        if p2p:
-            if not isinstance(p2p, bool):
-                raise OpenTokException(u('Cannot create session. p2p must be a bool {0}').format(p2p))
-            options[u('p2p.preference')] = u('enabled')
+        if not isinstance(media_mode, MediaModes):
+            raise OpenTokException(u('Cannot create session, {0} is not a valid media mode').format(role))
+        options[u('p2p.preference')] = media_mode.value
         if location:
             # validate IP address
             try:
@@ -219,7 +222,7 @@ def create_session(self, location=None, p2p=False):
                 raise AuthError('Failed to create session (code=%s): %s' % (error.attributes['code'].value, error.firstChild.attributes['message'].value))
 
             session_id = dom.getElementsByTagName('session_id')[0].childNodes[0].nodeValue
-            return Session(self, session_id, location=location, p2p=p2p)
+            return Session(self, session_id, location=location, media_mode=media_mode)
         except Exception as e:
             raise OpenTokException('Failed to generate session: %s' % str(e))
 
@@ -251,18 +254,18 @@ def archive_url(self, archive_id=None):
     def start_archive(self, session_id, **kwargs):
         """
         Starts archiving an OpenTok 2.0 session.
-       
+
         Clients must be actively connected to the OpenTok session for you to successfully start
         recording an archive.
-       
+
         You can only record one archive at a time for a given session. You can only record archives
         of OpenTok server-enabled sessions; you cannot archive peer-to-peer sessions.
-       
+
         :param String session_id: The session ID of the OpenTok session to archive.
         :param String name: This is the name of the archive. You can use this name
           to identify the archive. It is a property of the Archive object, and it is a property
           of archive-related events in the OpenTok.js library.
-       
+
         :rtype: The Archive object, which includes properties defining the archive,
           including the archive ID.
         """
@@ -286,12 +289,12 @@ def start_archive(self, session_id, **kwargs):
     def stop_archive(self, archive_id):
         """
         Stops an OpenTok archive that is being recorded.
-        
+
         Archives automatically stop recording after 90 minutes or when all clients have disconnected
         from the session being archived.
-        
+
         @param [String] archive_id The archive ID of the archive you want to stop recording.
-        
+
         :rtype: The Archive object corresponding to the archive being stopped.
         """
         response = requests.post(self.archive_url(archive_id) + '/stop', headers=self.archive_headers())
@@ -310,7 +313,7 @@ def stop_archive(self, archive_id):
     def delete_archive(self, archive_id):
         """
         Deletes an OpenTok archive.
-        
+
         You can only delete an archive which has a status of "available" or "uploaded". Deleting an
         archive removes its record from the list of archives. For an "available" archive, it also
         removes the archive file, making it unavailable for download.
@@ -330,9 +333,9 @@ def delete_archive(self, archive_id):
 
     def get_archive(self, archive_id):
         """Gets an Archive object for the given archive ID.
-        
+
         :param String archive_id: The archive ID.
-        
+
         :rtype: The Archive object.
         """
         response = requests.get(self.archive_url(archive_id), headers=self.archive_headers())
@@ -349,13 +352,13 @@ def get_archive(self, archive_id):
     def get_archives(self, offset=None, count=None):
         """Returns an ArchiveList, which is an array of archives that are completed and in-progress,
         for your API key.
-        
+
         :param int: offset Optional. The index offset of the first archive. 0 is offset
         of the most recently started archive. 1 is the offset of the archive that started prior to
         the most recent archive. If you do not specify an offset, 0 is used.
         :param int: count Optional. The number of archives to be returned. The maximum
         number of archives returned is 1000.
-        
+
         :rtype: An ArchiveList object, which is an array of Archive objects.
         """
         params = {}
@@ -377,4 +380,3 @@ def get_archives(self, offset=None, count=None):
 
     def _sign_string(self, string, secret):
         return hmac.new(secret.encode('utf-8'), string.encode('utf-8'), hashlib.sha1).hexdigest()
-