Add put and post for workspace endpoints #587

tracim/models/context_models.py

@@ -13,6 +13,14 @@ from tracim.models.workspace_menu_entries import default_workspace_menu_entry
 from tracim.models.workspace_menu_entries import WorkspaceMenuEntry
 
 
+class MoveParams(object):
+    """
+    Json body params for move action
+    """
+    def __init__(self, new_parent_id: str):
+        self.new_parent_id = new_parent_id
+
+
 class LoginCredentials(object):
     """
     Login credentials model for login
@@ -23,22 +31,45 @@ class LoginCredentials(object):
         self.password = password
 
 
+class WorkspaceAndContentPath(object):
+    """
+    Paths params with workspace id and content_id
+    """
+    def __init__(self, workspace_id: int, content_id: int):
+        self.content_id = content_id
+        self.workspace_id = workspace_id
+
+
 class ContentFilter(object):
     """
     Content filter model
     """
-    def __init__(self,
-                 parent_id: int = None,
-                 show_archived: int = 0,
-                 show_deleted: int = 0,
-                 show_active: int = 1,
-                 ):
+    def __init__(
+            self,
+            parent_id: int = None,
+            show_archived: int = 0,
+            show_deleted: int = 0,
+            show_active: int = 1,
+    ):
         self.parent_id = parent_id
         self.show_archived = bool(show_archived)
         self.show_deleted = bool(show_deleted)
         self.show_active = bool(show_active)
 
 
+class ContentCreation(object):
+    """
+    Content creation model
+    """
+    def __init__(
+            self,
+            label: str,
+            content_type_slug: str,
+    ):
+        self.label = label
+        self.content_type_slug = content_type_slug
+
+
 class UserInContext(object):
     """
     Interface to get User data and User data related to context.

tracim/tests/functional/test_workspaces.py

@@ -727,3 +727,136 @@ class TestWorkspaceContents(FunctionalTest):
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
         assert 'details' in res.json.keys()
+
+    def test_api__post_content_create_generic_content__ok_200__nominal_case(self) -> None:
+        """
+        Create generic content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        params = {
+            'label': 'GenericCreatedContent',
+            'content_type_slug': 'markdownpage',
+        }
+        res = self.testapp.post_json(
+            '/api/v2/workspaces/1/contents',
+            params=params,
+            status=200
+        )
+        assert res
+        assert res.json_body
+        assert res.json_body['status_slug'] == 'open'
+        assert res.json_body['id']
+        assert res.json_body['content_type_slug'] == 'markdownpage'
+        assert res.json_body['is_archived'] is False
+        assert res.json_body['is_deleted'] is False
+        assert res.json_body['workspace_id'] == 1
+        assert res.json_body['slug'] == 'genericcreatedcontent'
+        assert res.json_body['parent_id'] is None
+        assert res.json_body['show_in_ui'] is True
+        assert res.json_body['sub_content_type_slug']
+
+    def test_api_put_move_content__ok_200__nominal_case(self):
+        """
+        Move content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        params = {
+            'new_parent_id': '4',  # Salads
+        }
+        # TODO - G.M - 2018-06-163 - Check content
+        res = self.testapp.put_json(
+            # INFO - G.M - 2018-06-163 - move Apple_Pie
+            # from Desserts to Salads subfolder of workspace Recipes
+            '/api/v2/workspaces/2/contents/8/move',
+            params=params,
+            status=200
+        )
+        # TODO - G.M - 2018-06-163 - Recheck content
+
+    def test_api_put_delete_content__ok_200__nominal_case(self):
+        """
+        Move content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        # TODO - G.M - 2018-06-163 - Check content
+        res = self.testapp.put_json(
+            # INFO - G.M - 2018-06-163 - delete Apple_Pie
+            '/api/v2/workspaces/2/contents/8/delete',
+            status=200
+        )
+        # TODO - G.M - 2018-06-163 - Recheck content
+
+    def test_api_put_archive_content__ok_200__nominal_case(self):
+        """
+        archive content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        # TODO - G.M - 2018-06-163 - Check content
+        res = self.testapp.put_json(
+            # INFO - G.M - 2018-06-163 - archive Apple_Pie
+            '/api/v2/workspaces/2/contents/8/archive',
+            status=200
+        )
+        # TODO - G.M - 2018-06-163 - Recheck content
+
+    def test_api_put_undelete_content__ok_200__nominal_case(self):
+        """
+        Delete content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'bob@fsf.local',
+                'foobarbaz'
+            )
+        )
+        # TODO - G.M - 2018-06-163 - Check content
+        res = self.testapp.put_json(
+            # INFO - G.M - 2018-06-163 - delete Apple_Pie
+            '/api/v2/workspaces/2/contents/14/undelete',
+            status=200
+        )
+        # TODO - G.M - 2018-06-163 - Recheck content
+
+    def test_api_put_unarchive_content__ok_200__nominal_case(self):
+        """
+        Delete content
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'bob@fsf.local',
+                'foobarbaz'
+            )
+        )
+        # TODO - G.M - 2018-06-163 - Check content
+        res = self.testapp.put_json(
+            # INFO - G.M - 2018-06-163 - delete Apple_Pie
+            '/api/v2/workspaces/2/contents/13/unarchive',
+            status=200
+        )
+        # TODO - G.M - 2018-06-163 - Recheck content

