Partial Support for get content in api (without full filter support)

tracim/lib/core/content.py

@@ -9,6 +9,8 @@ import transaction
 from sqlalchemy import func
 from sqlalchemy.orm import Query
 
+from tracim.models.context_models import ContentInContext
+
 __author__ = 'damien'
 
 import datetime
@@ -113,6 +115,7 @@ class ContentApi(object):
             show_archived: bool = False,
             show_deleted: bool = False,
             show_temporary: bool = False,
+            show_active: bool = True,
             all_content_in_treeview: bool = True,
             force_show_all_types: bool = False,
             disable_user_workspaces_filter: bool = False,
@@ -124,6 +127,7 @@ class ContentApi(object):
         self._show_archived = show_archived
         self._show_deleted = show_deleted
         self._show_temporary = show_temporary
+        self._show_active = show_active
         self._show_all_type_of_contents_in_treeview = all_content_in_treeview
         self._force_show_all_types = force_show_all_types
         self._disable_user_workspaces_filter = disable_user_workspaces_filter
@@ -156,6 +160,9 @@ class ContentApi(object):
             self._show_deleted = previous_show_deleted
             self._show_temporary = previous_show_temporary
 
+    def get_content_in_context(self, content: Content):
+        return ContentInContext(content, self._session, self._config)
+
     def get_revision_join(self) -> sqlalchemy.sql.elements.BooleanClauseList:
         """
         Return the Content/ContentRevision query join condition
@@ -243,6 +250,9 @@ class ContentApi(object):
         if not self._show_temporary:
             result = result.filter(Content.is_temporary==False)
 
+        if not self._show_active:
+            result = result.filter(Content.is_active==False)
+
         return result
 
     def __revisions_real_base_query(
@@ -686,8 +696,9 @@ class ContentApi(object):
 
         if parent_id:
             resultset = resultset.filter(Content.parent_id==parent_id)
-        if parent_id is False:
+        if parent_id == 0 or parent_id is False:
             resultset = resultset.filter(Content.parent_id == None)
+        # parent_id == None give all contents
 
         return resultset.all()
 

tracim/models/contents.py

@@ -87,7 +87,7 @@ class ContentStatusLegacy(NewContentStatus):
     def __init__(self, slug: str):
         for status in CONTENT_DEFAULT_STATUS:
             if slug == status.slug:
-                super(ContentStatusLegacy).__init__(
+                super(ContentStatusLegacy, self).__init__(
                     slug=status.slug,
                     global_status=status.global_status,
                     label=status.label,
@@ -168,12 +168,22 @@ pagehtml_type = NewContentType(
     available_statuses=CONTENT_DEFAULT_STATUS,
 )
 
+# TODO - G.M - 31-05-2018 - Set Better folder params
+folder_type = NewContentType(
+    slug='folder',
+    icon=thread.icon,
+    hexcolor=thread.hexcolor,
+    label='Folder',
+    creation_label='Create collection of any documents',
+    available_statuses=CONTENT_DEFAULT_STATUS,
+)
 
 CONTENT_DEFAULT_TYPE = [
     thread_type,
     file_type,
     pagemarkdownplus_type,
     pagehtml_type,
+    folder_type,
 ]
 
 
@@ -195,7 +205,7 @@ class ContentTypeLegacy(NewContentType):
     def __init__(self, slug: str):
         for content_type in CONTENT_DEFAULT_TYPE:
             if slug == content_type.slug:
-                super(ContentTypeLegacy).__init__(
+                super(ContentTypeLegacy, self).__init__(
                     slug=content_type.slug,
                     icon=content_type.icon,
                     hexcolor=content_type.hexcolor,

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, UserRoleInWorkspace
+from tracim.models.data import Workspace, UserRoleInWorkspace, Content
 from tracim.models.workspace_menu_entries import default_workspace_menu_entry, \
     WorkspaceMenuEntry
 
@@ -22,6 +22,21 @@ class LoginCredentials(object):
         self.password = password
 
 
+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,
+                 ):
+        self.parent_id = parent_id
+        self.show_archived = bool(show_archived)
+        self.show_deleted = bool(show_deleted)
+        self.show_active = bool(show_active)
+
 class UserInContext(object):
     """
     Interface to get User data and User data related to context.
