Merge pull request #109 from opentok/2.5.0

Merge 2.5.0 into master

Author: aiham

README.rst

@@ -19,7 +19,7 @@ http://www.pip-installer.org/en/latest/
 Add the ``opentok`` package as a dependency in your project. The most common way is to add it to your
 ``requirements.txt`` file::
 
-  opentok>=2.4.1
+  opentok>=2.5.0
 
 Next, install the dependencies::
 
@@ -85,8 +85,9 @@ Generating Tokens
 
 Once a Session is created, you can start generating Tokens for clients to use when connecting to it.
 You can generate a token either by calling the ``opentok.generate_token(session_id)`` method or by
-calling the ``session.generate_token()`` method on a ``Session`` instance after creating it. There
-is a set of optional keyword parameters: ``role``, ``expire_time``, and ``data``.
+calling the ``session.generate_token()`` method on a ``Session`` instance after creating it. Both
+have a set of optional keyword parameters: ``role``, ``expire_time``, ``data``, and
+``initial_layout_class_list``.
 
 .. code:: python
 
@@ -99,7 +100,8 @@ is a set of optional keyword parameters: ``role``, ``expire_time``, and ``data``
   # Set some options in a token
   token = session.generate_token(role=Roles.moderator,
                                  expire_time=int(time.time()) + 10,
-                                 data=u'name=Johnny')
+                                 data=u'name=Johnny'
+                                 initial_layout_class_list=[u'focus'])
 
 Working with Archives
 ~~~~~~~~~~~~~~~~~~~~~

opentok/opentok.py

@@ -73,7 +73,8 @@ def proxies(self):
     def proxies(self, proxies):
         self._proxies = proxies
 
-    def generate_token(self, session_id, role=Roles.publisher, expire_time=None, data=None):
+    def generate_token(self, session_id, role=Roles.publisher, expire_time=None, data=None,
+        initial_layout_class_list=[]):
         """
         Generates a token for a given session.
 
@@ -102,6 +103,8 @@ def generate_token(self, session_id, role=Roles.publisher, expire_time=None, dat
           end-user. The length of the string is limited to 1000 characters. This data cannot be
           updated once it is set.
 
+        :param list initial_layout_class_list:
+
         :rtype:
           The token string.
         """
@@ -131,7 +134,12 @@ def generate_token(self, session_id, role=Roles.publisher, expire_time=None, dat
         if expire_time > now + (60*60*24*30):  # 30 days
             raise OpenTokException(u('Cannot generate token, expire_time is not in the next 30 days {0}').format(expire_time))
         if data and len(data) > 1000:
-            raise OpenTokException(u('Cannot generate token, data must be less than 1000 characters').format(data))
+            raise OpenTokException(u('Cannot generate token, data must be less than 1000 characters'))
+        if initial_layout_class_list and not all(text_type(c) for c in initial_layout_class_list):
+            raise OpenTokException(u('Cannot generate token, all items in initial_layout_class_list must be strings'))
+        initial_layout_class_list_serialized = u(' ').join(initial_layout_class_list)
+        if len(initial_layout_class_list_serialized) > 1000:
+            raise OpenTokException(u('Cannot generate token, initial_layout_class_list must be less than 1000 characters'))
 
         # decode session id to verify api_key
         sub_session_id = session_id[2:]
@@ -146,11 +154,12 @@ def generate_token(self, session_id, role=Roles.publisher, expire_time=None, dat
             raise OpenTokException(u('Cannot generate token, the session_id {0} does not belong to the api_key {1}').format(session_id, self.api_key))
 
         data_params = dict(
-            session_id      = session_id,
-            create_time     = now,
-            expire_time     = expire_time,
-            role            = role.value,
-            nonce           = random.randint(0,999999)
+            session_id                = session_id,
+            create_time               = now,
+            expire_time               = expire_time,
+            role                      = role.value,
+            nonce                     = random.randint(0,999999),
+            initial_layout_class_list = initial_layout_class_list_serialized
         )
         if data:
             data_params['connection_data'] = data

opentok/version.py

@@ -1,2 +1,2 @@
 # see: http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers
-__version__ = '2.4.2a1'
+__version__ = '2.5.0'

tests/test_token_generation.py

@@ -64,6 +64,13 @@ def test_generate_data_token(self):
         assert token_decoder(token)[u('connection_data')] == data
         assert token_signature_validator(token, self.api_secret)
 
+    def test_generate_initial_layout_class_list(self):
+        initial_layout_class_list = [u('focus'), u('small')];
+        token = self.opentok.generate_token(self.session_id, initial_layout_class_list=initial_layout_class_list)
+        assert isinstance(token, text_type)
+        assert sorted(token_decoder(token)[u('initial_layout_class_list')].split(u(' '))) == sorted(initial_layout_class_list)
+        assert token_signature_validator(token, self.api_secret)
+
     def test_generate_no_data_token(self):
         token = self.opentok.generate_token(self.session_id)
         assert isinstance(token, text_type)