tests,schema,controller for new api endpoints

tracim/__init__.py

@@ -15,6 +15,7 @@ from tracim.lib.utils.authorization import AcceptAllAuthorizationPolicy
 from tracim.lib.utils.authorization import TRACIM_DEFAULT_PERM
 from tracim.views import BASE_API_V2
 from tracim.views.core_api.session_controller import SessionController
+from tracim.views.core_api.system_controller import SystemController
 from tracim.views.errors import ErrorSchema
 from tracim.lib.utils.cors import add_cors_support
 
@@ -57,7 +58,9 @@ def main(global_config, **settings):
     )
     # Add controllers
     session_api = SessionController()
+    system_api = SystemController()
     configurator.include(session_api.bind, route_prefix=BASE_API_V2)
+    configurator.include(system_api.bind, route_prefix=BASE_API_V2)
     hapic.add_documentation_view(
         '/api/v2/doc',
         'Tracim v2 API',

tracim/models/applications.py

@@ -0,0 +1,96 @@
+# coding=utf-8
+import typing
+
+
+class Application(object):
+    """
+    Application class with data needed for frontend
+    """
+    def __init__(
+            self,
+            label: str,
+            slug: str,
+            icon: str,
+            hexcolor: str,
+            is_active: bool,
+            config: typing.Dict[str, str],
+            routes: typing.List[str],
+    ) -> None:
+        self.label = label
+        self.slug = slug
+        self.icon = icon
+        self.hexcolor = hexcolor
+        self.is_active = is_active
+        self.config = config
+        self.routes = routes
+
+
+# TODO - G.M - 21-05-2018 Do not rely on hardcoded app list
+# default apps
+calendar = Application(
+    label='Calendar',
+    slug='calendar',
+    icon='calendar-alt',
+    hexcolor='#757575',
+    is_active=True,
+    config={},
+    routes=[
+        '/#/workspaces/{workspace_id}/calendar',
+    ],
+)
+
+thread = Application(
+    label='Threads',
+    slug='contents/threads',
+    icon='comments-o',
+    hexcolor='#ad4cf9',
+    is_active=True,
+    config={},
+    routes=[
+        '/#/workspaces/{workspace_id}/contents?type=thread',
+    ],
+)
+
+file = Application(
+    label='Files',
+    slug='contents/files',
+    icon='paperclip',
+    hexcolor='#FF9900',
+    is_active=True,
+    config={},
+    routes=[
+        '/#/workspaces/{workspace_id}/contents?type=file',
+    ],
+)
+
+pagemarkdownplus = Application(
+    label='Rich Markdown Files',  # TODO : Better label
+    slug='contents/pagemarkdownplus',
+    icon='file-code',
+    hexcolor='#f12d2d',
+    is_active=True,
+    config={},
+    routes=[
+        '/#/workspaces/{workspace_id}/contents?type=file',
+    ],
+)
+
+pagehtml = Application(
+    label='Text Documents',  # TODO : Better label
+    slug='contents/pagehtml',
+    icon='file-text-o',
+    hexcolor='#3f52e3',
+    is_active=True,
+    config={},
+    routes=[
+        '/#/workspaces/{workspace_id}/contents?type=file',
+    ],
+)
+# List of applications
+applications = [
+    pagehtml,
+    pagemarkdownplus,
+    file,
+    thread,
+    calendar,
+]

tracim/models/workspace_menu_entries.py

@@ -0,0 +1,38 @@
+# coding=utf-8
+
+
+class WorkspaceMenuEntry(object):
+    """
+    Application class with data needed for frontend
+    """
+    def __init__(
+            self,
+            label: str,
+            slug: str,
+            icon: str,
+            hexcolor: str,
+            route: str,
+    ) -> None:
+        self.slug = slug
+        self.label = label
+        self.route = route
+        self.hexcolor = hexcolor
+        self.icon = icon
+
+
+dashboard_menu_entry = WorkspaceMenuEntry(
+  slug='dashboard',
+  label='Dashboard',
+  route='/#/workspaces/{workspace_id}/dashboard',
+  hexcolor='#252525',
+  icon="",
+)
+all_content_menu_entry = WorkspaceMenuEntry(
+  slug="contents/all",
+  label="Tous les contenus",
+  route="/#/workspaces/{workspace_id}/contents",
+  hexcolor="#fdfdfd",
+  icon="",
+)
+
+

tracim/tests/functional/test_system.py

@@ -0,0 +1,51 @@
+# coding=utf-8
+from tracim.tests import FunctionalTest
+
+
+class TestApplicationsEndpoint(FunctionalTest):
+    def test_api__get_applications__ok_200__nominal_case(self):
+        # TODO need authorization ? check permissions ?
+        # self.testapp.authorization = (
+        #     'Basic',
+        #     (
+        #         'admin@admin.admin',
+        #         'admin@admin.admin'
+        #     )
+        # )
+        res = self.testapp.get('/api/v2/system/applications', status=200)
+        res = res.json_body
+        application = res[0]
+        assert application['label'] == "Text Documents"
+        assert application['slug'] == 'contents/pagehtml'
+        assert application['icon'] == 'file-text-o'
+        assert application['hexcolor'] == '#3f52e3'
+        assert application['is_active'] is True
+        assert 'config' in application
+        application = res[1]
+        assert application['label'] == "Rich Markdown Files"
+        assert application['slug'] == 'contents/pagemarkdownplus'
+        assert application['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['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['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['hexcolor'] == '#757575'
+        assert application['is_active'] is True
+        assert 'config' in application

tracim/tests/functional/test_user.py

@@ -0,0 +1,70 @@
+# coding=utf-8
+from tracim.tests import FunctionalTest
+
+
+class TestUserWorkspaceEndpoint(FunctionalTest):
+    def test_api__get_user_workspaces__ok_200__nominal_case(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/users/1/workspaces', status=200)
+        workspace = res[0]
+        assert workspace['id'] == 1
+        assert workspace['slug'] == 'w1'
+        assert workspace['label'] == 'w1'
+        assert workspace['description'] == 'Just another description'
+        assert len(workspace['sidebar_entries']) == 3  # TODO change this
+
+        sidebar_entry = workspace['sidebar_entries'][0]
+        assert sidebar_entry['slug'] == 'markdown-pages'
+        assert sidebar_entry['label'] == 'Document Markdown'
+        assert sidebar_entry['route'] == "/#/workspace/{workspace_id}/contents/?type=mardown-page"  # nopep8
+        assert sidebar_entry['hexcolor'] == "#F0F9DC"
+        assert sidebar_entry['icon'] == "file-text-o"
+        # TODO To this for the other
+
+    def test_api__get_user_workspaces__err_403__unallowed_user(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'lawrence-not-real-email@fsf.local',
+                'foobarbaz'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/users/1/workspaces', status=403)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+    def test_api__get_user_workspaces__err_401__unregistered_user(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'john@doe.doe',
+                'lapin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/users/1/workspaces', status=401)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+    def test_api__get_user_workspaces__err_404__user_does_not_exist(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/users/5/workspaces', status=404)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()

tracim/tests/functional/test_workspaces.py

@@ -0,0 +1,147 @@
+# coding=utf-8
+
+from tracim.tests import FunctionalTest
+
+
+class TestWorkspaceEndpoint(FunctionalTest):
+
+    def test_api__get_workspace__ok_200__nominal_case(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        workspace = self.testapp.post_json('/api/v2/workspaces/1', status=200)
+        assert workspace['id'] == 1
+        assert workspace['slug'] == 'w1'
+        assert workspace['label'] == 'w1'
+        assert workspace['description'] == 'Just another description'
+        assert len(workspace['sidebar_entries']) == 3  # TODO change this
+
+        sidebar_entry = workspace['sidebar_entries'][0]
+        assert sidebar_entry['slug'] == 'markdown-pages'
+        assert sidebar_entry['label'] == 'Document Markdown'
+        assert sidebar_entry['route'] == "/#/workspace/{workspace_id}/contents/?type=mardown-page"  # nopep8
+        assert sidebar_entry['hexcolor'] == "#F0F9DC"
+        assert sidebar_entry['icon'] == "file-text-o"
+        # TODO To this for the other
+
+    def test_api__get_workspace__err_403__unallowed_user(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'lawrence-not-real-email@fsf.local',
+                'foobarbaz'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/1', status=403)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+    def test_api__get_workspace__err_401__unregistered_user(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'john@doe.doe',
+                'lapin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/1', status=401)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+    def test_api__get_workspace__err_404__workspace_does_not_exist(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/5', status=404)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+
+class TestWorkspaceMembersEndpoint(FunctionalTest):
+
+    def test_api__get_workspace_members__ok_200__nominal_case(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/1/members', status=200)
+        assert len(res) == 2
+        user_role = res[0]
+        assert user_role['role'] == 'administrator'
+        assert user_role['user_id'] == '1'
+        assert user_role['workspace_id'] == '1'
+        assert user_role['user']['label'] == 'Global manager'
+        assert user_role['user']['avatar_url'] == ''  # TODO
+
+        assert res['role'] == 1
+        assert res['slug'] == 'w1'
+        assert res['label'] == 'w1'
+        assert res['description'] == 'Just another description'
+        assert len(res['sidebar_entries']) == 3  # TODO change this
+
+        sidebar_entry = res['sidebar_entries'][0]
+        assert sidebar_entry['slug'] == 'markdown-pages'
+        assert sidebar_entry['label'] == 'Document Markdown'
+        assert sidebar_entry['route'] == "/#/workspace/{workspace_id}/contents/?type=mardown-page"  # nopep8
+        assert sidebar_entry['hexcolor'] == "#F0F9DC"
+        assert sidebar_entry['icon'] == "file-text-o"
+        # TODO Do this for the other
+
+    def test_api__get_workspace_members__err_400__unallowed_user(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'lawrence-not-real-email@fsf.local',
+                'foobarbaz'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/1/members', status=403)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+    def test_api__get_workspace_members__err_401__unregistered_user(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'john@doe.doe',
+                'lapin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/1/members', status=403)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()
+
+    def test_api__get_workspace_members__err_404__workspace_does_not_exist(self):
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.post_json('/api/v2/workspaces/5/members', status=404)
+        assert isinstance(res.json, dict)
+        assert 'code' in res.json.keys()
+        assert 'message' in res.json.keys()
+        assert 'details' in res.json.keys()

tracim/views/core_api/schemas.py

@@ -2,7 +2,7 @@
 import marshmallow
 from marshmallow import post_load
 
-from tracim.models.context_models import LoginCredentials, UserInContext
+from tracim.models.context_models import LoginCredentials
 
 
 class ProfileSchema(marshmallow.Schema):
@@ -48,3 +48,54 @@ class LoginOutputHeaders(marshmallow.Schema):
 
 class NoContentSchema(marshmallow.Schema):
     pass
+
+
+class WorkspaceMenuEntrySchema(marshmallow.Schema):
+    slug = marshmallow.fields.String()
+    label = marshmallow.fields.String()
+    route = marshmallow.fields.String()
+    hexcolor = marshmallow.fields.String()
+    icon = marshmallow.fields.String()
+
+
+class WorkspaceSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int()
+    slug = marshmallow.fields.String()
+    label = marshmallow.fields.String()
+    description = marshmallow.fields.String()
+    sidebar_entries = marshmallow.fields.Nested(
+        WorkspaceMenuEntrySchema,
+        many=True,
+    )
+
+
+class WorkspaceDigestSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int()
+    label = marshmallow.fields.String()
+    sidebar_entries = marshmallow.fields.Nested(
+        WorkspaceMenuEntrySchema,
+        many=True,
+    )
+
+
+class WorkspaceMemberSchema(marshmallow.Schema):
+    role = marshmallow.fields.String()
+    user_id = marshmallow.fields.Int()
+    workspace_id = marshmallow.fields.Int()
+    # TODO user
+
+
+class ApplicationConfigSchema(marshmallow.Schema):
+    pass
+    #  TODO
+
+
+class ApplicationSchema(marshmallow.Schema):
+    label = marshmallow.fields.String()
+    slug = marshmallow.fields.String()
+    icon = marshmallow.fields.String()
+    hexcolor = marshmallow.fields.String()
+    is_active = marshmallow.fields.Boolean()
+    config = marshmallow.fields.Nested(
+        ApplicationConfigSchema,
+    )

tracim/views/core_api/system_controller.py

@@ -0,0 +1,36 @@
+# coding=utf-8
+from pyramid.config import Configurator
+
+from tracim.models.applications import applications
+
+try:  # Python 3.5+
+    from http import HTTPStatus
+except ImportError:
+    from http import client as HTTPStatus
+
+from tracim import TracimRequest
+from tracim.extensions import hapic
+from tracim.views.controllers import Controller
+from tracim.views.core_api.schemas import ApplicationSchema
+
+
+class SystemController(Controller):
+
+    @hapic.with_api_doc()
+    @hapic.output_body(ApplicationSchema(many=True),)
+    def applications(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Get list of alls applications installed in this tracim instance.
+        """
+        return applications
+
+    def bind(self, configurator: Configurator) -> None:
+        """
+        Create all routes and views using pyramid configurator
+        for this controller
+        """
+
+        # Applications
+        configurator.add_route('applications', '/system/applications', request_method='GET')  # nopep8
+        configurator.add_view(self.applications, route_name='applications')
+