@@ -211,3 +226,67 @@ class UserRoleWorkspaceInContext(object):
             self.dbsession,
             self.config
         )
+
+
+class ContentInContext(object):
+    """
+    Interface to get Content data and Content data related to context.
+    """
+
+    def __init__(self, content: Content, dbsession: Session, config: CFG):
+        self.content = content
+        self.dbsession = dbsession
+        self.config = config
+
+    # Default
+
+    @property
+    def id(self) -> int:
+        return self.content.content_id
+
+    @property
+    def parent_id(self) -> int:
+        return self.content.parent_id
+
+    @property
+    def workspace_id(self) -> int:
+        return self.content.workspace_id
+
+    @property
+    def label(self) -> str:
+        return self.content.label
+
+    @property
+    def content_type_slug(self) -> str:
+        return self.content.type
+
+    @property
+    def sub_content_type_slug(self) -> typing.List[str]:
+        return [type.slug for type in self.content.get_allowed_content_types()]
+
+    @property
+    def status_slug(self) -> str:
+        return self.content.status
+
+    @property
+    def is_archived(self):
+        return self.content.is_archived
+
+    @property
+    def is_deleted(self):
+        return self.content.is_deleted
+
+    # Context-related
+
+    @property
+    def show_in_ui(self):
+        # TODO - G.M - 31-05-2018 - Enable Show_in_ui params
+        # if false, then do not show content in the treeview.
+        # This may his maybe used for specific contents or for sub-contents.
+        # Default is True.
+        # In first version of the API, this field is always True
+        return True
+
+    @property
+    def slug(self):
+        return slugify(self.content.label)

tracim/models/data.py

@@ -1148,6 +1148,10 @@ class Content(DeclarativeBase):
         return not self.is_archived and not self.is_deleted
 
     @property
+    def is_active(self) -> bool:
+        return self.is_editable
+
+    @property
     def depot_file(self) -> UploadedFile:
         return self.revision.depot_file
 

tracim/tests/functional/test_system.py

@@ -131,7 +131,7 @@ class TestContentsTypesEndpoint(FunctionalTest):
         assert content_type['creation_label'] == 'Write a document'
         assert 'available_statuses' in content_type
         assert len(content_type['available_statuses']) == 4
-
+        # TODO - G.M - 31-05-2018 - Check Folder type
         # TODO - G.M - 29-05-2018 - Better check for available_statuses
 
     def test_api__get_content_types__err_401__unregistered_user(self):

tracim/tests/functional/test_workspaces.py

@@ -219,7 +219,6 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert 'details' in res.json.keys()
 
 
-@pytest.mark.xfail()
 class TestWorkspaceContents(FunctionalTest):
     """
     Tests for /api/v2/workspaces/{workspace_id}/contents endpoint
@@ -240,7 +239,40 @@ class TestWorkspaceContents(FunctionalTest):
         )
         res = self.testapp.get('/api/v2/workspaces/1/contents', status=200).json_body   # nopep8
         # TODO - G.M - 30-05-2018 - Check this test
-        raise NotImplementedError()
+        assert len(res) == 3
+        content = res[0]
+        assert content['id'] == 1
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Tools'
+        assert content['parent_id'] is None
+        assert content['show_in_ui'] == True
+        assert content['slug'] == 'tools'
+        assert content['status_slug'] == 'open'
+        assert set(content['sub_content_type_slug']) == set(['thread', 'page', 'folder', 'file'])
+        assert content['workspace_id'] == 1
+        content = res[1]
+        assert content['id'] == 2
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Menus'
+        assert content['parent_id'] is None
+        assert content['show_in_ui'] == True
+        assert content['slug'] == 'menus'
+        assert content['status_slug'] == 'open'
+        assert set(content['sub_content_type_slug']) == set(['thread', 'page', 'folder', 'file'])
+        assert content['workspace_id'] == 1
+        content = res[2]
+        assert content['id'] == 11
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Current Menu'
+        assert content['parent_id'] == 2
+        assert content['show_in_ui'] == True
+        assert content['slug'] == 'current-menu'
+        assert content['status_slug'] == 'open'
+        assert set(content['sub_content_type_slug']) == set(['thread', 'page', 'folder', 'file'])
+        assert content['workspace_id'] == 1
 
     # Root related
 
@@ -267,8 +299,31 @@ class TestWorkspaceContents(FunctionalTest):
             params=params,
         ).json_body  # nopep8
         # TODO - G.M - 30-05-2018 - Check this test
-        raise NotImplementedError()
-
+        assert len(res) == 2
+        content = res[0]
+        assert content['id'] == 1
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Tools'
+        assert content['parent_id'] is None
+        assert content['show_in_ui'] == True
+        assert content['slug'] == 'tools'
+        assert content['status_slug'] == 'open'
+        assert set(content['sub_content_type_slug']) == set(['thread', 'page', 'folder', 'file'])
+        assert content['workspace_id'] == 1
+        content = res[1]
+        assert content['id'] == 2
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Menus'
+        assert content['parent_id'] is None
+        assert content['show_in_ui'] == True
+        assert content['slug'] == 'menus'
+        assert content['status_slug'] == 'open'
+        assert set(content['sub_content_type_slug']) == set(['thread', 'page', 'folder', 'file'])
+        assert content['workspace_id'] == 1
+
+    @pytest.mark.xfail()
     def test_api__get_workspace_content__ok_200__get_only_active_root_content(self):
         """
         Check obtain workspace root active contents
