Add workspace endpoint + some fixes

tracim/__init__.py

@@ -17,6 +17,7 @@ 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.core_api.workspace_controller import WorkspaceController
 from tracim.views.errors import ErrorSchema
 from tracim.lib.utils.cors import add_cors_support
 
@@ -58,12 +59,14 @@ 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)
+    session_controller = SessionController()
+    system_controller = SystemController()
+    user_controller = UserController()
+    workspace_controller = WorkspaceController()
+    configurator.include(session_controller.bind, route_prefix=BASE_API_V2)
+    configurator.include(system_controller.bind, route_prefix=BASE_API_V2)
+    configurator.include(user_controller.bind, route_prefix=BASE_API_V2)
+    configurator.include(workspace_controller.bind, route_prefix=BASE_API_V2)
     hapic.add_documentation_view(
         '/api/v2/doc',
         'Tracim v2 API',

tracim/lib/core/userworkspace.py

@@ -4,7 +4,7 @@ import typing
 __author__ = 'damien'
 
 from sqlalchemy.orm import Session
-from tracim.models.auth import User
+from tracim.models.auth import User, Group
 from tracim.models.data import Workspace
 from tracim.models.data import UserRoleInWorkspace
 from tracim.models.data import RoleType

tracim/models/context_models.py

@@ -7,7 +7,7 @@ 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.data import Workspace, UserRoleInWorkspace
 from tracim.models.workspace_menu_entries import default_workspace_menu_entry, \
     WorkspaceMenuEntry
 
@@ -135,3 +135,72 @@ class WorkspaceInContext(object):
         # list should be able to change (depending on activated/disabled
         # apps)
         return default_workspace_menu_entry(self.workspace)
+
+
+class UserRoleWorkspaceInContext(object):
+    """
+    Interface to get UserRoleInWorkspace data and related content
+
+    """
+    def __init__(
+            self,
+            user_role: UserRoleInWorkspace,
+            dbsession: Session,
+            config: CFG,
+    )-> None:
+        self.user_role = user_role
+        self.dbsession = dbsession
+        self.config = config
+
+    @property
+    def user_id(self) -> int:
+        """
+        User who has the role has this id
+        :return: user id as integer
+        """
+        return self.user_role.user_id
+
+    @property
+    def workspace_id(self) -> int:
+        """
+        This role apply only on the workspace with this workspace_id
+        :return: workspace id as integer
+        """
+        return self.user_role.workspace_id
+
+    # TODO - G.M - 23-05-2018 - Check the API spec for this this !
+
+    @property
+    def slug(self) -> str:
+        """
+        simple name of the role of the user.
+        can be anything from UserRoleInWorkspace SLUG, like
+        'not_applicable', 'reader',
+        'contributor', 'content_manager', 'workspace_manager'
+        :return: user workspace role as slug.
+        """
+        return UserRoleInWorkspace.SLUG[self.user_role.role]
+
+    @property
+    def user(self) -> UserInContext:
+        """
+        User who has this role, with context data
+        :return: UserInContext object
+        """
+        return UserInContext(
+            self.user_role.user,
+            self.dbsession,
+            self.config
+        )
+
+    @property
+    def workspace(self) -> WorkspaceInContext:
+        """
+        Workspace related to this role, with his context data
+        :return: WorkspaceInContext object
+        """
+        return WorkspaceInContext(
+            self.user_role.workspace,
+            self.dbsession,
+            self.config
+        )

tracim/models/data.py

@@ -131,6 +131,12 @@ class UserRoleInWorkspace(DeclarativeBase):
     WORKSPACE_MANAGER = 8
 
     # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
+    SLUG = dict()
+    SLUG[NOT_APPLICABLE] = 'not_applicable'
+    SLUG[READER] = 'reader'
+    SLUG[CONTRIBUTOR] = 'contributor'
+    SLUG[CONTENT_MANAGER] = 'content_manager'
+    SLUG[WORKSPACE_MANAGER] = 'workspace_manager'
     # LABEL = dict()
     # LABEL[0] = l_('N/A')
     # LABEL[1] = l_('Reader')

tracim/tests/functional/test_user.py

@@ -20,9 +20,7 @@ class TestUserWorkspaceEndpoint(FunctionalTest):
         res = res.json_body
         workspace = res[0]
         assert workspace['id'] == 1
-        assert workspace['slug'] == 'w1'
         assert workspace['label'] == 'w1'
-        assert workspace['description'] == 'This is a workspace'
         assert len(workspace['sidebar_entries']) == 7  # TODO change this
 
         sidebar_entry = workspace['sidebar_entries'][0]

tracim/tests/functional/test_workspaces.py

@@ -1,10 +1,14 @@
 # coding=utf-8
-
+from tracim.models.data import UserRoleInWorkspace
 from tracim.tests import FunctionalTest
+from tracim.fixtures.content import Content as ContentFixtures
+from tracim.fixtures.users_and_groups import Base as BaseFixture
 
 
 class TestWorkspaceEndpoint(FunctionalTest):
 
+    fixtures = [BaseFixture, ContentFixtures]
+
     def test_api__get_workspace__ok_200__nominal_case(self):
         self.testapp.authorization = (
             'Basic',
@@ -13,34 +17,77 @@ class TestWorkspaceEndpoint(FunctionalTest):
                 'admin@admin.admin'
             )
         )
