Merge branch 'fix/better_api_doc' of github.com:tracim/tracim_backend into fix/few_more_tests

README.md

@@ -124,7 +124,6 @@ You can run it this way with docker :
     docker pull mailhog/mailhog
     docker run -d -p 1025:1025 -p 8025:8025 mailhog/mailhog
 
-
 Run your project's tests:
 
     pytest

development.ini.oloool

@@ -0,0 +1,275 @@
+###
+# app configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html
+###
+;[pipeline:main]
+;pipeline = tracim_web
+
+[app:main]
+use = egg:tracim_backend
+
+pyramid.reload_templates = true
+pyramid.debug_authorization = false
+pyramid.debug_notfound = false
+pyramid.debug_routematch = false
+pyramid.default_locale_name = en
+;pyramid.includes =
+;    pyramid_debugtoolbar
+
+retry.attempts = 3
+
+sqlalchemy.url = sqlite:///%(here)s/tracim.sqlite
+
+# By default, the toolbar only appears for clients from IP addresses
+# '127.0.0.1' and '::1'.
+# debugtoolbar.hosts = 127.0.0.1 ::1
+
+###
+# TRACIM SPECIFIC CONF
+###
+
+### Global
+
+cache_dir = %(here)s/data
+# preview generator cache directory
+preview_cache_dir = /tmp/tracim/preview/
+# file depot storage
+depot_storage_name = tracim
+depot_storage_dir = %(here)s/depot/
+
+# The following parameters allow to personalize the home page
+# They are html ready (you can put html tags they will be interpreted)
+website.title = TRACIM
+website.title.color = #555
+website.home.subtitle = Default login: email: admin@admin.admin (password: admin@admin.admin)
+website.home.tag_line = <div class="text-center" style="font-weight: bold;">Collaboration, versionning and traceability</div>
+website.home.below_login_form = in case of problem, please contact the administrator.
+# Values may be 'all' or 'folders'
+website.treeview.content = all
+# The following base_url is used for links and icons
+# integrated in the email notifcations
+website.base_url = http://127.0.0.1:8080
+# If config not provided, it will be extracted from website.base_url
+website.server_name = 127.0.0.1
+
+# Specifies if the update of comments and attached files is allowed (by the owner only).
+# Examples:
+#    600 means 10 minutes (ie 600 seconds)
+#   3600 means 1 hour (60x60 seconds)
+#
+# Allowed values:
+#  -1 means that content update is allowed for ever
+#   0 means that content update is not allowed
+#   x means that content update is allowed for x seconds (with x>0)
+content.update.allowed.duration = 3600
+
+# Auth type (internal or ldap)
+auth_type = internal
+# If auth_type is ldap, uncomment following ldap_* parameters
+# LDAP server address
+# ldap_url = ldap://localhost:389
+# Base dn to make queries
+# ldap_base_dn = dc=directory,dc=fsf,dc=org
+# Bind dn to identify the search
+# ldap_bind_dn = cn=admin,dc=directory,dc=fsf,dc=org
+# The bind password
+# ldap_bind_pass = toor
+# Attribute name of user record who contain user login (email)
+# ldap_ldap_naming_attribute = uid
+# Matching between ldap attribute and ldap user field (ldap_attr1=user_field1,ldap_attr2=user_field2,...)
+# ldap_user_attributes = mail=email
+# TLS usage to communicate with your LDAP server
+# ldap_tls = False
+# If True, LDAP own tracim group managment (not available for now!)
+# ldap_group_enabled = False
+# User auth token validity in seconds (used to interfaces like web calendars)
+user.auth_token.validity = 604800
+
+### Mail
+
+# Reset password through email related configuration.
+# These emails will be sent through SMTP
+#
+resetpassword.email_sender = email@sender.com
+resetpassword.smtp_host = smtp.sender
+resetpassword.smtp_port = 25
+resetpassword.smtp_login = smtp.login
+resetpassword.smtp_passwd = smtp.password
+
+email.notification.activated = false
+# email.notification.log_file_path = /tmp/mail-notifications.log
+# email notifications can be sent with the user_id added as an identifier
+# this way email clients like Thunderbird will be able to distinguish
+# notifications generated by a user or another one
+email.notification.from.email = dev.tracim.maildaemon+{user_id}@algoo.fr
+email.notification.from.default_label = Tracim Notifications
+email.notification.reply_to.email = dev.tracim.maildaemon+{content_id}@algoo.fr
+email.notification.references.email = dev.tracim.maildaemon+{content_id}@algoo.fr
+email.notification.content_update.template.html = %(here)s/tracim/templates/mail/content_update_body_html.mak
+email.notification.content_update.template.text = %(here)s/tracim/templates/mail/content_update_body_text.mak
+email.notification.created_account.template.html = %(here)s/tracim/templates/mail/created_account_body_html.mak
+email.notification.created_account.template.text = %(here)s/tracim/templates/mail/created_account_body_text.mak
+# Note: items between { and } are variable names. Do not remove / rename them
+email.notification.content_update.subject = [{website_title}] [{workspace_label}] {content_label} ({content_status_label})
+email.notification.created_account.subject = [{website_title}] Created account
+# processing_mode may be sync or async
+email.notification.processing_mode = async
+email.notification.smtp.server = mail.gandi.net
+email.notification.smtp.port = 25
+email.notification.smtp.user = dev.tracim.maildaemon@algoo.fr
+email.notification.smtp.password = dev.tracim.maildaemon
+
+## Email sending configuration
+# processing_mode may be sync or async,
+# with async, please configure redis below
+email.processing_mode = sync
+# email.async.redis.host = localhost
+# email.async.redis.port = 6379
+# email.async.redis.db = 0
+
+# Email reply configuration
+email.reply.activated = false
+email.reply.imap.server = your_imap_server
+email.reply.imap.port = 993
+email.reply.imap.user = your_imap_user
+email.reply.imap.password = your_imap_password
+email.reply.imap.folder = INBOX
+email.reply.imap.use_ssl = true
+email.reply.imap.use_idle = true
+# Re-new connection each 10 minutes
+email.reply.connection.max_lifetime = 600
+# Token for communication between mail fetcher and tracim controller
+email.reply.token = mysecuretoken
+# Delay in seconds between each check
+email.reply.check.heartbeat = 60
+email.reply.use_html_parsing = true
+email.reply.use_txt_parsing = true
+# Lockfile path is required for email_reply feature,
+# it's just an empty file use to prevent concurrent access to imap unseen mail
+email.reply.lockfile_path = %(here)s/email_fetcher.lock
+
+### Radical (CalDav server) configuration
+
+# radicale.server.host = 0.0.0.0
+# radicale.server.port = 5232
+# radicale.server.ssl = false
+radicale.server.filesystem.folder = %(here)s/radicale/collections/
+# radicale.server.allow_origin = *
+# radicale.server.realm_message = Tracim Calendar - Password Required
+## url can be extended like http://127.0.0.1:5232/calendar
+## in this case, you have to create your own proxy behind this url.
+## and update following parameters
+# radicale.client.base_url.host = http://127.0.0.1:5232
+# radicale.client.base_url.prefix = /
+
+### WSGIDAV
+
+wsgidav.config_path = %(here)s/wsgidav.conf
+## url can be extended like 127.0.0.1/webdav
+## in this case, you have to create your own proxy behind this url.
+## Do not set http:// prefix.
+# wsgidav.client.base_url = 127.0.0.1:<WSGIDAV_PORT>
+
+###
+# wsgi server configuration
+###
+[uwsgi]
+# Legacy server config (waitress)
+[server:main]
+use = egg:waitress#main
+listen = localhost:6543
+
+[alembic]
+# path to migration scripts
+script_location = tracim/migration
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+#truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to migrate/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat migrate/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = sqlite:///%(here)s/tracim.sqlite
+
+###
+# logging configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html
+###
+
+[loggers]
+keys = root, tracim, sqlalchemy, alembic, sentry
+
+[handlers]
+keys = console, sentry
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = INFO
+handlers = console, sentry
+
+[logger_sentry]
+level = WARN
+handlers = console
+qualname = sentry.errors
+propagate = 0
+
+[logger_tracim]
+level = DEBUG
+handlers =
+qualname = tracim
+
+[logger_sqlalchemy]
+level = INFO
+handlers =
+qualname = sqlalchemy.engine
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARN" logs neither.  (Recommended for production systems.)
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[handler_sentry]
+class = raven.handlers.logging.SentryHandler
+args = ('http://1dbab0942cca4fbb97f3dae62cbc965d:4d1deecd8abc41e38c02b37ed4954f58@127.0.0.1:9000/4',)
+level = WARNING
+formatter = generic
+
+[formatter_generic]
+format = %(asctime)s %(levelname)-5.5s [%(name)s:%(lineno)s][%(threadName)s] %(message)s
+datefmt = %H:%M:%S

