Kai/habitica
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #6520 from HabitRPG/api-v3-groups-create-and-populate

Browse Source 
Add createAndPopulate group helper for v3
This commit is contained in:
Blade Barringer
2016-01-14 17:26:35 -06:00
parent 7d5a7503cb 5ff54fa332
commit 2a6241d549
3 changed files with 101 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/api/v3/integration/groups/POST-groups_groupId_join.js
+36 -34
View File
@@ -1,5 +1,6 @@
import {
generateUser,
createAndPopulateGroup,
translate as t,
} from '../../../../helpers/api-v3-integration.helper';
import { v4 as generateUUID } from 'uuid';
@@ -15,22 +16,28 @@ describe('POST /group/:groupId/join', () => {
});
});
context('Accepting invitation to a guild', () => {
context('Accepting invitation to a private guild', () => {
let user, invitedUser, guild;
beforeEach(async () => {
user = await generateUser({balance: 1});
guild = await user.post('/groups', {
name: 'Test Guild',
type: 'guild',
privacy: 'private',
let { group, groupLeader, invitees } = await createAndPopulateGroup({
groupDetails: {
name: 'Test Guild',
type: 'guild',
privacy: 'private',
},
invites: 1,
});
guild = group;
user = groupLeader;
invitedUser = invitees[0];
});
it('returns error when user is not invited to private guild', async () => {
let joiningUser = await generateUser();
let userWithoutInvite = await generateUser();
await expect(joiningUser.post(`/groups/${guild._id}/join`)).to.eventually.be.rejected.and.eql({
await expect(userWithoutInvite.post(`/groups/${guild._id}/join`)).to.eventually.be.rejected.and.eql({
code: 401,
error: 'NotAuthorized',
message: t('messageGroupRequiresInvite'),
@@ -38,26 +45,21 @@ describe('POST /group/:groupId/join', () => {
});
it('allows non-invited users to join public guilds', async () => {
await user.update({balance: 1});
guild = await user.post('/groups', {
name: 'Test Guild',
type: 'guild',
privacy: 'public',
});
let publicGuild = (await createAndPopulateGroup({
groupDetails: {
name: 'Test Guild',
type: 'guild',
privacy: 'public',
},
})).group;
let joiningUser = await generateUser();
await joiningUser.post(`/groups/${guild._id}/join`);
await joiningUser.post(`/groups/${publicGuild._id}/join`);
await expect(joiningUser.get('/user')).to.eventually.have.property('guilds').to.include(guild._id);
await expect(joiningUser.get('/user')).to.eventually.have.property('guilds').and.to.include(publicGuild._id);
});
context('User is invited', () => {
beforeEach(async () => {
invitedUser = await generateUser({
'invitations.guilds': [{ id: guild._id}],
});
});
it('allows invited user to join private guilds', async () => {
await invitedUser.post(`/groups/${guild._id}/join`);
@@ -92,17 +94,23 @@ describe('POST /group/:groupId/join', () => {
let user, invitedUser, party;
beforeEach(async () => {
user = await generateUser();
party = await user.post('/groups', {
name: 'Test Party',
type: 'party',
let { group, groupLeader, invitees } = await createAndPopulateGroup({
groupDetails: {
name: 'Test Party',
type: 'party',
},
invites: 1,
});
party = group;
user = groupLeader;
invitedUser = invitees[0];
});
it('returns error when user is not invited to party', async () => {
let joiningUser = await generateUser();
let userWithoutInvite = await generateUser();
await expect(joiningUser.post(`/groups/${party._id}/join`)).to.eventually.be.rejected.and.eql({
await expect(userWithoutInvite.post(`/groups/${party._id}/join`)).to.eventually.be.rejected.and.eql({
code: 401,
error: 'NotAuthorized',
message: t('messageGroupRequiresInvite'),
@@ -110,12 +118,6 @@ describe('POST /group/:groupId/join', () => {
});
context('User is invited', () => {
beforeEach(async () => {
invitedUser = await generateUser({
'invitations.party': { id: party._id, inviter: user._id },
});
});
it('allows invited user to join party', async () => {
await invitedUser.post(`/groups/${party._id}/join`);
test/api/v3/integration/groups/PUT-groups.test.js
+15 -16
View File
@@ -1,32 +1,31 @@
import {
generateUser,
createAndPopulateGroup,
translate as t,
} from '../../../../helpers/api-v3-integration.helper';
describe('PUT /group', () => {
let groupLeader;
let leader, nonLeader, groupToUpdate;
let groupName = 'Test Public Guild';
let groupType = 'guild';
let groupToUpdate;
let groupUpdatedName = 'Test Public Guild Updated';
beforeEach(async () => {
groupLeader = await generateUser({balance: 1});
groupToUpdate = await groupLeader.post('/groups', {
name: groupName,
type: groupType,
let { group, groupLeader, members } = await createAndPopulateGroup({
groupDetails: {
name: groupName,
type: groupType,
privacy: 'public',
},
members: 1,
});
groupToUpdate = group;
leader = groupLeader;
nonLeader = members[0];
});
it('returns an error when a non group leader tries to update', async () => {
let memberToAttemptUpdate = await generateUser();
await groupLeader.post(`/groups/${groupToUpdate._id}/invite`, {
uuids: [memberToAttemptUpdate._id],
});
await memberToAttemptUpdate.post(`/groups/${groupToUpdate._id}/join`);
await expect(memberToAttemptUpdate.put(`/groups/${groupToUpdate._id}`, {
await expect(nonLeader.put(`/groups/${groupToUpdate._id}`, {
name: groupUpdatedName,
})).to.eventually.be.rejected.and.eql({
code: 401,
@@ -36,7 +35,7 @@ describe('PUT /group', () => {
});
it('updates a group', async () => {
let updatedGroup = await groupLeader.put(`/groups/${groupToUpdate._id}`, {
let updatedGroup = await leader.put(`/groups/${groupToUpdate._id}`, {
name: groupUpdatedName,
});
test/helpers/api-v3-integration.helper.js
+50 -89
View File
@@ -7,6 +7,7 @@ import {
set,
times,
} from 'lodash';
import Q from 'q';
import { MongoClient as mongo } from 'mongodb';
import { v4 as generateUUID } from 'uuid';
import superagent from 'superagent';
@@ -14,15 +15,6 @@ import i18n from '../../common/script/src/i18n';
i18n.translations = require('../../website/src/libs/api-v3/i18n').translations;
const API_TEST_SERVER_PORT = 3003;
const API_V = process.env.API_VERSION || 'v2'; // eslint-disable-line no-process-env
const ROUTES = {
v2: {
register: '/register',
},
v3: {
register: '/user/auth/local/register',
},
};
class ApiUser {
constructor (options) {
@@ -97,26 +89,26 @@ export function checkExistence (collectionName, id) {
// paramter, such as the number of wolf eggs the user has,
// , you can do so by passing in the full path as a string:
// { 'items.eggs.Wolf': 10 }
export function generateUser (update = {}) {
export async function generateUser (update = {}) {
let username = generateUUID();
let password = 'password';
let email = `${username}@example.com`;
let request = _requestMaker({}, 'post');
return new Promise((resolve, reject) => {
request(ROUTES[API_V].register, {
username,
email,
password,
confirmPassword: password,
}).then((user) => {
_updateDocument('users', user, update, () => {
let apiUser = new ApiUser(user);
let user = await request('/user/auth/local/register', {
username,
email,
password,
confirmPassword: password,
});
resolve(apiUser);
});
}).catch(reject);
return Q.promise((resolve) => {
_updateDocument('users', user, update, () => {
let apiUser = new ApiUser(user);
resolve(apiUser);
});
});
}
@@ -124,10 +116,8 @@ export function generateUser (update = {}) {
// will will become the groups leader. Takes an update
// argument which will update group
export function generateGroup (leader, details = {}, update = {}) {
let request = _requestMaker(leader, 'post');
return new Promise((resolve, reject) => {
request('/groups', details).then((group) => {
leader.post('/groups', details).then((group) => {
_updateDocument('groups', group, update, () => {
resolve(group);
});
@@ -149,72 +139,52 @@ export function generateGroup (leader, details = {}, update = {}) {
// invitees: an array of user objects that correspond to the invitees of the group
// leader: the leader user object
// group: the group object
export function createAndPopulateGroup (settings = {}) {
let request;
let leader;
let members;
let invitees;
let group;
export async function createAndPopulateGroup (settings = {}) {
let numberOfMembers = settings.members || 0;
let numberOfInvites = settings.invites || 0;
let groupDetails = settings.groupDetails;
let leaderDetails = settings.leaderDetails || { balance: 10 };
let leaderPromise = generateUser(leaderDetails);
let groupLeader = await generateUser(leaderDetails);
let group = await generateGroup(groupLeader, groupDetails);
let memberPromises = Promise.all(
let members = await Q.all(
times(numberOfMembers, () => {
return generateUser();
})
);
let invitePromises = Promise.all(
let groupTypes = {
guild: { guilds: [group._id] },
party: { 'party._id': group._id },
};
let memberPromises = members.map((member) => {
return member.update(groupTypes[group.type]);
});
await Q.all(memberPromises);
let invitees = await Q.all(
times(numberOfInvites, () => {
return generateUser();
})
);
return new Promise((resolve, reject) => {
return leaderPromise.then((user) => {
leader = user;
request = _requestMaker(leader, 'post');
return memberPromises;
}).then((users) => {
members = users;
groupDetails.members = groupDetails.members || [leader._id];
each(members, (member) => {
groupDetails.members.push(member._id);
});
return generateGroup(leader, groupDetails);
}).then((createdGroup) => {
group = createdGroup;
return invitePromises;
}).then((users) => {
invitees = users;
let invitationPromises = [];
each(invitees, (invitee) => {
let invitePromise = request(`/groups/${group._id}/invite`, {
uuids: [invitee._id],
});
invitationPromises.push(invitePromise);
});
return Promise.all(invitationPromises);
}).then(() => {
resolve({
leader,
group,
members,
invitees,
});
}).catch(reject);
let invitationPromises = invitees.map((invitee) => {
return groupLeader.post(`/groups/${group._id}/invite`, {
uuids: [invitee._id],
});
});
await Q.all(invitationPromises);
return {
groupLeader,
group,
members,
invitees,
};
}
// Specifically helpful for the GET /groups tests,
@@ -250,7 +220,7 @@ export function resetHabiticaDB () {
function _requestMaker (user, method, additionalSets) {
return (route, send, query) => {
return new Promise((resolve, reject) => {
let request = superagent[method](`http://localhost:${API_TEST_SERVER_PORT}/api/${API_V}${route}`)
let request = superagent[method](`http://localhost:${API_TEST_SERVER_PORT}/api/v3${route}`)
.accept('application/json');
if (user && user._id && user.apiToken) {
@@ -270,20 +240,11 @@ function _requestMaker (user, method, additionalSets) {
if (err) {
if (!err.response) return reject(err);
if (API_V === 'v3') {
return reject({
code: err.status,
error: err.response.body.error,
message: err.response.body.message,
});
} else if (API_V === 'v2') {
return reject({
code: err.status,
text: err.response.body.err,
});
}
return reject(err);
return reject({
code: err.status,
error: err.response.body.error,
message: err.response.body.message,
});
}
resolve(response.body);