Feature/598 comment htmlpage thread contents endpoints #91

inkhey · 2018-06-21T14:56:29Z

require #88

add endpoint for comments: get/add/delete + test related
add endpoint for html_content + test related
add endpoint for threads + test related

Bug/Missing:

decide and active right protection for get/add/delete comments (see User role definition is not clear (v1) tracim#590)
Owner of content is broken, we should have correct owner/last_modifier("owner" should be different from "last_modifier" tracim#606), actually those 2 params return the same user.
Comments not related to a specific revision (Allow to attach comment to a specified revision + fix "Comments_ids" param in revision tracim#601), comments_ids params in revisions is returned as always empty.

Others:

Docs for roles and right access logic of tracim.
Workspace endpoint right corrected.
Fix 'page' -> 'html_documents' slug +retrocompat.(convert "page" content type into 'html-document" tracim#597)
Fix url for frontend

closes tracim/tracim#598
closes tracim/tracim#601
closes tracim/tracim#606
closes tracim/tracim#597

coveralls · 2018-06-21T15:09:15Z

Pull Request Test Coverage Report for Build 264

510 of 517 (98.65%) changed or added relevant lines in 20 files are covered.
7 unchanged lines in 3 files lost coverage.
Overall coverage increased (+1.07%) to 83.949%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tracim/models/context_models.py	28	29	96.55%
tracim/lib/utils/authorization.py	11	12	91.67%
tracim/lib/core/content.py	14	16	87.5%
tracim/lib/utils/request.py	21	24	87.5%

Files with Coverage Reduction	New Missed Lines	%
tracim/lib/core/content.py	1	72.66%
tracim/models/context_models.py	1	97.59%
tracim/lib/utils/request.py	5	87.5%

Totals
Change from base Build 236:	1.07%
Covered Lines:	6391
Relevant Lines:	7613

💛 - Coveralls

coveralls · 2018-06-21T15:09:15Z

Pull Request Test Coverage Report for Build 305

1225 of 1260 (97.22%) changed or added relevant lines in 27 files are covered.
30 unchanged lines in 7 files lost coverage.
Overall coverage increased (+2.3%) to 85.499%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tracim/lib/core/content.py	18	20	90.0%
tracim/lib/utils/authorization.py	45	47	95.74%
tracim/views/contents_api/html_document_controller.py	105	107	98.13%
tracim/views/contents_api/comment_controller.py	80	82	97.56%
tracim/views/contents_api/threads_controller.py	104	106	98.11%
tracim/models/context_models.py	121	124	97.58%
tracim/lib/utils/request.py	44	66	66.67%

Files with Coverage Reduction	New Missed Lines	%
tracim/lib/utils/request.py	1	82.14%
tracim/lib/utils/authorization.py	2	94.62%
tracim/views/core_api/session_controller.py	2	100.0%
tracim/views/core_api/system_controller.py	2	100.0%
tracim/views/core_api/user_controller.py	2	100.0%
tracim/views/core_api/workspace_controller.py	2	100.0%
tracim/command/database.py	19	33.33%

Totals
Change from base Build 272:	2.3%
Covered Lines:	7305
Relevant Lines:	8544

💛 - Coveralls

…r instead of contributor for few view)

This reverts commit e2edf42.

lebouquetin · 2018-07-02T13:21:12Z

README.md

@@ -152,6 +152,13 @@ For example, with default config:
    # launch your favorite web-browser
    firefox http://localhost:6543/api/v2/doc/

+## Roles, profile and access rights
+
+In Tracim, only some user can access to some informations, this is also true in


this is also true in Tracim REST API => this is checked at REST API layer

This should also be checked in webdav layer.

actually, it MUST be check in webdav layer too. It's implemented or not?

I should check this better, but i do think there is actually only restriction on visible workspaces according to user.

tracim/tracim#616

lebouquetin · 2018-07-02T13:23:38Z

tracim/fixtures/content.py

+        )
+        bob_content_api.create_comment(
+            parent=best_cake_thread,
+            content='<p>What about Apple Pie ? There are Awesome !</p>',


in English, there's no space before punctuation : What about Apple Pie ? There are Awesome ! => What about Apple Pie? There are Awesome!

lebouquetin · 2018-07-02T13:23:47Z

tracim/fixtures/content.py

+        )
+        reader_content_api.create_comment(
+            parent=best_cake_thread,
+            content='<p>You are right, but Kouign-amann are clearly better.</p>',


I do not understand this one, content selection is maybe uncorrect .

lebouquetin · 2018-07-02T13:24:18Z

tracim/fixtures/content.py

+        ):
+            bob_content_api.update_content(
+                item=best_cake_thread,
+                new_content='What is the best cake ?',


same remark

lebouquetin · 2018-07-02T13:25:11Z

tracim/lib/core/content.py

@@ -161,6 +164,10 @@ def show(
    def get_content_in_context(self, content: Content):
        return ContentInContext(content, self._session, self._config)

+    def get_revision_in_context(self, revision: ContentRevisionRO):


missing typing

lebouquetin · 2018-07-02T16:24:38Z

tracim/views/core_api/schemas.py

+    author = marshmallow.fields.Nested(UserDigestSchema)
+
+
+class ThreadRevisionSchema(RevisionSchema):


same remark. Define a unique TextBasedContentRevisionSchema used in place of ThreadRevisionSchema and HtmlDocumentRevisionSchema

tracim/tracim#618

lebouquetin · 2018-07-02T16:25:24Z

tracim/views/core_api/schemas.py

+
+####
+
+class CommentSchema(marshmallow.Schema):


CommentSchema can be overwritten with TextBasedContentSchema, doesnt it ?

Probably, tracim/tracim#618

lebouquetin · 2018-07-02T16:26:30Z

tracim/views/core_api/schemas.py

+    )
+
+
+class ContentModifySchema(marshmallow.Schema):


If the schema is not intended to be used as is, maybe rename it to something more clear. ContentModifyAbstractSchema ?

to be done here : tracim/tracim#618

lebouquetin · 2018-07-02T16:28:37Z

tracim/views/core_api/schemas.py

+    )
+
+
+class HtmlDocumentModifySchema(ContentModifySchema):


This schema is to rename to TextBasedContentModifySchema and to use in place of HTMLDocumentUpdate and ThreadUpdate

to be done in same time as tracim/tracim#618

lebouquetin · 2018-07-02T16:30:19Z

tracim/views/contents_api/comment_controller.py

+
+    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.handle_exception(NotAuthenticated, HTTPStatus.UNAUTHORIZED)
+    @hapic.handle_exception(InsufficientUserWorkspaceRole, HTTPStatus.FORBIDDEN)


InsufficientUserWorkspaceRole is probably to rename to InsufficientUserRoleInWorkspace. The reason for that is "it's understandable as naturally read"

inkhey added 2 commits June 21, 2018 11:02

add new schemas

c87cf3c

add endpoint and tests for comments of contents

9baf28f

inkhey added 13 commits June 22, 2018 16:59

add endpoints for html_documents

46bf33d

pep8

7e879db

fix role for set content

5a2a0b3

add thread endpoints

caccbc0

better doc for schema

01ed587

[#606] fix last_modifier and author should not be the same.

e12133f

[#601] fix 'created' field and comments_ids fields for revisions

aa7730c

Add role documentation

aeab83c

fix access for deleting comments + other access troube

adfa178

fix access in content_view (handle correct exception + content_manage…

d393890

…r instead of contributor for few view)

convert slug page to html-documents

a05c27a

rename htmlpage to html-documents

8ab1bc2

add retrocompatibility with old 'page' slug + tests

e58d961

inkhey changed the title ~~WIP: Feature/598 comment htmlpage thread contents endpoints~~ Feature/598 comment htmlpage thread contents endpoints Jun 28, 2018

doc+renaming

1736af9

inkhey mentioned this pull request Jun 28, 2018

"owner" should be different from "last_modifier" tracim/tracim#606

Closed

add created datetime in comment schema

b702874

This was referenced Jun 28, 2018

Refactoring + new exceptions correctly handled #93

Merged

Fix/simple webdav fix #94

Merged

inkhey changed the title ~~Feature/598 comment htmlpage thread contents endpoints~~ WIP:Feature/598 comment htmlpage thread contents endpoints Jun 29, 2018

fixed urls for frontend. Removed '/#'

e2edf42

inkhey changed the title ~~WIP:Feature/598 comment htmlpage thread contents endpoints~~ Feature/598 comment htmlpage thread contents endpoints Jun 29, 2018

fixed color and font awesome icons

6f2cdfb

inkhey changed the title ~~Feature/598 comment htmlpage thread contents endpoints~~ WIP:Feature/598 comment htmlpage thread contents endpoints Jun 29, 2018

Skylsmoi changed the title ~~WIP:Feature/598 comment htmlpage thread contents endpoints~~ Feature/598 comment htmlpage thread contents endpoints Jul 2, 2018

Revert "fixed urls for frontend. Removed '/#'"

1e31c58

This reverts commit e2edf42.

inkhey mentioned this pull request Jul 2, 2018

WIP: Feature/611 workspace and workspace member action endpoints #95

Merged

7 tasks

lebouquetin suggested changes Jul 2, 2018

View reviewed changes

Skylsmoi and others added 16 commits July 3, 2018 11:04

added some missing font awesome icons

1f34921

no space before punctuation in English

e8732cb

typing + rename as private

6e9485c

better typing + pep8

31fc4e8

clearer exception with chaining

11fa78c

doc,typing,cleaning

b84e5c0

refactoring comment_ids

13e30c8

renaming tests

ba2d51c

authentificationfailed is forbidden

83c8bf3

one datetime format

e1a4cbe

typing

c6db07d

one import per line

31262c1

html-documents as exemple

78f26e9

rename exception

d055b04

fix tests

59ec21e

best english

3a14460

lebouquetin merged commit 6056263 into develop Jul 4, 2018

inkhey deleted the feature/598_comment_htmlpage_thread_contents_endpoints branch July 17, 2018 14:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/598 comment htmlpage thread contents endpoints #91

Feature/598 comment htmlpage thread contents endpoints #91

inkhey commented Jun 21, 2018 •

edited

Loading

coveralls commented Jun 21, 2018

coveralls commented Jun 21, 2018 •

edited

Loading

lebouquetin Jul 2, 2018

inkhey Jul 3, 2018

lebouquetin Jul 3, 2018

inkhey Jul 3, 2018

inkhey Jul 3, 2018

lebouquetin Jul 2, 2018

lebouquetin Jul 2, 2018

inkhey Jul 3, 2018

lebouquetin Jul 2, 2018

lebouquetin Jul 2, 2018

lebouquetin Jul 2, 2018

inkhey Jul 3, 2018

lebouquetin Jul 2, 2018

inkhey Jul 3, 2018

lebouquetin Jul 2, 2018

inkhey Jul 3, 2018

lebouquetin Jul 2, 2018

inkhey Jul 3, 2018

lebouquetin Jul 2, 2018

		author = marshmallow.fields.Nested(UserDigestSchema)


		class ThreadRevisionSchema(RevisionSchema):

Feature/598 comment htmlpage thread contents endpoints #91

Feature/598 comment htmlpage thread contents endpoints #91

Conversation

inkhey commented Jun 21, 2018 • edited Loading

coveralls commented Jun 21, 2018

Pull Request Test Coverage Report for Build 264

💛 - Coveralls

coveralls commented Jun 21, 2018 • edited Loading

Pull Request Test Coverage Report for Build 305

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

inkhey commented Jun 21, 2018 •

edited

Loading

coveralls commented Jun 21, 2018 •

edited

Loading