Merge branch 'fix/better_api_doc' of github.com:tracim/tracim_backend into fix/few_more_tests

requirements.txt

@@ -0,0 +1,73 @@
+alembic==0.9.9
+atomicwrites==1.1.5
+attrs==18.1.0
+Babel==2.6.0
+beautifulsoup4==4.6.0
+certifi==2018.4.16
+chardet==3.0.4
+click==6.7
+cliff==2.12.0
+cmd2==0.9.1
+colorama==0.3.9
+coverage==4.5.1
+defusedxml==0.5.0
+filedepot==0.5.2
+hapic==0.42
+hapic-apispec==0.37.0
+hupper==1.3
+idna==2.7
+Jinja2==2.10
+jsmin==2.2.2
+lxml==4.2.1
+Mako==1.0.7
+MarkupSafe==1.0
+marshmallow==2.15.3
+more-itertools==4.2.0
+multidict==4.3.1
+mypy==0.610
+PasteDeploy==1.5.2
+pbr==4.0.4
+pep8==1.7.1
+pkg-resources==0.0.0
+plaster==1.0
+plaster-pastedeploy==0.5
+pluggy==0.6.0
+prettytable==0.7.2
+psycopg2==2.7.4
+py==1.5.3
+Pygments==2.2.0
+pyparsing==2.2.0
+pyperclip==1.6.2
+pyramid==1.9.2
+pyramid-debugtoolbar==4.4
+pyramid-jinja2==2.7
+pyramid-mako==1.0.2
+pyramid-retry==0.5
+pyramid-tm==2.2
+pytest==3.6.1
+pytest-cov==2.5.1
+python-dateutil==2.7.3
+python-editor==1.0.3
+pytz==2018.4
+PyYAML==3.12
+redis==2.10.6
+repoze.lru==0.7
+requests==2.19.1
+rq==0.11.0
+six==1.11.0
+SQLAlchemy==1.2.8
+stevedore==1.28.0
+transaction==2.2.1
+translationstring==1.3
+typed-ast==1.1.0
+Unidecode==1.0.22
+urllib3==1.23
+venusian==1.1.0
+waitress==1.1.0
+wcwidth==0.1.7
+WebOb==1.8.2
+WebTest==2.0.29
+WsgiDAV==2.4.0
+zope.deprecation==4.3.0
+zope.interface==4.5.0
+zope.sqlalchemy==1.0

tracim/lib/utils/request.py

@@ -1,11 +1,7 @@
 # -*- coding: utf-8 -*-
-"""
-TracimRequest and related functions
-"""
 from pyramid.request import Request
 from sqlalchemy.orm.exc import NoResultFound
 
-
 from tracim.exceptions import NotAuthenticated
 from tracim.exceptions import UserNotFoundInTracimRequest
 from tracim.exceptions import UserDoesNotExist
@@ -46,7 +42,7 @@ class TracimRequest(Request):
 
         # User found from request headers, content, distinct from authenticated
         # user
-        self._user_candidate = None  # type: User
+        self._candidate_user = None  # type: User
 
         # INFO - G.M - 18-05-2018 - Close db at the end of the request
         self.add_finished_callback(self._cleanup)
@@ -60,7 +56,7 @@ class TracimRequest(Request):
         :return: Workspace of the request
         """
         if self._current_workspace is None:
-            self.current_workspace = get_workspace(self.current_user, self)
+            self.current_workspace = self._get_workspace(self.current_user, self)
         return self._current_workspace
 
     @current_workspace.setter
@@ -82,7 +78,7 @@ class TracimRequest(Request):
         Get user from authentication mecanism.
         """
         if self._current_user is None:
-            self.current_user = get_auth_safe_user(self)
+            self.current_user = self._get_auth_safe_user(self)
         return self._current_user
 
     @current_user.setter
@@ -102,9 +98,9 @@ class TracimRequest(Request):
         can help user to know about who one page is about in
         a similar way as current_workspace.
         """
-        if self._user_candidate is None:
-            self.candidate_user = get_candidate_user(self)
-        return self._user_candidate
+        if self._candidate_user is None:
+            self.candidate_user = self._get_candidate_user(self)
+        return self._candidate_user
 
     def _cleanup(self, request: 'TracimRequest') -> None:
         """
@@ -122,86 +118,87 @@ class TracimRequest(Request):
 
     @candidate_user.setter
     def candidate_user(self, user: User) -> None:
-        if self._user_candidate is not None:
+        if self._candidate_user is not None:
             raise ImmutableAttribute(
                 "Can't modify already setted candidate_user"
             )
-        self._user_candidate = user
-###
-# Utils for TracimRequest
-###
+        self._candidate_user = user
 
+    ###
+    # Utils for TracimRequest
+    ###
 