tracim/views/core_api/schemas.py

@@ -4,8 +4,15 @@ from marshmallow import post_load
 from marshmallow.validate import OneOf
 
 from tracim.models.auth import Profile
-from tracim.models.contents import CONTENT_DEFAULT_TYPE, GlobalStatus, CONTENT_DEFAULT_STATUS
-from tracim.models.context_models import LoginCredentials, ContentFilter
+from tracim.models.contents import CONTENT_DEFAULT_TYPE
+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 MoveParams
+from tracim.models.context_models import WorkspaceAndContentPath
+from tracim.models.context_models import ContentFilter
+from tracim.models.context_models import LoginCredentials
 from tracim.models.data import UserRoleInWorkspace
 
 
@@ -82,7 +89,9 @@ class ContentIdPathSchema(marshmallow.Schema):
 
 
 class WorkspaceAndContentIdPathSchema(WorkspaceIdPathSchema, ContentIdPathSchema):
-    pass
+    @post_load
+    def make_path_object(self, data):
+        return WorkspaceAndContentPath(**data)
 
 
 class FilterContentQuerySchema(marshmallow.Schema):
@@ -292,6 +301,10 @@ class ContentMoveSchema(marshmallow.Schema):
         description='id of the new parent content id.'
     )
 
+    @post_load
+    def make_move_params(self, data):
+        return MoveParams(**data)
+
 
 class ContentCreationSchema(marshmallow.Schema):
     label = marshmallow.fields.String(
@@ -300,9 +313,13 @@ class ContentCreationSchema(marshmallow.Schema):
     )
     content_type_slug = marshmallow.fields.String(
         example='htmlpage',
-        validate=OneOf(CONTENT_DEFAULT_TYPE),
+        validate=OneOf([content.slug for content in CONTENT_DEFAULT_TYPE]),
     )
 
+    @post_load
+    def make_content_filter(self, data):
+        return ContentCreation(**data)
+
 
 class ContentDigestSchema(marshmallow.Schema):
     id = marshmallow.fields.Int(example=6)
@@ -330,9 +347,10 @@ class ContentDigestSchema(marshmallow.Schema):
         example='closed-deprecated',
         validate=OneOf([status.slug for status in CONTENT_DEFAULT_STATUS]),
         description='this slug is found in content_type available statuses',
+        default=open_status
     )