@@ -294,6 +349,7 @@ class TestWorkspaceContents(FunctionalTest):
         # TODO - G.M - 30-05-2018 - Check this test
         raise NotImplementedError()
 
+    @pytest.mark.xfail()
     def test_api__get_workspace_content__ok_200__get_only_archived_root_content(self):
         """
         Check obtain workspace root archived contents
@@ -319,6 +375,7 @@ class TestWorkspaceContents(FunctionalTest):
         # TODO - G.M - 30-05-2018 - Check this test
         raise NotImplementedError()
 
+    @pytest.mark.xfail()
     def test_api__get_workspace_content__ok_200__get_only_deleted_root_content(self):
         """
          Check obtain workspace root deleted contents
@@ -368,7 +425,7 @@ class TestWorkspaceContents(FunctionalTest):
             params=params,
         ).json_body  # nopep8
         # TODO - G.M - 30-05-2018 - Check this test
-        raise NotImplementedError()
+        assert res == []
 
     # Folder related
 
@@ -395,8 +452,20 @@ class TestWorkspaceContents(FunctionalTest):
             params=params,
         ).json_body   # nopep8
         # TODO - G.M - 30-05-2018 - Check this test
-        raise NotImplementedError()
-
+        assert len(res) == 1
+        content = res[0]
+        assert content['id'] == 11
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Current Menu'
+        assert content['parent_id'] == 2
+        assert content['show_in_ui'] == True
+        assert content['slug'] == 'current-menu'
+        assert content['status_slug'] == 'open'
+        assert set(content['sub_content_type_slug']) == set(['thread', 'page', 'folder', 'file'])
+        assert content['workspace_id'] == 1
+
+    @pytest.mark.xfail()
     def test_api__get_workspace_content__ok_200__get_only_active_folder_content(self):
         """
          Check obtain workspace folder active contents
@@ -422,6 +491,7 @@ class TestWorkspaceContents(FunctionalTest):
         # TODO - G.M - 30-05-2018 - Check this test
         raise NotImplementedError()
 
+    @pytest.mark.xfail()
     def test_api__get_workspace_content__ok_200__get_only_archived_folder_content(self):
         """
          Check obtain workspace folder archived contents
@@ -447,6 +517,7 @@ class TestWorkspaceContents(FunctionalTest):
         # TODO - G.M - 30-05-2018 - Check this test
         raise NotImplementedError()
 
