add endpoint and tests for comments of contents

tracim/__init__.py

@@ -21,6 +21,7 @@ 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.contents_api.comment_controller import CommentController
 from tracim.views.errors import ErrorSchema
 from tracim.lib.utils.cors import add_cors_support
 
@@ -71,10 +72,12 @@ def web(global_config, **local_settings):
     system_controller = SystemController()
     user_controller = UserController()
     workspace_controller = WorkspaceController()
+    comment_controller = CommentController()
     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)
+    configurator.include(comment_controller.bind, route_prefix=BASE_API_V2)
     hapic.add_documentation_view(
         '/api/v2/doc',
         'Tracim v2 API',

tracim/fixtures/content.py

@@ -38,6 +38,11 @@ class Content(Fixture):
             session=self._session,
             config=self._config
         )
+        bob_content_api = ContentApi(
+            current_user=bob,
+            session=self._session,
+            config=self._config
+        )
         role_api = RoleApi(
             current_user=admin,
             session=self._session,
@@ -246,5 +251,19 @@ class Content(Fixture):
             content_api.delete(bad_fruit_salad)
         content_api.save(bad_fruit_salad)
 
-
+        content_api.create_comment(
+            parent=best_cake_thread,
+            content='<p> What is for you the best cake ever ? </br> I personnally vote for Chocolate cupcake !</p>',  # nopep8
+            do_save=True,
+        )
+        bob_content_api.create_comment(
+            parent=best_cake_thread,
+            content='<p>What about Apple Pie ? There are Awesome !</p>',
+            do_save=True,
+        )
+        content_api.create_comment(
+            parent=best_cake_thread,
+            content='<p>You are right, but Kouign-amann are clearly better.</p>',
+            do_save=True,
+        )
         self._session.flush()

tracim/lib/core/content.py

@@ -418,6 +418,8 @@ class ContentApi(object):
         item = Content()
         item.owner = self._user
         item.parent = parent
+        if parent and not workspace:
+            workspace = item.parent.workspace
         item.workspace = workspace
         item.type = ContentType.Comment
         item.description = content
@@ -449,15 +451,20 @@ class ContentApi(object):
 
         return content
 
-    def get_one(self, content_id: int, content_type: str, workspace: Workspace=None) -> Content:
+    def get_one(self, content_id: int, content_type: str, workspace: Workspace=None, parent: Content=None) -> Content:
 
         if not content_id:
             return None
 
-        if content_type==ContentType.Any:
-            return self._base_query(workspace).filter(Content.content_id==content_id).one()
+        base_request = self._base_query(workspace).filter(Content.content_id==content_id)
 
-        return self._base_query(workspace).filter(Content.content_id==content_id).filter(Content.type==content_type).one()
+        if content_type!=ContentType.Any:
+            base_request = base_request.filter(Content.type==content_type)
+
+        if parent:
+            base_request = base_request.filter(Content.parent_id==parent.content_id)  # nopep8
+
+        return base_request.one()
 
     def get_one_revision(self, revision_id: int = None) -> ContentRevisionRO:
         """

tracim/models/contents.py

@@ -186,6 +186,33 @@ CONTENT_DEFAULT_TYPE = [
     folder_type,
 ]
 
+# TODO - G.M - 31-05-2018 - Set Better Event params
+event_type = NewContentType(
+    slug='event',
+    fa_icon=thread.fa_icon,
+    hexcolor=thread.hexcolor,
+    label='Event',
+    creation_label='Event',
+    available_statuses=CONTENT_DEFAULT_STATUS,
+)
+
+# TODO - G.M - 31-05-2018 - Set Better Event params
+comment_type = NewContentType(
+    slug='comment',
+    fa_icon=thread.fa_icon,
+    hexcolor=thread.hexcolor,
+    label='Comment',
+    creation_label='Comment',
+    available_statuses=CONTENT_DEFAULT_STATUS,
+)
+
+CONTENT_DEFAULT_TYPE_SPECIAL = [
+    event_type,
+    comment_type,
+]
+
+ALL_CONTENTS_DEFAULT_TYPES = CONTENT_DEFAULT_TYPE + CONTENT_DEFAULT_TYPE_SPECIAL
+
 
 class ContentTypeLegacy(NewContentType):
     """
@@ -204,7 +231,7 @@ class ContentTypeLegacy(NewContentType):
     MarkdownPage = markdownpluspage_type.slug
 
     def __init__(self, slug: str):
-        for content_type in CONTENT_DEFAULT_TYPE:
+        for content_type in ALL_CONTENTS_DEFAULT_TYPES:
             if slug == content_type.slug:
                 super(ContentTypeLegacy, self).__init__(
                     slug=content_type.slug,
@@ -223,8 +250,7 @@ class ContentTypeLegacy(NewContentType):
 
     @classmethod
     def allowed_types(cls) -> typing.List[str]:
-        contents_types = [status.slug for status in CONTENT_DEFAULT_TYPE]
-        contents_types.extend([cls.Folder, cls.Event, cls.Comment])
+        contents_types = [status.slug for status in ALL_CONTENTS_DEFAULT_TYPES]
         return contents_types
 
     @classmethod
@@ -232,7 +258,6 @@ class ContentTypeLegacy(NewContentType):
         # This method is used for showing only "main"
         # types in the left-side treeview
         contents_types = [status.slug for status in CONTENT_DEFAULT_TYPE]
-        contents_types.extend([cls.Folder])
         return contents_types
 
     # TODO - G.M - 30-05-2018 - This method don't do anything.

tracim/models/context_models.py

@@ -41,6 +41,16 @@ class WorkspaceAndContentPath(object):
         self.workspace_id = workspace_id
 
 
+class CommentPath(object):
+    """
+    Paths params with workspace id and content_id
+    """
+    def __init__(self, workspace_id: int, content_id: int, comment_id: int):
+        self.content_id = content_id
+        self.workspace_id = workspace_id
+        self.comment_id = comment_id
+
+
 class ContentFilter(object):
     """
     Content filter model
@@ -71,6 +81,17 @@ class ContentCreation(object):
         self.content_type = content_type
 
 
+class CommentCreation(object):
+    """
+    Comment creation model
+    """
+    def __init__(
+            self,
+            raw_content: str,
+    ):
+        self.raw_content=raw_content
+
+
 class UserInContext(object):
     """
     Interface to get User data and User data related to context.
@@ -324,6 +345,18 @@ class ContentInContext(object):
     def is_deleted(self):
         return self.content.is_deleted
 
+    @property
+    def raw_content(self):
+        return self.content.description
+
+    @property
+    def author(self):
+        return UserInContext(
+            dbsession=self.dbsession,
+            config=self.config,
+            user=self.content.owner
+        )
+
     # Context-related
 
     @property

tracim/tests/functional/test_comments.py

@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+"""
+Tests for /api/v2/workspaces subpath endpoints.
+"""
+from tracim.tests import FunctionalTest
+from tracim.fixtures.content import Content as ContentFixtures
+from tracim.fixtures.users_and_groups import Base as BaseFixture
+
+
+class TestCommentsEndpoint(FunctionalTest):
+    """
+    Tests for /api/v2/workspaces/{workspace_id}/contents/{content_id}/comments
+    endpoint
+    """
+
+    fixtures = [BaseFixture, ContentFixtures]
+
+    def test_api__get_contents_comments__ok_200__nominal_case(self) -> None:
+        """
+        Get alls comments of a content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.get('/api/v2/workspaces/2/contents/7/comments', status=200)   # nopep8
+        assert len(res.json_body) == 3
+        comment = res.json_body[0]
+        assert comment['content_id'] == 18
+        assert comment['parent_id'] == 7
+        assert comment['raw_content'] == '<p> What is for you the best cake ever ? </br> I personnally vote for Chocolate cupcake !</p>'  # nopep8
+        assert comment['author']
+        assert comment['author']['user_id'] == 1
+        # TODO - G.M - 2018-06-172 - [avatar] setup avatar url
+        assert comment['author']['avatar_url'] == None
+        assert comment['author']['public_name'] == 'Global manager'
+
+        comment = res.json_body[1]
+        assert comment['content_id'] == 19
+        assert comment['parent_id'] == 7
+        assert comment['raw_content'] == '<p>What about Apple Pie ? There are Awesome !</p>'  # nopep8
+        assert comment['author']
+        assert comment['author']['user_id'] == 3
+        # TODO - G.M - 2018-06-172 - [avatar] setup avatar url
+        assert comment['author']['avatar_url'] == None
+        assert comment['author']['public_name'] == 'Bob i.'
+
+        comment = res.json_body[2]
+        assert comment['content_id'] == 20
+        assert comment['parent_id'] == 7
+        assert comment['raw_content'] == '<p>You are right, but Kouign-amann are clearly better.</p>'  # nopep8
+        assert comment['author']
+        assert comment['author']['user_id'] == 1
+        # TODO - G.M - 2018-06-172 - [avatar] setup avatar url
+        assert comment['author']['avatar_url'] == None
+        assert comment['author']['public_name'] == 'Global manager'
+
+    def test_api__post_content_comment__ok_200__nominal_case(self) -> None:
+        """
+        Get alls comments of a content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        params = {
+            'raw_content': 'I strongly disagree, Tiramisu win !'
+        }
+        res = self.testapp.post_json(
+            '/api/v2/workspaces/2/contents/7/comments',
+            params=params,
+            status=200
+        )
+        comment = res.json_body
+        assert comment['content_id']
+        assert comment['parent_id'] == 7
+        assert comment['raw_content'] == 'I strongly disagree, Tiramisu win !'
+        assert comment['author']
+        assert comment['author']['user_id'] == 1
+        # TODO - G.M - 2018-06-172 - [avatar] setup avatar url
+        assert comment['author']['avatar_url'] is None
+        assert comment['author']['public_name'] == 'Global manager'
+
+        res = self.testapp.get('/api/v2/workspaces/2/contents/7/comments', status=200)  # nopep8
+        assert len(res.json_body) == 4
+        assert comment == res.json_body[3]
+
+    def test_api__delete_content_comment__ok_200__nominal_case(self) -> None:
+        """
+        Get alls comments of a content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.get('/api/v2/workspaces/2/contents/7/comments', status=200)
+        assert len(res.json_body) == 3
+        comment = res.json_body[2]
+        assert comment['content_id'] == 20
+        assert comment['parent_id'] == 7
+        assert comment['raw_content'] == '<p>You are right, but Kouign-amann are clearly better.</p>'   # nopep8
+        assert comment['author']
+        assert comment['author']['user_id'] == 1
+        # TODO - G.M - 2018-06-172 - [avatar] setup avatar url
+        assert comment['author']['avatar_url'] is None
+        assert comment['author']['public_name'] == 'Global manager'
+
+        res = self.testapp.delete(
+            '/api/v2/workspaces/2/contents/7/comments/20',
+            status=204
+        )
+        res = self.testapp.get('/api/v2/workspaces/2/contents/7/comments', status=200)
+        assert len(res.json_body) == 2
+        assert not [content for content in res.json_body if content['content_id'] == 20]  # nopep8

tracim/tests/functional/test_mail_notification.py

@@ -162,8 +162,8 @@ class TestNotificationsSync(MailHogTest):
         assert headers['From'][0] == '"Bob i. via Tracim" <test_user_from+3@localhost>'  # nopep8
         assert headers['To'][0] == 'Global manager <admin@admin.admin>'
         assert headers['Subject'][0] == '[TRACIM] [Recipes] file1 (Open)'
-        assert headers['References'][0] == 'test_user_refs+19@localhost'
-        assert headers['Reply-to'][0] == '"Bob i. & all members of Recipes" <test_user_reply+19@localhost>'  # nopep8
+        assert headers['References'][0] == 'test_user_refs+22@localhost'
+        assert headers['Reply-to'][0] == '"Bob i. & all members of Recipes" <test_user_reply+22@localhost>'  # nopep8
 
 
 class TestNotificationsAsync(MailHogTest):
@@ -263,5 +263,5 @@ class TestNotificationsAsync(MailHogTest):
         assert headers['From'][0] == '"Bob i. via Tracim" <test_user_from+3@localhost>'  # nopep8
         assert headers['To'][0] == 'Global manager <admin@admin.admin>'
         assert headers['Subject'][0] == '[TRACIM] [Recipes] file1 (Open)'
-        assert headers['References'][0] == 'test_user_refs+19@localhost'
-        assert headers['Reply-to'][0] == '"Bob i. & all members of Recipes" <test_user_reply+19@localhost>'  # nopep8
+        assert headers['References'][0] == 'test_user_refs+22@localhost'
+        assert headers['Reply-to'][0] == '"Bob i. & all members of Recipes" <test_user_reply+22@localhost>'  # nopep8

tracim/views/contents_api/comment_controller.py

@@ -0,0 +1,157 @@
+# coding=utf-8
+import transaction
+from pyramid.config import Configurator
+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.lib.core.content import ContentApi
+from tracim.lib.core.workspace import WorkspaceApi
+from tracim.views.controllers import Controller
+from tracim.views.core_api.schemas import CommentSchema
+from tracim.views.core_api.schemas import CommentsPathSchema
+from tracim.views.core_api.schemas import SetCommentSchema
+from tracim.views.core_api.schemas import WorkspaceAndContentIdPathSchema
+from tracim.views.core_api.schemas import NoContentSchema
+from tracim.exceptions import WorkspaceNotFound
+from tracim.exceptions import InsufficientUserProfile
+from tracim.exceptions import NotAuthenticated
+from tracim.exceptions import AuthenticationFailed
+from tracim.models.contents import ContentTypeLegacy as ContentType
+from tracim.models.revision_protection import new_revision
+
+COMMENT_ENDPOINTS_TAG = 'Comments'
+
+
+class CommentController(Controller):
+    pass
+
+    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(AuthenticationFailed, HTTPStatus.BAD_REQUEST)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.output_body(CommentSchema(many=True),)
+    def content_comments(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Get all comments related to a content in asc order (first is the oldest)
+        """
+
+        # login = hapic_data.body
+        app_config = request.registry.settings['CFG']
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        comments = content.get_comments()
+        comments.sort(key=lambda comment: comment.created)
+        return [api.get_content_in_context(comment)
+                for comment in comments
+        ]
+
+    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(AuthenticationFailed, HTTPStatus.BAD_REQUEST)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.input_body(SetCommentSchema())
+    @hapic.output_body(CommentSchema(),)
+    def add_comment(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Add new comment
+        """
+        # login = hapic_data.body
+        app_config = request.registry.settings['CFG']
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        comment = api.create_comment(
+            content.workspace,
+            content,
+            hapic_data.body.raw_content,
+            do_save=True,
+        )
+        return api.get_content_in_context(comment)
+
+    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(AuthenticationFailed, HTTPStatus.BAD_REQUEST)
+    @hapic.input_path(CommentsPathSchema())
+    @hapic.output_body(NoContentSchema(), default_http_code=HTTPStatus.NO_CONTENT)  # nopep8
+    def delete_comment(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Delete comment
+        """
+        app_config = request.registry.settings['CFG']
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        wapi = WorkspaceApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        workspace = wapi.get_one(hapic_data.path.workspace_id)
+        parent = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any,
+            workspace=workspace
+        )
+        comment = api.get_one(
+            hapic_data.path.comment_id,
+            content_type=ContentType.Comment,
+            workspace=workspace,
+            parent=parent,
+        )
+        with new_revision(
+                session=request.dbsession,
+                tm=transaction.manager,
+                content=comment
+        ):
+            api.delete(comment)
+        return
+
+    def bind(self, configurator: Configurator):
+        # Get comments
+        configurator.add_route(
+            'content_comments',
+            '/workspaces/{workspace_id}/contents/{content_id}/comments',
+            request_method='GET'
+        )
+        configurator.add_view(self.content_comments, route_name='content_comments')
+
+        # Add comments
+        configurator.add_route(
+            'add_comment',
+            '/workspaces/{workspace_id}/contents/{content_id}/comments',
+            request_method='POST'
+        )  # nopep8
+        configurator.add_view(self.add_comment, route_name='add_comment')
+
+        # delete comments
+        configurator.add_route(
+            'delete_comment',
+            '/workspaces/{workspace_id}/contents/{content_id}/comments/{comment_id}',  # nopep8
+            request_method='DELETE'
+        )
+        configurator.add_view(self.delete_comment, route_name='delete_comment')

tracim/views/core_api/schemas.py

@@ -9,6 +9,8 @@ from tracim.models.contents import CONTENT_DEFAULT_STATUS
 from tracim.models.contents import GlobalStatus
 from tracim.models.contents import open_status
 from tracim.models.context_models import ContentCreation
+from tracim.models.context_models import CommentCreation
+from tracim.models.context_models import CommentPath
 from tracim.models.context_models import MoveParams
 from tracim.models.context_models import WorkspaceAndContentPath
 from tracim.models.context_models import ContentFilter
@@ -100,6 +102,9 @@ class CommentsPathSchema(WorkspaceAndContentIdPathSchema):
         description='id of a comment related to content content_id',
         required=True
     )
+    @post_load
+    def make_path_object(self, data):
+        return CommentPath(**data)
 
 
 class FilterContentQuerySchema(marshmallow.Schema):
@@ -455,6 +460,10 @@ class SetCommentSchema(marshmallow.Schema):
         example='<p>This is just an html comment !</p>'
     )
 
+    @post_load
+    def create_comment(self, data):
+        return CommentCreation(**data)
+
 
 class SetContentStatusSchema(marshmallow.Schema):
     status = marshmallow.fields.Str(
@@ -462,4 +471,4 @@ class SetContentStatusSchema(marshmallow.Schema):
         validate=OneOf([status.slug for status in CONTENT_DEFAULT_STATUS]),
         description='this slug is found in content_type available statuses',
         default=open_status
-    )
+    )