Merge pull request #517 from topcoder-platform/feature/restful-invites

Restful Invites

Author: maxceem

docs/Project API.postman_collection.json

@@ -2890,7 +2890,7 @@ paths:
             example:
               'work.create': true
               'workItem.edit': true
-                    
+
         '401':
           description: Unauthorized
           schema:
@@ -3519,31 +3519,26 @@ paths:
           description: Internal Server Error
           schema:
             $ref: '#/definitions/ErrorModel'
-  '/projects/{projectId}/members/invite':
+  '/projects/{projectId}/invites':
     get:
       tags:
         - project member invite
-      operationId: getCurrentUserInvite
+      operationId: listProjectInvites
       security:
         - Bearer: []
-      description: Retrieve the invite for current user.
+      description: >-
+        If user can "view" this project, he/she can get all invitations.
+        Otherwise user can only see his/her own invitation in this project.
+        If user has no invitation in this project or this project doesn't exist, an empty array will be returned.
       parameters:
         - $ref: '#/parameters/projectIdParam'
       responses:
         '200':
           description: The invite for current user
           schema:
-            $ref: '#/definitions/ProjectMemberInviteSuccessAndFailure'
-        '400':
-          description: Bad request
-          schema:
-            $ref: '#/definitions/ErrorModel'
-        '401':
-          description: Unauthorized
-          schema:
-            $ref: '#/definitions/ErrorModel'
-        '404':
-          description: Invite not found
+            $ref: '#/definitions/ProjectMemberInviteListResult'
+        '403':
+          description: Forbidden
           schema:
             $ref: '#/definitions/ErrorModel'
         '500':
@@ -3567,27 +3562,54 @@ paths:
           schema:
             $ref: '#/definitions/AddProjectMemberInvitesRequest'
       responses:
-        '200':
-          description: Returns the newly created invite
+        '201':
+          description: Created
           schema:
             $ref: '#/definitions/ProjectMemberInviteSuccessAndFailure'
         '400':
           description: Bad request
           schema:
             $ref: '#/definitions/ErrorModel'
-        '401':
-          description: Unauthorized
+        '403':
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/ErrorModel'
+        '500':
+          description: Internal Server Error
           schema:
             $ref: '#/definitions/ErrorModel'
+  '/projects/{projectId}/invites/{inviteId}':
+    get:
+      tags:
+        - project member invite
+      operationId: getProjectMemberInvite
+      security:
+        - Bearer: []
+      description: >-
+        Get an invite. Users who can "view" this project can see this invitation.
+        User got invited by this inviteId can also see this invitation.
+        If project/invitation doesn't exist, or this invitation is not for logged-in user, it will return 404 response.
+      parameters:
+        - $ref: '#/parameters/projectIdParam'
+        - $ref: '#/parameters/inviteIdParam'
+      responses:
+        '200':
+          description: Returns the newly updated invite
+          schema:
+            $ref: '#/definitions/ProjectMemberInvite'
         '403':
           description: Forbidden
           schema:
             $ref: '#/definitions/ErrorModel'
+        '404':
+          description: Not Found
+          schema:
+            $ref: '#/definitions/ErrorModel'
         '500':
           description: Internal Server Error
           schema:
             $ref: '#/definitions/ErrorModel'
-    put:
+    patch:
       tags:
         - project member invite
       operationId: updateProjectMemberInvite
@@ -3598,6 +3620,7 @@ paths:
         restriction will be applied based on role to be updated.
       parameters:
         - $ref: '#/parameters/projectIdParam'
+        - $ref: '#/parameters/inviteIdParam'
         - in: body
           name: body
           required: true
@@ -3607,19 +3630,50 @@ paths:
         '200':
           description: Returns the newly updated invite
           schema:
-            $ref: '#/definitions/ProjectMemberInviteSuccessAndFailure'
+            $ref: '#/definitions/ProjectMemberInvite'
         '400':
           description: Bad request
           schema:
             $ref: '#/definitions/ErrorModel'
-        '401':
-          description: Unauthorized
+        '403':
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/ErrorModel'
+        '404':
+          description: Not Found
+          schema:
+            $ref: '#/definitions/ErrorModel'
+        '500':
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/ErrorModel'
+    delete:
+      tags:
+        - project member invite
+      operationId: deleteProjectMemberInvite
+      security:
+        - Bearer: []
+      description: >-
+        Cancel an invite. All users who can access this endpoint, however more
+        restriction will be applied based on role to be cancelled.
+      parameters:
+        - $ref: '#/parameters/projectIdParam'
+        - $ref: '#/parameters/inviteIdParam'
+      responses:
+        '204':
+          description: Cancel success
+        '400':
+          description: Bad request
           schema:
             $ref: '#/definitions/ErrorModel'
         '403':
           description: Forbidden
           schema:
             $ref: '#/definitions/ErrorModel'