setup.py

@@ -34,12 +34,12 @@ requires = [
     # others
     'filedepot',
     'babel',
+    'python-slugify',
     # mail-notifier
     'mako',
     'lxml',
     'redis',
     'rq',
-    'python-slugify',
 ]
 
 tests_require = [

tracim/exceptions.py

@@ -57,7 +57,7 @@ class SameValueError(ValueError):
     pass
 
 
-class NotAuthentificated(TracimException):
+class NotAuthenticated(TracimException):
     pass
 
 

tracim/lib/core/userworkspace.py

@@ -49,6 +49,7 @@ class RoleApi(object):
         """
         Return WorkspaceInContext object from Workspace
         """
+        assert self._config
         workspace = UserRoleWorkspaceInContext(
             user_role=user_role,
             dbsession=self._session,
@@ -138,7 +139,8 @@ class RoleApi(object):
         workspace:Workspace
     ) -> typing.List[UserRoleInWorkspace]:
         return self._session.query(UserRoleInWorkspace)\
-            .filter(UserRoleInWorkspace.workspace_id == workspace.workspace_id).all()  # nopep8
+            .filter(UserRoleInWorkspace.workspace_id==workspace.workspace_id)\
+            .all()
 
     def save(self, role: UserRoleInWorkspace) -> None:
         self._session.flush()

tracim/lib/mail_notifier/notifier.py

@@ -238,7 +238,7 @@ class EmailManager(object):
         notifiable_roles = WorkspaceApi(
             current_user=user,
             session=self.session,
-            config=self.config
+            config=self.config,
         ).get_notifiable_roles(content.workspace)
 
         if len(notifiable_roles) <= 0:
@@ -358,22 +358,22 @@ class EmailManager(object):
         text_template_file_path = self.config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_TEXT  # nopep8
         html_template_file_path = self.config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_HTML  # nopep8
 
+        context = {
+            'user': user,
+            'password': password,
+            # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for logo_url  # nopep8
+            'logo_url': '',
+            # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for login_url  # nopep8
+            'login_url': self.config.WEBSITE_BASE_URL,
+        }
         body_text = self._render_template(
             mako_template_filepath=text_template_file_path,
-            context={
-                'user': user,
-                'password': password,
-                'login_url': self.config.WEBSITE_BASE_URL,
-            }
+            context=context
         )
 
         body_html = self._render_template(
             mako_template_filepath=html_template_file_path,
-            context={
-                'user': user,
-                'password': password,
-                'login_url': self.config.WEBSITE_BASE_URL,
-            }
+            context=context,
         )
 
         part1 = MIMEText(body_text, 'plain', 'utf-8')
@@ -434,6 +434,15 @@ class EmailManager(object):
         content_text = ''
         call_to_action_text = ''
 
+        # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for call_to_action_url  # nopep8
+        call_to_action_url =''
+        # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for status_icon_url  # nopep8
+        status_icon_url = ''
+        # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for workspace_url  # nopep8
+        workspace_url = ''
+        # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for logo_url  # nopep8
+        logo_url = ''
+
         action = content.get_last_action().id
         if ActionDescription.COMMENT == action:
             content_intro = l_('<span id="content-intro-username">{}</span> added a comment:').format(actor.display_name)
@@ -523,20 +532,25 @@ class EmailManager(object):
             )
             raise ValueError('Unexpected empty notification')
 
