add user workspace view + many changes to make it work

setup.py

@@ -34,6 +34,7 @@ requires = [
     # others
     'filedepot',
     'babel',
+    'python-slugify',
 ]
 
 tests_require = [

tracim/__init__.py

@@ -16,6 +16,7 @@ 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.core_api.user_controller import UserController
 from tracim.views.errors import ErrorSchema
 from tracim.lib.utils.cors import add_cors_support
 
@@ -59,8 +60,10 @@ def main(global_config, **settings):
     # Add controllers
     session_api = SessionController()
     system_api = SystemController()
+    user_api = UserController()
     configurator.include(session_api.bind, route_prefix=BASE_API_V2)
     configurator.include(system_api.bind, route_prefix=BASE_API_V2)
+    configurator.include(user_api.bind, route_prefix=BASE_API_V2)
     hapic.add_documentation_view(
         '/api/v2/doc',
         'Tracim v2 API',

tracim/exceptions.py

@@ -92,5 +92,6 @@ class AuthenticationFailed(TracimException):
 class WrongUserPassword(TracimException):
     pass
 
+
 class UserNotExist(TracimException):
     pass

tracim/fixtures/content.py

@@ -40,9 +40,21 @@ class Content(Fixture):
         )
 
         # Workspaces
-        w1 = admin_workspace_api.create_workspace('w1', save_now=True)
-        w2 = bob_workspace_api.create_workspace('w2', save_now=True)
-        w3 = admin_workspace_api.create_workspace('w3', save_now=True)
+        w1 = admin_workspace_api.create_workspace(
+            'w1',
+            description='This is a workspace',
+            save_now=True
+        )
+        w2 = bob_workspace_api.create_workspace(
+            'w2',
+            description='A great workspace',
+            save_now=True
+        )
+        w3 = admin_workspace_api.create_workspace(
+            'w3',
+            description='Just another workspace',
+            save_now=True
+        )
 
         # Workspaces roles
         role_api.create_one(

tracim/lib/core/user.py

@@ -7,7 +7,7 @@ import typing as typing
 from sqlalchemy.orm import Session
 
 from tracim import CFG
-from tracim.models.auth import User
+from tracim.models.auth import User, Group
 from sqlalchemy.orm.exc import NoResultFound
 from tracim.exceptions import WrongUserPassword, UserNotExist
 from tracim.exceptions import AuthenticationFailed
@@ -98,6 +98,16 @@ class UserApi(object):
         except (WrongUserPassword, NoResultFound):
             raise AuthenticationFailed()
 
+    def can_see_private_info_of_user(self, user: User):
+        """
+        Return boolean wheter current api user has right
+        to see private information of a user.
+        :param user:
+        :return:
+        """
+        return self._user and (
+                self._user.user_id == user.user_id or
+                self._user.profile.id >= Group.TIM_ADMIN)
     # Actions
 
     def update(

tracim/models/applications.py

@@ -14,7 +14,7 @@ class Application(object):
             hexcolor: str,
             is_active: bool,
             config: typing.Dict[str, str],
-            routes: typing.List[str],
+            main_route: str,
     ) -> None:
         self.label = label
         self.slug = slug
@@ -22,7 +22,7 @@ class Application(object):
         self.hexcolor = hexcolor
         self.is_active = is_active
         self.config = config
-        self.routes = routes
+        self.main_route = main_route
 
 
 # TODO - G.M - 21-05-2018 Do not rely on hardcoded app list
@@ -34,9 +34,7 @@ calendar = Application(
     hexcolor='#757575',
     is_active=True,
     config={},
-    routes=[
-        '/#/workspaces/{workspace_id}/calendar',
-    ],
+    main_route='/#/workspaces/{workspace_id}/calendar',
 )
 
 thread = Application(
@@ -46,9 +44,8 @@ thread = Application(
     hexcolor='#ad4cf9',
     is_active=True,
     config={},
-    routes=[
-        '/#/workspaces/{workspace_id}/contents?type=thread',
-    ],
+    main_route='/#/workspaces/{workspace_id}/contents?type=thread',
+
 )
 
 file = Application(
@@ -58,9 +55,7 @@ file = Application(
     hexcolor='#FF9900',
     is_active=True,
     config={},
-    routes=[
-        '/#/workspaces/{workspace_id}/contents?type=file',
-    ],
+    main_route='/#/workspaces/{workspace_id}/contents?type=file',
 )
 
 pagemarkdownplus = Application(
@@ -70,9 +65,7 @@ pagemarkdownplus = Application(
     hexcolor='#f12d2d',
     is_active=True,
     config={},
-    routes=[
-        '/#/workspaces/{workspace_id}/contents?type=file',
-    ],
+    main_route='/#/workspaces/{workspace_id}/contents?type=pagemarkdownplus',
 )
 
 pagehtml = Application(
@@ -82,9 +75,7 @@ pagehtml = Application(
     hexcolor='#3f52e3',
     is_active=True,
     config={},
-    routes=[
-        '/#/workspaces/{workspace_id}/contents?type=file',
-    ],
+    main_route='/#/workspaces/{workspace_id}/contents?type=pagehtml',
 )
 # List of applications
 applications = [

tracim/models/context_models.py

@@ -2,10 +2,14 @@
 import typing
 from datetime import datetime
 
+from slugify import slugify
 from sqlalchemy.orm import Session
 from tracim import CFG
 from tracim.models import User
 from tracim.models.auth import Profile
+from tracim.models.data import Workspace
+from tracim.models.workspace_menu_entries import default_workspace_menu_entry, \
+    WorkspaceMenuEntry
 
 
 class LoginCredentials(object):
@@ -74,3 +78,60 @@ class UserInContext(object):
     def avatar_url(self) -> typing.Optional[str]:
         # TODO - G-M - 20-04-2018 - [Avatar] Add user avatar feature
         return None
+
+
+class WorkspaceInContext(object):
+    """
+    Interface to get Workspace data and Workspace data related to context.
+    """
+
+    def __init__(self, workspace: Workspace, dbsession: Session, config: CFG):
+        self.workspace = workspace
+        self.dbsession = dbsession
+        self.config = config
+
+    @property
+    def workspace_id(self) -> int:
+        """
+        numeric id of the workspace.
+        """
+        return self.workspace.workspace_id
+
+    @property
+    def id(self) -> int:
+        """
+        alias of workspace_id
+        """
+        return self.workspace_id
+
+    @property
+    def label(self) -> str:
+        """
+        get workspace label
+        """
+        return self.workspace.label
+
+    @property
+    def description(self) -> str:
+        """
+        get workspace description
+        """
+        return self.workspace.description
+
+    @property
+    def slug(self) -> str:
+        """
+        get workspace slug
+        """
+        return slugify(self.workspace.label)
+
+    @property
+    def sidebar_entries(self) -> typing.List[WorkspaceMenuEntry]:
+        """
+        get sidebar entries, those depends on activated apps.
+        """
+        # TODO - G.M - 22-05-2018 - Rework on this in
+        # order to not use hardcoded list
+        # list should be able to change (depending on activated/disabled
+        # apps)
+        return default_workspace_menu_entry(self.workspace)

tracim/models/data.py

@@ -173,6 +173,7 @@ class UserRoleInWorkspace(DeclarativeBase):
             UserRoleInWorkspace.WORKSPACE_MANAGER
         ]
 
+
 class RoleType(object):
     def __init__(self, role_id):
         self.role_type_id = role_id

tracim/models/workspace_menu_entries.py

@@ -1,4 +1,9 @@
 # coding=utf-8
+import typing
+from copy import copy
+
+from tracim.models.applications import applications
+from tracim.models.data import Workspace
 
 
 class WorkspaceMenuEntry(object):
@@ -29,10 +34,38 @@ dashboard_menu_entry = WorkspaceMenuEntry(
 )
 all_content_menu_entry = WorkspaceMenuEntry(
   slug="contents/all",
-  label="Tous les contenus",
+  label="All Contents",
   route="/#/workspaces/{workspace_id}/contents",
   hexcolor="#fdfdfd",
   icon="",
 )
 
 
+def default_workspace_menu_entry(
+    workspace: Workspace,
+)-> typing.List[WorkspaceMenuEntry]:
+    """
+    Get default menu entry for a workspace
+    """
+    menu_entries = [
+        copy(dashboard_menu_entry),
+        copy(all_content_menu_entry),
+    ]
+    for app in applications:
+        if app.main_route:
+            new_entry = WorkspaceMenuEntry(
+                slug=app.slug,
+                label=app.label,
+                hexcolor=app.hexcolor,
+                icon=app.icon,
+                route=app.main_route
+            )
+            menu_entries.append(new_entry)
+
+    for entry in menu_entries:
+        entry.route = entry.route.replace(
+            '{workspace_id}',
+            str(workspace.workspace_id)
+        )
+
+    return menu_entries

tracim/tests/functional/test_user.py

@@ -1,8 +1,13 @@
 # coding=utf-8
 from tracim.tests import FunctionalTest
+from tracim.fixtures.content import Content as ContentFixtures
+from tracim.fixtures.users_and_groups import Base as BaseFixture
 
 
 class TestUserWorkspaceEndpoint(FunctionalTest):
+
+    fixtures = [BaseFixture, ContentFixtures]
+
     def test_api__get_user_workspaces__ok_200__nominal_case(self):
         self.testapp.authorization = (
             'Basic',
@@ -11,21 +16,63 @@ class TestUserWorkspaceEndpoint(FunctionalTest):
                 'admin@admin.admin'
             )
         )
-        res = self.testapp.post_json('/api/v2/users/1/workspaces', status=200)
+        res = self.testapp.get('/api/v2/users/1/workspaces', status=200)
+        res = res.json_body
         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
+        assert workspace['description'] == 'This is a workspace'
+        assert len(workspace['sidebar_entries']) == 7  # 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['slug'] == 'dashboard'
+        assert sidebar_entry['label'] == 'Dashboard'
+        assert sidebar_entry['route'] == '/#/workspaces/1/dashboard'  # nopep8
+        assert sidebar_entry['hexcolor'] == "#252525"
+        assert sidebar_entry['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'] == ""
+
+        sidebar_entry = workspace['sidebar_entries'][2]
+        assert sidebar_entry['slug'] == 'contents/pagehtml'
+        assert sidebar_entry['label'] == 'Text Documents'
+        assert sidebar_entry['route'] == '/#/workspaces/1/contents?type=pagehtml'  # nopep8
+        assert sidebar_entry['hexcolor'] == "#3f52e3"
         assert sidebar_entry['icon'] == "file-text-o"
-        # TODO To this for the other
+
+        sidebar_entry = workspace['sidebar_entries'][3]
+        assert sidebar_entry['slug'] == 'contents/pagemarkdownplus'
+        assert sidebar_entry['label'] == 'Rich Markdown Files'
+        assert sidebar_entry['route'] == "/#/workspaces/1/contents?type=pagemarkdownplus"    # nopep8
+        assert sidebar_entry['hexcolor'] == "#f12d2d"
+        assert sidebar_entry['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"
+
+        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"
+
+        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"
 
     def test_api__get_user_workspaces__err_403__unallowed_user(self):
         self.testapp.authorization = (
@@ -35,7 +82,7 @@ class TestUserWorkspaceEndpoint(FunctionalTest):
                 'foobarbaz'
             )
         )
-        res = self.testapp.post_json('/api/v2/users/1/workspaces', status=403)
+        res = self.testapp.get('/api/v2/users/1/workspaces', status=403)
         assert isinstance(res.json, dict)
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
@@ -49,7 +96,7 @@ class TestUserWorkspaceEndpoint(FunctionalTest):
                 'lapin'
             )
         )
-        res = self.testapp.post_json('/api/v2/users/1/workspaces', status=401)
+        res = self.testapp.get('/api/v2/users/1/workspaces', status=401)
         assert isinstance(res.json, dict)
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
@@ -63,7 +110,7 @@ class TestUserWorkspaceEndpoint(FunctionalTest):
                 'admin@admin.admin'
             )
         )
-        res = self.testapp.post_json('/api/v2/users/5/workspaces', status=404)
+        res = self.testapp.get('/api/v2/users/5/workspaces', status=404)
         assert isinstance(res.json, dict)
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()

tracim/views/core_api/schemas.py

@@ -32,6 +32,10 @@ class UserSchema(marshmallow.Schema):
     )
 
 