-def get_candidate_user(
-        request: TracimRequest
-) -> User:
-    """
-    Get candidate user
-    :param request: pyramid request
-    :return: user found from header/body
-    """
-    app_config = request.registry.settings['CFG']
-    uapi = UserApi(None, session=request.dbsession, config=app_config)
-
-    try:
-        login = None
-        if 'user_id' in request.matchdict:
-            login = request.matchdict['user_id']
-        if not login:
-            raise UserNotFoundInTracimRequest('You request a candidate user but the context not permit to found one')  # nopep8
-        user = uapi.get_one(login)
-    except UserNotFoundInTracimRequest as exc:
-        raise UserDoesNotExist('User {} not found'.format(login)) from exc
-    return user
-
-
-def get_auth_safe_user(
-        request: TracimRequest,
-) -> User:
-    """
-    Get current pyramid authenticated user from request
-    :param request: pyramid request
-    :return: current authenticated user
-    """
-    app_config = request.registry.settings['CFG']
-    uapi = UserApi(None, session=request.dbsession, config=app_config)
-    try:
-        login = request.authenticated_userid
-        if not login:
-            raise UserNotFoundInTracimRequest('You request a current user but the context not permit to found one')  # nopep8
-        user = uapi.get_one_by_email(login)
-    except (UserDoesNotExist, UserNotFoundInTracimRequest) as exc:
-        raise NotAuthenticated('User {} not found'.format(login)) from exc
-    return user
-
-
-def get_workspace(
-        user: User,
-        request: TracimRequest
-) -> Workspace:
-    """
-    Get current workspace from request
-    :param user: User who want to check the workspace
-    :param request: pyramid request
-    :return: current workspace
-    """
-    workspace_id = ''
-    try:
-        if 'workspace_id' in request.matchdict:
-            workspace_id = request.matchdict['workspace_id']
-        if not workspace_id:
-            raise WorkspaceNotFound('No workspace_id property found in request')
-        wapi = WorkspaceApi(
-            current_user=user,
-            session=request.dbsession,
-            config=request.registry.settings['CFG']
-        )
-        workspace = wapi.get_one(workspace_id)
-    except JSONDecodeError:
-        raise WorkspaceNotFound('Bad json body')
-    except NoResultFound:
-        raise WorkspaceNotFound(
-            'Workspace {} does not exist '
-            'or is not visible for this user'.format(workspace_id)
-        )
-    return workspace
+    def _get_candidate_user(
+            self,
+            request: 'TracimRequest',
+    ) -> User:
+        """
+        Get candidate user
+        :param request: pyramid request
+        :return: user found from header/body
+        """
+        app_config = request.registry.settings['CFG']
+        uapi = UserApi(None, session=request.dbsession, config=app_config)
+
+        try:
+            login = None
+            if 'user_id' in request.matchdict:
+                login = request.matchdict['user_id']
+            if not login:
+                raise UserNotFoundInTracimRequest('You request a candidate user but the context not permit to found one')  # nopep8
+            user = uapi.get_one(login)
+        except UserNotFoundInTracimRequest as exc:
+            raise UserDoesNotExist('User {} not found'.format(login)) from exc
+        return user
+
+    def _get_auth_safe_user(
+            self,
+            request: 'TracimRequest',
+    ) -> User:
+        """
+        Get current pyramid authenticated user from request
+        :param request: pyramid request
+        :return: current authenticated user
+        """
+        app_config = request.registry.settings['CFG']
+        uapi = UserApi(None, session=request.dbsession, config=app_config)
+        try:
+            login = request.authenticated_userid
+            if not login:
+                raise UserNotFoundInTracimRequest('You request a current user but the context not permit to found one')  # nopep8
+            user = uapi.get_one_by_email(login)
+        except (UserDoesNotExist, UserNotFoundInTracimRequest) as exc:
+            raise NotAuthenticated('User {} not found'.format(login)) from exc
+        return user
+
+    def _get_workspace(
+            self,
+            user: User,
+            request: 'TracimRequest'
+    ) -> Workspace:
+        """
+        Get current workspace from request
+        :param user: User who want to check the workspace
+        :param request: pyramid request
+        :return: current workspace
+        """
+        workspace_id = ''
+        try:
+            if 'workspace_id' in request.matchdict:
+                workspace_id = request.matchdict['workspace_id']
+            if not workspace_id:
+                raise WorkspaceNotFound('No workspace_id property found in request')
+            wapi = WorkspaceApi(
+                current_user=user,
+                session=request.dbsession,
+                config=request.registry.settings['CFG']
+            )
+            workspace = wapi.get_one(workspace_id)
+        except JSONDecodeError:
+            raise WorkspaceNotFound('Bad json body')
+        except NoResultFound:
+            raise WorkspaceNotFound(
+                'Workspace {} does not exist '
+                'or is not visible for this user'.format(workspace_id)
+            )
+        return workspace

tracim/models/data.py

@@ -130,13 +130,12 @@ class UserRoleInWorkspace(DeclarativeBase):
     CONTENT_MANAGER = 4
     WORKSPACE_MANAGER = 8
 
-    # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
     SLUG = {
-        NOT_APPLICABLE: 'not_applicable',
+        NOT_APPLICABLE: 'not-applicable',
         READER: 'reader',
         CONTRIBUTOR: 'contributor',
-        CONTENT_MANAGER: 'content_manager',
-        WORKSPACE_MANAGER: 'workspace_manager',
+        CONTENT_MANAGER: 'content-manager',
+        WORKSPACE_MANAGER: 'workspace-manager',
     }
 
     LABEL = dict()
@@ -145,6 +144,7 @@ class UserRoleInWorkspace(DeclarativeBase):
     LABEL[2] = l_('Contributor')
     LABEL[4] = l_('Content Manager')
     LABEL[8] = l_('Workspace Manager')
+    # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
     #
     # STYLE = dict()
     # STYLE[0] = ''

tracim/tests/functional/test_system.py

@@ -1,11 +1,11 @@
 # coding=utf-8
+from tracim.tests import FunctionalTest
+
 """
 Tests for /api/v2/system subpath endpoints.
 """
-from tracim.tests import FunctionalTest
-
 
-class TestApplicationsEndpoint(FunctionalTest):
+class TestApplicationEndpoint(FunctionalTest):
     """
     Tests for /api/v2/system/applications
     """

tracim/tests/functional/test_workspaces.py

@@ -155,7 +155,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
         user_role = res[0]
-        assert user_role['role_slug'] == 'workspace_manager'
+        assert user_role['role_slug'] == 'workspace-manager'
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
         assert user_role['user']['display_name'] == 'Global manager'