+        context = {
+            'user': role.user,
+            'workspace': role.workspace,
+            'workspace_url': workspace_url,
+            'main_title': main_title,
+            'status_label': content.get_status().label,
+            'status_icon_url': status_icon_url,
+            'role_label': role.role_as_label(),
+            'content_intro': content_intro,
+            'content_text': content_text,
+            'call_to_action_text': call_to_action_text,
+            'call_to_action_url': call_to_action_url,
+            'logo_url': logo_url,
+        }
         user = role.user
         workspace = role.workspace
         body_content = self._render_template(
             mako_template_filepath=mako_template_filepath,
-            context={
-                'user': role.user,
-                'workspace': role.workspace,
-                'main_title': main_title,
-                'status': content.get_status().label,
-                'role': role.role_as_label(),
-                'content_intro': content_intro,
-                'content_text': content_text,
-                'call_to_action_text': call_to_action_text,
-            }
+            context=context,
         )
         return body_content
 

tracim/lib/utils/authentification.py

@@ -51,6 +51,6 @@ def _get_basic_auth_unsafe_user(
         if not login:
             return None
         user = uapi.get_one_by_email(login)
-    except (NoResultFound, UserDoesNotExist):
+    except UserDoesNotExist:
         return None
     return user

tracim/lib/utils/authorization.py

@@ -44,7 +44,7 @@ class AcceptAllAuthorizationPolicy(object):
 # We prefer to use decorators
 
 
-def require_same_user_or_profile(group):
+def require_same_user_or_profile(group: int):
     """
     Decorator for view to restrict access of tracim request if candidate user
     is distinct from authenticated user and not with high enough profile.
@@ -64,7 +64,7 @@ def require_same_user_or_profile(group):
     return decorator
 
 
-def require_profile(group):
+def require_profile(group: int):
     """
     Decorator for view to restrict access of tracim request if profile is
     not high enough
@@ -82,7 +82,7 @@ def require_profile(group):
     return decorator
 
 
-def require_workspace_role(minimal_required_role):
+def require_workspace_role(minimal_required_role: int):
     """
     Decorator for view to restrict access of tracim request if role
     is not high enough

tracim/lib/utils/request.py

@@ -6,7 +6,7 @@ from pyramid.request import Request
 from sqlalchemy.orm.exc import NoResultFound
 
 
-from tracim.exceptions import NotAuthentificated
+from tracim.exceptions import NotAuthenticated
 from tracim.exceptions import UserNotFoundInTracimRequest
 from tracim.exceptions import UserDoesNotExist
 from tracim.exceptions import WorkspaceNotFound
@@ -40,11 +40,14 @@ class TracimRequest(Request):
         )
         # Current workspace, found by request headers or content
         self._current_workspace = None  # type: Workspace
+
         # Authenticated user
         self._current_user = None  # type: User
+
         # User found from request headers, content, distinct from authenticated
         # user
         self._user_candidate = None  # type: User
+
         # INFO - G.M - 18-05-2018 - Close db at the end of the request
         self.add_finished_callback(self._cleanup)
 
@@ -168,7 +171,7 @@ def get_auth_safe_user(
             raise UserNotFoundInTracimRequest('You request a current user but the context not permit to found one')  # nopep8
         user = uapi.get_one_by_email(login)
     except (UserDoesNotExist, UserNotFoundInTracimRequest) as exc:
-        raise NotAuthentificated('User {} not found'.format(login)) from exc
+        raise NotAuthenticated('User {} not found'.format(login)) from exc
     return user
 
 
@@ -187,7 +190,7 @@ def get_workspace(
         if 'workspace_id' in request.matchdict:
             workspace_id = request.matchdict['workspace_id']
         if not workspace_id:
-            raise WorkspaceNotFound('No workspace_id param')
+            raise WorkspaceNotFound('No workspace_id property found in request')
         wapi = WorkspaceApi(
             current_user=user,
             session=request.dbsession,

tracim/lib/webdav/design.py

@@ -164,7 +164,7 @@ def designPage(content: data.Content, content_revision: data.ContentRevisionRO)
                     <td>%s</td>
                 </tr>
                 ''' % ('warning' if event.id == content_revision.revision_id else '',
-                       event.type.icon,
+                       event.type.fa_icon,
                        label,
                        date,
                        event.owner.display_name,
@@ -282,7 +282,7 @@ def designThread(content: data.Content, content_revision: data.ContentRevisionRO
                         </div>
                     </div>
                     ''' % ('warning' if t.id == content_revision.revision_id else '',
-                           t.type.icon,
+                           t.type.fa_icon,
                            t.owner.display_name,
                            t.create_readable_date(),
                            label,

tracim/models/applications.py

@@ -10,15 +10,27 @@ class Application(object):
             self,
             label: str,
             slug: str,
-            icon: str,
+            fa_icon: str,
             hexcolor: str,
             is_active: bool,
             config: typing.Dict[str, str],
             main_route: str,
     ) -> None:
+        """
+        @param label: public label of application
+        @param slug: identifier of application
+        @param icon: font awesome icon class
+        @param hexcolor: hexa color of application main color
+        @param is_active: True if application enable, False if inactive
+        @param config: a dict with eventual application config
+        @param main_route: the route of the frontend "home" screen of
+        the application. For exemple, if you have an application
+        called "calendar", the main route will be something
+        like /#/workspace/{wid}/calendar.
+        """
         self.label = label
         self.slug = slug
-        self.icon = icon
+        self.fa_icon = fa_icon
         self.hexcolor = hexcolor
         self.is_active = is_active
         self.config = config
@@ -29,7 +41,7 @@ class Application(object):
 calendar = Application(
     label='Calendar',
     slug='calendar',
-    icon='calendar-alt',
+    fa_icon='calendar-alt',
     hexcolor='#757575',
     is_active=True,
     config={},
@@ -39,7 +51,7 @@ calendar = Application(
 thread = Application(
     label='Threads',
     slug='contents/threads',
-    icon='comments-o',
+    fa_icon='comments-o',
     hexcolor='#ad4cf9',
     is_active=True,
     config={},
@@ -47,10 +59,10 @@ thread = Application(
 
 )
 
-file = Application(
+_file = Application(
     label='Files',
     slug='contents/files',
-    icon='paperclip',
+    fa_icon='paperclip',
     hexcolor='#FF9900',
     is_active=True,
     config={},
@@ -60,7 +72,7 @@ file = Application(
 markdownpluspage = Application(
     label='Markdown Plus Documents',  # TODO - G.M - 24-05-2018 - Check label
     slug='contents/markdownpluspage',
-    icon='file-code',
+    fa_icon='file-code',
     hexcolor='#f12d2d',
     is_active=True,
     config={},
@@ -70,7 +82,7 @@ markdownpluspage = Application(
 htmlpage = Application(
     label='Text Documents',  # TODO - G.M - 24-05-2018 - Check label
     slug='contents/htmlpage',
-    icon='file-text-o',
+    fa_icon='file-text-o',
     hexcolor='#3f52e3',
     is_active=True,
     config={},
@@ -81,7 +93,7 @@ htmlpage = Application(
 applications = [
     htmlpage,
     markdownpluspage,
-    file,
+    _file,
     thread,
     calendar,
 ]

tracim/models/data.py

@@ -162,7 +162,7 @@ class UserRoleInWorkspace(DeclarativeBase):
     #
     #
     # @property
-    # def icon(self):
+    # def fa_icon(self):
     #     return UserRoleInWorkspace.ICON[self.role]
     #
     # @property
@@ -200,7 +200,7 @@ class RoleType(object):
     def __init__(self, role_id):
         self.role_type_id = role_id
         # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
-        # self.icon = UserRoleInWorkspace.ICON[role_id]
+        # self.fa_icon = UserRoleInWorkspace.ICON[role_id]
         # self.role_label = UserRoleInWorkspace.LABEL[role_id]
         # self.css_style = UserRoleInWorkspace.STYLE[role_id]
 
@@ -265,11 +265,12 @@ class ActionDescription(object):
     def __init__(self, id):
         assert id in ActionDescription.allowed_values()
         self.id = id
-        # FIXME - G.M - 17-04-2018 - Label and icon needed for webdav
+        # FIXME - G.M - 17-04-2018 - Label and fa_icon needed for webdav
         #  design template,
         # find a way to not rely on this.
         self.label = self.id
-        self.icon = ActionDescription._ICONS[id]
+        self.fa_icon = ActionDescription._ICONS[id]
+        #self.icon = self.fa_icon
         # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
         # self.label = ActionDescription._LABELS[id]
 
@@ -343,7 +344,7 @@ class ContentStatus(object):
         self.id = id
         self.label = self.id
         # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
-        # self.icon = ContentStatus._ICONS[id]
+        # self.fa_icon = ContentStatus._ICONS[id]
         # self.css = ContentStatus._CSS[id]
         #
         # if type==ContentType.Thread:
@@ -520,7 +521,7 @@ class ContentType(object):
     def __init__(self, type):
         self.id = type
         # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
-        # self.icon = ContentType._CSS_ICONS[type]
+        # self.fa_icon = ContentType._CSS_ICONS[type]
         # self.color = ContentType._CSS_COLORS[type]  # deprecated
         # self.css = ContentType._CSS_COLORS[type]
         # self.label = ContentType._LABEL[type]
@@ -530,7 +531,7 @@ class ContentType(object):
         return dict(id=self.type,
                     type=self.type,
                     # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
-                    # icon=self.icon,
+                    # fa_icon=self.fa_icon,
                     # color=self.color,
                     # label=self.label,
                     priority=self.priority)
@@ -1457,7 +1458,7 @@ class VirtualEvent(object):
         assert hasattr(type, 'id')
         # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
         # assert hasattr(type, 'css')
-        # assert hasattr(type, 'icon')
+        # assert hasattr(type, 'fa_icon')
         # assert hasattr(type, 'label')
 
     def created_as_delta(self, delta_from_datetime:datetime=None):

tracim/models/workspace_menu_entries.py

@@ -14,7 +14,7 @@ class WorkspaceMenuEntry(object):
             self,
             label: str,
             slug: str,
-            icon: str,
+            fa_icon: str,
             hexcolor: str,
             route: str,
     ) -> None:
@@ -22,21 +22,21 @@ class WorkspaceMenuEntry(object):
         self.label = label
         self.route = route
         self.hexcolor = hexcolor
-        self.icon = icon
+        self.fa_icon = fa_icon
 
 dashboard_menu_entry = WorkspaceMenuEntry(
   slug='dashboard',
   label='Dashboard',
   route='/#/workspaces/{workspace_id}/dashboard',
   hexcolor='#252525',
-  icon="",
+  fa_icon="",
 )
 all_content_menu_entry = WorkspaceMenuEntry(
   slug="contents/all",
   label="All Contents",
   route="/#/workspaces/{workspace_id}/contents",
   hexcolor="#fdfdfd",
-  icon="",
+  fa_icon="",
 )
 
 # TODO - G.M - 08-06-2018 - This is hardcoded default menu entry,
@@ -57,7 +57,7 @@ def default_workspace_menu_entry(
                 slug=app.slug,
                 label=app.label,
                 hexcolor=app.hexcolor,
-                icon=app.icon,
+                fa_icon=app.fa_icon,
                 route=app.main_route
             )
             menu_entries.append(new_entry)

tracim/templates/mail/content_update_body_html.mak

@@ -38,14 +38,14 @@
     <table style="width: 100%; cell-padding: 0; border-collapse: collapse; margin: 0">
       <tr style="background-color: F5F5F5; border-bottom: 1px solid #CCC;" >
         <td style="background-color: #666;">
-            <!-- FIXME - G.M - 09-06-2018 - restore logo -->
+            <img alt="logo" src="${logo_url}" style="vertical-align: middle;">
         </td>
         <td style="padding: 0.5em; background-color: #666; text-align: left;">
           <span style="font-size: 1.3em; color: #FFF; font-weight: bold;">
             ${main_title}
             &mdash;&nbsp;<span style="font-weight: bold; color: #999; font-weight: bold;">
-              ${status|n}
-              <!-- FIXME - G.M - 09-06-2018 - restore icon -->
+              ${status_label|n}
+              <img alt="status_icon" src="${status_icon_url}" style="vertical-align: middle;">
             </span>
         </td>
       </tr>
@@ -54,15 +54,14 @@
     <p id="content-intro">${content_intro|n}</p>
     <div id="content-body">
         <div>${content_text|n}</div>
-        <!-- FIXME - G.M - 09-06-2018 - fix action url -->
         <div href='' id="call-to-action-container">
         </div>
     </div>
     
     <div id="footer">
         <p>
-            <!-- FIXME - G.M - 09-06-2018 - Set correct workspace url -->
-            ${_('{user_display_name}, you receive this email because you are registered on <i>{website_title}</i> and you are <i>{user_role_label}</i> in the workspace <a href="{workspace_url}">{workspace_label}</a>.').format(user_display_name=user.display_name, user_role_label=role, workspace_url='', workspace_label=workspace.label, website_title=config.WEBSITE_TITLE)|n}
+
+            ${_('{user_display_name}, you receive this email because you are registered on <i>{website_title}</i> and you are <i>{user_role_label}</i> in the workspace <a href="{workspace_url}">{workspace_label}</a>.').format(user_display_name=user.display_name, user_role_label=role_label, workspace_url=workspace_url, workspace_label=workspace.label, website_title=config.WEBSITE_TITLE)|n}
         </p>
         <hr/>
         <p>

tracim/templates/mail/content_update_body_text.mak

@@ -16,7 +16,7 @@ Hope you'll switch your mail client configuration and enjoy Tracim :)
 
 
 You receive this email because you are registered on /${config.WEBSITE_TITLE}/
-and you are /${role}/ in the workspace /${workspace.label}/
+and you are /${role_label}/ in the workspace /${workspace.label}/
 
 ----
 

tracim/templates/mail/created_account_body_html.mak

@@ -38,7 +38,7 @@
     <table style="width: 100%; cell-padding: 0; border-collapse: collapse; margin: 0">
       <tr style="background-color: F5F5F5; border-bottom: 1px solid #CCC;" >
         <td style="background-color: #666;">
-            <!-- FIXME - G.M - 09-06-2018 - restore logo -->
+            <img alt="logo" src="${logo_url}" style="vertical-align: middle;">
         </td>
         <td style="padding: 0.5em; background-color: #666; text-align: left;">
           <span style="font-size: 1.3em; color: #FFF; font-weight: bold;">

tracim/tests/functional/test_system.py

@@ -26,35 +26,35 @@ class TestApplicationsEndpoint(FunctionalTest):
         application = res[0]
         assert application['label'] == "Text Documents"
         assert application['slug'] == 'contents/htmlpage'
-        assert application['icon'] == 'file-text-o'
+        assert application['fa_icon'] == 'file-text-o'
         assert application['hexcolor'] == '#3f52e3'
         assert application['is_active'] is True
         assert 'config' in application
         application = res[1]
         assert application['label'] == "Markdown Plus Documents"
         assert application['slug'] == 'contents/markdownpluspage'
-        assert application['icon'] == 'file-code'
+        assert application['fa_icon'] == 'file-code'
         assert application['hexcolor'] == '#f12d2d'
         assert application['is_active'] is True
         assert 'config' in application
         application = res[2]
         assert application['label'] == "Files"
         assert application['slug'] == 'contents/files'
-        assert application['icon'] == 'paperclip'
+        assert application['fa_icon'] == 'paperclip'
         assert application['hexcolor'] == '#FF9900'
         assert application['is_active'] is True
         assert 'config' in application
         application = res[3]
         assert application['label'] == "Threads"
         assert application['slug'] == 'contents/threads'
-        assert application['icon'] == 'comments-o'
+        assert application['fa_icon'] == 'comments-o'
         assert application['hexcolor'] == '#ad4cf9'
         assert application['is_active'] is True
         assert 'config' in application
         application = res[4]
         assert application['label'] == "Calendar"
         assert application['slug'] == 'calendar'
-        assert application['icon'] == 'calendar-alt'
+        assert application['fa_icon'] == 'calendar-alt'
         assert application['hexcolor'] == '#757575'
         assert application['is_active'] is True
         assert 'config' in application

tracim/tests/functional/test_user.py

@@ -37,49 +37,49 @@ class TestUserWorkspaceEndpoint(FunctionalTest):
         assert sidebar_entry['label'] == 'Dashboard'
         assert sidebar_entry['route'] == '/#/workspaces/1/dashboard'  # nopep8
         assert sidebar_entry['hexcolor'] == "#252525"
-        assert sidebar_entry['icon'] == ""
+        assert sidebar_entry['fa_icon'] == ""
 
         sidebar_entry = workspace['sidebar_entries'][1]
         assert sidebar_entry['slug'] == 'contents/all'
         assert sidebar_entry['label'] == 'All Contents'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents"  # nopep8
         assert sidebar_entry['hexcolor'] == "#fdfdfd"
-        assert sidebar_entry['icon'] == ""
+        assert sidebar_entry['fa_icon'] == ""
 
         sidebar_entry = workspace['sidebar_entries'][2]
         assert sidebar_entry['slug'] == 'contents/htmlpage'
         assert sidebar_entry['label'] == 'Text Documents'
         assert sidebar_entry['route'] == '/#/workspaces/1/contents?type=htmlpage'  # nopep8
         assert sidebar_entry['hexcolor'] == "#3f52e3"
-        assert sidebar_entry['icon'] == "file-text-o"
+        assert sidebar_entry['fa_icon'] == "file-text-o"
 
         sidebar_entry = workspace['sidebar_entries'][3]
         assert sidebar_entry['slug'] == 'contents/markdownpluspage'
         assert sidebar_entry['label'] == 'Markdown Plus Documents'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=markdownpluspage"    # nopep8
         assert sidebar_entry['hexcolor'] == "#f12d2d"
-        assert sidebar_entry['icon'] == "file-code"
+        assert sidebar_entry['fa_icon'] == "file-code"
 
         sidebar_entry = workspace['sidebar_entries'][4]
         assert sidebar_entry['slug'] == 'contents/files'
         assert sidebar_entry['label'] == 'Files'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=file"  # nopep8
         assert sidebar_entry['hexcolor'] == "#FF9900"
-        assert sidebar_entry['icon'] == "paperclip"
+        assert sidebar_entry['fa_icon'] == "paperclip"
 
         sidebar_entry = workspace['sidebar_entries'][5]
         assert sidebar_entry['slug'] == 'contents/threads'
         assert sidebar_entry['label'] == 'Threads'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=thread"  # nopep8
         assert sidebar_entry['hexcolor'] == "#ad4cf9"
-        assert sidebar_entry['icon'] == "comments-o"
+        assert sidebar_entry['fa_icon'] == "comments-o"
 
         sidebar_entry = workspace['sidebar_entries'][6]
         assert sidebar_entry['slug'] == 'calendar'
         assert sidebar_entry['label'] == 'Calendar'
         assert sidebar_entry['route'] == "/#/workspaces/1/calendar"  # nopep8
         assert sidebar_entry['hexcolor'] == "#757575"
-        assert sidebar_entry['icon'] == "calendar-alt"
+        assert sidebar_entry['fa_icon'] == "calendar-alt"
 
     def test_api__get_user_workspaces__err_403__unallowed_user(self):
         """

tracim/tests/functional/test_workspaces.py

@@ -38,49 +38,49 @@ class TestWorkspaceEndpoint(FunctionalTest):
         assert sidebar_entry['label'] == 'Dashboard'
         assert sidebar_entry['route'] == '/#/workspaces/1/dashboard'  # nopep8
         assert sidebar_entry['hexcolor'] == "#252525"
-        assert sidebar_entry['icon'] == ""
+        assert sidebar_entry['fa_icon'] == ""
 
         sidebar_entry = workspace['sidebar_entries'][1]
         assert sidebar_entry['slug'] == 'contents/all'
         assert sidebar_entry['label'] == 'All Contents'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents"  # nopep8
         assert sidebar_entry['hexcolor'] == "#fdfdfd"
-        assert sidebar_entry['icon'] == ""
+        assert sidebar_entry['fa_icon'] == ""
 
         sidebar_entry = workspace['sidebar_entries'][2]
         assert sidebar_entry['slug'] == 'contents/htmlpage'
         assert sidebar_entry['label'] == 'Text Documents'
         assert sidebar_entry['route'] == '/#/workspaces/1/contents?type=htmlpage'  # nopep8
         assert sidebar_entry['hexcolor'] == "#3f52e3"
-        assert sidebar_entry['icon'] == "file-text-o"
+        assert sidebar_entry['fa_icon'] == "file-text-o"
 
         sidebar_entry = workspace['sidebar_entries'][3]
         assert sidebar_entry['slug'] == 'contents/markdownpluspage'
         assert sidebar_entry['label'] == 'Markdown Plus Documents'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=markdownpluspage"    # nopep8
         assert sidebar_entry['hexcolor'] == "#f12d2d"
-        assert sidebar_entry['icon'] == "file-code"
+        assert sidebar_entry['fa_icon'] == "file-code"
 
         sidebar_entry = workspace['sidebar_entries'][4]
         assert sidebar_entry['slug'] == 'contents/files'
         assert sidebar_entry['label'] == 'Files'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=file"  # nopep8
         assert sidebar_entry['hexcolor'] == "#FF9900"
-        assert sidebar_entry['icon'] == "paperclip"
+        assert sidebar_entry['fa_icon'] == "paperclip"
 
         sidebar_entry = workspace['sidebar_entries'][5]
         assert sidebar_entry['slug'] == 'contents/threads'
         assert sidebar_entry['label'] == 'Threads'
         assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=thread"  # nopep8
         assert sidebar_entry['hexcolor'] == "#ad4cf9"
-        assert sidebar_entry['icon'] == "comments-o"
+        assert sidebar_entry['fa_icon'] == "comments-o"
 
         sidebar_entry = workspace['sidebar_entries'][6]
         assert sidebar_entry['slug'] == 'calendar'
         assert sidebar_entry['label'] == 'Calendar'
         assert sidebar_entry['route'] == "/#/workspaces/1/calendar"  # nopep8
         assert sidebar_entry['hexcolor'] == "#757575"
-        assert sidebar_entry['icon'] == "calendar-alt"
+        assert sidebar_entry['fa_icon'] == "calendar-alt"
 
     def test_api__get_workspace__err_403__unallowed_user(self) -> None:
         """

tracim/views/core_api/schemas.py

@@ -114,7 +114,7 @@ class WorkspaceMenuEntrySchema(marshmallow.Schema):
                     'which must be replaced on backend size '
                     '(the route must be ready-to-use)'
     )
-    icon = marshmallow.fields.String(
+    fa_icon = marshmallow.fields.String(
         example='file-text-o',
         description='CSS class of the icon. Example: file-o for using Fontawesome file-text-o icon',  # nopep8
     )
@@ -170,7 +170,7 @@ class ApplicationConfigSchema(marshmallow.Schema):
 class ApplicationSchema(marshmallow.Schema):
     label = marshmallow.fields.String(example='Calendar')
     slug = marshmallow.fields.String(example='calendar')
-    icon = marshmallow.fields.String(
+    fa_icon = marshmallow.fields.String(
         example='file-o',
         description='CSS class of the icon. Example: file-o for using Fontawesome file-o icon',  # nopep8
     )

tracim/views/core_api/session_controller.py

@@ -13,7 +13,7 @@ from tracim.views.core_api.schemas import UserSchema
 from tracim.views.core_api.schemas import NoContentSchema
 from tracim.views.core_api.schemas import LoginOutputHeaders
 from tracim.views.core_api.schemas import BasicAuthSchema
-from tracim.exceptions import NotAuthentificated
+from tracim.exceptions import NotAuthenticated
 from tracim.exceptions import AuthenticationFailed
 
 
@@ -52,7 +52,7 @@ class SessionController(Controller):
         return
 
     @hapic.with_api_doc()
-    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
     @hapic.output_body(UserSchema(),)
     def whoami(self, context, request: TracimRequest, hapic_data=None):
         """

tracim/views/core_api/system_controller.py

@@ -1,7 +1,7 @@
 # coding=utf-8
 from pyramid.config import Configurator
 
-from tracim.exceptions import NotAuthentificated, InsufficientUserProfile
+from tracim.exceptions import NotAuthenticated, InsufficientUserProfile
 from tracim.lib.utils.authorization import require_profile
 from tracim.models import Group
 from tracim.models.applications import applications
@@ -20,7 +20,7 @@ from tracim.views.core_api.schemas import ApplicationSchema
 class SystemController(Controller):
 
     @hapic.with_api_doc()
-    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
     @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
     @require_profile(Group.TIM_USER)
     @hapic.output_body(ApplicationSchema(many=True),)

tracim/views/core_api/user_controller.py

@@ -12,7 +12,7 @@ except ImportError:
 
 from tracim import hapic, TracimRequest
 
-from tracim.exceptions import NotAuthentificated
+from tracim.exceptions import NotAuthenticated
 from tracim.exceptions import InsufficientUserProfile
 from tracim.exceptions import UserDoesNotExist
 from tracim.lib.core.workspace import WorkspaceApi
@@ -24,7 +24,7 @@ from tracim.views.core_api.schemas import WorkspaceDigestSchema
 class UserController(Controller):
 
     @hapic.with_api_doc()
-    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
     @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
     @hapic.handle_exception(UserDoesNotExist, HTTPStatus.NOT_FOUND)
     @require_same_user_or_profile(Group.TIM_ADMIN)

tracim/views/core_api/workspace_controller.py

@@ -15,7 +15,7 @@ except ImportError:
     from http import client as HTTPStatus
 
 from tracim import hapic, TracimRequest
-from tracim.exceptions import NotAuthentificated
+from tracim.exceptions import NotAuthenticated
 from tracim.exceptions import InsufficientUserProfile
 from tracim.exceptions import WorkspaceNotFound
 from tracim.lib.core.user import UserApi
@@ -29,7 +29,7 @@ from tracim.views.core_api.schemas import WorkspaceMemberSchema
 class WorkspaceController(Controller):
 
     @hapic.with_api_doc()
-    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
     @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
     @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
     @require_workspace_role(UserRoleInWorkspace.READER)
@@ -49,7 +49,7 @@ class WorkspaceController(Controller):
         return wapi.get_workspace_with_context(request.current_workspace)
 
     @hapic.with_api_doc()
-    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
     @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
     @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
     @require_workspace_role(UserRoleInWorkspace.READER)