comment + cleaning currentUser old code

tracim/lib/core/user.py

@@ -6,11 +6,6 @@ import typing as typing
 
 from tracim.models.auth import User
 
-# TODO - G.M -28-03-2018 - [CurrentUser][auth]
-#  Check if "current user" stuff is always needed for tracimv2
-# CURRENT_USER_WEB = 'WEB'
-# CURRENT_USER_WSGIDAV = 'WSGIDAV'
-
 
 class UserApi(object):
 
@@ -53,18 +48,11 @@ class UserApi(object):
         if do_save:
             self.save(user)
 
-        if email and self._user and user.user_id==self._user.user_id:
-            pass
-            # this is required for the _session to keep on being up-to-date
-            # TODO - G.M - 28-03-2018 -
-            # [CurrentUser] Check for pyramid equivalent
-            # tg.request.identity['repoze.who.userid'] = email
-            # tg.auth_force_login(email)
-
     def user_with_email_exists(self, email: str):
         try:
             self.get_one_by_email(email)
             return True
+        # TODO - G.M - 09-04-2018 - Better exception
         except:
             return False
 
@@ -115,64 +103,3 @@ class UserApi(object):
         #     calendar_class=UserCalendar,
         #     related_object_id=created_user.user_id,
         # )
-
-
-# TODO - G.M - 28-03-2018 - [CurrentUser][auth] Check for pyramid equivalent
-# class CurrentUserGetterInterface(object):
-#     def get_current_user(self) -> typing.Union[None, User]:
-#         raise NotImplementedError()
-#
-#
-# class BaseCurrentUserGetter(CurrentUserGetterInterface):
-#     def __init__(self) -> None:
-#         self.api = UserApi(None)
-
-
-# class WebCurrentUserGetter(BaseCurrentUserGetter):
-#     def get_current_user(self) -> typing.Union[None, User]:
-#         # HACK - D.A. - 2015-09-02
-#         # In tests, the tg.request.identity may not be set
-#         # (this is a buggy case, but for now this is how the software is;)
-#         if tg.request is not None:
-#             if hasattr(tg.request, 'identity'):
-#                 if tg.request.identity is not None:
-#                     return self.api.get_one_by_email(
-#                         tg.request.identity['repoze.who.userid'],
-#                     )
-#
-#         return None
-
-# TODO - G.M - 28-03-2018 - [Webdav] Reenable Webdav stuff
-# class WsgidavCurrentUserGetter(BaseCurrentUserGetter):
-#     def get_current_user(self) -> typing.Union[None, User]:
-#         if hasattr(cherrypy.request, 'current_user_email'):
-#             return self.api.get_one_by_email(
-#                 cherrypy.request.current_user_email,
-#             )
-#
-#         return None
-
-
-# class CurrentUserGetterApi(object):
-#     thread_local = threading.local()
-#     matches = {
-#         CURRENT_USER_WEB: WebCurrentUserGetter,
-#         CURRENT_USER_WSGIDAV: WsgidavCurrentUserGetter,
-#     }
-#     default = CURRENT_USER_WEB
-#
-#     @classmethod
-#     def get_current_user(cls) -> User:
-#         try:
-#             return cls.thread_local.getter.get_current_user()
-#         except AttributeError:
-#             return cls.factory(cls.default).get_current_user()
-#
-#     @classmethod
-#     def set_thread_local_getter(cls, name) -> None:
-#         if not hasattr(cls.thread_local, 'getter'):
-#             cls.thread_local.getter = cls.factory(name)
-#
-#     @classmethod
-#     def factory(cls, name: str) -> CurrentUserGetterInterface:
-#         return cls.matches[name]()

tracim/lib/utils/auth.py

@@ -21,16 +21,6 @@ from tracim.lib.core.userworkspace import RoleApi
 # based on this tutorial : https://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/auth/basic.html  # nopep8
 BASIC_AUTH_WEBUI_REALM = "tracim"
 