+        '404':
+          description: Not Found
+          schema:
+            $ref: '#/definitions/ErrorModel'
         '500':
           description: Internal Server Error
           schema:
@@ -4794,6 +4848,13 @@ parameters:
     required: true
     type: integer
     format: int64
+  inviteIdParam:
+    name: inviteId
+    in: path
+    description: project member invite identifier
+    required: true
+    type: integer
+    format: int64
 definitions:
   ErrorModel:
     type: object
@@ -6119,6 +6180,9 @@ definitions:
       email:
         type: string
         description: The user email
+      hashEmail:
+        type: string
+        description: The email hash value
       role:
         description: The user role in the project
         type: string
@@ -6156,26 +6220,41 @@ definitions:
     type: object
     properties:
       success:
-        $ref: '#/definitions/ProjectMemberInvite'
+        type: array
+        items:
+          $ref: '#/definitions/ProjectMemberInvite'
       failed:
         type: array
         items:
           type: object
+          properties:
+            email:
+              description: invitation user email(Optional)
+              type: string
+            handle:
+              description: invitation user handle(Optional)
+              type: string
+            message:
+              description: create invitation error message
+              type: string
+  ProjectMemberInviteListResult:
+    type: array
+    items:
+      $ref: '#/definitions/ProjectMemberInvite'
   AddProjectMemberInvitesRequest:
     title: Add project member invites request object
     type: object
     properties:
-      userIds:
-        description: 'The user Id list, could not present with emails'
+      handles:
+        description: 'The user handle list, could not present with emails'
         type: array
         items:
-          type: integer
-          format: int64
+          type: string
       emails:
         type: array
         items:
           type: string
-        description: 'The user email list, could not present with userIds'
+        description: 'The user email list, could not present with handles'
       role:
         description: The target role in the project
         type: string
@@ -6187,13 +6266,6 @@ definitions:
     title: Update project member invite request object
     type: object
     properties:
-      userId:
-        type: integer
-        format: int64
-        description: 'The user Id, could not present with email'
-      email:
-        type: string
-        description: 'The user email, could not present with userId'
       status:
         description: The invite status
         type: string

docs/swagger.yaml

@@ -25,7 +25,7 @@ server.use(authMiddleware);
 server.get('/v3/members/_search', (req, res) => {
   const fields = _.isString(req.query.fields) ? req.query.fields.split(',') : [];
   const filter = _.isString(req.query.query) ?
-    req.query.query.replace('%2520', ' ').replace('%20', ' ').split(' OR ') : [];
+    req.query.query.replace(/%2520/g, ' ').replace(/%20/g, ' ').split(' OR ') : [];
   const criteria = _.map(filter, (single) => {
     const ret = {};
     const splitted = single.split(':');
@@ -45,6 +45,7 @@ server.get('/v3/members/_search', (req, res) => {
   });
   const userIds = _.map(criteria, 'userId');
   const handles = _.map(criteria, 'handle');
+  const handleLowers = _.map(criteria, 'handleLower');
   const cloned = _.cloneDeep(members);
   const response = {
     id: 'res1',
@@ -66,6 +67,12 @@ server.get('/v3/members/_search', (req, res) => {
         found = _.pick(found, fields);
       }
       return found;
+    } else if (_.indexOf(handleLowers, single.result.content.handleLower) > -1) {
+      let found = single.result.content;
+      if (fields.length > 0) {
+        found = _.pick(found, fields);
+      }
+      return found;
     }
     return null;
   }).filter(_.identity);
@@ -76,7 +83,7 @@ server.get('/v3/members/_search', (req, res) => {
 
 // add filter route for project members
 server.get('/users', (req, res) => {
-  const filter = req.query.filter.replace('%2520', ' ').replace('%20', ' ').replace('%3D', ' ');
+  const filter = req.query.filter.replace(/%2520/g, ' ').replace(/%20/g, ' ').replace('%3D', ' ');
   const allEmails = filter.split('=')[1];
   const emails = allEmails.split('OR');
   const cloned = _.cloneDeep(members);
@@ -97,7 +104,7 @@ server.get('/users', (req, res) => {
 // add additional search route for project members
 server.get('/roles', (req, res) => {
   const filter = _.isString(req.query.filter) ?
-    req.query.filter.replace('%2520', ' ').replace('%20', ' ').split('=') : [];
+    req.query.filter.replace(/%2520/g, ' ').replace(/%20/g, ' ').split('=') : [];
   const cloned = _.cloneDeep(roles);
   const response = {
     id: 'res1',

local/mock-services/server.js

@@ -0,0 +1,10 @@
+--
+-- UPDATE EXISTING TABLES:
+--   project_member_invites:
+--     added column `hashEmail`
+
+--
+-- project_member_invites
+
+-- Add new column
+ALTER TABLE project_member_invites ADD COLUMN "hashEmail" character varying(255) ;