+class UserIdPathSchema(marshmallow.Schema):
+    user_id = marshmallow.fields.Int()
+
+
 class BasicAuthSchema(marshmallow.Schema):
 
     email = marshmallow.fields.Email(required=True)
@@ -68,7 +72,6 @@ class WorkspaceSchema(marshmallow.Schema):
         many=True,
     )
 
-
 class WorkspaceDigestSchema(marshmallow.Schema):
     id = marshmallow.fields.Int()
     label = marshmallow.fields.String()

tracim/views/core_api/user_controller.py

@@ -0,0 +1,68 @@
+from pyramid.config import Configurator
+from sqlalchemy.orm.exc import NoResultFound
+
+from tracim.models.context_models import WorkspaceInContext
+
+try:  # Python 3.5+
+    from http import HTTPStatus
+except ImportError:
+    from http import client as HTTPStatus
+
+from tracim import hapic, TracimRequest
+from tracim.exceptions import NotAuthentificated, InsufficientUserProfile, \
+    UserNotExist
+from tracim.lib.core.user import UserApi
+from tracim.lib.core.workspace import WorkspaceApi
+from tracim.views.controllers import Controller
+from tracim.views.core_api.schemas import WorkspaceSchema, UserSchema, \
+    UserIdPathSchema
+
+
+class UserController(Controller):
+
+    @hapic.with_api_doc()
+    @hapic.input_path(UserIdPathSchema())
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(UserNotExist, HTTPStatus.NOT_FOUND)
+    @hapic.output_body(WorkspaceSchema(many=True),)
+    def user_workspace(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Get list of user workspaces
+        """
+        uid = hapic_data.path['user_id']
+        app_config = request.registry.settings['CFG']
+        uapi = UserApi(
+            request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        wapi = WorkspaceApi(
+            current_user=request.current_user,  # User
+            session=request.dbsession,
+        )
+        # TODO - G.M - 22-05-2018 - Refactor this in a more lib way( avoid
+        # try/catch and complex code here).
+        try:
+            user = uapi.get_one(uid)
+        except NoResultFound:
+            raise UserNotExist()
+        if not uapi.can_see_private_info_of_user(user):
+            raise InsufficientUserProfile()
+        workspaces = wapi.get_all_for_user(user)
+        workspaces_in_context = []
+        for workspace in workspaces:
+            workspaces_in_context.append(
+                WorkspaceInContext(workspace, request.dbsession, app_config)
+            )
+        return workspaces_in_context
+
+    def bind(self, configurator: Configurator) -> None:
+        """
+        Create all routes and views using pyramid configurator
+        for this controller
+        """
+
+        # Applications
+        configurator.add_route('user_workspace', '/users/{user_id}/workspaces', request_method='GET')  # nopep8
+        configurator.add_view(self.user_workspace, route_name='user_workspace')