Renaming + Comment + small refactor

tracim/development.ini.base

@@ -246,13 +246,14 @@ jitsi_meet.domain = your_jitsi_meet_instance
 jitsi_meet.use_token = False
 # If token mode is choosen, you need to provide a token generator.
 # "local" value mean that tracim himself will create token for jitsi-meet
+# Distant token generator are not yet implemented.
 jitsi_meet.token_generator = local
 # identifier share between jitsi_meet and local token_generator
 jitsi_meet.token_generator.local.app_id = tracim
 # Secret share between jitsi-meet and local token_generator
 jitsi_meet.token_generator.local.secret = my_secret
 # Algorithm used to sign JWT token
-jitsi_meet.token_generator.local.algo = HS256
+jitsi_meet.token_generator.local.algorithm = HS256
 # Duration of token validity in second. 5 minutes (300) is a good choice.
 jitsi_meet.token_generator.local.duration = 300
 

tracim/tracim/config/app_cfg.py

@@ -460,8 +460,8 @@ class CFG(object):
         self.JITSI_MEET_TOKEN_GENERATOR_LOCAL_SECRET = tg.config.get(
             'jitsi_meet.token_generator.local.secret'
         )
-        self.JITSI_MEET_TOKEN_GENERATOR_LOCAL_ALG = tg.config.get(
-            'jitsi_meet.token_generator.local.alg',
+        self.JITSI_MEET_TOKEN_GENERATOR_LOCAL_ALGORITHM = tg.config.get(
+            'jitsi_meet.token_generator.local.algorithm',
             'HS256'
         )
         self.JITSI_MEET_TOKEN_GENERATOR_LOCAL_DURATION = int(tg.config.get(

tracim/tracim/lib/jitsi_meet/room.py

@@ -16,6 +16,8 @@ class JitsiMeetRoom(object):
             issuer: typing.Union[User, JitsiMeetUser, None]=None,
     ) -> None:
         """
+        This class set all to create a JitsiMeetRoom according
+        to current config.
         :param issuer: user who initiated Jitsi Meet talk
         if None, default user is created. Can be both Tracim User or
         JitsiMeetUser.
@@ -26,7 +28,7 @@ class JitsiMeetRoom(object):
         self._set_domain()
         self._set_token_params()
         self._set_context(
-            receivers=receivers,
+            workspace=receivers,
             issuer=issuer,
         )
         self.room = self._generate_room_name(receivers)
@@ -45,17 +47,17 @@ class JitsiMeetRoom(object):
         """
         self.use_token = self.tracim_cfg.JITSI_MEET_USE_TOKEN
         if self.use_token:
-            if self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR == 'local':
-                self.token_app_id = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_APP_ID  # nopep8
-                self.token_secret = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_SECRET  # nopep8
-                self.token_alg = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_ALG   # nopep8
-                self.token_duration = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_DURATION  # nopep8
-            else:
+            if self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR != 'local':
                 raise JitsiMeetNoTokenGenerator
 
+            self.token_app_id = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_APP_ID  # nopep8
+            self.token_secret = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_SECRET  # nopep8
+            self.token_alg = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_ALGORITHM   # nopep8
+            self.token_duration = self.tracim_cfg.JITSI_MEET_TOKEN_GENERATOR_LOCAL_DURATION  # nopep8
+
     def _set_context(
             self,
-            receivers: Workspace,
+            workspace: Workspace,
             issuer: typing.Union[User, JitsiMeetUser, None],
     ) -> None:
         """
@@ -63,7 +65,7 @@ class JitsiMeetRoom(object):
         :param issuer: user who initiated Jitsi Meet talk
         if None, default user is created. Can be both Tracim User or
         JitsiMeetUser.
-        :param receivers: User or Room who can talk with sender. Now, only
+        :param workspace: User or Room who can talk with sender. Now, only
         Workspace are supported.
         :return: nothing.
         """
@@ -84,7 +86,7 @@ class JitsiMeetRoom(object):
             )
 
         # INFO - G.M - 13-02-2018 - Associate
-        group = receivers.label
+        group = workspace.label
 
         self.context = JitsiMeetContext(
             user=user,
@@ -107,7 +109,7 @@ class JitsiMeetRoom(object):
         # Jitsi-Meet doesn't like specials_characters
         return str_as_alpha_num_str(room)
 
-    def generate_token(self) -> str:
+    def generate_jwt_token(self) -> str:
         """
         Generate Jitsi-Meet related JWT token
         :return: JWT token as str
@@ -129,6 +131,9 @@ class JitsiMeetRoom(object):
     def generate_url(self, token=None) -> str:
         """
         Generate Jitsi-Meet url with or without token
+        examples :
+         - https://myjitsiinstance/myroom
+         - https://mysecurejitsiinstance/myroom?jwt=[very_long_jwt_token]
         :return: url as string
         """
         if token:

tracim/tracim/templates/videoconf/invite.mak

@@ -11,7 +11,7 @@
         <p>
         ${_('To invite someone from outside of tracim into this conference, share this link. This link is available for 5 minutes.')}
         </p>
-        <textarea readonly=readonly wrap="off" style="width: 100%;">${jitsi_meet_room.generate_url(jitsi_meet_room.generate_token())}</textarea>
+        <textarea readonly=readonly wrap="off" style="width: 100%;">${jitsi_meet_room.generate_url(jitsi_meet_room.generate_jwt_token())}</textarea>
     </div>
     <div class="modal-footer">
         <button type="button" class="btn btn-default" data-dismiss="modal">${_('Close')}</button>

tracim/tracim/templates/videoconf/jitsi_meet.mak

@@ -46,7 +46,7 @@
         // for another way to deal with auto-auth :
         // see this rejected PR : https://github.com/jitsi/jitsi-meet/pull/2109
             %if jitsi_meet_room.use_token:
-                jwt: '${jitsi_meet_room.generate_token()}',
+                jwt: '${jitsi_meet_room.generate_jwt_token()}',
             %endif
             roomName : '${jitsi_meet_room.room}',
             parentNode: document.querySelector('#jitsi'),

tracim/tracim/tests/library/test_jitsi_meet_room.py

@@ -67,7 +67,7 @@ class TestJitsiMeetRoom(object):
                 receivers=Workspace()
             )
             jmr.use_token = False
-            jmr.generate_token()
+            jmr.generate_jwt_token()
 
     def test_unit__set_context_return_always_jitsi_meet_user(self):
         with patch.object(JitsiMeetRoom,
@@ -76,7 +76,7 @@ class TestJitsiMeetRoom(object):
             jmr = JitsiMeetRoom(
                 receivers=Workspace()
             )
-            jmr._set_context(issuer=None, receivers=Workspace())
+            jmr._set_context(issuer=None, workspace=Workspace())
             assert jmr.context
             assert hasattr(jmr.context, 'user')
             assert isinstance(jmr.context.user, JitsiMeetUser)
@@ -85,7 +85,7 @@ class TestJitsiMeetRoom(object):
                 receivers=Workspace()
             )
             jmr2._set_context(issuer=JitsiMeetUser(jitsi_meet_user_id='user'),
-                              receivers=Workspace())
+                              workspace=Workspace())
             assert jmr2.context
             assert hasattr(jmr2.context, 'user')
             assert isinstance(jmr2.context.user, JitsiMeetUser)
@@ -93,7 +93,7 @@ class TestJitsiMeetRoom(object):
             jmr3 = JitsiMeetRoom(
                 receivers=Workspace()
             )
-            jmr3._set_context(issuer=User(), receivers=Workspace())
+            jmr3._set_context(issuer=User(), workspace=Workspace())
             assert jmr3.context
             assert hasattr(jmr3.context, 'user')
             assert isinstance(jmr3.context.user, JitsiMeetUser)