+    @pytest.mark.xfail()
     def test_api__get_workspace_content__ok_200__get_only_deleted_folder_content(self):
         """
          Check obtain workspace folder deleted contents
@@ -496,7 +567,7 @@ class TestWorkspaceContents(FunctionalTest):
             params=params,
         ).json_body   # nopep8
         # TODO - G.M - 30-05-2018 - Check this test
-        raise NotImplementedError()
+        assert res == []
 
     # Error case
 
@@ -552,7 +623,3 @@ class TestWorkspaceContents(FunctionalTest):
         assert 'code' in res.json.keys()
         assert 'message' in res.json.keys()
         assert 'details' in res.json.keys()
-
-    def test_api_get_workspace_content__err_404__parent_id_does_not_exist(self):
-        # TODO - G.M - 30-05-2018 - Check this test
-        raise NotImplementedError()

tracim/views/core_api/schemas.py

@@ -5,7 +5,7 @@ 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
+from tracim.models.context_models import LoginCredentials, ContentFilter
 from tracim.models.data import UserRoleInWorkspace
 
 
@@ -85,8 +85,7 @@ class WorkspaceAndContentIdPathSchema(WorkspaceIdPathSchema, ContentIdPathSchema
     pass
 
 
-class FilterContentPathSchema(marshmallow.Schema):
-    workspace_id = marshmallow.fields.Int(example=4, required=True)
+class FilterContentQuerySchema(marshmallow.Schema):
     parent_id = workspace_id = marshmallow.fields.Int(
         example=2,
         default=None,
@@ -118,7 +117,9 @@ class FilterContentPathSchema(marshmallow.Schema):
                     'The reason for this parameter to exist is for example '
                     'to allow to show only archived documents'
     )
-
+    @post_load
+    def make_content_filter(self, data):
+        return ContentFilter(**data)
 ###
 
 
@@ -325,9 +326,8 @@ class ContentDigestSchema(marshmallow.Schema):
         example='htmlpage',
         validate=OneOf([content.slug for content in CONTENT_DEFAULT_TYPE]),
     )
-    sub_content_type_slug = marshmallow.fields.Nested(
-        ContentTypeSchema(only=('slug',)),
-        many=True,
+    sub_content_type_slug = marshmallow.fields.List(
+        marshmallow.fields.Str,
         description='list of content types allowed as sub contents. '
                     'This field is required for folder contents, '
                     'set it to empty list in other cases'

tracim/views/core_api/workspace_controller.py

@@ -3,10 +3,11 @@ import typing
 from pyramid.config import Configurator
 from sqlalchemy.orm.exc import NoResultFound
 
+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.context_models import WorkspaceInContext, \
-    UserRoleWorkspaceInContext
+    UserRoleWorkspaceInContext, ContentInContext
 from tracim.models.data import UserRoleInWorkspace
 
 try:  # Python 3.5+
@@ -21,7 +22,9 @@ 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
+    WorkspaceIdPathSchema, WorkspaceMemberSchema, \
+    WorkspaceAndContentIdPathSchema, FilterContentQuerySchema, \
+    ContentDigestSchema
 
 
 class WorkspaceController(Controller):
@@ -73,14 +76,55 @@ class WorkspaceController(Controller):
             for user_role in rapi.get_all_for_workspace(request.current_workspace)
         ]
 
+    @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.READER)
+    @hapic.input_path(WorkspaceIdPathSchema())
+    @hapic.input_query(FilterContentQuerySchema())
+    @hapic.output_body(ContentDigestSchema(many=True))
+    def workspace_content(
+            self,
+            context,
+            request: TracimRequest,
+            hapic_data=None,
+    ) -> typing.List[ContentInContext]:
+        """
+        return list of contents found in the workspace
+        """
+        #hapic_data.query=
+        app_config = request.registry.settings['CFG']
+        content_filter = hapic_data.query
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+            show_archived=content_filter.show_archived,
+            show_deleted=content_filter.show_deleted,
+            show_active=content_filter.show_active,
+        )
+        contents = api.get_all(
+            parent_id=content_filter.parent_id,
+            workspace=request.current_workspace,
+        )
+        contents = [
+            api.get_content_in_context(content) for content in contents
+        ]
+        return contents
+
     def bind(self, configurator: Configurator) -> None:
         """
         Create all routes and views using pyramid configurator
         for this controller
         """
 
-        # Applications
+        # Workspace
         configurator.add_route('workspace', '/workspaces/{workspace_id}', request_method='GET')  # nopep8
         configurator.add_view(self.workspace, route_name='workspace')
+        # Workspace Members (Roles)
         configurator.add_route('workspace_members', '/workspaces/{workspace_id}/members', request_method='GET')  # nopep8
         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