Merge pull request #77 from aoberoi/feat.layout-control

add initial_layout_class_list field to token generation

Author: aoberoi

opentok/opentok.py

@@ -70,7 +70,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.
 
@@ -99,6 +100,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.
         """
@@ -128,7 +131,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 is not None) 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:]
@@ -143,12 +151,13 @@ 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,
-            connection_data = (data or None),
-            nonce           = random.randint(0,999999)
+            session_id                = session_id,
+            create_time               = now,
+            expire_time               = expire_time,
+            role                      = role.value,
+            connection_data           = (data or None),
+            nonce                     = random.randint(0,999999),
+            initial_layout_class_list = initial_layout_class_list_serialized
         )
         data_string = urlencode(data_params, True)
 

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)
+
     @raises(TypeError)
     def test_does_not_generate_token_without_params(self):
         token = self.opentok.generate_token()