From 6f606df211ff79c5c3a33dfc7465bef17631091a Mon Sep 17 00:00:00 2001 From: Keith Holliday Date: Thu, 4 Feb 2016 15:22:37 -0600 Subject: [PATCH] Added quest abort route and initial tests --- common/locales/en/api-v3.json | 3 +- .../POST-groups_groupid_quests_abort.test.js | 78 +++++++++++++++++++ website/src/controllers/api-v3/quests.js | 52 +++++++++++++ 3 files changed, 132 insertions(+), 1 deletion(-) create mode 100644 test/api/v3/integration/quests/POST-groups_groupid_quests_abort.test.js diff --git a/common/locales/en/api-v3.json b/common/locales/en/api-v3.json index cdb6718327..2818fe6307 100644 --- a/common/locales/en/api-v3.json +++ b/common/locales/en/api-v3.json @@ -73,5 +73,6 @@ "questNotFound": "Quest \"<%= key %>\" not found.", "questNotOwned": "You don't own that quest scroll.", "questLevelTooHigh": "You must be Level <%= level %> to begin this quest.", - "questAlreadyUnderway": "Your party is already on a quest. Try again when the current quest has ended." + "questAlreadyUnderway": "Your party is already on a quest. Try again when the current quest has ended.", + "noActiveQuestToAbort": "There is no active quest to abort" } diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_abort.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_abort.test.js new file mode 100644 index 0000000000..1ed6871307 --- /dev/null +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_abort.test.js @@ -0,0 +1,78 @@ +import { + createAndPopulateGroup, + translate as t, +} from '../../../../helpers/api-v3-integration.helper'; +import { v4 as generateUUID } from 'uuid'; + +describe('POST /groups/:groupId/quests/abort', () => { + let questingGroup, member, leader; + const PET_QUEST = 'whale'; + let userQuestUpdate = { + items: { + quests: {}, + }, + 'party.quest.RSVPNeeded': true, + 'party.quest.key': PET_QUEST, + }; + + before(async () => { + let { group, groupLeader, members } = await createAndPopulateGroup({ + groupDetails: { type: 'party', privacy: 'private' }, + members: 1, + }); + + leader = groupLeader; + questingGroup = group; + member = members[0]; + + userQuestUpdate.items.quests[PET_QUEST] = 1; + }); + + it('returns an error when group is not found', async () => { + await expect(leader.post(`/groups/${generateUUID()}/quests/abort`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('groupNotFound'), + }); + }); + + it('returns an error when quest is not active', async () => { + await expect(leader.post(`/groups/${questingGroup._id}/quests/abort`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('noActiveQuestToAbort'), + }); + }); + + xit('returns an error when non quest leader attempts to abort', async () => { + await questingGroup.update({quest: {key: PET_QUEST, active: true, leader: leader._id}}); + + await expect(member.post(`/groups/${questingGroup._id}/quests/abort`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('questLeaderCannotAbortQuest'), + }); + }); + + it('aborts a quest', async () => { + await member.update(userQuestUpdate); + + let questMembers = {}; + questMembers[member._id] = true; + await questingGroup.update({'quest.members': questMembers}); + await questingGroup.update({quest: {key: PET_QUEST, active: true, leader: leader._id}}); + + let abortResult = await leader.post(`/groups/${questingGroup._id}/quests/abort`); + let updatedMember = await member.get('/user'); + let updatedLeader = await leader.get('/user'); + let updatedGroup = await member.get(`/groups/${questingGroup._id}`); + + expect(updatedMember.party.quest.key).to.be.null; + expect(updatedMember.party.quest.RSVPNeeded).to.be.false; + expect(updatedLeader.items.quests[PET_QUEST]).to.equal(1); + expect(updatedGroup.quest).to.deep.equal(abortResult); + }); +}); diff --git a/website/src/controllers/api-v3/quests.js b/website/src/controllers/api-v3/quests.js index 38020fcae5..53e2274959 100644 --- a/website/src/controllers/api-v3/quests.js +++ b/website/src/controllers/api-v3/quests.js @@ -3,11 +3,13 @@ import cron from '../../middlewares/api-v3/cron'; import { model as Group, } from '../../models/group'; +import { model as User } from '../../models/user'; import { NotFound, NotAuthorized, } from '../../libs/api-v3/errors'; import { quests as questScrolls } from '../../../../common/script/content'; +import Q from 'q'; let api = {}; @@ -65,4 +67,54 @@ api.inviteToQuest = { }, }; +/** + * @api {post} /groups/:groupId/quests/abort Abort a quest + * @apiVersion 3.0.0 + * @apiName AbortQuest + * @apiGroup Group + * + * @apiParam {string} groupId The group _id (or 'party') + * + * @apiSuccess {Object} Quest Object + */ +api.abortQuest = { + method: 'POST', + url: '/groups/:groupId/quests/abort', + middlewares: [authWithHeaders(), cron], + async handler (req, res) { + // Abort a quest AFTER it has begun (see questCancel for BEFORE) + let user = res.locals.user; + let groupId = req.params.groupId; + + req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); + + let validationErrors = req.validationErrors(); + if (validationErrors) throw validationErrors; + + let group = await Group.getGroup({user, groupId, fields: 'type quest'}); + if (!group) throw new NotFound(res.t('groupNotFound')); + if (!group.quest.active) throw new NotFound(res.t('noActiveQuestToAbort')); + + let memberUpdates = User.update( + {'party._id': groupId}, + { + $set: {'party.quest': Group.cleanQuestProgress()}, + $inc: {_v: 1}, + }, + {multi: true}, + ); + + let update = {$inc: {}}; + update.$inc[`items.quests.${group.quest.key}`] = 1; + let questLeaderUpdate = User.update({_id: group.quest.leader}, update).exec(); + + group.quest = {key: null, progress: {collect: {}}, leader: null, members: {}, extra: {}, active: false}; + group.markModified('quest'); + + let [groupSaved] = await Q.all([group.save(), memberUpdates, questLeaderUpdate]); + + res.respond(200, groupSaved.quest); + }, +}; + export default api;