Merge branch 'feature/578_add_api_for_workspace/apps' of github.com:tracim/tracim_backend into fix/better_api_doc

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={},
@@ -50,7 +62,7 @@ thread = 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={},

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/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
     )