add content_filter to workspace_content endpoint

tracim/lib/core/content.py

@@ -713,8 +713,8 @@ class ContentApi(object):
 
     def get_all(self, parent_id: int=None, content_type: str=ContentType.Any, workspace: Workspace=None) -> typing.List[Content]:
         assert parent_id is None or isinstance(parent_id, int) # DYN_REMOVE
-        assert content_type is not None# DYN_REMOVE
-        assert isinstance(content_type, str) # DYN_REMOVE
+        if not content_type:
+            content_type = ContentType.Any
 
         resultset = self._base_query(workspace)
 

tracim/models/contents.py

@@ -261,6 +261,15 @@ class ContentTypeLegacy(NewContentType):
         return contents_types
 
     @classmethod
+    def allowed_type_values(cls) -> typing.List[str]:
+        """
+        All content type slug + special values like any
+        """
+        content_types = cls.allowed_types()
+        content_types.append(ContentTypeLegacy.Any)
+        return content_types
+
+    @classmethod
     def allowed_types_for_folding(cls):
         # This method is used for showing only "main"
         # types in the left-side treeview

tracim/models/context_models.py

@@ -68,11 +68,13 @@ class ContentFilter(object):
             show_archived: int = 0,
             show_deleted: int = 0,
             show_active: int = 1,
+            content_type: str = None,
     ) -> None:
         self.parent_id = parent_id
         self.show_archived = bool(show_archived)
         self.show_deleted = bool(show_deleted)
         self.show_active = bool(show_active)
+        self.content_type = content_type
 
 
 class ContentCreation(object):

tracim/tests/functional/test_workspaces.py

@@ -241,6 +241,7 @@ class TestWorkspaceContents(FunctionalTest):
         assert len(res) == 3
         content = res[0]
         assert content['content_id'] == 1
+        assert content['content_type'] == 'folder'
         assert content['is_archived'] is False
         assert content['is_deleted'] is False
         assert content['label'] == 'Tools'
@@ -252,6 +253,7 @@ class TestWorkspaceContents(FunctionalTest):
         assert content['workspace_id'] == 1
         content = res[1]
         assert content['content_id'] == 2
+        assert content['content_type'] == 'folder'
         assert content['is_archived'] is False
         assert content['is_deleted'] is False
         assert content['label'] == 'Menus'
@@ -263,6 +265,37 @@ class TestWorkspaceContents(FunctionalTest):
         assert content['workspace_id'] == 1
         content = res[2]
         assert content['content_id'] == 11
+        assert content['content_type'] == 'html-documents'
+        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'] is True
+        assert content['slug'] == 'current-menu'
+        assert content['status'] == 'open'
+        assert set(content['sub_content_types']) == {'thread', 'html-documents', 'folder', 'file'}  # nopep8
+        assert content['workspace_id'] == 1
+
+    def test_api__get_workspace_content__ok_200__get_default_html_documents(self):
+        """
+        Check obtain workspace contents with defaults filters + content_filter
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        params = {
+            'content_type': 'html-documents',
+        }
+        res = self.testapp.get('/api/v2/workspaces/1/contents', status=200, params=params).json_body   # nopep8
+        assert len(res) == 1
+        content = res[0]
+        assert content
+        assert content['content_id'] == 11
+        assert content['content_type'] == 'html-documents'
         assert content['is_archived'] is False
         assert content['is_deleted'] is False
         assert content['label'] == 'Current Menu'
@@ -549,6 +582,7 @@ class TestWorkspaceContents(FunctionalTest):
             'show_archived': 1,
             'show_deleted': 1,
             'show_active': 1,
+            'content_type': 'any'
         }
         self.testapp.authorization = (
             'Basic',

tracim/views/core_api/schemas.py

@@ -142,6 +142,11 @@ class FilterContentQuerySchema(marshmallow.Schema):
                     'The reason for this parameter to exist is for example '
                     'to allow to show only archived documents'
     )
+    content_type = marshmallow.fields.String(
+        example=ContentType.Any,
+        default=ContentType.Any,
+        validate=OneOf(ContentType.allowed_type_values())
+    )
 
     @post_load
     def make_content_filter(self, data):

tracim/views/core_api/workspace_controller.py

@@ -107,6 +107,7 @@ class WorkspaceController(Controller):
         contents = api.get_all(
             parent_id=content_filter.parent_id,
             workspace=request.current_workspace,
+            content_type=content_filter.content_type,
         )
         contents = [
             api.get_content_in_context(content) for content in contents