-        workspace = self.testapp.post_json('/api/v2/workspaces/1', status=200)
+        res = self.testapp.get('/api/v2/workspaces/1', status=200)
+        workspace = res.json_body
         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
 
-    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()
+        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"
+
+    # TODO - G.M - 22-05-2018 - Check if this feature is needed
+    # def test_api__get_workspace__err_403__unallowed_user(self):
+    #     self.testapp.authorization = (
+    #         'Basic',
+    #         (
+    #             'lawrence-not-real-email@fsf.local',
+    #             'foobarbaz'
+    #         )
+    #     )
+    #     res = self.testapp.get('/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 = (
@@ -50,7 +97,7 @@ class TestWorkspaceEndpoint(FunctionalTest):
                 'lapin'
             )
         )
-        res = self.testapp.post_json('/api/v2/workspaces/1', status=401)
+        res = self.testapp.get('/api/v2/workspaces/1', status=401)
         assert isinstance(res.json, dict)
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
@@ -64,7 +111,7 @@ class TestWorkspaceEndpoint(FunctionalTest):
                 'admin@admin.admin'
             )
         )
-        res = self.testapp.post_json('/api/v2/workspaces/5', status=404)
+        res = self.testapp.get('/api/v2/workspaces/5', status=404)
         assert isinstance(res.json, dict)
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
@@ -73,6 +120,8 @@ class TestWorkspaceEndpoint(FunctionalTest):
 
 class TestWorkspaceMembersEndpoint(FunctionalTest):
 
+    fixtures = [BaseFixture, ContentFixtures]
+
     def test_api__get_workspace_members__ok_200__nominal_case(self):
         self.testapp.authorization = (
             'Basic',
@@ -81,42 +130,30 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
                 'admin@admin.admin'
             )
         )
-        res = self.testapp.post_json('/api/v2/workspaces/1/members', status=200)
+        res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body
         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()
+        assert user_role['slug'] == 'workspace_manager'
+        assert user_role['user_id'] == 1
+        assert user_role['workspace_id'] == 1
+        assert user_role['user']['display_name'] == 'Global manager'
+        assert user_role['user']['avatar_url'] is None  # TODO
+
+
+
+    # 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.get('/api/v2/workspaces/3/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 = (
@@ -126,7 +163,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
                 'lapin'
             )
         )
-        res = self.testapp.post_json('/api/v2/workspaces/1/members', status=403)
+        res = self.testapp.get('/api/v2/workspaces/1/members', status=401)
         assert isinstance(res.json, dict)
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
@@ -140,7 +177,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
                 'admin@admin.admin'
             )
         )
-        res = self.testapp.post_json('/api/v2/workspaces/5/members', status=404)
+        res = self.testapp.get('/api/v2/workspaces/5/members', 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

@@ -36,6 +36,10 @@ class UserIdPathSchema(marshmallow.Schema):
     user_id = marshmallow.fields.Int()
 
 
+class WorkspaceIdPathSchema(marshmallow.Schema):
+    workspace_id = marshmallow.fields.Int()
+
+
 class BasicAuthSchema(marshmallow.Schema):
 
     email = marshmallow.fields.Email(required=True)
@@ -72,6 +76,7 @@ class WorkspaceSchema(marshmallow.Schema):
         many=True,
     )
 