-    is_archived = marshmallow.fields.Bool(example=False)
-    is_deleted = marshmallow.fields.Bool(example=False)
+    is_archived = marshmallow.fields.Bool(example=False, default=False)
+    is_deleted = marshmallow.fields.Bool(example=False, default=False)
     show_in_ui = marshmallow.fields.Bool(
         example=True,
         description='if false, then do not show content in the treeview. '

tracim/views/core_api/workspace_controller.py

@@ -1,7 +1,7 @@
 import typing
 
+import transaction
 from pyramid.config import Configurator
-
 try:  # Python 3.5+
     from http import HTTPStatus
 except ImportError:
@@ -12,7 +12,7 @@ from tracim.lib.core.workspace import WorkspaceApi
 from tracim.lib.core.content import ContentApi
 from tracim.lib.core.userworkspace import RoleApi
 from tracim.lib.utils.authorization import require_workspace_role
-from tracim.models.data import UserRoleInWorkspace
+from tracim.models.data import UserRoleInWorkspace, ActionDescription
 from tracim.models.context_models import UserRoleWorkspaceInContext
 from tracim.models.context_models import ContentInContext
 from tracim.exceptions import NotAuthentificated
@@ -20,10 +20,16 @@ from tracim.exceptions import InsufficientUserProfile
 from tracim.exceptions import WorkspaceNotFound
 from tracim.views.controllers import Controller
 from tracim.views.core_api.schemas import FilterContentQuerySchema
+from tracim.views.core_api.schemas import ContentMoveSchema
+from tracim.views.core_api.schemas import NoContentSchema
+from tracim.views.core_api.schemas import ContentCreationSchema
+from tracim.views.core_api.schemas import WorkspaceAndContentIdPathSchema
 from tracim.views.core_api.schemas import ContentDigestSchema
 from tracim.views.core_api.schemas import WorkspaceSchema
 from tracim.views.core_api.schemas import WorkspaceIdPathSchema
 from tracim.views.core_api.schemas import WorkspaceMemberSchema
+from tracim.models.data import ContentType
+from tracim.models.revision_protection import new_revision
 
 
 class WorkspaceController(Controller):
@@ -113,6 +119,218 @@ class WorkspaceController(Controller):
         ]
         return contents
 
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
+    @hapic.input_path(WorkspaceIdPathSchema())
+    @hapic.input_body(ContentCreationSchema())
+    @hapic.output_body(ContentDigestSchema())
+    def create_generic_empty_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        create a generic empty content
+        """
+        app_config = request.registry.settings['CFG']
+        creation_data = hapic_data.body
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.create(
+            label=creation_data.label,
+            content_type=creation_data.content_type_slug,
+            workspace=request.current_workspace,
+        )
+        api.save(content, ActionDescription.CREATION)
+        content = api.get_content_in_context(content)
+        return content
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.input_body(ContentMoveSchema())
+    @hapic.output_body(NoContentSchema())
+    def move_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        move a content
+        """
+        app_config = request.registry.settings['CFG']
+        path_data = hapic_data.path
+        move_data = hapic_data.body
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            path_data.content_id,
+            content_type=ContentType.Any
+        )
+        new_parent = api.get_one(
+            move_data.new_parent_id, content_type=ContentType.Any
+        )
+        with new_revision(
+                session=request.dbsession,
+                tm=transaction.manager,
+                content=content
+        ):
+            api.move(content, new_parent=new_parent)
+        return
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.output_body(NoContentSchema())
+    def delete_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        delete a content
+        """
+        app_config = request.registry.settings['CFG']
+        path_data = hapic_data.path
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            path_data.content_id,
+            content_type=ContentType.Any
+        )
+        with new_revision(
+                session=request.dbsession,
+                tm=transaction.manager,
+                content=content
+        ):
+            api.delete(content)
+        return
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.output_body(NoContentSchema())
+    def undelete_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        undelete a content
+        """
+        app_config = request.registry.settings['CFG']
+        path_data = hapic_data.path
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+            show_deleted=True,
+        )
+        content = api.get_one(
+            path_data.content_id,
+            content_type=ContentType.Any
+        )
+        with new_revision(
+                session=request.dbsession,
+                tm=transaction.manager,
+                content=content
+        ):
+            api.undelete(content)
+        return
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.output_body(NoContentSchema())
+    def archive_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        archive a content
+        """
+        app_config = request.registry.settings['CFG']
+        path_data = hapic_data.path
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(path_data.content_id, content_type=ContentType.Any)
+        with new_revision(
+                session=request.dbsession,
+                tm=transaction.manager,
+                content=content
+        ):
+            api.archive(content)
+        return
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
+    @hapic.handle_exception(WorkspaceNotFound, HTTPStatus.FORBIDDEN)
+    @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.output_body(NoContentSchema())
+    def unarchive_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        unarchive a content
+        """
+        app_config = request.registry.settings['CFG']
+        path_data = hapic_data.path
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+            show_archived=True,
+        )
+        content = api.get_one(
+            path_data.content_id,
+            content_type=ContentType.Any
+        )
+        with new_revision(
+                session=request.dbsession,
+                tm=transaction.manager,
+                content=content
+        ):
+            api.unarchive(content)
+        return
+
     def bind(self, configurator: Configurator) -> None:
         """
         Create all routes and views using
@@ -127,4 +345,20 @@ class WorkspaceController(Controller):
         configurator.add_view(self.workspaces_members, route_name='workspace_members')  # nopep8
         # Workspace Content
         configurator.add_route('workspace_content', '/workspaces/{workspace_id}/contents', request_method='GET')  # nopep8
-        configurator.add_view(self.workspace_content, route_name='workspace_content')  # nopep8
+        configurator.add_view(self.workspace_content, route_name='workspace_content')  # nopep8
+        # Create Generic Content
+        configurator.add_route('create_generic_content', '/workspaces/{workspace_id}/contents', request_method='POST')  # nopep8
+        configurator.add_view(self.create_generic_empty_content, route_name='create_generic_content')  # nopep8
+        # Move Content
+        configurator.add_route('move_content', '/workspaces/{workspace_id}/contents/{content_id}/move', request_method='PUT')  # nopep8
+        configurator.add_view(self.move_content, route_name='move_content')  # nopep8
+        # Delete/Undelete Content
+        configurator.add_route('delete_content', '/workspaces/{workspace_id}/contents/{content_id}/delete', request_method='PUT')  # nopep8
+        configurator.add_view(self.delete_content, route_name='delete_content')  # nopep8
+        configurator.add_route('undelete_content', '/workspaces/{workspace_id}/contents/{content_id}/undelete', request_method='PUT')  # nopep8
+        configurator.add_view(self.undelete_content, route_name='undelete_content')  # nopep8
+        # # Archive/Unarchive Content
+        configurator.add_route('archive_content', '/workspaces/{workspace_id}/contents/{content_id}/archive', request_method='PUT')  # nopep8
+        configurator.add_view(self.archive_content, route_name='archive_content')  # nopep8
+        configurator.add_route('unarchive_content', '/workspaces/{workspace_id}/contents/{content_id}/unarchive', request_method='PUT')  # nopep8
+        configurator.add_view(self.unarchive_content, route_name='unarchive_content')  # nopep8