fix returned schema for adding member_role

tracim/lib/core/userworkspace.py

@@ -58,7 +58,9 @@ class RoleApi(object):
 
     def get_user_role_workspace_with_context(
             self,
-            user_role: UserRoleInWorkspace
+            user_role: UserRoleInWorkspace,
+            newly_created:bool = None,
+            email_sent: bool = None,
     ) -> UserRoleWorkspaceInContext:
         """
         Return WorkspaceInContext object from Workspace
@@ -68,6 +70,8 @@ class RoleApi(object):
             user_role=user_role,
             dbsession=self._session,
             config=self._config,
+            newly_created=newly_created,
+            email_sent=email_sent,
         )
         return workspace
 

tracim/models/context_models.py

@@ -310,10 +310,16 @@ class UserRoleWorkspaceInContext(object):
             user_role: UserRoleInWorkspace,
             dbsession: Session,
             config: CFG,
+            # Extended params
+            newly_created:bool = None,
+            email_sent: bool = None
     )-> None:
         self.user_role = user_role
         self.dbsession = dbsession
         self.config = config
+        # Extended params
+        self.newly_created = newly_created
+        self.email_sent = email_sent
 
     @property
     def user_id(self) -> int:

tracim/tests/functional/test_workspaces.py

@@ -376,6 +376,8 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['role'] == 'content-manager'
         assert user_role_found['user_id'] == 2
         assert user_role_found['workspace_id'] == 1
+        assert user_role_found['newly_created'] is False
+        assert user_role_found['email_sent'] is False
 
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
@@ -384,7 +386,9 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
         user_role = res[1]
-        assert user_role_found == user_role
+        assert user_role_found['role'] == user_role['role']
+        assert user_role_found['user_id'] == user_role['user_id']
+        assert user_role_found['workspace_id'] == user_role['workspace_id']
 
     def test_api__create_workspace_member_role__ok_200__user_email(self):
         """
@@ -413,6 +417,8 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['role'] == 'content-manager'
         assert user_role_found['user_id'] == 2
         assert user_role_found['workspace_id'] == 1
+        assert user_role_found['newly_created'] is False
+        assert user_role_found['email_sent'] is False
 
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
@@ -421,7 +427,9 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
         user_role = res[1]
-        assert user_role_found == user_role
+        assert user_role_found['role'] == user_role['role']
+        assert user_role_found['user_id'] == user_role['user_id']
+        assert user_role_found['workspace_id'] == user_role['workspace_id']
 
     def test_api__create_workspace_member_role__ok_200__user_public_name(self):
         """
@@ -450,6 +458,8 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['role'] == 'content-manager'
         assert user_role_found['user_id'] == 2
         assert user_role_found['workspace_id'] == 1
+        assert user_role_found['newly_created'] is False
+        assert user_role_found['email_sent'] is False
 
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
@@ -458,7 +468,9 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
         user_role = res[1]
-        assert user_role_found == user_role
+        assert user_role_found['role'] == user_role['role']
+        assert user_role_found['user_id'] == user_role['user_id']
+        assert user_role_found['workspace_id'] == user_role['workspace_id']
 
     def test_api__create_workspace_member_role__err_400__nothing(self):
         """
@@ -531,6 +543,25 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             status=200,
             params=params,
         )
+        user_role_found = res.json_body
+        assert user_role_found['role'] == 'content-manager'
+        assert user_role_found['user_id']
+        user_id = user_role_found['user_id']
+        assert user_role_found['workspace_id'] == 1
+        assert user_role_found['newly_created'] is True
+        assert user_role_found['email_sent'] is False
+
+        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'] == 'workspace-manager'
+        assert user_role['user_id'] == 1
+        assert user_role['workspace_id'] == 1
+        user_role = res[1]
+        assert user_role_found['role'] == user_role['role']
+        assert user_role_found['user_id'] == user_role['user_id']
+        assert user_role_found['workspace_id'] == user_role['workspace_id']
 
     def test_api__update_workspace_member_role__ok_200__nominal_case(self):
         """

tracim/views/core_api/schemas.py

@@ -301,6 +301,20 @@ class WorkspaceMemberSchema(marshmallow.Schema):
         description = 'Workspace Member information'
 
 
+class WorkspaceMemberCreationSchema(WorkspaceMemberSchema):
+    newly_created = marshmallow.fields.Bool(
+        exemple=False,
+        description='Is the user completely new '
+                    '(and account was just created) or not ?',
+    )
+    email_sent = marshmallow.fields.Bool(
+        exemple=False,
+        description='Has an email been sent to user to inform him about '
+                    'this new workspace registration and eventually his account'
+                    'creation'
+    )
+
+
 class ApplicationConfigSchema(marshmallow.Schema):
     pass
     #  TODO - G.M - 24-05-2018 - Set this

tracim/views/core_api/workspace_controller.py

@@ -30,6 +30,7 @@ from tracim.exceptions import UserDoesNotExist
 from tracim.exceptions import WorkspacesDoNotMatch
 from tracim.views.controllers import Controller
 from tracim.views.core_api.schemas import FilterContentQuerySchema
+from tracim.views.core_api.schemas import WorkspaceMemberCreationSchema
 from tracim.views.core_api.schemas import WorkspaceMemberInviteSchema
 from tracim.views.core_api.schemas import RoleUpdateSchema
 from tracim.views.core_api.schemas import WorkspaceCreationSchema
@@ -176,7 +177,7 @@ class WorkspaceController(Controller):
     @require_workspace_role(UserRoleInWorkspace.WORKSPACE_MANAGER)
     @hapic.input_path(WorkspaceIdPathSchema())
     @hapic.input_body(WorkspaceMemberInviteSchema())
-    @hapic.output_body(WorkspaceMemberSchema())
+    @hapic.output_body(WorkspaceMemberCreationSchema())
     def create_workspaces_members_role(
             self,
             context,
@@ -186,6 +187,8 @@ class WorkspaceController(Controller):
         """
         Add Members to this workspace
         """
+        newly_created = False
+        email_sent = False
         app_config = request.registry.settings['CFG']
         rapi = RoleApi(
             current_user=request.current_user,
@@ -211,6 +214,7 @@ class WorkspaceController(Controller):
                     hapic_data.body.user_email_or_public_name,
                     do_notify=False
                 )  # nopep8
+                newly_created = True
             except EmailValidationFailed:
                 raise UserCreationFailed('no valid mail given')
         role = rapi.create_one(
@@ -220,7 +224,11 @@ class WorkspaceController(Controller):
             with_notif=False,
             flush=True,
         )
-        return rapi.get_user_role_workspace_with_context(role)
+        return rapi.get_user_role_workspace_with_context(
+            role,
+            newly_created=newly_created,
+            email_sent=email_sent,
+        )
 
     @hapic.with_api_doc(tags=[WORKSPACE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)