+
 class WorkspaceDigestSchema(marshmallow.Schema):
     id = marshmallow.fields.Int()
     label = marshmallow.fields.String()
@@ -82,10 +87,12 @@ class WorkspaceDigestSchema(marshmallow.Schema):
 
 
 class WorkspaceMemberSchema(marshmallow.Schema):
-    role = marshmallow.fields.String()
+    slug = marshmallow.fields.String()
     user_id = marshmallow.fields.Int()
     workspace_id = marshmallow.fields.Int()
-    # TODO user
+    user = marshmallow.fields.Nested(
+        UserSchema(only=('display_name', 'avatar_url'))
+    )
 
 
 class ApplicationConfigSchema(marshmallow.Schema):

tracim/views/core_api/user_controller.py

@@ -14,8 +14,8 @@ from tracim.exceptions import NotAuthentificated, InsufficientUserProfile, \
 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
+from tracim.views.core_api.schemas import UserIdPathSchema, \
+    WorkspaceDigestSchema
 
 
 class UserController(Controller):
@@ -25,7 +25,7 @@ class UserController(Controller):
     @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),)
+    @hapic.output_body(WorkspaceDigestSchema(many=True),)
     def user_workspace(self, context, request: TracimRequest, hapic_data=None):
         """
         Get list of user workspaces
@@ -49,13 +49,11 @@ class UserController(Controller):
             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
+
+        return [
+            WorkspaceInContext(workspace, request.dbsession, app_config)
+            for workspace in wapi.get_all_for_user(user)
+        ]
 
     def bind(self, configurator: Configurator) -> None:
         """

tracim/views/core_api/workspace_controller.py

@@ -0,0 +1,94 @@
+from pyramid.config import Configurator
+from sqlalchemy.orm.exc import NoResultFound
+
+from tracim.lib.core.userworkspace import RoleApi
+from tracim.models.context_models import WorkspaceInContext, \
+    UserRoleWorkspaceInContext
+
+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, \
+    WorkspaceNotFound
+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, \
+    WorkspaceIdPathSchema, WorkspaceMemberSchema
+
+
+class WorkspaceController(Controller):
+
+    @hapic.with_api_doc()
+    @hapic.input_path(WorkspaceIdPathSchema())
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    #@hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.NOT_FOUND)
+    @hapic.output_body(WorkspaceSchema())
+    def workspace(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Get workspace information
+        """
+        wid = hapic_data.path['workspace_id']
+        app_config = request.registry.settings['CFG']
+        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:
+            workspace = wapi.get_one(wid)
+        except NoResultFound:
+            raise WorkspaceNotFound()
+        return WorkspaceInContext(workspace, request.dbsession, app_config)
+
+    @hapic.with_api_doc()
+    @hapic.input_path(WorkspaceIdPathSchema())
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    #@hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.NOT_FOUND)
+    @hapic.output_body(WorkspaceMemberSchema(many=True))
+    def workspaces_members(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None
+    ) -> None:
+        wid = hapic_data.path['workspace_id']
+        app_config = request.registry.settings['CFG']
+        rapi = RoleApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+        )
+        wapi = WorkspaceApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+        )
+        try:
+            wapi.get_one(wid)
+        except NoResultFound:
+            raise WorkspaceNotFound()
+        return [
+            UserRoleWorkspaceInContext(
+                user_role,
+                request.dbsession,
+                app_config
+            )
+            for user_role in rapi.get_all_for_workspace(wid)
+        ]
+
+    def bind(self, configurator: Configurator) -> None:
+        """
+        Create all routes and views using pyramid configurator
+        for this controller
+        """
+
+        # Applications
+        configurator.add_route('workspace', '/workspaces/{workspace_id}', request_method='GET')  # nopep8
+        configurator.add_view(self.workspace, route_name='workspace')
+        configurator.add_route('workspace_members', '/workspaces/{workspace_id}/members', request_method='GET')  # nopep8
+        configurator.add_view(self.workspaces_members, route_name='workspace_members')