From 3f6a2c3792b2ed45a9424eb7a2aead51a5f38d5f Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 12 Jun 2017 16:24:44 +0300 Subject: [PATCH 01/84] Generation of user part of swagger document - added users structure - added new object for fields for users part --- core/server/api.js | 240 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 240 insertions(+) diff --git a/core/server/api.js b/core/server/api.js index dfd1eb9ed8..88552c5e49 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -17,6 +17,95 @@ const ApiV1 = new Restivus({ enableCors: true, }); +const UserFields = {}; + +UserFields.params = { + company: { + name: 'company', + in: 'body', + description: 'Company name of user', + required: true, + type: 'string', + }, + email: { + name: 'email', + in: 'body', + description: 'Email address for user', + required: true, + type: 'string', + }, + limit: { + name: 'limit', + in: 'query', + description: 'Maximum number of records to return in query.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + maximum: 50, + }, + optionalSearch: { + name: 'q', + in: 'query', + description: 'An optional search string for looking up inventory.', + required: false, + type: 'string', + }, + organizationId: { + name: 'id', + in: 'path', + description: 'ID of Organization', + required: false, + type: 'string', + }, + password: { + name: 'password', + in: 'body', + description: 'Password for user', + required: true, + type: 'string', + }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, + since: { + name: 'since', + in: 'path', + description: 'Time frame in days', + required: true, + type: 'integer', + format: 'int32', + minimum: 1, + }, + sortBy: { + name: 'sort_by', + in: 'query', + description: 'Criteria for sort ', + required: false, + type: 'string', + }, + userId: { + name: 'id', + in: 'path', + description: 'ID of User', + required: true, + type: 'string', + }, + userName: { + name: 'username', + in: 'body', + description: 'Username', + required: true, + type: 'string', + }, +}; + // Add Restivus Swagger configuration - meta, tags, params, definitions ApiV1.swagger = { meta: { @@ -26,6 +115,155 @@ ApiV1.swagger = { version: '1.0.0', title: 'Admin API', }, + paths: { + '/users': { + getAll: { + description: 'Returns users', + parameters: [ + UserFields.params.optionalSearch, + UserFields.params.organizationId, + UserFields.params.skip, + UserFields.params.limit, + UserFields.params.sortBy, + ], + responses: { + 200: { + description: 'success', + }, + 400: { + description: 'Bad query parameters', + }, + }, + }, + + get: { + description: 'Returns user with given ID.', + parameters: { + name: 'id', + in: 'path', + description: 'ID of User', + required: true, + type: 'string', + }, + + responses: { + 200: { + description: 'One user.', + }, + }, + }, + post: { + description: 'Adds a new user. On success, returns newly added object.', + parameters: [ + UserFields.params.userId, + UserFields.params.userName, + UserFields.params.email, + UserFields.params.password, + ], + responses: { + 201: { + description: 'User successfully added', + }, + 400: { + description: 'Invalid input, object invalid', + }, + 401: { + description: 'Authentication is required', + }, + 409: { + description: 'User already exists', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + delete: { + description: 'Deletes the identified Organization from catalog.', + parameters: [ + UserFields.params.userId, + ], + responses: { + 200: { + description: 'User deleted.', + }, + 400: { + description: 'Invalid input, invalid object', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'User not found', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + put: { + description: 'Update a User', + parameters: [ + UserFields.params.userId, + UserFields.params.userName, + UserFields.params.company, + UserFields.params.password, + ], + responses: { + 200: { + description: 'User successfully updated.', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'No user found with given UserID', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + + }, + + }, + }, + }, + '/users/updates': { + get: { + description: 'Returns users', + parameters: [ + UserFields.params.since, + UserFields.params.organizationId, + UserFields.params.skip, + UserFields.params.limit, + ], + responses: { + 200: { + description: 'success', + }, + 400: { + description: 'Bad query parameters', + }, + }, + }, + + }, + + }, securityDefinitions: { userSecurityToken: { in: 'header', @@ -244,6 +482,8 @@ ApiV1.swagger = { }, }, }, + + }; // Generate Swagger to route /rest/v1/swagger.json From f7625c3f152688f85c5db49fe8438f7b41339770 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 13 Jun 2017 08:52:32 +0300 Subject: [PATCH 02/84] Comment update --- core/server/api.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 88552c5e49..c5300a58f3 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -118,7 +118,7 @@ ApiV1.swagger = { paths: { '/users': { getAll: { - description: 'Returns users', + description: 'Returns: For Admin: all users data. For non-admin: only own data.', parameters: [ UserFields.params.optionalSearch, UserFields.params.organizationId, @@ -137,7 +137,7 @@ ApiV1.swagger = { }, get: { - description: 'Returns user with given ID.', + description: 'Returns user data with given ID.', parameters: { name: 'id', in: 'path', @@ -181,7 +181,7 @@ ApiV1.swagger = { }, ], delete: { - description: 'Deletes the identified Organization from catalog.', + description: 'Deletes the identified User.', parameters: [ UserFields.params.userId, ], @@ -244,7 +244,7 @@ ApiV1.swagger = { }, '/users/updates': { get: { - description: 'Returns users', + description: 'Returns users, who are created in given timeframe', parameters: [ UserFields.params.since, UserFields.params.organizationId, From fe3522ee0bfb93f9f24c082aaa00929a83cb70e2 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 13 Jun 2017 10:26:41 +0300 Subject: [PATCH 03/84] Added responses to users get verb --- core/server/api.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/core/server/api.js b/core/server/api.js index c5300a58f3..75bdf069a8 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -148,7 +148,13 @@ ApiV1.swagger = { responses: { 200: { - description: 'One user.', + description: 'Data of identified user.', + }, + 403: { + description: 'User does not have permission.', + }, + 404: { + description: 'No user found with given UserID.', }, }, }, From d54d67de95b254727368f548dc76f610942adfac Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 13 Jun 2017 10:30:08 +0300 Subject: [PATCH 04/84] Added functionality of getting user by id --- users/collection/server/api.js | 76 +++++++++++++++++++++++++++++++++- 1 file changed, 74 insertions(+), 2 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 9a1b0bf760..4916bfefe8 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -32,7 +32,7 @@ ApiV1.addCollection(Meteor.users, { tags: [ ApiV1.swagger.tags.users, ], - description: 'Returns users', + description: 'Returns: For Admin: all users data. For non-admin: only own data.', parameters: [ ApiV1.swagger.params.optionalSearch, ApiV1.swagger.params.organization_id, @@ -206,6 +206,78 @@ ApiV1.addCollection(Meteor.users, { }, }, }, + action () { + // Get requestor's id + const requestorId = this.userId; + + const userIsGettingOwnAccount = this.urlParams.id === requestorId; + + const userIsAdmin = Roles.userIsInRole(requestorId, ['admin']); + + if (userIsGettingOwnAccount || userIsAdmin) { + // Get ID of User to be fetched + const userId = this.urlParams.id; + + // Exclude password + const options = {}; + const excludeFields = {}; + + excludeFields.services = 0; + options.fields = excludeFields; + + // Check if user exists + const user = Meteor.users.findOne(userId, options); + if (user) { + // Array for Organization name and id + const orgDataList = []; + // Get user id + const userIdSearch = user._id; + // Find all Organizations, where User belongs to + const organizations = Organizations.find({ + managerIds: userIdSearch, + }).fetch(); + // If there are Users' Organizations + if (organizations.length > 0) { + // Loop through Users' Organizations + organizations.forEach((organization) => { + const orgData = {}; + // Put Organization name and id into an object + orgData.organizationId = organization._id; + orgData.organizationName = organization.name; + // Add this Organization data into Users' organization data list + orgDataList.push(orgData); + }); + // Add Organizations' information to Users' data + user.organization = orgDataList; + } + // Construct response + return { + statusCode: 200, + body: { + status: 'success', + data: user, + }, + }; + } + + // User didn't exist + return { + statusCode: 404, + body: { + status: 'Fail', + message: 'No user found with given UserID', + }, + }; + } + return { + statusCode: 403, + body: { + status: 'Fail', + message: 'User does not have permission', + }, + }; + }, + }, post: { authRequired: true, @@ -308,7 +380,7 @@ ApiV1.addCollection(Meteor.users, { tags: [ ApiV1.swagger.tags.users, ], - description: 'Deletes the identified Organization from catalog.', + description: 'Deletes the identified User.', parameters: [ ApiV1.swagger.params.userId, ], From 474776e042129190ba91b9dcde82152d30639535 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 14 Jun 2017 16:34:13 +0300 Subject: [PATCH 05/84] Added a new method to remove user from all Organizations --- organizations/server/methods.js | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/organizations/server/methods.js b/organizations/server/methods.js index 3980d0994d..3f4f2a7aa8 100644 --- a/organizations/server/methods.js +++ b/organizations/server/methods.js @@ -100,6 +100,23 @@ Meteor.methods({ } ); }, + removeUserFromAllOrganizations (userId) { + // Make sure userId is an String + check(userId, String); + // Check if user to be deleted is a manager in any Organizations + const organizations = Organizations.find({ + managerIds: userId, + }).fetch(); + + // If user is a manager in any Organization + if (organizations.length > 0) { + // Loop through Users' Organizations + organizations.forEach((organization) => { + // Remove user from organization manager list + Meteor.call('removeOrganizationManager', organization._id, userId); + }); + } + }, removeApiFromFeaturedList (organizationId, apiId) { // Make sure organizationId is an String check(organizationId, String); From 6c7f3c05dc292e013e39e908d2d6c4a3f7f9b74f Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 14 Jun 2017 16:35:18 +0300 Subject: [PATCH 06/84] When user is deleted, user is removed from all Organizations, too. --- users/collection/server/api.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 4916bfefe8..bace8e574f 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -422,6 +422,9 @@ ApiV1.addCollection(Meteor.users, { // Check if user exists const user = Meteor.users.findOne(userId); if (user) { + // Remove user from all Organizations + Meteor.call('removeUserFromAllOrganizations', userId); + // Remove existing User account Meteor.users.remove(user._id); From 224c8d48a340f16ab9bdb770592fb906ba5a0ad2 Mon Sep 17 00:00:00 2001 From: matleppa Date: Fri, 16 Jun 2017 12:15:25 +0300 Subject: [PATCH 07/84] Corrected comment --- organizations/server/methods.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/organizations/server/methods.js b/organizations/server/methods.js index 3f4f2a7aa8..e45be462d1 100644 --- a/organizations/server/methods.js +++ b/organizations/server/methods.js @@ -103,7 +103,7 @@ Meteor.methods({ removeUserFromAllOrganizations (userId) { // Make sure userId is an String check(userId, String); - // Check if user to be deleted is a manager in any Organizations + // Get list of Organizations where user is a manager const organizations = Organizations.find({ managerIds: userId, }).fetch(); From 7b783bd56bc8ec028f28d1c5762e1d993ef28320 Mon Sep 17 00:00:00 2001 From: matleppa Date: Fri, 16 Jun 2017 14:05:14 +0300 Subject: [PATCH 08/84] Changed order to alphabetical --- core/server/api.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 75bdf069a8..169ec52cef 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -65,15 +65,6 @@ UserFields.params = { required: true, type: 'string', }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - }, since: { name: 'since', in: 'path', @@ -83,6 +74,15 @@ UserFields.params = { format: 'int32', minimum: 1, }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, sortBy: { name: 'sort_by', in: 'query', From c3f36fe91495b0cc6eb855ee3ff50da58a866a40 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 20 Jun 2017 14:39:05 +0300 Subject: [PATCH 09/84] Removed unnecessary parameter userId --- users/collection/server/api.js | 1 - 1 file changed, 1 deletion(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index bace8e574f..e31b0af535 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -288,7 +288,6 @@ ApiV1.addCollection(Meteor.users, { ], description: 'Adds a new user. On success, returns newly added object.', parameters: [ - ApiV1.swagger.params.userId, ApiV1.swagger.params.userName, ApiV1.swagger.params.email, ApiV1.swagger.params.password, From 91eea9bf2aa22229514cab4f7c207e0fe4d94240 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 20 Jun 2017 14:45:47 +0300 Subject: [PATCH 10/84] Changes concerning users path - Renamed UserFields.params to UserFields.structs - added tags section into UserFields.structs - added section params and definitions into UserFields.struct - added definition for addUser and updateUser - renamed parameters according to UserFields changes - added users section into general definitions --- core/server/api.js | 407 +++++++++++++++++++++++++++------------------ 1 file changed, 247 insertions(+), 160 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 169ec52cef..6835ac6c58 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -19,90 +19,148 @@ const ApiV1 = new Restivus({ const UserFields = {}; -UserFields.params = { - company: { - name: 'company', - in: 'body', - description: 'Company name of user', - required: true, - type: 'string', - }, - email: { - name: 'email', - in: 'body', - description: 'Email address for user', - required: true, - type: 'string', - }, - limit: { - name: 'limit', - in: 'query', - description: 'Maximum number of records to return in query.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 50, - }, - optionalSearch: { - name: 'q', - in: 'query', - description: 'An optional search string for looking up inventory.', - required: false, - type: 'string', - }, - organizationId: { - name: 'id', - in: 'path', - description: 'ID of Organization', - required: false, - type: 'string', - }, - password: { - name: 'password', - in: 'body', - description: 'Password for user', - required: true, - type: 'string', - }, - since: { - name: 'since', - in: 'path', - description: 'Time frame in days', - required: true, - type: 'integer', - format: 'int32', - minimum: 1, - }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - }, - sortBy: { - name: 'sort_by', - in: 'query', - description: 'Criteria for sort ', - required: false, - type: 'string', +UserFields.struct = { + tags: { + users: 'Users', }, - userId: { - name: 'id', - in: 'path', - description: 'ID of User', - required: true, - type: 'string', + + params: { + company: { + name: 'company', + in: 'body', + description: 'Company name of user', + required: true, + type: 'string', + }, + email: { + name: 'email', + in: 'body', + description: 'Email address for user', + required: true, + type: 'string', + }, + limit: { + name: 'limit', + in: 'query', + description: 'Maximum number of records to return in query.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + maximum: 50, + }, + optionalSearch: { + name: 'q', + in: 'query', + description: 'An optional search string for looking up inventory.', + required: false, + type: 'string', + }, + organizationId: { + name: 'id', + in: 'path', + description: 'ID of Organization', + required: false, + type: 'string', + }, + password: { + name: 'password', + in: 'body', + description: 'Password for user', + required: true, + type: 'string', + }, + since: { + name: 'since', + in: 'path', + description: 'Time frame in days', + required: true, + type: 'integer', + format: 'int32', + minimum: 1, + }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, + sortBy: { + name: 'sort_by', + in: 'query', + description: 'Criteria for sort ', + required: false, + type: 'string', + }, + updateUser: { + name: 'Update user', + in: 'body', + description: 'Data for editing User', + schema: { + $ref: '#/definitions/updateUser', + }, + }, + + userId: { + name: 'id', + in: 'path', + description: 'ID of User', + required: true, + type: 'string', + }, + userName: { + name: 'username', + in: 'body', + description: 'Username', + required: true, + type: 'string', + }, }, - userName: { - name: 'username', - in: 'body', - description: 'Username', - required: true, - type: 'string', + + definitions: { + addUser: { + required: ['userName', 'password', 'email'], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + password: { + type: 'string', + example: 'secrecy_is_everything#¤%', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'company-mail@gmail.com', + }, + }, + }, + + updateUser: { + required: [], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + company: { + type: 'string', + example: 'Amazing Company Ltd.', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'company-mail@gmail.com', + }, + }, + }, + }, }; @@ -118,13 +176,17 @@ ApiV1.swagger = { paths: { '/users': { getAll: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Returns: For Admin: all users data. For non-admin: only own data.', parameters: [ - UserFields.params.optionalSearch, - UserFields.params.organizationId, - UserFields.params.skip, - UserFields.params.limit, - UserFields.params.sortBy, + UserFields.struct.params.optionalSearch, + UserFields.struct.params.organizationId, + UserFields.struct.params.skip, + UserFields.struct.params.limit, + UserFields.struct.params.sortBy, ], responses: { 200: { @@ -135,16 +197,14 @@ ApiV1.swagger = { }, }, }, - get: { + tags: [ + UserFields.struct.tags.users, + ], description: 'Returns user data with given ID.', - parameters: { - name: 'id', - in: 'path', - description: 'ID of User', - required: true, - type: 'string', - }, + parameters: [ + UserFields.struct.params.userId, + ], responses: { 200: { @@ -158,13 +218,20 @@ ApiV1.swagger = { }, }, }, + }, + + '/users/{id}': { post: { + tags: [ + UserFields.struct.tags.users, + ], description: 'Adds a new user. On success, returns newly added object.', + consumes: 'application/json', + produces: 'application/json', + parameters: [ - UserFields.params.userId, - UserFields.params.userName, - UserFields.params.email, - UserFields.params.password, + UserFields.struct.params.userName, + UserFields.struct.params.addUser, ], responses: { 201: { @@ -186,76 +253,82 @@ ApiV1.swagger = { userId: [], }, ], - delete: { - description: 'Deletes the identified User.', - parameters: [ - UserFields.params.userId, - ], - responses: { - 200: { - description: 'User deleted.', - }, - 400: { - description: 'Invalid input, invalid object', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'User not found', - }, + }, + delete: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Deletes the identified User.', + parameters: [ + UserFields.struct.params.userId, + ], + responses: { + 200: { + description: 'User deleted.', + }, + 400: { + description: 'Invalid input, invalid object', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'User not found', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + }, + put: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Update a User', + parameters: [ + UserFields.struct.params.userId, + UserFields.struct.params.updateUser, + ], + responses: { + 200: { + description: 'User successfully updated.', }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - put: { - description: 'Update a User', - parameters: [ - UserFields.params.userId, - UserFields.params.userName, - UserFields.params.company, - UserFields.params.password, - ], - responses: { - 200: { - description: 'User successfully updated.', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'No user found with given UserID', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'No user found with given UserID', }, - }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], }, }, + '/users/updates': { get: { + tags: [ + UserFields.struct.tags.users, + ], description: 'Returns users, who are created in given timeframe', parameters: [ - UserFields.params.since, - UserFields.params.organizationId, - UserFields.params.skip, - UserFields.params.limit, + UserFields.struct.params.since, + UserFields.struct.params.organizationId, + UserFields.struct.params.skip, + UserFields.struct.params.limit, ], responses: { 200: { @@ -487,6 +560,20 @@ ApiV1.swagger = { }, }, }, + + users: { + required: ['name', 'email', 'password'], + properties: { + username: + UserFields.params.userName, + email: + UserFields.params.email, + password: + UserFields.params.password, + company: + UserFields.params.company, + }, + }, }, From 9969166a6b7d4792d7747d7ffee716bc3ef063e1 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 21 Jun 2017 12:21:29 +0300 Subject: [PATCH 11/84] Changes in swagger document generation - corrected parameter (since, organizationId) position from path to query - replaced references to updateUser and addUser with plain field descriptions - changes in descriptions - removed definitions part from UserFields object - added /users/{id} method - corrected references to UserFields object --- core/server/api.js | 186 +++++++++++++++++++++++++-------------------- 1 file changed, 104 insertions(+), 82 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 6835ac6c58..95744a0788 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -25,6 +25,30 @@ UserFields.struct = { }, params: { + addUser: { + name: 'Update user', + in: 'body', + description: 'Data for adding User', + schema: { + required: ['userName', 'password', 'email'], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + password: { + type: 'string', + example: 'secrecy_is_everything#¤%', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'company-mail@gmail.com', + }, + }, + }, + }, company: { name: 'company', in: 'body', @@ -39,6 +63,22 @@ UserFields.struct = { required: true, type: 'string', }, + // getUserData { + // properties: + // _id: + // type: string + // example: '7L4jNtdfNFGH3igPs' + // created_at: + // $ref: '#/definitions/get_user_created_at' + // username: + // type: string + // example: myusername + // profile: + // $ref: '#/definitions/get_user_profile' + // organization: + // $ref: '#/definitions/get_user_organization' + // + // }, limit: { name: 'limit', in: 'query', @@ -52,14 +92,14 @@ UserFields.struct = { optionalSearch: { name: 'q', in: 'query', - description: 'An optional search string for looking up inventory.', + description: 'Pass an optional search string for looking up users.', required: false, type: 'string', }, organizationId: { - name: 'id', - in: 'path', - description: 'ID of Organization', + name: 'organization_id', + in: 'query', + description: 'Limit results to the given organization.', required: false, type: 'string', }, @@ -72,9 +112,9 @@ UserFields.struct = { }, since: { name: 'since', - in: 'path', + in: 'query', description: 'Time frame in days', - required: true, + required: false, type: 'integer', format: 'int32', minimum: 1, @@ -91,7 +131,7 @@ UserFields.struct = { sortBy: { name: 'sort_by', in: 'query', - description: 'Criteria for sort ', + description: 'options "username, created_at".', required: false, type: 'string', }, @@ -100,68 +140,39 @@ UserFields.struct = { in: 'body', description: 'Data for editing User', schema: { - $ref: '#/definitions/updateUser', + required: [], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + company: { + type: 'string', + example: 'Amazing Company Ltd.', + }, + password: { + type: 'string', + example: 'secrecy_is_everything#¤%', + }, + }, }, }, - userId: { name: 'id', in: 'path', - description: 'ID of User', + description: 'Id of the user to fetch.', required: true, type: 'string', }, userName: { name: 'username', in: 'body', - description: 'Username', + description: 'Name of user', required: true, type: 'string', }, }, - definitions: { - addUser: { - required: ['userName', 'password', 'email'], - properties: { - userName: { - type: 'string', - example: 'John Doe', - }, - password: { - type: 'string', - example: 'secrecy_is_everything#¤%', - }, - email: { - type: 'string', - format: 'email', - description: 'E-mail address of user', - example: 'company-mail@gmail.com', - }, - }, - }, - - updateUser: { - required: [], - properties: { - userName: { - type: 'string', - example: 'John Doe', - }, - company: { - type: 'string', - example: 'Amazing Company Ltd.', - }, - email: { - type: 'string', - format: 'email', - description: 'E-mail address of user', - example: 'company-mail@gmail.com', - }, - }, - }, - - }, }; // Add Restivus Swagger configuration - meta, tags, params, definitions @@ -175,7 +186,7 @@ ApiV1.swagger = { }, paths: { '/users': { - getAll: { + get: { tags: [ UserFields.struct.tags.users, ], @@ -195,32 +206,11 @@ ApiV1.swagger = { 400: { description: 'Bad query parameters', }, - }, - }, - get: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Returns user data with given ID.', - parameters: [ - UserFields.struct.params.userId, - ], - - responses: { - 200: { - description: 'Data of identified user.', - }, - 403: { - description: 'User does not have permission.', - }, - 404: { - description: 'No user found with given UserID.', + 401: { + description: 'Authentication is required', }, }, }, - }, - - '/users/{id}': { post: { tags: [ UserFields.struct.tags.users, @@ -230,7 +220,6 @@ ApiV1.swagger = { produces: 'application/json', parameters: [ - UserFields.struct.params.userName, UserFields.struct.params.addUser, ], responses: { @@ -254,6 +243,33 @@ ApiV1.swagger = { }, ], }, + }, + + '/users/{id}': { + get: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Returns user data with given ID.', + parameters: [ + UserFields.struct.params.userId, + ], + + responses: { + 200: { + description: 'Data of identified user.', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission.', + }, + 404: { + description: 'No user found with given UserID.', + }, + }, + }, delete: { tags: [ UserFields.struct.tags.users, @@ -299,6 +315,9 @@ ApiV1.swagger = { 200: { description: 'User successfully updated.', }, + 400: { + description: 'Invalid input, object invalid, Erroneous new password', + }, 401: { description: 'Authentication is required', }, @@ -337,6 +356,9 @@ ApiV1.swagger = { 400: { description: 'Bad query parameters', }, + 401: { + description: 'Authentication is required', + }, }, }, @@ -565,13 +587,13 @@ ApiV1.swagger = { required: ['name', 'email', 'password'], properties: { username: - UserFields.params.userName, + UserFields.struct.params.userName, email: - UserFields.params.email, + UserFields.struct.params.email, password: - UserFields.params.password, + UserFields.struct.params.password, company: - UserFields.params.company, + UserFields.struct.params.company, }, }, }, From 91940008421dc2a77b7388e2c706e48523ff39e7 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Wed, 21 Jun 2017 18:11:01 +0300 Subject: [PATCH 12/84] Replace path "/users/{id}" into related folder Remove path "/users/{id}" from ApiV1.swagger.meta.paths in file "core/server/api.js", save a placeholder Remove swagger part from origin REST API file. Because of restivus-swagger doesn't create properly Swagger documentation for Users collection, thispart wasremoved. Now it allows us two different part: one ofthis provides only feature for creating Swagger file (ApiV1.swagger.meta.paths) and another one provides only logic for REST API --- core/server/api.js | 25 +--------------------- users/collection/server/api.js | 38 +++++++++++++++++++++------------- 2 files changed, 25 insertions(+), 38 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 95744a0788..ecf6750ad1 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -246,30 +246,7 @@ ApiV1.swagger = { }, '/users/{id}': { - get: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Returns user data with given ID.', - parameters: [ - UserFields.struct.params.userId, - ], - - responses: { - 200: { - description: 'Data of identified user.', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission.', - }, - 404: { - description: 'No user found with given UserID.', - }, - }, - }, + get: {}, delete: { tags: [ UserFields.struct.tags.users, diff --git a/users/collection/server/api.js b/users/collection/server/api.js index e31b0af535..91cfe1a781 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -18,6 +18,30 @@ import Organizations from '/organizations/collection'; import _ from 'lodash'; +ApiV1.swagger.meta.paths['/users/{id}'].get = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Returns user data with given ID.', + parameters: [ + ApiV1.swagger.params.userId, + ], + responses: { + 200: { + description: 'Data of identified user.', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission.', + }, + 404: { + description: 'No user found with given UserID.', + }, + }, +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -192,20 +216,6 @@ ApiV1.addCollection(Meteor.users, { }, get: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Returns user with given ID.', - parameters: [ - ApiV1.swagger.params.userId, - ], - responses: { - 200: { - description: 'One user.', - }, - }, - }, action () { // Get requestor's id const requestorId = this.userId; From adb808fc8acac9677e44349fad2d68ed4d2d9163 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Mon, 12 Jun 2017 18:06:09 -0300 Subject: [PATCH 13/84] Setup chimp on travis --- .scripts/run-chimp.js | 94 ++++++++++++++++++++++++++++++++++++++++++ .scripts/start-xvfb.sh | 13 ++++++ .travis.yml | 15 +++++++ package.json | 2 +- 4 files changed, 123 insertions(+), 1 deletion(-) create mode 100644 .scripts/run-chimp.js create mode 100644 .scripts/start-xvfb.sh diff --git a/.scripts/run-chimp.js b/.scripts/run-chimp.js new file mode 100644 index 0000000000..9d67b828b4 --- /dev/null +++ b/.scripts/run-chimp.js @@ -0,0 +1,94 @@ +/* Copyright 2017 Apinf Oy +This file is covered by the EUPL license. +You may obtain a copy of the licence at +https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Inspired by https://goo.gl/Rbd2s2 + +var path = require('path'), + fs = require('fs'), + extend = require('util')._extend, + exec = require('child_process').exec, + processes = []; + +var baseDir = path.resolve(__dirname, '..'), + srcDir = path.resolve(baseDir); + +var appOptions = { + env: { + PORT: 3000, + ROOT_URL: 'http://localhost:3000' + } +}; + +function startProcess(opts, callback) { + var proc = exec( + opts.command, + opts.options + ); + + if (opts.waitForMessage) { + proc.stdout.on('data', function waitForMessage(data) { + if (data.toString().match(opts.waitForMessage)) { + if (callback) { + callback(); + } + } + }); + } + + if (!opts.silent) { + proc.stdout.pipe(process.stdout); + proc.stderr.pipe(process.stderr); + } + + if (opts.logFile) { + var logStream = fs.createWriteStream(opts.logFile, {flags: 'a'}); + proc.stdout.pipe(logStream); + proc.stderr.pipe(logStream); + } + + proc.on('close', function(code) { + console.log(opts.name, 'exited with code ' + code); + for (var i = 0; i < processes.length; i += 1) { + processes[i].kill(); + } + process.exit(code); + }); + processes.push(proc); +} + +function startApp(callback) { + startProcess({ + name: 'Meteor App', + command: 'meteor', + waitForMessage: appOptions.waitForMessage, + options: { + cwd: srcDir, + env: extend(appOptions.env, process.env) + } + }, callback); +} + +function startChimp() { + startProcess({ + name: 'Chimp', + command: 'yarn run chimp-test', + options: { + env: Object.assign({}, process.env, { + NODE_PATH: process.env.NODE_PATH + + path.delimiter + srcDir + + path.delimiter + srcDir + '/node_modules' + }) + } + }); +} + +function chimpNoMirror() { + appOptions.waitForMessage = 'SERVER RUNNING'; + startApp(function() { + startChimp(); + }); +} + +chimpNoMirror(); \ No newline at end of file diff --git a/.scripts/start-xvfb.sh b/.scripts/start-xvfb.sh new file mode 100644 index 0000000000..6cfdf1536b --- /dev/null +++ b/.scripts/start-xvfb.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +# Copyright 2017 Apinf Oy +#This file is covered by the EUPL license. +#You may obtain a copy of the licence at +#https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 + +set -ev + +if [ "${TRAVIS_OS_NAME}" = "linux" ]; then + sh -e /etc/init.d/xvfb start + sleep 3 +fi diff --git a/.travis.yml b/.travis.yml index 93de32696e..df1fffb959 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,9 @@ language: node_js node_js: - "node" +addons: + chrome: stable + branches: only: - develop @@ -11,6 +14,7 @@ cache: yarn: true before_install: + - if [ ! -e "$HOME/.meteor/meteor" ]; then curl https://install.meteor.com | sed s/--progress-bar/-sL/g | /bin/sh; fi - curl -o- -L https://yarnpkg.com/install.sh | bash - export PATH=$HOME/.yarn/bin:$PATH @@ -18,7 +22,18 @@ services: - docker before_script: + # Start X Virtual Frame Buffer for headless testing with real browsers + - ./scripts/start-xvfb.sh + # Install node-gyp for running chimp + - meteor npm install -g node-gyp node-pre-gyp - yarn run lint script: + # Run meteor and chimp from node.js + - travis_retry yarn test - ./.scripts/docker_build.sh + +env: + global: + - DISPLAY=:99.0 + - TEST_MODE: "true" \ No newline at end of file diff --git a/package.json b/package.json index 4e54ee4f86..1b50fc17fe 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "chimp-watch": "chimp --ddp=http://localhost:3000 --mocha --path=tests/end-to-end --watch", "chimp-test": "chimp tests/chimp-config.js", "start": "meteor", - "test": "mocha ./.test/" + "test": "node ./scripts/start.js" }, "repository": { "type": "git", From 0e509b0754239e2800bb0d6761385c1f481dc22f Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Mon, 12 Jun 2017 18:21:23 -0300 Subject: [PATCH 14/84] Fix path to start-xvfb and set executable --- .scripts/start-xvfb.sh | 0 .travis.yml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) mode change 100644 => 100755 .scripts/start-xvfb.sh diff --git a/.scripts/start-xvfb.sh b/.scripts/start-xvfb.sh old mode 100644 new mode 100755 diff --git a/.travis.yml b/.travis.yml index df1fffb959..ff08398218 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,7 +23,7 @@ services: before_script: # Start X Virtual Frame Buffer for headless testing with real browsers - - ./scripts/start-xvfb.sh + - ./.scripts/start-xvfb.sh # Install node-gyp for running chimp - meteor npm install -g node-gyp node-pre-gyp - yarn run lint From 8e6c726022b57738c0cd96450e3876c9670110b0 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Mon, 12 Jun 2017 21:57:47 -0300 Subject: [PATCH 15/84] Run correct script --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 1b50fc17fe..1e73910510 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "chimp-watch": "chimp --ddp=http://localhost:3000 --mocha --path=tests/end-to-end --watch", "chimp-test": "chimp tests/chimp-config.js", "start": "meteor", - "test": "node ./scripts/start.js" + "test": "node .scripts/run-chimp.js" }, "repository": { "type": "git", From 4a6d5f8e6cb8a07f39de99f29c598ddbab2c2063 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Sun, 11 Jun 2017 14:43:58 -0300 Subject: [PATCH 16/84] Prevent travis to break when not running from apinf/platform --- .scripts/docker_build.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.scripts/docker_build.sh b/.scripts/docker_build.sh index d9a6107e74..a476eacd58 100755 --- a/.scripts/docker_build.sh +++ b/.scripts/docker_build.sh @@ -7,7 +7,7 @@ set -ev -if [ "${TRAVIS_PULL_REQUEST}" = "false" ] +if [ "${TRAVIS_PULL_REQUEST}" = "false" -a "${TRAVIS_REPO_SLUG}" = "apinf/platform" ] then docker build -t apinf/platform:$DOCKER_TAG . docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD" From 1f377f8813af38cad3ddfcf9d009dae27a1900d3 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 13 Jun 2017 08:33:43 -0300 Subject: [PATCH 17/84] Fix waitForMessage - https://goo.gl/lAOTlt --- .scripts/run-chimp.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.scripts/run-chimp.js b/.scripts/run-chimp.js index 9d67b828b4..73ed4e6773 100644 --- a/.scripts/run-chimp.js +++ b/.scripts/run-chimp.js @@ -85,7 +85,7 @@ function startChimp() { } function chimpNoMirror() { - appOptions.waitForMessage = 'SERVER RUNNING'; + appOptions.waitForMessage = 'App running at:'; startApp(function() { startChimp(); }); From 6b10d54e803b93efe68c8dbbb1018342dbdcbf1d Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Fri, 16 Jun 2017 15:16:02 -0300 Subject: [PATCH 18/84] Downgrade node to 4 and install travis test packages --- .travis.yml | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/.travis.yml b/.travis.yml index ff08398218..1dfb498953 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,9 +1,14 @@ sudo: false language: node_js node_js: - - "node" + - '4' addons: + apt: + sources: + - ubuntu-toolchain-r-test + packages: + - g++-4.8 chrome: stable branches: @@ -13,27 +18,31 @@ branches: cache: yarn: true +services: + - docker + before_install: + # Install meteor locally on CI - if [ ! -e "$HOME/.meteor/meteor" ]; then curl https://install.meteor.com | sed s/--progress-bar/-sL/g | /bin/sh; fi + # Install Yarn - curl -o- -L https://yarnpkg.com/install.sh | bash - export PATH=$HOME/.yarn/bin:$PATH -services: - - docker - before_script: + - yarn run lint # Start X Virtual Frame Buffer for headless testing with real browsers - ./.scripts/start-xvfb.sh # Install node-gyp for running chimp - - meteor npm install -g node-gyp node-pre-gyp - - yarn run lint + - yarn install script: # Run meteor and chimp from node.js - travis_retry yarn test + # Build docker image - ./.scripts/docker_build.sh env: global: - DISPLAY=:99.0 - - TEST_MODE: "true" \ No newline at end of file + - TEST_MODE: "true" + - CXX=g++-4.8 \ No newline at end of file From d9b428454c79637e2836556e913017962d5f8247 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Fri, 16 Jun 2017 16:29:00 -0300 Subject: [PATCH 19/84] Add some documentation --- .scripts/run-chimp.js | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/.scripts/run-chimp.js b/.scripts/run-chimp.js index 73ed4e6773..d37fb6f5b1 100644 --- a/.scripts/run-chimp.js +++ b/.scripts/run-chimp.js @@ -21,6 +21,14 @@ var appOptions = { } }; +/** + * Start a process on the O.S. + * Optionally start a child process if options.waitForMessage + * is set to an output message emitted by this process. + * + * @param {command, options} opts + * @param {*} callback + */ function startProcess(opts, callback) { var proc = exec( opts.command, @@ -58,6 +66,11 @@ function startProcess(opts, callback) { processes.push(proc); } +/** + * Run meteor + * + * @param {*} callback + */ function startApp(callback) { startProcess({ name: 'Meteor App', @@ -70,6 +83,9 @@ function startApp(callback) { }, callback); } +/** + * Start chimp + */ function startChimp() { startProcess({ name: 'Chimp', @@ -84,6 +100,9 @@ function startChimp() { }); } +/** + * Run meteor and then chimp after application has started + */ function chimpNoMirror() { appOptions.waitForMessage = 'App running at:'; startApp(function() { From 2422f0f98e739d3db3569a3f90af3fd28d3690eb Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Fri, 16 Jun 2017 16:29:25 -0300 Subject: [PATCH 20/84] Run meteor in production mode --- .scripts/run-chimp.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.scripts/run-chimp.js b/.scripts/run-chimp.js index d37fb6f5b1..bc515ffff8 100644 --- a/.scripts/run-chimp.js +++ b/.scripts/run-chimp.js @@ -67,14 +67,15 @@ function startProcess(opts, callback) { } /** - * Run meteor + * Always run meteor in production-like environment + * since we do not want to reload changing files * * @param {*} callback */ function startApp(callback) { startProcess({ name: 'Meteor App', - command: 'meteor', + command: 'meteor --production', waitForMessage: appOptions.waitForMessage, options: { cwd: srcDir, From 5c360d8fb23e479911201c531e528963335f6fea Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Fri, 16 Jun 2017 16:29:52 -0300 Subject: [PATCH 21/84] Set travis to cache meteor properly --- .travis.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 1dfb498953..378389563c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,8 +15,12 @@ branches: only: - develop +before_cache: + - rm -f $HOME/.meteor/log/*.log + cache: yarn: true + - $HOME/.meteor services: - docker @@ -45,4 +49,5 @@ env: global: - DISPLAY=:99.0 - TEST_MODE: "true" - - CXX=g++-4.8 \ No newline at end of file + - CXX=g++-4.8 + From 3638e8438a9777ed4f90c35e5a2beaec4f126d66 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Sat, 17 Jun 2017 08:24:18 -0300 Subject: [PATCH 22/84] Cache yarn and meteor - Previous setup had syntax error --- .travis.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 378389563c..ff7d36f218 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,8 +19,9 @@ before_cache: - rm -f $HOME/.meteor/log/*.log cache: - yarn: true - - $HOME/.meteor + directories: + - $HOME/.meteor + - $HOME/.cache/yarn services: - docker @@ -49,5 +50,4 @@ env: global: - DISPLAY=:99.0 - TEST_MODE: "true" - - CXX=g++-4.8 - + - CXX=g++-4.8 \ No newline at end of file From 783b8e2cad15a0e5a751357f0e613b652cd75972 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 10:38:28 -0300 Subject: [PATCH 23/84] Don't run yarn install twice --- .travis.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index ff7d36f218..a26b953b6d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -37,9 +37,7 @@ before_script: - yarn run lint # Start X Virtual Frame Buffer for headless testing with real browsers - ./.scripts/start-xvfb.sh - # Install node-gyp for running chimp - - yarn install - + script: # Run meteor and chimp from node.js - travis_retry yarn test From b3e5fb624ac4e34cd25dd9652af5be275fa6eedd Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 11:21:45 -0300 Subject: [PATCH 24/84] Add ids to setup modal buttons --- setup/client/modal.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup/client/modal.html b/setup/client/modal.html index a5ae79087f..c92844e59a 100644 --- a/setup/client/modal.html +++ b/setup/client/modal.html @@ -21,10 +21,10 @@

- + {{_ "setupNeededModal_viewBrandingButton" }} - + {{_ "setupNeededModal_viewSettingsButton" }}
From 3f9404d8939255eea57a2b02e9ab78cfa496f1fd Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 11:22:37 -0300 Subject: [PATCH 25/84] Navigate to settings page from signup --- tests/page-objects/signup.page.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/page-objects/signup.page.js b/tests/page-objects/signup.page.js index 1fb83952aa..a976f34fc0 100644 --- a/tests/page-objects/signup.page.js +++ b/tests/page-objects/signup.page.js @@ -24,6 +24,9 @@ class SignUpPage extends Page { get passwordErrorField () { return this.errorFields[2]; } get confirmPasswordErrorField () { return this.errorFields[3]; } + // Modal after first signup + get settingsLink () { return browser.element('#setup-settings') } + open () { super.open(); this.pause(); @@ -40,6 +43,11 @@ class SignUpPage extends Page { this.submit(); } + gotToSetup () { + this.settingsLink.waitForVisible(5000); + this.settingsLink.click(); + } + submit () { this.registerButton.waitForVisible(5000); this.registerButton.click(); From cd80685a23af103d7eda58426b737d520756806a Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 11:23:21 -0300 Subject: [PATCH 26/84] Add logic to setup github as admin --- tests/data/settings.js | 3 +++ tests/page-objects/settings.page.js | 40 +++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 tests/data/settings.js create mode 100644 tests/page-objects/settings.page.js diff --git a/tests/data/settings.js b/tests/data/settings.js new file mode 100644 index 0000000000..367a145676 --- /dev/null +++ b/tests/data/settings.js @@ -0,0 +1,3 @@ + +export const githubClientId = 'github-client-id'; +export const githubClientSecret = 'g1th&b53c43t'; \ No newline at end of file diff --git a/tests/page-objects/settings.page.js b/tests/page-objects/settings.page.js new file mode 100644 index 0000000000..641e0cb039 --- /dev/null +++ b/tests/page-objects/settings.page.js @@ -0,0 +1,40 @@ +/* Copyright 2017 Apinf Oy +This file is covered by the EUPL license. +You may obtain a copy of the licence at +https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +/* globals browser */ + +import MainContentPage from './main-content.page'; + +class SettingsPage extends MainContentPage { + + // Left Menu + + // Profile + + // Account + + // Branding + + // Settings + get githubId () { return browser.element('#github-id'); } + get githubSecret () { return browser.element('#github-secret'); } + get saveSettingsButton () { return browser.element('#save-settings'); } + + setupGithub ({ githubClientId, githubClientSecret }) { + this.githubId.waitForVisible(5000); + + this.githubId.setValue(githubClientId); + this.githubSecret.setValue(githubClientSecret); + + this.submit(); + } + + submit () { + this.saveSettingsButton.waitForVisible(5000); + this.saveSettingsButton.click(); + } +} + +module.exports = new SettingsPage(); From f2b43d189d57e98608ff5e11f55488a164c49c88 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 11:35:15 -0300 Subject: [PATCH 27/84] Fix lint errors --- tests/data/settings.js | 2 +- tests/page-objects/settings.page.js | 4 ++-- tests/page-objects/signup.page.js | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/tests/data/settings.js b/tests/data/settings.js index 367a145676..ddde489497 100644 --- a/tests/data/settings.js +++ b/tests/data/settings.js @@ -1,3 +1,3 @@ export const githubClientId = 'github-client-id'; -export const githubClientSecret = 'g1th&b53c43t'; \ No newline at end of file +export const githubClientSecret = 'g1th&b53c43t'; diff --git a/tests/page-objects/settings.page.js b/tests/page-objects/settings.page.js index 641e0cb039..d12f7c5bbf 100644 --- a/tests/page-objects/settings.page.js +++ b/tests/page-objects/settings.page.js @@ -5,9 +5,9 @@ https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence /* globals browser */ -import MainContentPage from './main-content.page'; +import MainContentPage from './main-content.page'; -class SettingsPage extends MainContentPage { +class SettingsPage extends MainContentPage { // Left Menu diff --git a/tests/page-objects/signup.page.js b/tests/page-objects/signup.page.js index a976f34fc0..be9787a83c 100644 --- a/tests/page-objects/signup.page.js +++ b/tests/page-objects/signup.page.js @@ -25,7 +25,7 @@ class SignUpPage extends Page { get confirmPasswordErrorField () { return this.errorFields[3]; } // Modal after first signup - get settingsLink () { return browser.element('#setup-settings') } + get settingsLink () { return browser.element('#setup-settings'); } open () { super.open(); From 0c7a1287901613f7d5ed361f02c3d083892a46e3 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 12:03:02 -0300 Subject: [PATCH 28/84] Make admin user creation test to create settings --- tests/chimp-config.js | 2 +- tests/end-to-end/ui/03-user-creation.js | 28 ++++++++++++++++++++++--- tests/page-objects/settings.page.js | 4 ++-- tests/page-objects/signup.page.js | 8 +++---- 4 files changed, 32 insertions(+), 10 deletions(-) diff --git a/tests/chimp-config.js b/tests/chimp-config.js index 6aa6d50bd6..c554ec13dd 100644 --- a/tests/chimp-config.js +++ b/tests/chimp-config.js @@ -18,7 +18,7 @@ module.exports = { mochaCommandLineOptions: ['--color'], mochaConfig: { tags: '', - grep: '', // Change to '03' for testing the 03-user-creation.js file + grep: '03', // Change to '03' for testing the 03-user-creation.js file timeout: 80000, reporter: 'spec', slow: 100, diff --git a/tests/end-to-end/ui/03-user-creation.js b/tests/end-to-end/ui/03-user-creation.js index 813800f059..feb9b2356d 100644 --- a/tests/end-to-end/ui/03-user-creation.js +++ b/tests/end-to-end/ui/03-user-creation.js @@ -10,19 +10,41 @@ https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence import signUpPage from '../../page-objects/signup.page'; import mainContent from '../../page-objects/main-content.page'; +import settingsPage from '../../page-objects/settings.page'; -import { username, email, password } from '../../data/user'; - +import { + username, + email, + password, + adminUsername, + adminEmail, + adminPassword, +} from '../../data/user'; +import { githubClientId, githubClientSecret } from '../../data/settings'; describe('03 user creation', () => { before(() => { signUpPage.open(); }); - it('create user', () => { + it('create admin user', () => { + // Create Admin user + signUpPage.registerNewUser({ adminUsername, adminEmail, adminPassword }); + + // Setup settings + signUpPage.gotModalToSetup(); + settingsPage.setupGithub({ githubClientId, githubClientSecret }); + + mainContent.signOutLink.waitForExist(5000); + mainContent.signOutLink.isVisible().should.be.true; + mainContent.logOut(); + }); + + it('create normal user', () => { signUpPage.registerNewUser({ username, email, password }); mainContent.signOutLink.waitForExist(5000); mainContent.signOutLink.isVisible().should.be.true; + mainContent.logOut(); }); }); diff --git a/tests/page-objects/settings.page.js b/tests/page-objects/settings.page.js index d12f7c5bbf..af30e8ecce 100644 --- a/tests/page-objects/settings.page.js +++ b/tests/page-objects/settings.page.js @@ -5,9 +5,9 @@ https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence /* globals browser */ -import MainContentPage from './main-content.page'; +import Page from './page'; -class SettingsPage extends MainContentPage { +class SettingsPage extends Page { // Left Menu diff --git a/tests/page-objects/signup.page.js b/tests/page-objects/signup.page.js index be9787a83c..39df6bac06 100644 --- a/tests/page-objects/signup.page.js +++ b/tests/page-objects/signup.page.js @@ -25,7 +25,7 @@ class SignUpPage extends Page { get confirmPasswordErrorField () { return this.errorFields[3]; } // Modal after first signup - get settingsLink () { return browser.element('#setup-settings'); } + get modalSettingsLink () { return browser.element('#setup-settings'); } open () { super.open(); @@ -43,9 +43,9 @@ class SignUpPage extends Page { this.submit(); } - gotToSetup () { - this.settingsLink.waitForVisible(5000); - this.settingsLink.click(); + gotModalToSetup () { + this.modalSettingsLink.waitForVisible(5000); + this.modalSettingsLink.click(); } submit () { From fffc32e759913e8c47e533f220c7e25d048d8bb7 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 12:03:47 -0300 Subject: [PATCH 29/84] Add nvmrc to use v4.8.3 --- .nvmrc | 1 + 1 file changed, 1 insertion(+) create mode 100644 .nvmrc diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000000..8fb83c6e90 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +v4.8.3 From f6dbcf0e88a5ffba0edf6138df0089c610afc002 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 16:05:32 -0300 Subject: [PATCH 30/84] Fix admin creation test --- tests/end-to-end/ui/03-user-creation.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/tests/end-to-end/ui/03-user-creation.js b/tests/end-to-end/ui/03-user-creation.js index feb9b2356d..6cae2cd593 100644 --- a/tests/end-to-end/ui/03-user-creation.js +++ b/tests/end-to-end/ui/03-user-creation.js @@ -28,8 +28,14 @@ describe('03 user creation', () => { }); it('create admin user', () => { + const adminCredentials = { + username: adminUsername, + email: adminEmail, + password: adminPassword, + }; + // Create Admin user - signUpPage.registerNewUser({ adminUsername, adminEmail, adminPassword }); + signUpPage.registerNewUser(adminCredentials); // Setup settings signUpPage.gotModalToSetup(); From 996a4a4e622bc325d7d20c76eb09212b59c385ac Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 16:15:14 -0300 Subject: [PATCH 31/84] Remove failing test --- tests/end-to-end/ui/03-user-creation.js | 8 -------- 1 file changed, 8 deletions(-) diff --git a/tests/end-to-end/ui/03-user-creation.js b/tests/end-to-end/ui/03-user-creation.js index 6cae2cd593..b92c261026 100644 --- a/tests/end-to-end/ui/03-user-creation.js +++ b/tests/end-to-end/ui/03-user-creation.js @@ -45,12 +45,4 @@ describe('03 user creation', () => { mainContent.signOutLink.isVisible().should.be.true; mainContent.logOut(); }); - - it('create normal user', () => { - signUpPage.registerNewUser({ username, email, password }); - - mainContent.signOutLink.waitForExist(5000); - mainContent.signOutLink.isVisible().should.be.true; - mainContent.logOut(); - }); }); From 354fcd5ca74a7b044352a003ef9171c24c85227c Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 16:15:32 -0300 Subject: [PATCH 32/84] Run all tests --- tests/chimp-config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/chimp-config.js b/tests/chimp-config.js index c554ec13dd..6aa6d50bd6 100644 --- a/tests/chimp-config.js +++ b/tests/chimp-config.js @@ -18,7 +18,7 @@ module.exports = { mochaCommandLineOptions: ['--color'], mochaConfig: { tags: '', - grep: '03', // Change to '03' for testing the 03-user-creation.js file + grep: '', // Change to '03' for testing the 03-user-creation.js file timeout: 80000, reporter: 'spec', slow: 100, From bfc0cc430799088c3fa93f5726889e47b454438d Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Tue, 20 Jun 2017 16:26:47 -0300 Subject: [PATCH 33/84] Remove unused variables --- tests/end-to-end/ui/03-user-creation.js | 3 --- 1 file changed, 3 deletions(-) diff --git a/tests/end-to-end/ui/03-user-creation.js b/tests/end-to-end/ui/03-user-creation.js index b92c261026..a5770db78e 100644 --- a/tests/end-to-end/ui/03-user-creation.js +++ b/tests/end-to-end/ui/03-user-creation.js @@ -13,9 +13,6 @@ import mainContent from '../../page-objects/main-content.page'; import settingsPage from '../../page-objects/settings.page'; import { - username, - email, - password, adminUsername, adminEmail, adminPassword, From 9a61f021e51eeeb8c4d669be9b593e188158f387 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Wed, 21 Jun 2017 11:57:56 -0300 Subject: [PATCH 34/84] Install yarn official repo --- .travis.yml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index a26b953b6d..576bc92ae4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,11 +6,15 @@ node_js: addons: apt: sources: - - ubuntu-toolchain-r-test + - ubuntu-toolchain-r-test + - sourceline: 'deb https://dl.yarnpkg.com/debian/ stable main' + key_url: 'https://dl.yarnpkg.com/debian/pubkey.gpg' packages: - - g++-4.8 + - g++-4.8 + - yarn chrome: stable + branches: only: - develop @@ -29,9 +33,6 @@ services: before_install: # Install meteor locally on CI - if [ ! -e "$HOME/.meteor/meteor" ]; then curl https://install.meteor.com | sed s/--progress-bar/-sL/g | /bin/sh; fi - # Install Yarn - - curl -o- -L https://yarnpkg.com/install.sh | bash - - export PATH=$HOME/.yarn/bin:$PATH before_script: - yarn run lint From 38ea978d80674b801db56f705ea367ad689426a0 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Wed, 21 Jun 2017 13:56:03 -0300 Subject: [PATCH 35/84] Remove chimp node options --- .scripts/run-chimp.js | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/.scripts/run-chimp.js b/.scripts/run-chimp.js index bc515ffff8..4b3fb2d991 100644 --- a/.scripts/run-chimp.js +++ b/.scripts/run-chimp.js @@ -90,14 +90,7 @@ function startApp(callback) { function startChimp() { startProcess({ name: 'Chimp', - command: 'yarn run chimp-test', - options: { - env: Object.assign({}, process.env, { - NODE_PATH: process.env.NODE_PATH + - path.delimiter + srcDir + - path.delimiter + srcDir + '/node_modules' - }) - } + command: 'yarn run chimp-test' }); } From 981fe252499c76312ec83a8e96bf5bfe28d75273 Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Thu, 22 Jun 2017 11:23:14 -0300 Subject: [PATCH 36/84] Add ids to branding form-buttons --- branding/client/branding.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/branding/client/branding.html b/branding/client/branding.html index b104476644..83539e7adb 100644 --- a/branding/client/branding.html +++ b/branding/client/branding.html @@ -46,7 +46,7 @@

{{> afQuickField name='homeCustomBlock' }}
-
@@ -62,7 +62,7 @@

{{> afQuickField name='footerCode' }} {{> afQuickField name='socialMedia' }}
-
From f7715f9d1a751268d835e931080ed92a6ff5deaf Mon Sep 17 00:00:00 2001 From: Mauricio Vieira Date: Thu, 22 Jun 2017 11:23:35 -0300 Subject: [PATCH 37/84] Add getters for settings page --- tests/page-objects/settings.page.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/tests/page-objects/settings.page.js b/tests/page-objects/settings.page.js index af30e8ecce..476796ab46 100644 --- a/tests/page-objects/settings.page.js +++ b/tests/page-objects/settings.page.js @@ -10,12 +10,26 @@ import Page from './page'; class SettingsPage extends Page { // Left Menu + get buttonProfileLink () { return browser.element('#button-profile'); } + get buttonAccountLink () { return browser.element('#button-account'); } + get buttonBrandingLink () { return browser.element('#button-branding'); } + get buttonSettingsLink () { return browser.element('#button-settings'); } + get buttonProxiesLink () { return browser.element('#button-proxies'); } // Profile + get username () { return browser.element('#username'); } + get company () { return browser.element('#company'); } + get updateButton () { return browser.element('#update-button'); } // Account + get passwordOld () { return browser.element('#password-old'); } + get passwordNew () { return browser.element('#password-new'); } + get passwordNewAgain () { return browser.element('#password-new-again'); } + get submitPasswordButton () { return browser.element('#submit-password'); } // Branding + get brandingUpdateButton () { return browser.element('#branding-update-button'); } + get brandingSaveButton () { return browser.element('#branding-save-button'); } // Settings get githubId () { return browser.element('#github-id'); } From 047e8358df3c9c46161da345363fee380009bc3d Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 10:51:01 +0300 Subject: [PATCH 38/84] Authorization is not required for POST operation --- users/collection/server/api.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index e31b0af535..4af65f320f 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -280,8 +280,8 @@ ApiV1.addCollection(Meteor.users, { }, post: { - authRequired: true, - roleRequired: ['admin'], + authRequired: false, + // roleRequired: ['admin'], swagger: { tags: [ ApiV1.swagger.tags.users, From f93a1a7c60fa3ae361e9723a83b1a0115f53cc61 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 10:53:26 +0300 Subject: [PATCH 39/84] Changes in user related parameters - renamed userName to username - corrected name and description in addUser and updateUser data models - corrections in examples --- core/server/api.js | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 95744a0788..3003a70657 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -26,25 +26,25 @@ UserFields.struct = { params: { addUser: { - name: 'Update user', + name: 'addUserData', in: 'body', - description: 'Data for adding User', + description: 'Data for adding a user account', schema: { - required: ['userName', 'password', 'email'], + required: ['username', 'password', 'email'], properties: { - userName: { + username: { type: 'string', - example: 'John Doe', + example: 'johndoe', }, password: { type: 'string', - example: 'secrecy_is_everything#¤%', + example: 'password', }, email: { type: 'string', format: 'email', description: 'E-mail address of user', - example: 'company-mail@gmail.com', + example: 'firstname.lastname@vendor.com', }, }, }, @@ -136,15 +136,15 @@ UserFields.struct = { type: 'string', }, updateUser: { - name: 'Update user', + name: 'updateUserData', in: 'body', - description: 'Data for editing User', + description: 'Data for updating a user account', schema: { required: [], properties: { - userName: { + username: { type: 'string', - example: 'John Doe', + example: 'johndoe', }, company: { type: 'string', @@ -152,7 +152,7 @@ UserFields.struct = { }, password: { type: 'string', - example: 'secrecy_is_everything#¤%', + example: 'updatedPassword', }, }, }, @@ -164,7 +164,7 @@ UserFields.struct = { required: true, type: 'string', }, - userName: { + username: { name: 'username', in: 'body', description: 'Name of user', @@ -483,7 +483,7 @@ ApiV1.swagger = { required: true, type: 'string', }, - userName: { + username: { name: 'username', in: 'body', description: 'Username', @@ -587,7 +587,7 @@ ApiV1.swagger = { required: ['name', 'email', 'password'], properties: { username: - UserFields.struct.params.userName, + UserFields.struct.params.username, email: UserFields.struct.params.email, password: From 27f462540d72f67f1ec9130a4f92881ec908d9b0 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 12:42:49 +0300 Subject: [PATCH 40/84] Removed parameter delete from Users path --- core/server/api.js | 33 +-------------------------------- 1 file changed, 1 insertion(+), 32 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index a395f66965..a5c26162d4 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -247,38 +247,7 @@ ApiV1.swagger = { '/users/{id}': { get: {}, - delete: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Deletes the identified User.', - parameters: [ - UserFields.struct.params.userId, - ], - responses: { - 200: { - description: 'User deleted.', - }, - 400: { - description: 'Invalid input, invalid object', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'User not found', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, + delete: {}, put: { tags: [ UserFields.struct.tags.users, From 84d0ea92d2c873dfd2b12ab0fffa0e142bcb2ba0 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 12:44:24 +0300 Subject: [PATCH 41/84] Moved descriptions of parameter delete from ApiV1.addCollection to ApiV1.swagger.meta.paths --- users/collection/server/api.js | 65 +++++++++++++++++----------------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 505975a59c..d74d7b5af6 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -42,6 +42,39 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { }, }; +ApiV1.swagger.meta.paths['/users/{id}'].delete = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Deletes the identified User.', + parameters: [ + ApiV1.swagger.params.userId, + ], + responses: { + 200: { + description: 'User deleted.', + }, + 400: { + description: 'Invalid input, invalid object', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'User not found', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -385,38 +418,6 @@ ApiV1.addCollection(Meteor.users, { // Delete a user delete: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Deletes the identified User.', - parameters: [ - ApiV1.swagger.params.userId, - ], - responses: { - 200: { - description: 'User deleted.', - }, - 400: { - description: 'Invalid input, invalid object', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'User not found', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, action () { // Get requestor's id const requestorId = this.userId; From 9e816db7eea25fe4c08073303a83aa9006ee10f5 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 13:02:03 +0300 Subject: [PATCH 42/84] Removed method PUT from Users swagger --- core/server/api.js | 34 +--------------------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index a5c26162d4..36e9f7e7f7 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -248,39 +248,7 @@ ApiV1.swagger = { '/users/{id}': { get: {}, delete: {}, - put: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Update a User', - parameters: [ - UserFields.struct.params.userId, - UserFields.struct.params.updateUser, - ], - responses: { - 200: { - description: 'User successfully updated.', - }, - 400: { - description: 'Invalid input, object invalid, Erroneous new password', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'No user found with given UserID', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, + put: {}, }, '/users/updates': { From 2a6b3c39ddb93aaa8351927f88d6c09eacaf85c2 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 13:03:25 +0300 Subject: [PATCH 43/84] Moved method PUT from ApiV1.addCollection to ApiV1.swagger.meta.paths --- users/collection/server/api.js | 70 ++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 33 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index d74d7b5af6..f14f712d92 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -75,6 +75,42 @@ ApiV1.swagger.meta.paths['/users/{id}'].delete = { ], }; +ApiV1.swagger.meta.paths['/users/{id}'].put = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Update a User', + parameters: [ + ApiV1.swagger.params.userId, + ApiV1.swagger.params.username, + ApiV1.swagger.params.company, + ApiV1.swagger.params.password, + ], + responses: { + 200: { + description: 'User successfully updated.', + }, + 400: { + description: 'Invalid input, object invalid, Erroneous new password', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'No user found with given UserID', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -331,7 +367,7 @@ ApiV1.addCollection(Meteor.users, { ], description: 'Adds a new user. On success, returns newly added object.', parameters: [ - ApiV1.swagger.params.userName, + ApiV1.swagger.params.username, ApiV1.swagger.params.email, ApiV1.swagger.params.password, ], @@ -468,38 +504,6 @@ ApiV1.addCollection(Meteor.users, { // Udpdate user data put: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Update a User', - parameters: [ - ApiV1.swagger.params.userId, - ApiV1.swagger.params.userName, - ApiV1.swagger.params.company, - ApiV1.swagger.params.password, - ], - responses: { - 200: { - description: 'User successfully updated.', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'No user found with given UserID', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, action () { // Get requestor's id const requestorId = this.userId; From c93d253e37fa874f49d13e6b88c1c29632790f6a Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 17:00:15 +0300 Subject: [PATCH 44/84] Changes in descriptions - removed swagger definition of methods POST and GET - renamed and corrected data types --- core/server/api.js | 93 +++++++++++++++------------------------------- 1 file changed, 30 insertions(+), 63 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 36e9f7e7f7..7f91381a4d 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -211,38 +211,7 @@ ApiV1.swagger = { }, }, }, - post: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Adds a new user. On success, returns newly added object.', - consumes: 'application/json', - produces: 'application/json', - - parameters: [ - UserFields.struct.params.addUser, - ], - responses: { - 201: { - description: 'User successfully added', - }, - 400: { - description: 'Invalid input, object invalid', - }, - 401: { - description: 'Authentication is required', - }, - 409: { - description: 'User already exists', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, + post: {}, }, '/users/{id}': { @@ -252,30 +221,7 @@ ApiV1.swagger = { }, '/users/updates': { - get: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Returns users, who are created in given timeframe', - parameters: [ - UserFields.struct.params.since, - UserFields.struct.params.organizationId, - UserFields.struct.params.skip, - UserFields.struct.params.limit, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - 401: { - description: 'Authentication is required', - }, - }, - }, - + get: {}, }, }, @@ -320,6 +266,12 @@ ApiV1.swagger = { required: true, type: 'string', }, + createdAt: { + name: 'createdAt', + in: 'body', + description: 'Date and time in ISODate format, e.g. "2012-07-14T01:00:00+01:00" ', + type: 'string', + }, email: { name: 'email', in: 'body', @@ -390,6 +342,15 @@ ApiV1.swagger = { format: 'int32', minimum: 1, }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, userId: { name: 'id', in: 'path', @@ -397,6 +358,13 @@ ApiV1.swagger = { required: true, type: 'string', }, + userIdResponse: { + name: '_id', + in: 'body', + description: 'ID of User', + required: true, + type: 'string', + }, username: { name: 'username', in: 'body', @@ -404,15 +372,14 @@ ApiV1.swagger = { required: true, type: 'string', }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', + userOrganizationId: { + name: 'organization_id', + in: 'path', + description: 'ID of Organization, that User belongs to', required: false, - type: 'integer', - format: 'int32', - minimum: 0, + type: 'string', }, + }, definitions: { // The schema defining the type used for the body parameter. From 2dc609139a6aa5819c100451796c0631f5ecd23a Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 17:01:56 +0300 Subject: [PATCH 45/84] Changes in swagger definitions - moved methods GET and POST to paths - corrected variable name --- users/collection/server/api.js | 177 +++++++++++++++++++-------------- 1 file changed, 103 insertions(+), 74 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index f14f712d92..ad69dc8edd 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -17,6 +17,76 @@ import Organizations from '/organizations/collection'; // Npm packages imports import _ from 'lodash'; +ApiV1.swagger.meta.paths['/users'].get = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Returns all users', + parameters: [ + ApiV1.swagger.params.optionalSearch, + ApiV1.swagger.params.userOrganizationId, + ApiV1.swagger.params.skip, + ApiV1.swagger.params.limit, + ApiV1.swagger.params.sort_by, + ], + responses: { + 200: { + description: 'success', + parameters: [ + ApiV1.swagger.params.userIdResponse, + ApiV1.swagger.params.createdAt, + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ], + }, + 400: { + description: 'Bad query parameters', + }, + 401: { + description: 'Authentication is required', + }, + }, +}; + +ApiV1.swagger.meta.paths['/users'].post = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Adds a new user. On success, returns newly added object.', + parameters: [ + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ApiV1.swagger.params.password, + ], + responses: { + 201: { + description: 'User successfully added', + parameters: [ + ApiV1.swagger.params.userIdResponse, + ApiV1.swagger.params.createdAt, + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ], + + }, + 400: { + description: 'Invalid input, object invalid', + }, + 401: { + description: 'Authentication is required', + }, + 409: { + description: 'User already exists', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], +}; + ApiV1.swagger.meta.paths['/users/{id}'].get = { tags: [ @@ -29,6 +99,7 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { responses: { 200: { description: 'Data of identified user.', + }, 401: { description: 'Authentication is required', @@ -111,6 +182,36 @@ ApiV1.swagger.meta.paths['/users/{id}'].put = { ], }; +ApiV1.swagger.meta.paths['/users/updates'].get = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Returns users based on creation date', + parameters: [ + ApiV1.swagger.params.since, + ApiV1.swagger.params.userOrganizationId, + ApiV1.swagger.params.skip, + ApiV1.swagger.params.limit, + ], + responses: { + 200: { + description: 'success', + parameters: [ + ApiV1.swagger.params.userIdResponse, + ApiV1.swagger.params.createdAt, + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ], + }, + 400: { + description: 'Bad query parameters', + }, + 401: { + description: 'Authentication is required', + }, + }, +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -121,27 +222,6 @@ ApiV1.addCollection(Meteor.users, { endpoints: { getAll: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Returns: For Admin: all users data. For non-admin: only own data.', - parameters: [ - ApiV1.swagger.params.optionalSearch, - ApiV1.swagger.params.organization_id, - ApiV1.swagger.params.skip, - ApiV1.swagger.params.limit, - ApiV1.swagger.params.sort_by, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - }, - }, action () { const queryParams = this.queryParams; @@ -154,9 +234,9 @@ ApiV1.addCollection(Meteor.users, { const requestorId = this.userId; // Check if requestor is administrator - const requestorHasRights = Roles.userIsInRole(requestorId, ['admin']); + const requestorIsAdmin = Roles.userIsInRole(requestorId, ['admin']); - if (!requestorHasRights) { + if (!requestorIsAdmin) { searchOnlyWithOwnId = true; } @@ -361,37 +441,6 @@ ApiV1.addCollection(Meteor.users, { post: { authRequired: false, // roleRequired: ['admin'], - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Adds a new user. On success, returns newly added object.', - parameters: [ - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ApiV1.swagger.params.password, - ], - responses: { - 201: { - description: 'User successfully added', - }, - 400: { - description: 'Invalid input, object invalid', - }, - 401: { - description: 'Authentication is required', - }, - 409: { - description: 'User already exists', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, action () { // Get data from body parameters const bodyParams = this.bodyParams; @@ -639,26 +688,6 @@ ApiV1.addCollection(Meteor.users, { ApiV1.addRoute('users/updates', { get: { roleRequired: ['admin'], - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Returns users', - parameters: [ - ApiV1.swagger.params.since, - ApiV1.swagger.params.organization_id, - ApiV1.swagger.params.skip, - ApiV1.swagger.params.limit, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - }, - }, action () { let badQueryParameters = false; // Read possible query parameters From a16164fdaa6ce6d9d342dadbb2f209613d46efa5 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Tue, 27 Jun 2017 15:02:21 +0300 Subject: [PATCH 46/84] Update text about removing proxy --- core/lib/i18n/en.i18n.json | 13 ++++++------- proxies/client/remove/remove.html | 9 +++++---- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/core/lib/i18n/en.i18n.json b/core/lib/i18n/en.i18n.json index 2f2d3cdf4f..fc8be7ad24 100644 --- a/core/lib/i18n/en.i18n.json +++ b/core/lib/i18n/en.i18n.json @@ -181,8 +181,7 @@ "backlogItem_deleteButton_text": "Delete", "bookmark_buttonText_bookmark": "Bookmark", "bookmark_buttonText_unbookmark": "Unbookmark", - "branding_homeCustomBlock_helpIcon_text": "This field gives you the ability to add text and HTML/CSS custom code which will appear on the home page. - In addition you may add HTML content like images, social media plugins, or YouTube video. Bootstrap classes are also available, e.g. you may use .container to center your content on a page.", + "branding_homeCustomBlock_helpIcon_text": "This field gives you the ability to add text and HTML/CSS custom code which will appear on the home page. In addition you may add HTML content like images, social media plugins, or YouTube video. Bootstrap classes are also available, e.g. you may use .container to center your content on a page.", "branding_panel_title": "Project Branding", "branding_save": "Save", "branding_successMessage": "Branding saved", @@ -451,7 +450,6 @@ "organizationSettings_uploadLogo_heading": "Logo", "organizationSettings_uploadCover_heading": "Cover photo", "organizationSettings_uploadLogoText": "You can upload a logo for your organization. The logo will appear in the catalogue and on the single organization profile.", - "organizationSettings_uploadCover_heading": "Upload cover image", "organizationSettings_uploadCoverText": "You can upload a cover image for your organization.", "organizationSettingsDelete_buttonText_delete": "Delete", "organizationSettingsDelete_text_information": "The organization information will be removed and all APIs will be disconnected. This action cannot be undone.", @@ -550,10 +548,11 @@ "postItem_buttonText_delete": "Delete", "postItem_buttonText_edit": "Edit", "postItem_text_added": "Added", - "removeProxy_modalLabel": "Are you sure that you want to remove proxy?", - "removeProxy_modalBody": "proxy backends are connected to this proxy. Removing the proxy will mean that API calls made to any of the connected API backends will break.", - "removeProxy_confirmRemoveProxy": "Yes, remove", - "removeProxy_cancelRemove": "Cancel", + "removeProxy_modalLabel_title": "Removing Proxy", + "removeProxy_modalBody_warning": "Warning!", + "removeProxy_modalBody_text": "You are about to remove a proxy. There are currently __count__ APIs connected to this proxy. Removing the proxy would break all API calls made to the connected API backends. Are you sure you want to continue?", + "removeProxy_buttonText_confirmRemoveProxy": "Yes", + "removeProxy_buttonText_cancelRemove": "No", "removeProxy_errorMessage": "Error: Proxy removal failed", "requestsOverTimeChart_showingRecordsCount": "Showing records", "requestsOverTimeChart_title": "API Request Timeline", diff --git a/proxies/client/remove/remove.html b/proxies/client/remove/remove.html index c51f242653..3693f7d3c0 100644 --- a/proxies/client/remove/remove.html +++ b/proxies/client/remove/remove.html @@ -23,24 +23,25 @@
- {{ connectedProxyBackends }} {{_ "removeProxy_modalBody" }} + {{_ "removeProxy_modalBody_warning" }} + {{_ "removeProxy_modalBody_text" count=connectedProxyBackends }}
From 499cf9bb7773befad2a1e181d37e651a3472b967 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 27 Jun 2017 16:27:14 +0300 Subject: [PATCH 47/84] Changes in definitions of Users route - moved definitions from Userfields to Api.swagger - changed definitions accordingly - removed overlapping struct Userfields - removed method GET for /users - corrected values of parameters in definitions --- core/server/api.js | 421 ++++++++++++++++++++++++--------------------- 1 file changed, 224 insertions(+), 197 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 7f91381a4d..6c16a32823 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -17,164 +17,6 @@ const ApiV1 = new Restivus({ enableCors: true, }); -const UserFields = {}; - -UserFields.struct = { - tags: { - users: 'Users', - }, - - params: { - addUser: { - name: 'addUserData', - in: 'body', - description: 'Data for adding a user account', - schema: { - required: ['username', 'password', 'email'], - properties: { - username: { - type: 'string', - example: 'johndoe', - }, - password: { - type: 'string', - example: 'password', - }, - email: { - type: 'string', - format: 'email', - description: 'E-mail address of user', - example: 'firstname.lastname@vendor.com', - }, - }, - }, - }, - company: { - name: 'company', - in: 'body', - description: 'Company name of user', - required: true, - type: 'string', - }, - email: { - name: 'email', - in: 'body', - description: 'Email address for user', - required: true, - type: 'string', - }, - // getUserData { - // properties: - // _id: - // type: string - // example: '7L4jNtdfNFGH3igPs' - // created_at: - // $ref: '#/definitions/get_user_created_at' - // username: - // type: string - // example: myusername - // profile: - // $ref: '#/definitions/get_user_profile' - // organization: - // $ref: '#/definitions/get_user_organization' - // - // }, - limit: { - name: 'limit', - in: 'query', - description: 'Maximum number of records to return in query.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 50, - }, - optionalSearch: { - name: 'q', - in: 'query', - description: 'Pass an optional search string for looking up users.', - required: false, - type: 'string', - }, - organizationId: { - name: 'organization_id', - in: 'query', - description: 'Limit results to the given organization.', - required: false, - type: 'string', - }, - password: { - name: 'password', - in: 'body', - description: 'Password for user', - required: true, - type: 'string', - }, - since: { - name: 'since', - in: 'query', - description: 'Time frame in days', - required: false, - type: 'integer', - format: 'int32', - minimum: 1, - }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - }, - sortBy: { - name: 'sort_by', - in: 'query', - description: 'options "username, created_at".', - required: false, - type: 'string', - }, - updateUser: { - name: 'updateUserData', - in: 'body', - description: 'Data for updating a user account', - schema: { - required: [], - properties: { - username: { - type: 'string', - example: 'johndoe', - }, - company: { - type: 'string', - example: 'Amazing Company Ltd.', - }, - password: { - type: 'string', - example: 'updatedPassword', - }, - }, - }, - }, - userId: { - name: 'id', - in: 'path', - description: 'Id of the user to fetch.', - required: true, - type: 'string', - }, - username: { - name: 'username', - in: 'body', - description: 'Name of user', - required: true, - type: 'string', - }, - }, - -}; - // Add Restivus Swagger configuration - meta, tags, params, definitions ApiV1.swagger = { meta: { @@ -186,31 +28,7 @@ ApiV1.swagger = { }, paths: { '/users': { - get: { - tags: [ - UserFields.struct.tags.users, - ], - - description: 'Returns: For Admin: all users data. For non-admin: only own data.', - parameters: [ - UserFields.struct.params.optionalSearch, - UserFields.struct.params.organizationId, - UserFields.struct.params.skip, - UserFields.struct.params.limit, - UserFields.struct.params.sortBy, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - 401: { - description: 'Authentication is required', - }, - }, - }, + get: {}, post: {}, }, @@ -279,6 +97,14 @@ ApiV1.swagger = { required: true, type: 'string', }, + emailResponse: { + properties: { + name: 'address', + in: 'body', + description: 'Email address for user', + type: 'string', + }, + }, lifecycle: { name: 'lifecycle', in: 'query', @@ -321,7 +147,7 @@ ApiV1.swagger = { }, organizationId: { name: 'id', - in: 'path', + in: 'query', description: 'ID of Organization', required: true, type: 'string', @@ -335,9 +161,9 @@ ApiV1.swagger = { }, since: { name: 'since', - in: 'path', + in: 'query', description: 'Time frame in days', - required: true, + required: false, type: 'integer', format: 'int32', minimum: 1, @@ -351,6 +177,30 @@ ApiV1.swagger = { format: 'int32', minimum: 0, }, + sortBy: { + name: 'sort_by', + in: 'query', + description: 'Criteria for sort ', + required: false, + type: 'string', + }, + userAddition: { + name: 'user', + in: 'body', + description: 'Data for adding a new User', + schema: { + $ref: '#/definitions/user_addition', + }, + }, + userUpdate: { + name: 'user', + in: 'body', + description: 'Data for updating a User', + schema: { + $ref: '#/definitions/user_update', + }, + }, + userId: { name: 'id', in: 'path', @@ -374,7 +224,7 @@ ApiV1.swagger = { }, userOrganizationId: { name: 'organization_id', - in: 'path', + in: 'query', description: 'ID of Organization, that User belongs to', required: false, type: 'string', @@ -465,21 +315,198 @@ ApiV1.swagger = { }, users: { - required: ['name', 'email', 'password'], + required: ['username', 'email', 'password'], properties: { - username: - UserFields.struct.params.username, - email: - UserFields.struct.params.email, - password: - UserFields.struct.params.password, - company: - UserFields.struct.params.company, + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'john.doe@ispname.com', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, + company: { + type: 'string', + description: 'Company name of user', + example: 'My Company Ltd', + }, + }, + }, + user_addition: { + required: ['username', 'email', 'password'], + properties: { + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'john.doe@ispname.com', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, + }, + }, + user_update: { + required: ['username', 'company', 'password'], + properties: { + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + company: { + type: 'string', + description: 'Name of company user belongs to', + example: 'Mighty API owners Ltd.', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, }, }, - }, + get_user_profile: { + type: 'object', + properties: { + company: { + type: 'string', + example: 'Mighty API owners Ltd.', + }, + }, + }, + get_user_created_at: { + type: 'string', + example: '2012-07-14T01:00:00+01:00', + description: 'Dates and times are stored in ISODate format', + }, + post_user_email_address: { + type: 'array', + items: { + type: 'object', + properties: { + address: { + type: 'string', + example: 'sam.won@apinf.io', + }, + verified: { + type: 'string', + example: 'false', + }, + }, + }, + }, + get_user_roles: { + type: 'array', + items: { + type: 'string', + example: 'manager', + }, + }, + get_user_data: { + type: 'object', + properties: { + status: { + type: 'string', + example: 'success', + }, + data: { + type: 'object', + properties: { + _id: { + type: 'string', + example: '7L4jNtdfNFGH3igPs', + }, + created_at: { + $ref: '#/definitions/get_user_created_at', + }, + username: { + type: 'string', + example: 'myusername', + }, + emails: { + $ref: '#/definitions/post_user_email_address', + }, + profile: { + $ref: '#/definitions/get_user_profile', + }, + roles: { + $ref: '#/definitions/get_user_roles', + }, + organization: { + $ref: '#/definitions/get_user_organization', + }, + }, + }, + }, + }, + get_user_organization: { + type: 'array', + items: { + type: 'object', + properties: { + organization_id: { + type: 'string', + example: 'eFsLsJH3JTos4HfLc', + }, + organization_name: { + type: 'string', + example: 'APInf oy', + }, + }, + }, + }, + + post_user_response: { + type: 'object', + properties: { + status: { + type: 'string', + example: 'success', + }, + data: { + type: 'object', + properties: { + _id: { + type: 'string', + example: '7L4jNtdfNFGH3igPs', + }, + created_at: { + $ref: '#/definitions/get_user_created_at', + }, + username: { + type: 'string', + example: 'myusername', + }, + emails: { + $ref: '#/definitions/post_user_email_address', + }, + profile: { + $ref: '#/definitions/get_user_profile', + }, + }, + }, + }, + }, + + }, }; // Generate Swagger to route /rest/v1/swagger.json From 7b37f5cc1ac50169138a43029f4894f8ab4825e7 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 27 Jun 2017 16:28:56 +0300 Subject: [PATCH 48/84] Changes in methods - corrected descriptions - added summaries - changed parameter references according to changes in main swagger docment --- users/collection/server/api.js | 55 ++++++++++++++++------------------ 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index ad69dc8edd..67764f76f7 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -21,23 +21,21 @@ ApiV1.swagger.meta.paths['/users'].get = { tags: [ ApiV1.swagger.tags.users, ], - description: 'Returns all users', + summary: 'List and search users.', + description: 'By passing options you can search users in system.', + produces: 'application/json', parameters: [ ApiV1.swagger.params.optionalSearch, ApiV1.swagger.params.userOrganizationId, ApiV1.swagger.params.skip, ApiV1.swagger.params.limit, - ApiV1.swagger.params.sort_by, + ApiV1.swagger.params.sortBy, ], responses: { 200: { - description: 'success', - parameters: [ - ApiV1.swagger.params.userIdResponse, - ApiV1.swagger.params.createdAt, - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ], + description: 'Success', + schema: + ApiV1.swagger.definitions.get_user_data, }, 400: { description: 'Bad query parameters', @@ -52,22 +50,17 @@ ApiV1.swagger.meta.paths['/users'].post = { tags: [ ApiV1.swagger.tags.users, ], + summary: 'Adds a new user.', description: 'Adds a new user. On success, returns newly added object.', + produces: 'application/json', parameters: [ - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ApiV1.swagger.params.password, + ApiV1.swagger.params.userAddition, ], responses: { 201: { description: 'User successfully added', - parameters: [ - ApiV1.swagger.params.userIdResponse, - ApiV1.swagger.params.createdAt, - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ], - + schema: + ApiV1.swagger.definitions.post_user_response, }, 400: { description: 'Invalid input, object invalid', @@ -92,13 +85,17 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { tags: [ ApiV1.swagger.tags.users, ], + summary: 'Search Users one by one with userID.', description: 'Returns user data with given ID.', + produces: 'application/json', parameters: [ ApiV1.swagger.params.userId, ], responses: { 200: { description: 'Data of identified user.', + schema: + ApiV1.swagger.definitions.get_user_data, }, 401: { @@ -117,6 +114,7 @@ ApiV1.swagger.meta.paths['/users/{id}'].delete = { tags: [ ApiV1.swagger.tags.users, ], + summary: 'Delete Users one by one with userID.', description: 'Deletes the identified User.', parameters: [ ApiV1.swagger.params.userId, @@ -150,12 +148,11 @@ ApiV1.swagger.meta.paths['/users/{id}'].put = { tags: [ ApiV1.swagger.tags.users, ], - description: 'Update a User', + summary: 'Update User\'s data.', + description: 'Updates data of a User indicated by user ID.', parameters: [ ApiV1.swagger.params.userId, - ApiV1.swagger.params.username, - ApiV1.swagger.params.company, - ApiV1.swagger.params.password, + ApiV1.swagger.params.userUpdate, ], responses: { 200: { @@ -186,7 +183,9 @@ ApiV1.swagger.meta.paths['/users/updates'].get = { tags: [ ApiV1.swagger.tags.users, ], - description: 'Returns users based on creation date', + summary: 'List and search user based on addition date', + description: 'Returns users based on addition date', + produces: 'application/json', parameters: [ ApiV1.swagger.params.since, ApiV1.swagger.params.userOrganizationId, @@ -196,12 +195,8 @@ ApiV1.swagger.meta.paths['/users/updates'].get = { responses: { 200: { description: 'success', - parameters: [ - ApiV1.swagger.params.userIdResponse, - ApiV1.swagger.params.createdAt, - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ], + schema: + ApiV1.swagger.definitions.get_user_data, }, 400: { description: 'Bad query parameters', From de1468bf9b474bb08ee407c33864d33f2466ccfc Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 28 Jun 2017 16:04:00 +0300 Subject: [PATCH 49/84] Added definitions for user login and credentials --- core/server/api.js | 64 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/core/server/api.js b/core/server/api.js index 6c16a32823..11e5b73656 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -42,6 +42,10 @@ ApiV1.swagger = { get: {}, }, + '/login': { + post: {}, + }, + }, securityDefinitions: { userSecurityToken: { @@ -60,6 +64,7 @@ ApiV1.swagger = { api: 'APIs', organization: 'Organizations', users: 'Users', + login: 'Login', }, params: { api: { @@ -192,6 +197,14 @@ ApiV1.swagger = { $ref: '#/definitions/user_addition', }, }, + userLogin: { + name: 'user', + in: 'body', + description: 'User login data', + schema: { + $ref: '#/definitions/user_login', + }, + }, userUpdate: { name: 'user', in: 'body', @@ -229,6 +242,20 @@ ApiV1.swagger = { required: false, type: 'string', }, + x_user_id: { + name: 'X-User-Id', + in: 'header', + description: 'User ID for authentication', + required: false, + type: 'string', + }, + x_auth_token: { + name: 'X-Auth-Token', + in: 'header', + description: 'Authentication Token', + required: false, + type: 'string', + }, }, definitions: { @@ -361,6 +388,21 @@ ApiV1.swagger = { }, }, }, + user_login: { + required: ['username', 'password'], + properties: { + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, + }, + }, user_update: { required: ['username', 'company', 'password'], properties: { @@ -505,6 +547,28 @@ ApiV1.swagger = { }, }, }, + user_login_response: { + type: 'object', + properties: { + status: { + type: 'string', + example: 'success', + }, + data: { + type: 'object', + properties: { + authToken: { + type: 'string', + example: '7L4jNt-dfNFGH3igPslP5VMH0-hrnbMSFtmjfVOMm_zVg0yT8eGQ-', + }, + userId: { + type: 'string', + example: 'GFJzMtdzqEYgH8PHSQ-', + }, + }, + }, + }, + }, }, }; From 68932ff871f0e82e152c7db94112be0db2d8a5e9 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 28 Jun 2017 16:04:50 +0300 Subject: [PATCH 50/84] Added swagger path descriptions for user login and using credentials --- users/collection/server/api.js | 35 ++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 67764f76f7..e0779c6963 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -17,6 +17,31 @@ import Organizations from '/organizations/collection'; // Npm packages imports import _ from 'lodash'; +ApiV1.swagger.meta.paths['/login'].post = { + tags: [ + ApiV1.swagger.tags.login, + ], + summary: 'Logging in.', + description: 'By giving existing username and password you get login credentials.', + produces: 'application/json', + parameters: [ + ApiV1.swagger.params.userLogin, + ], + responses: { + 200: { + description: 'Success', + schema: + ApiV1.swagger.definitions.user_login_response, + }, + 400: { + description: 'Bad query parameters', + }, + 401: { + description: 'Unauthorized', + }, + }, +}; + ApiV1.swagger.meta.paths['/users'].get = { tags: [ ApiV1.swagger.tags.users, @@ -25,6 +50,8 @@ ApiV1.swagger.meta.paths['/users'].get = { description: 'By passing options you can search users in system.', produces: 'application/json', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.optionalSearch, ApiV1.swagger.params.userOrganizationId, ApiV1.swagger.params.skip, @@ -89,6 +116,8 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { description: 'Returns user data with given ID.', produces: 'application/json', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.userId, ], responses: { @@ -117,6 +146,8 @@ ApiV1.swagger.meta.paths['/users/{id}'].delete = { summary: 'Delete Users one by one with userID.', description: 'Deletes the identified User.', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.userId, ], responses: { @@ -151,6 +182,8 @@ ApiV1.swagger.meta.paths['/users/{id}'].put = { summary: 'Update User\'s data.', description: 'Updates data of a User indicated by user ID.', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.userId, ApiV1.swagger.params.userUpdate, ], @@ -187,6 +220,8 @@ ApiV1.swagger.meta.paths['/users/updates'].get = { description: 'Returns users based on addition date', produces: 'application/json', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.since, ApiV1.swagger.params.userOrganizationId, ApiV1.swagger.params.skip, From 50d9db979faba7e39e34c2f051ebde1c605122b9 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Mon, 26 Jun 2017 18:25:32 +0300 Subject: [PATCH 51/84] Update config files Install npm packages raven & raven-js Update yarn.lock & package.json Add rule to ESlint config file --- .eslintrc | 2 +- package.json | 2 ++ yarn.lock | 37 ++++++++++++++++++++++++++++++++----- 3 files changed, 35 insertions(+), 6 deletions(-) diff --git a/.eslintrc b/.eslintrc index 78b57b072d..1a5791e1a2 100644 --- a/.eslintrc +++ b/.eslintrc @@ -44,7 +44,7 @@ "no-underscore-dangle": [ 2, { - "allow": ["_id", "__", "_initialized", "_config"] + "allow": ["_id", "__", "_initialized", "_config", "_debug"] } ], "no-negated-condition": [ diff --git a/package.json b/package.json index 1e73910510..cb400855cd 100644 --- a/package.json +++ b/package.json @@ -27,6 +27,8 @@ "lodash": "^4.17.4", "meteor-node-stubs": "^0.2.5", "moment": "^2.17.1", + "raven": "^2.1.0", + "raven-js": "^3.16.0", "simple-statistics": "^2.2.0", "swagger-client": "^2.1.32", "swagger-parser": "^3.4.1", diff --git a/yarn.lock b/yarn.lock index 66b053af55..1ab50fc0c3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1300,6 +1300,10 @@ convert-source-map@^1.1.0: version "1.5.0" resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-1.5.0.tgz#9acd70851c6d5dfdd93d9282e5edf94a03ff46b5" +cookie@0.3.1: + version "0.3.1" + resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.3.1.tgz#e7e0a1f9ef43b4c8ba925c5c5a96e806d16873bb" + cookiejar@^2.0.1, cookiejar@^2.0.6: version "2.1.1" resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.1.tgz#41ad57b1b555951ec171412a81942b1e8200d34a" @@ -2777,7 +2781,7 @@ json-stable-stringify@^1.0.0, json-stable-stringify@^1.0.1: dependencies: jsonify "~0.0.0" -json-stringify-safe@~5.0.0, json-stringify-safe@~5.0.1: +json-stringify-safe@5.0.1, json-stringify-safe@~5.0.0, json-stringify-safe@~5.0.1: version "5.0.1" resolved "https://registry.yarnpkg.com/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz#1296a2d58fd45f19a0f6ce01d65701e2c735b6eb" @@ -2984,6 +2988,10 @@ lru-cache@2.6.x: version "2.6.5" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-2.6.5.tgz#e56d6354148ede8d7707b58d143220fd08df0fd5" +lsmod@1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/lsmod/-/lsmod-1.0.0.tgz#9a00f76dca36eb23fa05350afe1b585d4299e64b" + meteor-node-stubs@^0.2.5: version "0.2.6" resolved "https://registry.yarnpkg.com/meteor-node-stubs/-/meteor-node-stubs-0.2.6.tgz#dd43c9a8bc7793d80adc766d342410da6de909c5" @@ -3555,6 +3563,21 @@ randombytes@^2.0.0, randombytes@^2.0.1: version "2.0.3" resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.0.3.tgz#674c99760901c3c4112771a31e521dc349cc09ec" +raven-js@^3.16.0: + version "3.16.0" + resolved "https://registry.yarnpkg.com/raven-js/-/raven-js-3.16.0.tgz#a799da4fdd04c63943f67deb93daa0ecfe101eab" + +raven@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/raven/-/raven-2.1.0.tgz#1b624e56374d9c9d93c74448461a2a356ce37527" + dependencies: + cookie "0.3.1" + json-stringify-safe "5.0.1" + lsmod "1.0.0" + stack-trace "0.0.9" + timed-out "4.0.1" + uuid "3.0.0" + rc@^1.1.7: version "1.2.1" resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.1.tgz#2e03e8e42ee450b8cb3dce65be1bf8974e1dfd95" @@ -4013,6 +4036,10 @@ stack-generator@^1.0.7: dependencies: stackframe "^1.0.2" +stack-trace@0.0.9: + version "0.0.9" + resolved "https://registry.yarnpkg.com/stack-trace/-/stack-trace-0.0.9.tgz#a8f6eaeca90674c333e7c43953f275b451510695" + stackframe@^0.3.1, stackframe@~0.3: version "0.3.1" resolved "https://registry.yarnpkg.com/stackframe/-/stackframe-0.3.1.tgz#33aa84f1177a5548c8935533cbfeb3420975f5a4" @@ -4257,7 +4284,7 @@ through2@2.0.1: version "2.3.8" resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" -timed-out@^4.0.0: +timed-out@4.0.1, timed-out@^4.0.0: version "4.0.1" resolved "https://registry.yarnpkg.com/timed-out/-/timed-out-4.0.1.tgz#f32eacac5a175bea25d7fab565ab3ed8741ef56f" @@ -4406,9 +4433,9 @@ util@0.10.3, util@^0.10.3: dependencies: inherits "2.0.1" -uuid@^3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.0.1.tgz#6544bba2dfda8c1cf17e629a3a305e2bb1fee6c1" +uuid@3.0.0, uuid@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.0.0.tgz#6728fc0459c450d796a99c31837569bdf672d728" validator@^6.0.0: version "6.3.0" From 6c2e0f7a7e1c399c805b2fd5f9d15ee05a0149fd Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Mon, 26 Jun 2017 18:31:04 +0300 Subject: [PATCH 52/84] Settings Raven for Client side --- .../capture_exception/client/error_handler.js | 36 +++++++++++++++++++ core/capture_exception/client/start_up.js | 27 ++++++++++++++ .../client/wrap_meteor_debug.js | 27 ++++++++++++++ 3 files changed, 90 insertions(+) create mode 100644 core/capture_exception/client/error_handler.js create mode 100644 core/capture_exception/client/start_up.js create mode 100644 core/capture_exception/client/wrap_meteor_debug.js diff --git a/core/capture_exception/client/error_handler.js b/core/capture_exception/client/error_handler.js new file mode 100644 index 0000000000..23cafe3f18 --- /dev/null +++ b/core/capture_exception/client/error_handler.js @@ -0,0 +1,36 @@ +/* Copyright 2017 Apinf Oy + This file is covered by the EUPL license. + You may obtain a copy of the licence at + https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Meteor packages imports +import { Meteor } from 'meteor/meteor'; +import { Accounts } from 'meteor/accounts-base'; + +// Npm packages imports +import Raven from 'raven-js'; + +// Set Global Error Handler +window.addEventListener('error', (e) => { + // Send error message and stack + Raven.captureException(e.message, { extra: { stack: e.error.stack } }); +}); + +// Set Global Error Handler on Promise rejection +window.addEventListener('unhandledrejection', (e) => { + // Send error message and stack + Raven.captureException(e.reason.message, { extra: { stack: e.reason.stack } }); +}); + +// Set Global Handler on Sign in +Accounts.onLogin(() => { + Raven.setUserContext({ + email: Meteor.user().emails[0].address, + id: Meteor.userId(), + }); +}); + +// Set Global Handler on Sign Out +Accounts.onLogout(() => { + Raven.setUserContext(); +}); diff --git a/core/capture_exception/client/start_up.js b/core/capture_exception/client/start_up.js new file mode 100644 index 0000000000..0c7f11145e --- /dev/null +++ b/core/capture_exception/client/start_up.js @@ -0,0 +1,27 @@ +/* Copyright 2017 Apinf Oy + This file is covered by the EUPL license. + You may obtain a copy of the licence at + https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Meteor packages imports +import { Meteor } from 'meteor/meteor'; + +// Npm packages imports +import Raven from 'raven-js'; + +// APInf imports +import wrapMeteorDebug from './wrap_meteor_debug'; + +Meteor.startup(() => { + Meteor.call('getClientDsn', (err, result) => { + // The falsy result will turn off the Sentry app + const SENTRY_DSN = result || false; + + // Configure Raven capture tracking for Client side + Raven + .config(SENTRY_DSN) + .install(); + }); + + wrapMeteorDebug(); +}); diff --git a/core/capture_exception/client/wrap_meteor_debug.js b/core/capture_exception/client/wrap_meteor_debug.js new file mode 100644 index 0000000000..df94bcdbcb --- /dev/null +++ b/core/capture_exception/client/wrap_meteor_debug.js @@ -0,0 +1,27 @@ +/* Copyright 2017 Apinf Oy + This file is covered by the EUPL license. + You may obtain a copy of the licence at + https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Meteor packages imports +import { Meteor } from 'meteor/meteor'; + +// Npm packages imports +import Raven from 'raven-js'; + +export default function wrapMeteorDebug () { + // Expand Meteor._debug function - capture and log exception to Sentry before display error + const originalMeteorDebug = Meteor._debug; + + Meteor._debug = function (m, s) { + // Exception message contains two message. + // One of them is Exception Tracker which is not useful for debugging + // Don't send exception to Sentry which is related to Tracker exception + if (m !== 'Exception from Tracker recompute function:') { + // Provide message of error and stack + Raven.captureException(m, { extra: { stack: s } }); + } + // eslint-disable-next-line + return originalMeteorDebug.apply(this, arguments); + }; +}; From 98c35beed0858e8f9706965e53dd6a8b20791eaf Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Tue, 27 Jun 2017 12:54:18 +0300 Subject: [PATCH 53/84] Settings Raven for Server side --- core/capture_exception/server/methods.js | 26 +++++++++++++ core/capture_exception/server/start_up.js | 28 +++++++++++++ .../server/wrap_meteor_methods.js | 39 +++++++++++++++++++ 3 files changed, 93 insertions(+) create mode 100644 core/capture_exception/server/methods.js create mode 100644 core/capture_exception/server/start_up.js create mode 100644 core/capture_exception/server/wrap_meteor_methods.js diff --git a/core/capture_exception/server/methods.js b/core/capture_exception/server/methods.js new file mode 100644 index 0000000000..fdd4decc5e --- /dev/null +++ b/core/capture_exception/server/methods.js @@ -0,0 +1,26 @@ +/* Copyright 2017 Apinf Oy + This file is covered by the EUPL license. + You may obtain a copy of the licence at + https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Meteor packages imports +import { Meteor } from 'meteor/meteor'; + +Meteor.methods({ + getClientDsn () { + // Client side must have special public DSN which can be calculated from SENTRY_DSN + + // Get SENTRY_DNS from environment variables + const DSN = process.env.SENTRY_DSN || ''; + // Get position ':' + const twoSpot = DSN.lastIndexOf(':'); + // Get position '@' + const sign = DSN.lastIndexOf('@'); + + // Concat part before ':' and part after '@' including the sign + const publicDsn = DSN.slice(0, twoSpot) + DSN.slice(sign, DSN.length); + + // Return public key for DSN or empty line + return publicDsn; + }, +}); diff --git a/core/capture_exception/server/start_up.js b/core/capture_exception/server/start_up.js new file mode 100644 index 0000000000..de83086494 --- /dev/null +++ b/core/capture_exception/server/start_up.js @@ -0,0 +1,28 @@ +/* Copyright 2017 Apinf Oy + This file is covered by the EUPL license. + You may obtain a copy of the licence at + https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Meteor packages imports +import { Meteor } from 'meteor/meteor'; + +// Npm packages imports +import Raven from 'raven'; + +// APInf imports +import wrapMethods from './wrap_meteor_methods'; + +Meteor.startup(() => { + // Get Sentry DNS from environment variable or set false + // Falsy value turns off the Sentry app + const SENTRY_DSN = process.env.SENTRY_DSN || false; + + // Configure Raven capture tracking for Server side + Raven.config(SENTRY_DSN, + { + // Capture unhandled promise rejections + captureUnhandledRejections: true, + }).install(); + + wrapMethods(); +}); diff --git a/core/capture_exception/server/wrap_meteor_methods.js b/core/capture_exception/server/wrap_meteor_methods.js new file mode 100644 index 0000000000..962f0bd1d4 --- /dev/null +++ b/core/capture_exception/server/wrap_meteor_methods.js @@ -0,0 +1,39 @@ +/* Copyright 2017 Apinf Oy + This file is covered by the EUPL license. + You may obtain a copy of the licence at + https://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11 */ + +// Meteor packages imports +import { Meteor } from 'meteor/meteor'; + +// Npm packages imports +import Raven from 'raven'; + +const wrapMethodHanderForErrors = function (name, originalHandler, methodMap) { + methodMap[name] = function () { + try { + // eslint-disable-next-line + return originalHandler.apply(this, arguments); + } catch (ex) { + Raven.captureException(ex); + throw ex; + } + }; +}; + +// TODO: the same for Publish function +export default function wrapMethods () { + const originalMeteorMethods = Meteor.methods; + // Wrap future method handlers for capturing errors + Meteor.methods = function (methodMap) { + _.each(methodMap, (handler, name) => { + wrapMethodHanderForErrors(name, handler, methodMap); + }); + originalMeteorMethods(methodMap); + }; + + // Wrap existing method handlers for capturing errors + _.each(Meteor.default_server.method_handlers, (handler, name) => { + wrapMethodHanderForErrors(name, handler, Meteor.default_server.method_handlers); + }); +} From 91e117fdfc5b2598eb56bd51133437a1ef7b52a0 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Tue, 27 Jun 2017 13:13:33 +0300 Subject: [PATCH 54/84] Update example configs for docker Add example for the new environment variable SENTRY_DSN Code lint --- .travis.yml | 4 ++-- core/capture_exception/client/wrap_meteor_debug.js | 2 +- core/capture_exception/server/wrap_meteor_methods.js | 5 +++-- docker/apinf/env.example | 1 + 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 576bc92ae4..552077dbe5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -38,7 +38,7 @@ before_script: - yarn run lint # Start X Virtual Frame Buffer for headless testing with real browsers - ./.scripts/start-xvfb.sh - + script: # Run meteor and chimp from node.js - travis_retry yarn test @@ -49,4 +49,4 @@ env: global: - DISPLAY=:99.0 - TEST_MODE: "true" - - CXX=g++-4.8 \ No newline at end of file + - CXX=g++-4.8 diff --git a/core/capture_exception/client/wrap_meteor_debug.js b/core/capture_exception/client/wrap_meteor_debug.js index df94bcdbcb..cc6e6b0bf8 100644 --- a/core/capture_exception/client/wrap_meteor_debug.js +++ b/core/capture_exception/client/wrap_meteor_debug.js @@ -24,4 +24,4 @@ export default function wrapMeteorDebug () { // eslint-disable-next-line return originalMeteorDebug.apply(this, arguments); }; -}; +} diff --git a/core/capture_exception/server/wrap_meteor_methods.js b/core/capture_exception/server/wrap_meteor_methods.js index 962f0bd1d4..11117bd62d 100644 --- a/core/capture_exception/server/wrap_meteor_methods.js +++ b/core/capture_exception/server/wrap_meteor_methods.js @@ -8,6 +8,7 @@ import { Meteor } from 'meteor/meteor'; // Npm packages imports import Raven from 'raven'; +import _ from 'lodash'; const wrapMethodHanderForErrors = function (name, originalHandler, methodMap) { methodMap[name] = function () { @@ -26,14 +27,14 @@ export default function wrapMethods () { const originalMeteorMethods = Meteor.methods; // Wrap future method handlers for capturing errors Meteor.methods = function (methodMap) { - _.each(methodMap, (handler, name) => { + _.forEach(methodMap, (handler, name) => { wrapMethodHanderForErrors(name, handler, methodMap); }); originalMeteorMethods(methodMap); }; // Wrap existing method handlers for capturing errors - _.each(Meteor.default_server.method_handlers, (handler, name) => { + _.forEach(Meteor.default_server.method_handlers, (handler, name) => { wrapMethodHanderForErrors(name, handler, Meteor.default_server.method_handlers); }); } diff --git a/docker/apinf/env.example b/docker/apinf/env.example index 1f84ee05cb..c80ac69280 100644 --- a/docker/apinf/env.example +++ b/docker/apinf/env.example @@ -1 +1,2 @@ ROOT_URL=https://example.com +SENTRY_DSN=https://public:private@sentry-dsn.url From 794a2431d45b4b1e10dc845e050bfba572b65d09 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Wed, 28 Jun 2017 12:49:26 +0300 Subject: [PATCH 55/84] Change travis settings Re-write the cache way for yarn Run `yarn` in `install` part Save `.meteor` in PATH --- .travis.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 552077dbe5..8cd393095d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,7 +14,6 @@ addons: - yarn chrome: stable - branches: only: - develop @@ -23,9 +22,9 @@ before_cache: - rm -f $HOME/.meteor/log/*.log cache: + yarn: true directories: - $HOME/.meteor - - $HOME/.cache/yarn services: - docker @@ -35,10 +34,14 @@ before_install: - if [ ! -e "$HOME/.meteor/meteor" ]; then curl https://install.meteor.com | sed s/--progress-bar/-sL/g | /bin/sh; fi before_script: + - yarn - yarn run lint # Start X Virtual Frame Buffer for headless testing with real browsers - ./.scripts/start-xvfb.sh +install: + - export PATH="$HOME/.meteor:$PATH" + script: # Run meteor and chimp from node.js - travis_retry yarn test From f2966e70560fc132798d7e773424b6d74ed36532 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 12 Jun 2017 16:24:44 +0300 Subject: [PATCH 56/84] Generation of user part of swagger document - added users structure - added new object for fields for users part --- core/server/api.js | 240 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 240 insertions(+) diff --git a/core/server/api.js b/core/server/api.js index dfd1eb9ed8..88552c5e49 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -17,6 +17,95 @@ const ApiV1 = new Restivus({ enableCors: true, }); +const UserFields = {}; + +UserFields.params = { + company: { + name: 'company', + in: 'body', + description: 'Company name of user', + required: true, + type: 'string', + }, + email: { + name: 'email', + in: 'body', + description: 'Email address for user', + required: true, + type: 'string', + }, + limit: { + name: 'limit', + in: 'query', + description: 'Maximum number of records to return in query.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + maximum: 50, + }, + optionalSearch: { + name: 'q', + in: 'query', + description: 'An optional search string for looking up inventory.', + required: false, + type: 'string', + }, + organizationId: { + name: 'id', + in: 'path', + description: 'ID of Organization', + required: false, + type: 'string', + }, + password: { + name: 'password', + in: 'body', + description: 'Password for user', + required: true, + type: 'string', + }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, + since: { + name: 'since', + in: 'path', + description: 'Time frame in days', + required: true, + type: 'integer', + format: 'int32', + minimum: 1, + }, + sortBy: { + name: 'sort_by', + in: 'query', + description: 'Criteria for sort ', + required: false, + type: 'string', + }, + userId: { + name: 'id', + in: 'path', + description: 'ID of User', + required: true, + type: 'string', + }, + userName: { + name: 'username', + in: 'body', + description: 'Username', + required: true, + type: 'string', + }, +}; + // Add Restivus Swagger configuration - meta, tags, params, definitions ApiV1.swagger = { meta: { @@ -26,6 +115,155 @@ ApiV1.swagger = { version: '1.0.0', title: 'Admin API', }, + paths: { + '/users': { + getAll: { + description: 'Returns users', + parameters: [ + UserFields.params.optionalSearch, + UserFields.params.organizationId, + UserFields.params.skip, + UserFields.params.limit, + UserFields.params.sortBy, + ], + responses: { + 200: { + description: 'success', + }, + 400: { + description: 'Bad query parameters', + }, + }, + }, + + get: { + description: 'Returns user with given ID.', + parameters: { + name: 'id', + in: 'path', + description: 'ID of User', + required: true, + type: 'string', + }, + + responses: { + 200: { + description: 'One user.', + }, + }, + }, + post: { + description: 'Adds a new user. On success, returns newly added object.', + parameters: [ + UserFields.params.userId, + UserFields.params.userName, + UserFields.params.email, + UserFields.params.password, + ], + responses: { + 201: { + description: 'User successfully added', + }, + 400: { + description: 'Invalid input, object invalid', + }, + 401: { + description: 'Authentication is required', + }, + 409: { + description: 'User already exists', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + delete: { + description: 'Deletes the identified Organization from catalog.', + parameters: [ + UserFields.params.userId, + ], + responses: { + 200: { + description: 'User deleted.', + }, + 400: { + description: 'Invalid input, invalid object', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'User not found', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + put: { + description: 'Update a User', + parameters: [ + UserFields.params.userId, + UserFields.params.userName, + UserFields.params.company, + UserFields.params.password, + ], + responses: { + 200: { + description: 'User successfully updated.', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'No user found with given UserID', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + + }, + + }, + }, + }, + '/users/updates': { + get: { + description: 'Returns users', + parameters: [ + UserFields.params.since, + UserFields.params.organizationId, + UserFields.params.skip, + UserFields.params.limit, + ], + responses: { + 200: { + description: 'success', + }, + 400: { + description: 'Bad query parameters', + }, + }, + }, + + }, + + }, securityDefinitions: { userSecurityToken: { in: 'header', @@ -244,6 +482,8 @@ ApiV1.swagger = { }, }, }, + + }; // Generate Swagger to route /rest/v1/swagger.json From 8fd5d93bb470bcc04e6eaf5e7a6b6741bf0a2e49 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 13 Jun 2017 08:52:32 +0300 Subject: [PATCH 57/84] Comment update --- core/server/api.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 88552c5e49..c5300a58f3 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -118,7 +118,7 @@ ApiV1.swagger = { paths: { '/users': { getAll: { - description: 'Returns users', + description: 'Returns: For Admin: all users data. For non-admin: only own data.', parameters: [ UserFields.params.optionalSearch, UserFields.params.organizationId, @@ -137,7 +137,7 @@ ApiV1.swagger = { }, get: { - description: 'Returns user with given ID.', + description: 'Returns user data with given ID.', parameters: { name: 'id', in: 'path', @@ -181,7 +181,7 @@ ApiV1.swagger = { }, ], delete: { - description: 'Deletes the identified Organization from catalog.', + description: 'Deletes the identified User.', parameters: [ UserFields.params.userId, ], @@ -244,7 +244,7 @@ ApiV1.swagger = { }, '/users/updates': { get: { - description: 'Returns users', + description: 'Returns users, who are created in given timeframe', parameters: [ UserFields.params.since, UserFields.params.organizationId, From 392f23420d679d70021e58df813e34142c625d45 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 13 Jun 2017 10:26:41 +0300 Subject: [PATCH 58/84] Added responses to users get verb --- core/server/api.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/core/server/api.js b/core/server/api.js index c5300a58f3..75bdf069a8 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -148,7 +148,13 @@ ApiV1.swagger = { responses: { 200: { - description: 'One user.', + description: 'Data of identified user.', + }, + 403: { + description: 'User does not have permission.', + }, + 404: { + description: 'No user found with given UserID.', }, }, }, From 136eb22fae18e27a446845eaee8be5a71da39ddf Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 13 Jun 2017 10:30:08 +0300 Subject: [PATCH 59/84] Added functionality of getting user by id --- users/collection/server/api.js | 76 +++++++++++++++++++++++++++++++++- 1 file changed, 74 insertions(+), 2 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 9a1b0bf760..4916bfefe8 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -32,7 +32,7 @@ ApiV1.addCollection(Meteor.users, { tags: [ ApiV1.swagger.tags.users, ], - description: 'Returns users', + description: 'Returns: For Admin: all users data. For non-admin: only own data.', parameters: [ ApiV1.swagger.params.optionalSearch, ApiV1.swagger.params.organization_id, @@ -206,6 +206,78 @@ ApiV1.addCollection(Meteor.users, { }, }, }, + action () { + // Get requestor's id + const requestorId = this.userId; + + const userIsGettingOwnAccount = this.urlParams.id === requestorId; + + const userIsAdmin = Roles.userIsInRole(requestorId, ['admin']); + + if (userIsGettingOwnAccount || userIsAdmin) { + // Get ID of User to be fetched + const userId = this.urlParams.id; + + // Exclude password + const options = {}; + const excludeFields = {}; + + excludeFields.services = 0; + options.fields = excludeFields; + + // Check if user exists + const user = Meteor.users.findOne(userId, options); + if (user) { + // Array for Organization name and id + const orgDataList = []; + // Get user id + const userIdSearch = user._id; + // Find all Organizations, where User belongs to + const organizations = Organizations.find({ + managerIds: userIdSearch, + }).fetch(); + // If there are Users' Organizations + if (organizations.length > 0) { + // Loop through Users' Organizations + organizations.forEach((organization) => { + const orgData = {}; + // Put Organization name and id into an object + orgData.organizationId = organization._id; + orgData.organizationName = organization.name; + // Add this Organization data into Users' organization data list + orgDataList.push(orgData); + }); + // Add Organizations' information to Users' data + user.organization = orgDataList; + } + // Construct response + return { + statusCode: 200, + body: { + status: 'success', + data: user, + }, + }; + } + + // User didn't exist + return { + statusCode: 404, + body: { + status: 'Fail', + message: 'No user found with given UserID', + }, + }; + } + return { + statusCode: 403, + body: { + status: 'Fail', + message: 'User does not have permission', + }, + }; + }, + }, post: { authRequired: true, @@ -308,7 +380,7 @@ ApiV1.addCollection(Meteor.users, { tags: [ ApiV1.swagger.tags.users, ], - description: 'Deletes the identified Organization from catalog.', + description: 'Deletes the identified User.', parameters: [ ApiV1.swagger.params.userId, ], From 3a22bf18c333f941925bb9352b9140197dbc6123 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 14 Jun 2017 16:34:13 +0300 Subject: [PATCH 60/84] Added a new method to remove user from all Organizations --- organizations/server/methods.js | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/organizations/server/methods.js b/organizations/server/methods.js index 3980d0994d..3f4f2a7aa8 100644 --- a/organizations/server/methods.js +++ b/organizations/server/methods.js @@ -100,6 +100,23 @@ Meteor.methods({ } ); }, + removeUserFromAllOrganizations (userId) { + // Make sure userId is an String + check(userId, String); + // Check if user to be deleted is a manager in any Organizations + const organizations = Organizations.find({ + managerIds: userId, + }).fetch(); + + // If user is a manager in any Organization + if (organizations.length > 0) { + // Loop through Users' Organizations + organizations.forEach((organization) => { + // Remove user from organization manager list + Meteor.call('removeOrganizationManager', organization._id, userId); + }); + } + }, removeApiFromFeaturedList (organizationId, apiId) { // Make sure organizationId is an String check(organizationId, String); From a30c75b5acc0730223f8a221c9bfc5e6a68cf448 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 14 Jun 2017 16:35:18 +0300 Subject: [PATCH 61/84] When user is deleted, user is removed from all Organizations, too. --- users/collection/server/api.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 4916bfefe8..bace8e574f 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -422,6 +422,9 @@ ApiV1.addCollection(Meteor.users, { // Check if user exists const user = Meteor.users.findOne(userId); if (user) { + // Remove user from all Organizations + Meteor.call('removeUserFromAllOrganizations', userId); + // Remove existing User account Meteor.users.remove(user._id); From 549d46656ab29a640c639088e5284c2b3cc1a2c8 Mon Sep 17 00:00:00 2001 From: matleppa Date: Fri, 16 Jun 2017 12:15:25 +0300 Subject: [PATCH 62/84] Corrected comment --- organizations/server/methods.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/organizations/server/methods.js b/organizations/server/methods.js index 3f4f2a7aa8..e45be462d1 100644 --- a/organizations/server/methods.js +++ b/organizations/server/methods.js @@ -103,7 +103,7 @@ Meteor.methods({ removeUserFromAllOrganizations (userId) { // Make sure userId is an String check(userId, String); - // Check if user to be deleted is a manager in any Organizations + // Get list of Organizations where user is a manager const organizations = Organizations.find({ managerIds: userId, }).fetch(); From 4b21e6bb6e8d3364ee121b01e070c0dec86dd991 Mon Sep 17 00:00:00 2001 From: matleppa Date: Fri, 16 Jun 2017 14:05:14 +0300 Subject: [PATCH 63/84] Changed order to alphabetical --- core/server/api.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 75bdf069a8..169ec52cef 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -65,15 +65,6 @@ UserFields.params = { required: true, type: 'string', }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - }, since: { name: 'since', in: 'path', @@ -83,6 +74,15 @@ UserFields.params = { format: 'int32', minimum: 1, }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, sortBy: { name: 'sort_by', in: 'query', From d62d1c790ce53ead9985d0028ff56ac6ed7014a9 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 20 Jun 2017 14:39:05 +0300 Subject: [PATCH 64/84] Removed unnecessary parameter userId --- users/collection/server/api.js | 1 - 1 file changed, 1 deletion(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index bace8e574f..e31b0af535 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -288,7 +288,6 @@ ApiV1.addCollection(Meteor.users, { ], description: 'Adds a new user. On success, returns newly added object.', parameters: [ - ApiV1.swagger.params.userId, ApiV1.swagger.params.userName, ApiV1.swagger.params.email, ApiV1.swagger.params.password, From 47f2ab82055b6b60209faf7f0f1262ebc97baf01 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 20 Jun 2017 14:45:47 +0300 Subject: [PATCH 65/84] Changes concerning users path - Renamed UserFields.params to UserFields.structs - added tags section into UserFields.structs - added section params and definitions into UserFields.struct - added definition for addUser and updateUser - renamed parameters according to UserFields changes - added users section into general definitions --- core/server/api.js | 407 +++++++++++++++++++++++++++------------------ 1 file changed, 247 insertions(+), 160 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 169ec52cef..6835ac6c58 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -19,90 +19,148 @@ const ApiV1 = new Restivus({ const UserFields = {}; -UserFields.params = { - company: { - name: 'company', - in: 'body', - description: 'Company name of user', - required: true, - type: 'string', - }, - email: { - name: 'email', - in: 'body', - description: 'Email address for user', - required: true, - type: 'string', - }, - limit: { - name: 'limit', - in: 'query', - description: 'Maximum number of records to return in query.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 50, - }, - optionalSearch: { - name: 'q', - in: 'query', - description: 'An optional search string for looking up inventory.', - required: false, - type: 'string', - }, - organizationId: { - name: 'id', - in: 'path', - description: 'ID of Organization', - required: false, - type: 'string', - }, - password: { - name: 'password', - in: 'body', - description: 'Password for user', - required: true, - type: 'string', - }, - since: { - name: 'since', - in: 'path', - description: 'Time frame in days', - required: true, - type: 'integer', - format: 'int32', - minimum: 1, - }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - }, - sortBy: { - name: 'sort_by', - in: 'query', - description: 'Criteria for sort ', - required: false, - type: 'string', +UserFields.struct = { + tags: { + users: 'Users', }, - userId: { - name: 'id', - in: 'path', - description: 'ID of User', - required: true, - type: 'string', + + params: { + company: { + name: 'company', + in: 'body', + description: 'Company name of user', + required: true, + type: 'string', + }, + email: { + name: 'email', + in: 'body', + description: 'Email address for user', + required: true, + type: 'string', + }, + limit: { + name: 'limit', + in: 'query', + description: 'Maximum number of records to return in query.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + maximum: 50, + }, + optionalSearch: { + name: 'q', + in: 'query', + description: 'An optional search string for looking up inventory.', + required: false, + type: 'string', + }, + organizationId: { + name: 'id', + in: 'path', + description: 'ID of Organization', + required: false, + type: 'string', + }, + password: { + name: 'password', + in: 'body', + description: 'Password for user', + required: true, + type: 'string', + }, + since: { + name: 'since', + in: 'path', + description: 'Time frame in days', + required: true, + type: 'integer', + format: 'int32', + minimum: 1, + }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, + sortBy: { + name: 'sort_by', + in: 'query', + description: 'Criteria for sort ', + required: false, + type: 'string', + }, + updateUser: { + name: 'Update user', + in: 'body', + description: 'Data for editing User', + schema: { + $ref: '#/definitions/updateUser', + }, + }, + + userId: { + name: 'id', + in: 'path', + description: 'ID of User', + required: true, + type: 'string', + }, + userName: { + name: 'username', + in: 'body', + description: 'Username', + required: true, + type: 'string', + }, }, - userName: { - name: 'username', - in: 'body', - description: 'Username', - required: true, - type: 'string', + + definitions: { + addUser: { + required: ['userName', 'password', 'email'], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + password: { + type: 'string', + example: 'secrecy_is_everything#¤%', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'company-mail@gmail.com', + }, + }, + }, + + updateUser: { + required: [], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + company: { + type: 'string', + example: 'Amazing Company Ltd.', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'company-mail@gmail.com', + }, + }, + }, + }, }; @@ -118,13 +176,17 @@ ApiV1.swagger = { paths: { '/users': { getAll: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Returns: For Admin: all users data. For non-admin: only own data.', parameters: [ - UserFields.params.optionalSearch, - UserFields.params.organizationId, - UserFields.params.skip, - UserFields.params.limit, - UserFields.params.sortBy, + UserFields.struct.params.optionalSearch, + UserFields.struct.params.organizationId, + UserFields.struct.params.skip, + UserFields.struct.params.limit, + UserFields.struct.params.sortBy, ], responses: { 200: { @@ -135,16 +197,14 @@ ApiV1.swagger = { }, }, }, - get: { + tags: [ + UserFields.struct.tags.users, + ], description: 'Returns user data with given ID.', - parameters: { - name: 'id', - in: 'path', - description: 'ID of User', - required: true, - type: 'string', - }, + parameters: [ + UserFields.struct.params.userId, + ], responses: { 200: { @@ -158,13 +218,20 @@ ApiV1.swagger = { }, }, }, + }, + + '/users/{id}': { post: { + tags: [ + UserFields.struct.tags.users, + ], description: 'Adds a new user. On success, returns newly added object.', + consumes: 'application/json', + produces: 'application/json', + parameters: [ - UserFields.params.userId, - UserFields.params.userName, - UserFields.params.email, - UserFields.params.password, + UserFields.struct.params.userName, + UserFields.struct.params.addUser, ], responses: { 201: { @@ -186,76 +253,82 @@ ApiV1.swagger = { userId: [], }, ], - delete: { - description: 'Deletes the identified User.', - parameters: [ - UserFields.params.userId, - ], - responses: { - 200: { - description: 'User deleted.', - }, - 400: { - description: 'Invalid input, invalid object', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'User not found', - }, + }, + delete: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Deletes the identified User.', + parameters: [ + UserFields.struct.params.userId, + ], + responses: { + 200: { + description: 'User deleted.', + }, + 400: { + description: 'Invalid input, invalid object', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'User not found', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], + }, + put: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Update a User', + parameters: [ + UserFields.struct.params.userId, + UserFields.struct.params.updateUser, + ], + responses: { + 200: { + description: 'User successfully updated.', }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - put: { - description: 'Update a User', - parameters: [ - UserFields.params.userId, - UserFields.params.userName, - UserFields.params.company, - UserFields.params.password, - ], - responses: { - 200: { - description: 'User successfully updated.', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'No user found with given UserID', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'No user found with given UserID', }, - }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], }, }, + '/users/updates': { get: { + tags: [ + UserFields.struct.tags.users, + ], description: 'Returns users, who are created in given timeframe', parameters: [ - UserFields.params.since, - UserFields.params.organizationId, - UserFields.params.skip, - UserFields.params.limit, + UserFields.struct.params.since, + UserFields.struct.params.organizationId, + UserFields.struct.params.skip, + UserFields.struct.params.limit, ], responses: { 200: { @@ -487,6 +560,20 @@ ApiV1.swagger = { }, }, }, + + users: { + required: ['name', 'email', 'password'], + properties: { + username: + UserFields.params.userName, + email: + UserFields.params.email, + password: + UserFields.params.password, + company: + UserFields.params.company, + }, + }, }, From 64ae5eb584b74910b8e24c6627d803cc7bef4dee Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 21 Jun 2017 12:21:29 +0300 Subject: [PATCH 66/84] Changes in swagger document generation - corrected parameter (since, organizationId) position from path to query - replaced references to updateUser and addUser with plain field descriptions - changes in descriptions - removed definitions part from UserFields object - added /users/{id} method - corrected references to UserFields object --- core/server/api.js | 186 +++++++++++++++++++++++++-------------------- 1 file changed, 104 insertions(+), 82 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 6835ac6c58..95744a0788 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -25,6 +25,30 @@ UserFields.struct = { }, params: { + addUser: { + name: 'Update user', + in: 'body', + description: 'Data for adding User', + schema: { + required: ['userName', 'password', 'email'], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + password: { + type: 'string', + example: 'secrecy_is_everything#¤%', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'company-mail@gmail.com', + }, + }, + }, + }, company: { name: 'company', in: 'body', @@ -39,6 +63,22 @@ UserFields.struct = { required: true, type: 'string', }, + // getUserData { + // properties: + // _id: + // type: string + // example: '7L4jNtdfNFGH3igPs' + // created_at: + // $ref: '#/definitions/get_user_created_at' + // username: + // type: string + // example: myusername + // profile: + // $ref: '#/definitions/get_user_profile' + // organization: + // $ref: '#/definitions/get_user_organization' + // + // }, limit: { name: 'limit', in: 'query', @@ -52,14 +92,14 @@ UserFields.struct = { optionalSearch: { name: 'q', in: 'query', - description: 'An optional search string for looking up inventory.', + description: 'Pass an optional search string for looking up users.', required: false, type: 'string', }, organizationId: { - name: 'id', - in: 'path', - description: 'ID of Organization', + name: 'organization_id', + in: 'query', + description: 'Limit results to the given organization.', required: false, type: 'string', }, @@ -72,9 +112,9 @@ UserFields.struct = { }, since: { name: 'since', - in: 'path', + in: 'query', description: 'Time frame in days', - required: true, + required: false, type: 'integer', format: 'int32', minimum: 1, @@ -91,7 +131,7 @@ UserFields.struct = { sortBy: { name: 'sort_by', in: 'query', - description: 'Criteria for sort ', + description: 'options "username, created_at".', required: false, type: 'string', }, @@ -100,68 +140,39 @@ UserFields.struct = { in: 'body', description: 'Data for editing User', schema: { - $ref: '#/definitions/updateUser', + required: [], + properties: { + userName: { + type: 'string', + example: 'John Doe', + }, + company: { + type: 'string', + example: 'Amazing Company Ltd.', + }, + password: { + type: 'string', + example: 'secrecy_is_everything#¤%', + }, + }, }, }, - userId: { name: 'id', in: 'path', - description: 'ID of User', + description: 'Id of the user to fetch.', required: true, type: 'string', }, userName: { name: 'username', in: 'body', - description: 'Username', + description: 'Name of user', required: true, type: 'string', }, }, - definitions: { - addUser: { - required: ['userName', 'password', 'email'], - properties: { - userName: { - type: 'string', - example: 'John Doe', - }, - password: { - type: 'string', - example: 'secrecy_is_everything#¤%', - }, - email: { - type: 'string', - format: 'email', - description: 'E-mail address of user', - example: 'company-mail@gmail.com', - }, - }, - }, - - updateUser: { - required: [], - properties: { - userName: { - type: 'string', - example: 'John Doe', - }, - company: { - type: 'string', - example: 'Amazing Company Ltd.', - }, - email: { - type: 'string', - format: 'email', - description: 'E-mail address of user', - example: 'company-mail@gmail.com', - }, - }, - }, - - }, }; // Add Restivus Swagger configuration - meta, tags, params, definitions @@ -175,7 +186,7 @@ ApiV1.swagger = { }, paths: { '/users': { - getAll: { + get: { tags: [ UserFields.struct.tags.users, ], @@ -195,32 +206,11 @@ ApiV1.swagger = { 400: { description: 'Bad query parameters', }, - }, - }, - get: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Returns user data with given ID.', - parameters: [ - UserFields.struct.params.userId, - ], - - responses: { - 200: { - description: 'Data of identified user.', - }, - 403: { - description: 'User does not have permission.', - }, - 404: { - description: 'No user found with given UserID.', + 401: { + description: 'Authentication is required', }, }, }, - }, - - '/users/{id}': { post: { tags: [ UserFields.struct.tags.users, @@ -230,7 +220,6 @@ ApiV1.swagger = { produces: 'application/json', parameters: [ - UserFields.struct.params.userName, UserFields.struct.params.addUser, ], responses: { @@ -254,6 +243,33 @@ ApiV1.swagger = { }, ], }, + }, + + '/users/{id}': { + get: { + tags: [ + UserFields.struct.tags.users, + ], + description: 'Returns user data with given ID.', + parameters: [ + UserFields.struct.params.userId, + ], + + responses: { + 200: { + description: 'Data of identified user.', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission.', + }, + 404: { + description: 'No user found with given UserID.', + }, + }, + }, delete: { tags: [ UserFields.struct.tags.users, @@ -299,6 +315,9 @@ ApiV1.swagger = { 200: { description: 'User successfully updated.', }, + 400: { + description: 'Invalid input, object invalid, Erroneous new password', + }, 401: { description: 'Authentication is required', }, @@ -337,6 +356,9 @@ ApiV1.swagger = { 400: { description: 'Bad query parameters', }, + 401: { + description: 'Authentication is required', + }, }, }, @@ -565,13 +587,13 @@ ApiV1.swagger = { required: ['name', 'email', 'password'], properties: { username: - UserFields.params.userName, + UserFields.struct.params.userName, email: - UserFields.params.email, + UserFields.struct.params.email, password: - UserFields.params.password, + UserFields.struct.params.password, company: - UserFields.params.company, + UserFields.struct.params.company, }, }, }, From 7c96e9997816e039fe6ae4ee8a58d2b9ac18d2d4 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Wed, 21 Jun 2017 18:11:01 +0300 Subject: [PATCH 67/84] Replace path "/users/{id}" into related folder Remove path "/users/{id}" from ApiV1.swagger.meta.paths in file "core/server/api.js", save a placeholder Remove swagger part from origin REST API file. Because of restivus-swagger doesn't create properly Swagger documentation for Users collection, thispart wasremoved. Now it allows us two different part: one ofthis provides only feature for creating Swagger file (ApiV1.swagger.meta.paths) and another one provides only logic for REST API --- core/server/api.js | 25 +--------------------- users/collection/server/api.js | 38 +++++++++++++++++++++------------- 2 files changed, 25 insertions(+), 38 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 95744a0788..ecf6750ad1 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -246,30 +246,7 @@ ApiV1.swagger = { }, '/users/{id}': { - get: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Returns user data with given ID.', - parameters: [ - UserFields.struct.params.userId, - ], - - responses: { - 200: { - description: 'Data of identified user.', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission.', - }, - 404: { - description: 'No user found with given UserID.', - }, - }, - }, + get: {}, delete: { tags: [ UserFields.struct.tags.users, diff --git a/users/collection/server/api.js b/users/collection/server/api.js index e31b0af535..91cfe1a781 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -18,6 +18,30 @@ import Organizations from '/organizations/collection'; import _ from 'lodash'; +ApiV1.swagger.meta.paths['/users/{id}'].get = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Returns user data with given ID.', + parameters: [ + ApiV1.swagger.params.userId, + ], + responses: { + 200: { + description: 'Data of identified user.', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission.', + }, + 404: { + description: 'No user found with given UserID.', + }, + }, +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -192,20 +216,6 @@ ApiV1.addCollection(Meteor.users, { }, get: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Returns user with given ID.', - parameters: [ - ApiV1.swagger.params.userId, - ], - responses: { - 200: { - description: 'One user.', - }, - }, - }, action () { // Get requestor's id const requestorId = this.userId; From 1d9c61d3132995a43bbdf345e7efa1895a7ef783 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 10:51:01 +0300 Subject: [PATCH 68/84] Authorization is not required for POST operation --- users/collection/server/api.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 91cfe1a781..505975a59c 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -290,8 +290,8 @@ ApiV1.addCollection(Meteor.users, { }, post: { - authRequired: true, - roleRequired: ['admin'], + authRequired: false, + // roleRequired: ['admin'], swagger: { tags: [ ApiV1.swagger.tags.users, From 11a9be1fde457388289298a41eb1de6fd31daf59 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 10:53:26 +0300 Subject: [PATCH 69/84] Changes in user related parameters - renamed userName to username - corrected name and description in addUser and updateUser data models - corrections in examples --- core/server/api.js | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index ecf6750ad1..a395f66965 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -26,25 +26,25 @@ UserFields.struct = { params: { addUser: { - name: 'Update user', + name: 'addUserData', in: 'body', - description: 'Data for adding User', + description: 'Data for adding a user account', schema: { - required: ['userName', 'password', 'email'], + required: ['username', 'password', 'email'], properties: { - userName: { + username: { type: 'string', - example: 'John Doe', + example: 'johndoe', }, password: { type: 'string', - example: 'secrecy_is_everything#¤%', + example: 'password', }, email: { type: 'string', format: 'email', description: 'E-mail address of user', - example: 'company-mail@gmail.com', + example: 'firstname.lastname@vendor.com', }, }, }, @@ -136,15 +136,15 @@ UserFields.struct = { type: 'string', }, updateUser: { - name: 'Update user', + name: 'updateUserData', in: 'body', - description: 'Data for editing User', + description: 'Data for updating a user account', schema: { required: [], properties: { - userName: { + username: { type: 'string', - example: 'John Doe', + example: 'johndoe', }, company: { type: 'string', @@ -152,7 +152,7 @@ UserFields.struct = { }, password: { type: 'string', - example: 'secrecy_is_everything#¤%', + example: 'updatedPassword', }, }, }, @@ -164,7 +164,7 @@ UserFields.struct = { required: true, type: 'string', }, - userName: { + username: { name: 'username', in: 'body', description: 'Name of user', @@ -460,7 +460,7 @@ ApiV1.swagger = { required: true, type: 'string', }, - userName: { + username: { name: 'username', in: 'body', description: 'Username', @@ -564,7 +564,7 @@ ApiV1.swagger = { required: ['name', 'email', 'password'], properties: { username: - UserFields.struct.params.userName, + UserFields.struct.params.username, email: UserFields.struct.params.email, password: From 233fede2745163fc2c5052b076d839fde1aff283 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 12:42:49 +0300 Subject: [PATCH 70/84] Removed parameter delete from Users path --- core/server/api.js | 33 +-------------------------------- 1 file changed, 1 insertion(+), 32 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index a395f66965..a5c26162d4 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -247,38 +247,7 @@ ApiV1.swagger = { '/users/{id}': { get: {}, - delete: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Deletes the identified User.', - parameters: [ - UserFields.struct.params.userId, - ], - responses: { - 200: { - description: 'User deleted.', - }, - 400: { - description: 'Invalid input, invalid object', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'User not found', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, + delete: {}, put: { tags: [ UserFields.struct.tags.users, From 2e08ea6a6ce3d4b4409ed7a620e3c65484159eb0 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 12:44:24 +0300 Subject: [PATCH 71/84] Moved descriptions of parameter delete from ApiV1.addCollection to ApiV1.swagger.meta.paths --- users/collection/server/api.js | 65 +++++++++++++++++----------------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 505975a59c..d74d7b5af6 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -42,6 +42,39 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { }, }; +ApiV1.swagger.meta.paths['/users/{id}'].delete = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Deletes the identified User.', + parameters: [ + ApiV1.swagger.params.userId, + ], + responses: { + 200: { + description: 'User deleted.', + }, + 400: { + description: 'Invalid input, invalid object', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'User not found', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -385,38 +418,6 @@ ApiV1.addCollection(Meteor.users, { // Delete a user delete: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Deletes the identified User.', - parameters: [ - ApiV1.swagger.params.userId, - ], - responses: { - 200: { - description: 'User deleted.', - }, - 400: { - description: 'Invalid input, invalid object', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'User not found', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, action () { // Get requestor's id const requestorId = this.userId; From d74898ee27fcc6fb7e257aef7390a390277a6f08 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 13:02:03 +0300 Subject: [PATCH 72/84] Removed method PUT from Users swagger --- core/server/api.js | 34 +--------------------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index a5c26162d4..36e9f7e7f7 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -248,39 +248,7 @@ ApiV1.swagger = { '/users/{id}': { get: {}, delete: {}, - put: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Update a User', - parameters: [ - UserFields.struct.params.userId, - UserFields.struct.params.updateUser, - ], - responses: { - 200: { - description: 'User successfully updated.', - }, - 400: { - description: 'Invalid input, object invalid, Erroneous new password', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'No user found with given UserID', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, + put: {}, }, '/users/updates': { From bde6b18edb1385d2496d978193182974edc70f07 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 13:03:25 +0300 Subject: [PATCH 73/84] Moved method PUT from ApiV1.addCollection to ApiV1.swagger.meta.paths --- users/collection/server/api.js | 70 ++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 33 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index d74d7b5af6..f14f712d92 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -75,6 +75,42 @@ ApiV1.swagger.meta.paths['/users/{id}'].delete = { ], }; +ApiV1.swagger.meta.paths['/users/{id}'].put = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Update a User', + parameters: [ + ApiV1.swagger.params.userId, + ApiV1.swagger.params.username, + ApiV1.swagger.params.company, + ApiV1.swagger.params.password, + ], + responses: { + 200: { + description: 'User successfully updated.', + }, + 400: { + description: 'Invalid input, object invalid, Erroneous new password', + }, + 401: { + description: 'Authentication is required', + }, + 403: { + description: 'User does not have permission', + }, + 404: { + description: 'No user found with given UserID', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -331,7 +367,7 @@ ApiV1.addCollection(Meteor.users, { ], description: 'Adds a new user. On success, returns newly added object.', parameters: [ - ApiV1.swagger.params.userName, + ApiV1.swagger.params.username, ApiV1.swagger.params.email, ApiV1.swagger.params.password, ], @@ -468,38 +504,6 @@ ApiV1.addCollection(Meteor.users, { // Udpdate user data put: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Update a User', - parameters: [ - ApiV1.swagger.params.userId, - ApiV1.swagger.params.userName, - ApiV1.swagger.params.company, - ApiV1.swagger.params.password, - ], - responses: { - 200: { - description: 'User successfully updated.', - }, - 401: { - description: 'Authentication is required', - }, - 403: { - description: 'User does not have permission', - }, - 404: { - description: 'No user found with given UserID', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, action () { // Get requestor's id const requestorId = this.userId; From 0147a45a29158315ff9afdd9ce0de216d8831278 Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 17:00:15 +0300 Subject: [PATCH 74/84] Changes in descriptions - removed swagger definition of methods POST and GET - renamed and corrected data types --- core/server/api.js | 93 +++++++++++++++------------------------------- 1 file changed, 30 insertions(+), 63 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 36e9f7e7f7..7f91381a4d 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -211,38 +211,7 @@ ApiV1.swagger = { }, }, }, - post: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Adds a new user. On success, returns newly added object.', - consumes: 'application/json', - produces: 'application/json', - - parameters: [ - UserFields.struct.params.addUser, - ], - responses: { - 201: { - description: 'User successfully added', - }, - 400: { - description: 'Invalid input, object invalid', - }, - 401: { - description: 'Authentication is required', - }, - 409: { - description: 'User already exists', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, + post: {}, }, '/users/{id}': { @@ -252,30 +221,7 @@ ApiV1.swagger = { }, '/users/updates': { - get: { - tags: [ - UserFields.struct.tags.users, - ], - description: 'Returns users, who are created in given timeframe', - parameters: [ - UserFields.struct.params.since, - UserFields.struct.params.organizationId, - UserFields.struct.params.skip, - UserFields.struct.params.limit, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - 401: { - description: 'Authentication is required', - }, - }, - }, - + get: {}, }, }, @@ -320,6 +266,12 @@ ApiV1.swagger = { required: true, type: 'string', }, + createdAt: { + name: 'createdAt', + in: 'body', + description: 'Date and time in ISODate format, e.g. "2012-07-14T01:00:00+01:00" ', + type: 'string', + }, email: { name: 'email', in: 'body', @@ -390,6 +342,15 @@ ApiV1.swagger = { format: 'int32', minimum: 1, }, + skip: { + name: 'skip', + in: 'query', + description: 'Number of records to skip for pagination.', + required: false, + type: 'integer', + format: 'int32', + minimum: 0, + }, userId: { name: 'id', in: 'path', @@ -397,6 +358,13 @@ ApiV1.swagger = { required: true, type: 'string', }, + userIdResponse: { + name: '_id', + in: 'body', + description: 'ID of User', + required: true, + type: 'string', + }, username: { name: 'username', in: 'body', @@ -404,15 +372,14 @@ ApiV1.swagger = { required: true, type: 'string', }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', + userOrganizationId: { + name: 'organization_id', + in: 'path', + description: 'ID of Organization, that User belongs to', required: false, - type: 'integer', - format: 'int32', - minimum: 0, + type: 'string', }, + }, definitions: { // The schema defining the type used for the body parameter. From e37f9c1ab46ba2c77dbd99fbe6d17b0dca0b741a Mon Sep 17 00:00:00 2001 From: matleppa Date: Mon, 26 Jun 2017 17:01:56 +0300 Subject: [PATCH 75/84] Changes in swagger definitions - moved methods GET and POST to paths - corrected variable name --- users/collection/server/api.js | 177 +++++++++++++++++++-------------- 1 file changed, 103 insertions(+), 74 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index f14f712d92..ad69dc8edd 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -17,6 +17,76 @@ import Organizations from '/organizations/collection'; // Npm packages imports import _ from 'lodash'; +ApiV1.swagger.meta.paths['/users'].get = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Returns all users', + parameters: [ + ApiV1.swagger.params.optionalSearch, + ApiV1.swagger.params.userOrganizationId, + ApiV1.swagger.params.skip, + ApiV1.swagger.params.limit, + ApiV1.swagger.params.sort_by, + ], + responses: { + 200: { + description: 'success', + parameters: [ + ApiV1.swagger.params.userIdResponse, + ApiV1.swagger.params.createdAt, + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ], + }, + 400: { + description: 'Bad query parameters', + }, + 401: { + description: 'Authentication is required', + }, + }, +}; + +ApiV1.swagger.meta.paths['/users'].post = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Adds a new user. On success, returns newly added object.', + parameters: [ + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ApiV1.swagger.params.password, + ], + responses: { + 201: { + description: 'User successfully added', + parameters: [ + ApiV1.swagger.params.userIdResponse, + ApiV1.swagger.params.createdAt, + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ], + + }, + 400: { + description: 'Invalid input, object invalid', + }, + 401: { + description: 'Authentication is required', + }, + 409: { + description: 'User already exists', + }, + }, + security: [ + { + userSecurityToken: [], + userId: [], + }, + ], +}; + ApiV1.swagger.meta.paths['/users/{id}'].get = { tags: [ @@ -29,6 +99,7 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { responses: { 200: { description: 'Data of identified user.', + }, 401: { description: 'Authentication is required', @@ -111,6 +182,36 @@ ApiV1.swagger.meta.paths['/users/{id}'].put = { ], }; +ApiV1.swagger.meta.paths['/users/updates'].get = { + tags: [ + ApiV1.swagger.tags.users, + ], + description: 'Returns users based on creation date', + parameters: [ + ApiV1.swagger.params.since, + ApiV1.swagger.params.userOrganizationId, + ApiV1.swagger.params.skip, + ApiV1.swagger.params.limit, + ], + responses: { + 200: { + description: 'success', + parameters: [ + ApiV1.swagger.params.userIdResponse, + ApiV1.swagger.params.createdAt, + ApiV1.swagger.params.username, + ApiV1.swagger.params.email, + ], + }, + 400: { + description: 'Bad query parameters', + }, + 401: { + description: 'Authentication is required', + }, + }, +}; + // Generates: POST on /api/v1/users and GET, DELETE /api/v1/users/:id for // Meteor.users collection ApiV1.addCollection(Meteor.users, { @@ -121,27 +222,6 @@ ApiV1.addCollection(Meteor.users, { endpoints: { getAll: { authRequired: true, - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Returns: For Admin: all users data. For non-admin: only own data.', - parameters: [ - ApiV1.swagger.params.optionalSearch, - ApiV1.swagger.params.organization_id, - ApiV1.swagger.params.skip, - ApiV1.swagger.params.limit, - ApiV1.swagger.params.sort_by, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - }, - }, action () { const queryParams = this.queryParams; @@ -154,9 +234,9 @@ ApiV1.addCollection(Meteor.users, { const requestorId = this.userId; // Check if requestor is administrator - const requestorHasRights = Roles.userIsInRole(requestorId, ['admin']); + const requestorIsAdmin = Roles.userIsInRole(requestorId, ['admin']); - if (!requestorHasRights) { + if (!requestorIsAdmin) { searchOnlyWithOwnId = true; } @@ -361,37 +441,6 @@ ApiV1.addCollection(Meteor.users, { post: { authRequired: false, // roleRequired: ['admin'], - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Adds a new user. On success, returns newly added object.', - parameters: [ - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ApiV1.swagger.params.password, - ], - responses: { - 201: { - description: 'User successfully added', - }, - 400: { - description: 'Invalid input, object invalid', - }, - 401: { - description: 'Authentication is required', - }, - 409: { - description: 'User already exists', - }, - }, - security: [ - { - userSecurityToken: [], - userId: [], - }, - ], - }, action () { // Get data from body parameters const bodyParams = this.bodyParams; @@ -639,26 +688,6 @@ ApiV1.addCollection(Meteor.users, { ApiV1.addRoute('users/updates', { get: { roleRequired: ['admin'], - swagger: { - tags: [ - ApiV1.swagger.tags.users, - ], - description: 'Returns users', - parameters: [ - ApiV1.swagger.params.since, - ApiV1.swagger.params.organization_id, - ApiV1.swagger.params.skip, - ApiV1.swagger.params.limit, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - }, - }, action () { let badQueryParameters = false; // Read possible query parameters From 711fb4c83f57142c3a252a10138bd64731d8da69 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 27 Jun 2017 16:27:14 +0300 Subject: [PATCH 76/84] Changes in definitions of Users route - moved definitions from Userfields to Api.swagger - changed definitions accordingly - removed overlapping struct Userfields - removed method GET for /users - corrected values of parameters in definitions --- core/server/api.js | 421 ++++++++++++++++++++++++--------------------- 1 file changed, 224 insertions(+), 197 deletions(-) diff --git a/core/server/api.js b/core/server/api.js index 7f91381a4d..6c16a32823 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -17,164 +17,6 @@ const ApiV1 = new Restivus({ enableCors: true, }); -const UserFields = {}; - -UserFields.struct = { - tags: { - users: 'Users', - }, - - params: { - addUser: { - name: 'addUserData', - in: 'body', - description: 'Data for adding a user account', - schema: { - required: ['username', 'password', 'email'], - properties: { - username: { - type: 'string', - example: 'johndoe', - }, - password: { - type: 'string', - example: 'password', - }, - email: { - type: 'string', - format: 'email', - description: 'E-mail address of user', - example: 'firstname.lastname@vendor.com', - }, - }, - }, - }, - company: { - name: 'company', - in: 'body', - description: 'Company name of user', - required: true, - type: 'string', - }, - email: { - name: 'email', - in: 'body', - description: 'Email address for user', - required: true, - type: 'string', - }, - // getUserData { - // properties: - // _id: - // type: string - // example: '7L4jNtdfNFGH3igPs' - // created_at: - // $ref: '#/definitions/get_user_created_at' - // username: - // type: string - // example: myusername - // profile: - // $ref: '#/definitions/get_user_profile' - // organization: - // $ref: '#/definitions/get_user_organization' - // - // }, - limit: { - name: 'limit', - in: 'query', - description: 'Maximum number of records to return in query.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 50, - }, - optionalSearch: { - name: 'q', - in: 'query', - description: 'Pass an optional search string for looking up users.', - required: false, - type: 'string', - }, - organizationId: { - name: 'organization_id', - in: 'query', - description: 'Limit results to the given organization.', - required: false, - type: 'string', - }, - password: { - name: 'password', - in: 'body', - description: 'Password for user', - required: true, - type: 'string', - }, - since: { - name: 'since', - in: 'query', - description: 'Time frame in days', - required: false, - type: 'integer', - format: 'int32', - minimum: 1, - }, - skip: { - name: 'skip', - in: 'query', - description: 'Number of records to skip for pagination.', - required: false, - type: 'integer', - format: 'int32', - minimum: 0, - }, - sortBy: { - name: 'sort_by', - in: 'query', - description: 'options "username, created_at".', - required: false, - type: 'string', - }, - updateUser: { - name: 'updateUserData', - in: 'body', - description: 'Data for updating a user account', - schema: { - required: [], - properties: { - username: { - type: 'string', - example: 'johndoe', - }, - company: { - type: 'string', - example: 'Amazing Company Ltd.', - }, - password: { - type: 'string', - example: 'updatedPassword', - }, - }, - }, - }, - userId: { - name: 'id', - in: 'path', - description: 'Id of the user to fetch.', - required: true, - type: 'string', - }, - username: { - name: 'username', - in: 'body', - description: 'Name of user', - required: true, - type: 'string', - }, - }, - -}; - // Add Restivus Swagger configuration - meta, tags, params, definitions ApiV1.swagger = { meta: { @@ -186,31 +28,7 @@ ApiV1.swagger = { }, paths: { '/users': { - get: { - tags: [ - UserFields.struct.tags.users, - ], - - description: 'Returns: For Admin: all users data. For non-admin: only own data.', - parameters: [ - UserFields.struct.params.optionalSearch, - UserFields.struct.params.organizationId, - UserFields.struct.params.skip, - UserFields.struct.params.limit, - UserFields.struct.params.sortBy, - ], - responses: { - 200: { - description: 'success', - }, - 400: { - description: 'Bad query parameters', - }, - 401: { - description: 'Authentication is required', - }, - }, - }, + get: {}, post: {}, }, @@ -279,6 +97,14 @@ ApiV1.swagger = { required: true, type: 'string', }, + emailResponse: { + properties: { + name: 'address', + in: 'body', + description: 'Email address for user', + type: 'string', + }, + }, lifecycle: { name: 'lifecycle', in: 'query', @@ -321,7 +147,7 @@ ApiV1.swagger = { }, organizationId: { name: 'id', - in: 'path', + in: 'query', description: 'ID of Organization', required: true, type: 'string', @@ -335,9 +161,9 @@ ApiV1.swagger = { }, since: { name: 'since', - in: 'path', + in: 'query', description: 'Time frame in days', - required: true, + required: false, type: 'integer', format: 'int32', minimum: 1, @@ -351,6 +177,30 @@ ApiV1.swagger = { format: 'int32', minimum: 0, }, + sortBy: { + name: 'sort_by', + in: 'query', + description: 'Criteria for sort ', + required: false, + type: 'string', + }, + userAddition: { + name: 'user', + in: 'body', + description: 'Data for adding a new User', + schema: { + $ref: '#/definitions/user_addition', + }, + }, + userUpdate: { + name: 'user', + in: 'body', + description: 'Data for updating a User', + schema: { + $ref: '#/definitions/user_update', + }, + }, + userId: { name: 'id', in: 'path', @@ -374,7 +224,7 @@ ApiV1.swagger = { }, userOrganizationId: { name: 'organization_id', - in: 'path', + in: 'query', description: 'ID of Organization, that User belongs to', required: false, type: 'string', @@ -465,21 +315,198 @@ ApiV1.swagger = { }, users: { - required: ['name', 'email', 'password'], + required: ['username', 'email', 'password'], properties: { - username: - UserFields.struct.params.username, - email: - UserFields.struct.params.email, - password: - UserFields.struct.params.password, - company: - UserFields.struct.params.company, + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'john.doe@ispname.com', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, + company: { + type: 'string', + description: 'Company name of user', + example: 'My Company Ltd', + }, + }, + }, + user_addition: { + required: ['username', 'email', 'password'], + properties: { + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + email: { + type: 'string', + format: 'email', + description: 'E-mail address of user', + example: 'john.doe@ispname.com', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, + }, + }, + user_update: { + required: ['username', 'company', 'password'], + properties: { + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + company: { + type: 'string', + description: 'Name of company user belongs to', + example: 'Mighty API owners Ltd.', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, }, }, - }, + get_user_profile: { + type: 'object', + properties: { + company: { + type: 'string', + example: 'Mighty API owners Ltd.', + }, + }, + }, + get_user_created_at: { + type: 'string', + example: '2012-07-14T01:00:00+01:00', + description: 'Dates and times are stored in ISODate format', + }, + post_user_email_address: { + type: 'array', + items: { + type: 'object', + properties: { + address: { + type: 'string', + example: 'sam.won@apinf.io', + }, + verified: { + type: 'string', + example: 'false', + }, + }, + }, + }, + get_user_roles: { + type: 'array', + items: { + type: 'string', + example: 'manager', + }, + }, + get_user_data: { + type: 'object', + properties: { + status: { + type: 'string', + example: 'success', + }, + data: { + type: 'object', + properties: { + _id: { + type: 'string', + example: '7L4jNtdfNFGH3igPs', + }, + created_at: { + $ref: '#/definitions/get_user_created_at', + }, + username: { + type: 'string', + example: 'myusername', + }, + emails: { + $ref: '#/definitions/post_user_email_address', + }, + profile: { + $ref: '#/definitions/get_user_profile', + }, + roles: { + $ref: '#/definitions/get_user_roles', + }, + organization: { + $ref: '#/definitions/get_user_organization', + }, + }, + }, + }, + }, + get_user_organization: { + type: 'array', + items: { + type: 'object', + properties: { + organization_id: { + type: 'string', + example: 'eFsLsJH3JTos4HfLc', + }, + organization_name: { + type: 'string', + example: 'APInf oy', + }, + }, + }, + }, + + post_user_response: { + type: 'object', + properties: { + status: { + type: 'string', + example: 'success', + }, + data: { + type: 'object', + properties: { + _id: { + type: 'string', + example: '7L4jNtdfNFGH3igPs', + }, + created_at: { + $ref: '#/definitions/get_user_created_at', + }, + username: { + type: 'string', + example: 'myusername', + }, + emails: { + $ref: '#/definitions/post_user_email_address', + }, + profile: { + $ref: '#/definitions/get_user_profile', + }, + }, + }, + }, + }, + + }, }; // Generate Swagger to route /rest/v1/swagger.json From 396d3ba5c3030a5a898c3258ffa3973ef894ac62 Mon Sep 17 00:00:00 2001 From: matleppa Date: Tue, 27 Jun 2017 16:28:56 +0300 Subject: [PATCH 77/84] Changes in methods - corrected descriptions - added summaries - changed parameter references according to changes in main swagger docment --- users/collection/server/api.js | 55 ++++++++++++++++------------------ 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index ad69dc8edd..67764f76f7 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -21,23 +21,21 @@ ApiV1.swagger.meta.paths['/users'].get = { tags: [ ApiV1.swagger.tags.users, ], - description: 'Returns all users', + summary: 'List and search users.', + description: 'By passing options you can search users in system.', + produces: 'application/json', parameters: [ ApiV1.swagger.params.optionalSearch, ApiV1.swagger.params.userOrganizationId, ApiV1.swagger.params.skip, ApiV1.swagger.params.limit, - ApiV1.swagger.params.sort_by, + ApiV1.swagger.params.sortBy, ], responses: { 200: { - description: 'success', - parameters: [ - ApiV1.swagger.params.userIdResponse, - ApiV1.swagger.params.createdAt, - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ], + description: 'Success', + schema: + ApiV1.swagger.definitions.get_user_data, }, 400: { description: 'Bad query parameters', @@ -52,22 +50,17 @@ ApiV1.swagger.meta.paths['/users'].post = { tags: [ ApiV1.swagger.tags.users, ], + summary: 'Adds a new user.', description: 'Adds a new user. On success, returns newly added object.', + produces: 'application/json', parameters: [ - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ApiV1.swagger.params.password, + ApiV1.swagger.params.userAddition, ], responses: { 201: { description: 'User successfully added', - parameters: [ - ApiV1.swagger.params.userIdResponse, - ApiV1.swagger.params.createdAt, - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ], - + schema: + ApiV1.swagger.definitions.post_user_response, }, 400: { description: 'Invalid input, object invalid', @@ -92,13 +85,17 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { tags: [ ApiV1.swagger.tags.users, ], + summary: 'Search Users one by one with userID.', description: 'Returns user data with given ID.', + produces: 'application/json', parameters: [ ApiV1.swagger.params.userId, ], responses: { 200: { description: 'Data of identified user.', + schema: + ApiV1.swagger.definitions.get_user_data, }, 401: { @@ -117,6 +114,7 @@ ApiV1.swagger.meta.paths['/users/{id}'].delete = { tags: [ ApiV1.swagger.tags.users, ], + summary: 'Delete Users one by one with userID.', description: 'Deletes the identified User.', parameters: [ ApiV1.swagger.params.userId, @@ -150,12 +148,11 @@ ApiV1.swagger.meta.paths['/users/{id}'].put = { tags: [ ApiV1.swagger.tags.users, ], - description: 'Update a User', + summary: 'Update User\'s data.', + description: 'Updates data of a User indicated by user ID.', parameters: [ ApiV1.swagger.params.userId, - ApiV1.swagger.params.username, - ApiV1.swagger.params.company, - ApiV1.swagger.params.password, + ApiV1.swagger.params.userUpdate, ], responses: { 200: { @@ -186,7 +183,9 @@ ApiV1.swagger.meta.paths['/users/updates'].get = { tags: [ ApiV1.swagger.tags.users, ], - description: 'Returns users based on creation date', + summary: 'List and search user based on addition date', + description: 'Returns users based on addition date', + produces: 'application/json', parameters: [ ApiV1.swagger.params.since, ApiV1.swagger.params.userOrganizationId, @@ -196,12 +195,8 @@ ApiV1.swagger.meta.paths['/users/updates'].get = { responses: { 200: { description: 'success', - parameters: [ - ApiV1.swagger.params.userIdResponse, - ApiV1.swagger.params.createdAt, - ApiV1.swagger.params.username, - ApiV1.swagger.params.email, - ], + schema: + ApiV1.swagger.definitions.get_user_data, }, 400: { description: 'Bad query parameters', From 1105166804f2b0308ceff23ac4071b20a8b546e9 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 28 Jun 2017 16:04:00 +0300 Subject: [PATCH 78/84] Added definitions for user login and credentials --- core/server/api.js | 64 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/core/server/api.js b/core/server/api.js index 6c16a32823..11e5b73656 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -42,6 +42,10 @@ ApiV1.swagger = { get: {}, }, + '/login': { + post: {}, + }, + }, securityDefinitions: { userSecurityToken: { @@ -60,6 +64,7 @@ ApiV1.swagger = { api: 'APIs', organization: 'Organizations', users: 'Users', + login: 'Login', }, params: { api: { @@ -192,6 +197,14 @@ ApiV1.swagger = { $ref: '#/definitions/user_addition', }, }, + userLogin: { + name: 'user', + in: 'body', + description: 'User login data', + schema: { + $ref: '#/definitions/user_login', + }, + }, userUpdate: { name: 'user', in: 'body', @@ -229,6 +242,20 @@ ApiV1.swagger = { required: false, type: 'string', }, + x_user_id: { + name: 'X-User-Id', + in: 'header', + description: 'User ID for authentication', + required: false, + type: 'string', + }, + x_auth_token: { + name: 'X-Auth-Token', + in: 'header', + description: 'Authentication Token', + required: false, + type: 'string', + }, }, definitions: { @@ -361,6 +388,21 @@ ApiV1.swagger = { }, }, }, + user_login: { + required: ['username', 'password'], + properties: { + username: { + type: 'string', + description: 'Username', + example: 'johndoe', + }, + password: { + type: 'string', + description: 'Password for user', + example: 'mypassword', + }, + }, + }, user_update: { required: ['username', 'company', 'password'], properties: { @@ -505,6 +547,28 @@ ApiV1.swagger = { }, }, }, + user_login_response: { + type: 'object', + properties: { + status: { + type: 'string', + example: 'success', + }, + data: { + type: 'object', + properties: { + authToken: { + type: 'string', + example: '7L4jNt-dfNFGH3igPslP5VMH0-hrnbMSFtmjfVOMm_zVg0yT8eGQ-', + }, + userId: { + type: 'string', + example: 'GFJzMtdzqEYgH8PHSQ-', + }, + }, + }, + }, + }, }, }; From f0e1c154067194bad62539d3b2afbe1da96794a3 Mon Sep 17 00:00:00 2001 From: matleppa Date: Wed, 28 Jun 2017 16:04:50 +0300 Subject: [PATCH 79/84] Added swagger path descriptions for user login and using credentials --- users/collection/server/api.js | 35 ++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/users/collection/server/api.js b/users/collection/server/api.js index 67764f76f7..e0779c6963 100644 --- a/users/collection/server/api.js +++ b/users/collection/server/api.js @@ -17,6 +17,31 @@ import Organizations from '/organizations/collection'; // Npm packages imports import _ from 'lodash'; +ApiV1.swagger.meta.paths['/login'].post = { + tags: [ + ApiV1.swagger.tags.login, + ], + summary: 'Logging in.', + description: 'By giving existing username and password you get login credentials.', + produces: 'application/json', + parameters: [ + ApiV1.swagger.params.userLogin, + ], + responses: { + 200: { + description: 'Success', + schema: + ApiV1.swagger.definitions.user_login_response, + }, + 400: { + description: 'Bad query parameters', + }, + 401: { + description: 'Unauthorized', + }, + }, +}; + ApiV1.swagger.meta.paths['/users'].get = { tags: [ ApiV1.swagger.tags.users, @@ -25,6 +50,8 @@ ApiV1.swagger.meta.paths['/users'].get = { description: 'By passing options you can search users in system.', produces: 'application/json', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.optionalSearch, ApiV1.swagger.params.userOrganizationId, ApiV1.swagger.params.skip, @@ -89,6 +116,8 @@ ApiV1.swagger.meta.paths['/users/{id}'].get = { description: 'Returns user data with given ID.', produces: 'application/json', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.userId, ], responses: { @@ -117,6 +146,8 @@ ApiV1.swagger.meta.paths['/users/{id}'].delete = { summary: 'Delete Users one by one with userID.', description: 'Deletes the identified User.', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.userId, ], responses: { @@ -151,6 +182,8 @@ ApiV1.swagger.meta.paths['/users/{id}'].put = { summary: 'Update User\'s data.', description: 'Updates data of a User indicated by user ID.', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.userId, ApiV1.swagger.params.userUpdate, ], @@ -187,6 +220,8 @@ ApiV1.swagger.meta.paths['/users/updates'].get = { description: 'Returns users based on addition date', produces: 'application/json', parameters: [ + ApiV1.swagger.params.x_user_id, + ApiV1.swagger.params.x_auth_token, ApiV1.swagger.params.since, ApiV1.swagger.params.userOrganizationId, ApiV1.swagger.params.skip, From fff9c12ff8ebc644ed4ab1ac8485c3d67c6f9870 Mon Sep 17 00:00:00 2001 From: matleppa Date: Thu, 29 Jun 2017 09:55:01 +0300 Subject: [PATCH 80/84] Added summary fields for Apis and Organizations --- apis/server/api.js | 5 +++++ organizations/server/api.js | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/apis/server/api.js b/apis/server/api.js index 617854898f..ac1c6fa0a4 100644 --- a/apis/server/api.js +++ b/apis/server/api.js @@ -23,6 +23,7 @@ ApiV1.addCollection(Apis, { tags: [ ApiV1.swagger.tags.api, ], + summary: 'List and search public APIs.', description: 'List and search public APIs.', parameters: [ ApiV1.swagger.params.optionalSearch, @@ -106,6 +107,7 @@ ApiV1.addCollection(Apis, { tags: [ ApiV1.swagger.tags.api, ], + summary: 'Fetch API with specified ID', description: 'Returns one API with specified ID or nothing if there is not match found', parameters: [ ApiV1.swagger.params.apiId, @@ -126,6 +128,7 @@ ApiV1.addCollection(Apis, { tags: [ ApiV1.swagger.tags.api, ], + summary: 'Add new API to catalog.', description: 'Adds an API to catalog. On success, returns newly added API object.', parameters: [ ApiV1.swagger.params.api, @@ -155,6 +158,7 @@ ApiV1.addCollection(Apis, { tags: [ ApiV1.swagger.tags.api, ], + summary: 'Update API', description: 'Update an API', parameters: [ ApiV1.swagger.params.apiId, @@ -232,6 +236,7 @@ ApiV1.addCollection(Apis, { tags: [ ApiV1.swagger.tags.api, ], + summary: 'Delete API.', description: 'Deletes the identified API from the system.', parameters: [ ApiV1.swagger.params.apiId, diff --git a/organizations/server/api.js b/organizations/server/api.js index b0912a89f3..b31f617399 100644 --- a/organizations/server/api.js +++ b/organizations/server/api.js @@ -19,6 +19,7 @@ ApiV1.addRoute('organizations', { tags: [ ApiV1.swagger.tags.organization, ], + summary: 'List and search organizations.', description: 'List and search organizations.', parameters: [ ApiV1.swagger.params.optionalSearch, @@ -91,6 +92,7 @@ ApiV1.addRoute('organizations', { tags: [ ApiV1.swagger.tags.organization, ], + summary: 'Add Organization to catalog.', description: 'Adds an Organization to catalog. On success, returns newly added object.', parameters: [ ApiV1.swagger.params.organization, @@ -158,6 +160,7 @@ ApiV1.addRoute('organizations/:id', { tags: [ ApiV1.swagger.tags.organization, ], + summary: 'Fetch Organization with specified ID', description: 'Returns one Organization with specified ID or nothing if not match found', parameters: [ ApiV1.swagger.params.organizationId, @@ -201,6 +204,7 @@ ApiV1.addRoute('organizations/:id', { tags: [ ApiV1.swagger.tags.organization, ], + summary: 'Update Organization', description: 'Update an Organization', parameters: [ ApiV1.swagger.params.organizationId, @@ -301,6 +305,7 @@ ApiV1.addRoute('organizations/:id', { tags: [ ApiV1.swagger.tags.organization, ], + summary: 'Delete identified Organization from catalog.', description: 'Deletes the identified Organization from catalog.', parameters: [ ApiV1.swagger.params.organizationId, From 8b9396535018479e73e162b76f253f58ce950947 Mon Sep 17 00:00:00 2001 From: Daria Voytova Date: Thu, 29 Jun 2017 12:43:50 +0300 Subject: [PATCH 81/84] Return type "in: path" for organizationId parameter This parameter is used in endpoint 'organization/:id' and it must have type "in: path" --- core/server/api.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/server/api.js b/core/server/api.js index 11e5b73656..c20f2f10fa 100644 --- a/core/server/api.js +++ b/core/server/api.js @@ -152,7 +152,7 @@ ApiV1.swagger = { }, organizationId: { name: 'id', - in: 'query', + in: 'path', description: 'ID of Organization', required: true, type: 'string', From 158d890e2cba9bc9639d20856a94747cbdbc3f16 Mon Sep 17 00:00:00 2001 From: wuder4 Date: Thu, 29 Jun 2017 14:49:29 +0300 Subject: [PATCH 82/84] changing site title and slogan id's --- branding/client/branding.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/branding/client/branding.html b/branding/client/branding.html index 83539e7adb..0d7da6ff47 100644 --- a/branding/client/branding.html +++ b/branding/client/branding.html @@ -26,8 +26,8 @@

type="update" collection=brandingCollection doc=branding }} - {{> afQuickField name='siteTitle' id="site-title" }} - {{> afQuickField name='siteSlogan' id="site-slogan" }} + {{> afQuickField name='siteTitle' id="branding-site-title" }} + {{> afQuickField name='siteSlogan' id="branding-site-slogan" }} {{> afQuickField name='colors' }} {{> afQuickField name='siteFooter' id="site-footer" }} {{> afQuickField name='footerCode' id="footer-code" }} From c8ac6d13d98ee0bbf80a087a208a8b872947e7f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matti=20Lepp=C3=A4nen?= Date: Mon, 3 Jul 2017 11:44:50 +0300 Subject: [PATCH 83/84] 0.47.0 --- about/client/about.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/about/client/about.html b/about/client/about.html index a6767906da..6e13f0be0a 100644 --- a/about/client/about.html +++ b/about/client/about.html @@ -33,7 +33,7 @@

Apinf
- 0.46.0 + 0.47.0
API Umbrella From 9b6f0813e8ae53a35cec054e16bbb0f6c538c1ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matti=20Lepp=C3=A4nen?= Date: Mon, 3 Jul 2017 11:47:08 +0300 Subject: [PATCH 84/84] 0.47.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index cb400855cd..6ec5a8f996 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "apinf", - "version": "0.46.0", + "version": "0.47.0", "description": "API management portal and proxy.", "main": "index.js", "directories": {