-# Global Permissions
-ADMIN_PERM = 'admin'
-MANAGE_GLOBAL_PERM = 'manage_global'
-USER_PERM = 'user'
-# Workspace-specific permission
-READ_PERM = 'read'
-CONTRIBUTE_PERM = 'contribute'
-MANAGE_CONTENT_PERM = 'manage_content'
-MANAGE_WORKSPACE_PERM = 'manage_workspace'
-
 
 def get_user(request: Request) -> typing.Optional[User]:
     """
@@ -108,6 +98,17 @@ def check_credentials(
     return permissions
 
 
+# Global Permissions
+ADMIN_PERM = 'admin'
+MANAGE_GLOBAL_PERM = 'manage_global'
+USER_PERM = 'user'
+# Workspace-specific permission
+READ_PERM = 'read'
+CONTRIBUTE_PERM = 'contribute'
+MANAGE_CONTENT_PERM = 'manage_content'
+MANAGE_WORKSPACE_PERM = 'manage_workspace'
+
+
 class Root(object):
     """
     Root of all Pyramid requests, used to store global acl

tracim/lib/utils/logger.py

@@ -3,6 +3,9 @@ import logging
 
 
 class Logger(object):
+    """
+    Global logger
+    """
     TPL = '[{cls}] {msg}'
 
     def __init__(self, logger_name):

tracim/lib/utils/translation.py

@@ -9,4 +9,4 @@ def fake_translator(text: str):
 
 def get_locale():
     # TODO - G.M - 27-03-2018 - [i18n] Reconnect true internationalization
-    return default_locale('LC_TIME')
+    return default_locale('LC_TIME')

tracim/lib/utils/utils.py

@@ -11,20 +11,28 @@ def cmp_to_key(mycmp):
     class K(object):
         def __init__(self, obj, *args):
             self.obj = obj
+
         def __lt__(self, other):
             return mycmp(self.obj, other.obj) < 0
+
         def __gt__(self, other):
             return mycmp(self.obj, other.obj) > 0
+
         def __eq__(self, other):
             return mycmp(self.obj, other.obj) == 0
+
         def __le__(self, other):
             return mycmp(self.obj, other.obj) <= 0
+
         def __ge__(self, other):
             return mycmp(self.obj, other.obj) >= 0
+
         def __ne__(self, other):
             return mycmp(self.obj, other.obj) != 0
+
     return K
 
+
 def current_date_for_filename() -> str:
     """
     ISO8601 current date, adapted to be used in filename (for
@@ -32,6 +40,6 @@ def current_date_for_filename() -> str:
     :return: current date as string like "2018-03-19T15.49.27.246592"
     """
     # INFO - G.M - 19-03-2018 - As ':' is in transform_to_bdd method in
-    # webdav utils, it may cause trouble. So, it should be replaced to
+    # webdav utils, it may cause trouble. So, it should be replaced to
     # a character which will not change in bdd.
-    return datetime.datetime.now().isoformat().replace(':', '.')
+    return datetime.datetime.now().isoformat().replace(':', '.')

tracim/models/auth.py

@@ -212,7 +212,6 @@ class User(DeclarativeBase):
     password = synonym('_password', descriptor=property(_get_password,
                                                         _set_password))
 
-
     def validate_password(self, cleartext_password: str) -> bool:
         """
         Check the password against existing credentials.

tracim/views/__init__.py

@@ -1 +1 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8 -*-

tracim/views/example_api/__init__.py

@@ -1 +1 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8 -*-

tracim/views/example_api/schema.py

@@ -22,7 +22,7 @@ class UserSchema(marshmallow.Schema):
     id = marshmallow.fields.Int(required=True)
     username = marshmallow.fields.String(
         required=True,
-        validate = marshmallow.validate.Regexp(regex='[\w-]+'),
+        validate=marshmallow.validate.Regexp(regex='[\w-]+'),
     )
     email_address = marshmallow.fields.Email(required=True)
     first_name = marshmallow.fields.String(required=True)