From d5148a7bf01f196d77c83a028190b277b51aaf47 Mon Sep 17 00:00:00 2001 From: Keith Holliday Date: Mon, 1 Feb 2016 19:33:35 -0600 Subject: [PATCH 1/8] Added quest reject route and intial tests --- common/locales/en/quests.json | 3 +- .../POST-groups_groupid_quests_reject.test.js | 98 +++++++++++++++++++ website/src/controllers/api-v3/groups.js | 97 ++++++++++++++++++ 3 files changed, 197 insertions(+), 1 deletion(-) create mode 100644 test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js diff --git a/common/locales/en/quests.json b/common/locales/en/quests.json index 7b3fe7af43..5edae258e5 100644 --- a/common/locales/en/quests.json +++ b/common/locales/en/quests.json @@ -78,5 +78,6 @@ "whichQuestStart": "Which quest do you want to start?", "getMoreQuests": "Get more quests", "unlockedAQuest": "You unlocked a quest!", - "leveledUpReceivedQuest": "You leveled up to Level <%= level %> and received a quest scroll!" + "leveledUpReceivedQuest": "You leveled up to Level <%= level %> and received a quest scroll!", + "questInvitationDoesNotExist": "No quest invitation has been sent out yet." } diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js new file mode 100644 index 0000000000..e5f7517eff --- /dev/null +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js @@ -0,0 +1,98 @@ +import { + createAndPopulateGroup, + translate as t, +} from '../../../../helpers/api-v3-integration.helper'; +import { v4 as generateUUID } from 'uuid'; + +describe('POST /groups/:groupId/quests/invite/:questKey', () => { + let questingGroup; + let member; + const PET_QUEST = 'whale'; + let userQuestUpdate = { + items: { + quests: {}, + }, + 'party.quest.RSVPNeeded': true, + 'party.quest.key': PET_QUEST, + }; + + before(async () => { + let { group, members } = await createAndPopulateGroup({ + groupDetails: { type: 'party', privacy: 'private' }, + members: 1, + }); + + questingGroup = group; + member = members[0]; + + userQuestUpdate.items.quests[PET_QUEST] = 1; + }); + + context('failure conditions', () => { + it('returns an error when group is not found', async () => { + await expect(member.post(`/groups/${generateUUID()}/quests/reject/${PET_QUEST}`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('groupNotFound'), + }); + }); + + it('returns an error when group is not a party', async () => { + let { group, groupLeader } = await createAndPopulateGroup({ + groupDetails: { type: 'guild', privacy: 'private' }, + }); + + await expect(groupLeader.post(`/groups/${group._id}/quests/reject/${PET_QUEST}`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('guildQuestsNotSupported'), + }); + }); + + it('returns an error when quest is not found', async () => { + let questKey = 'fakeQuestName'; + + await expect(member.post(`/groups/${questingGroup._id}/quests/reject/${questKey}`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('questNotFound', { key: questKey }), + }); + }); + + it('returns an error when user is not on the quest', async () => { + await expect(member.post(`/groups/${questingGroup._id}/quests/reject/${PET_QUEST}`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('questNotOwned'), + }); + }); + + it('returns an error when group is not on a quest', async () => { + await member.update(userQuestUpdate); + + await expect(member.post(`/groups/${questingGroup._id}/quests/reject/${PET_QUEST}`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('questInvitationDoesNotExist'), + }); + }); + }); + + context('successfully quest rejection', () => { + it('rejects a quest invitation', async () => { + await member.update(userQuestUpdate); + await questingGroup.update({'quest.key': PET_QUEST}); + + await member.post(`/groups/${questingGroup._id}/quests/reject/${PET_QUEST}`); + + let userWithRejectInvitation = await member.get('/user'); + expect(userWithRejectInvitation.party.quest.key).to.be.null; + expect(userWithRejectInvitation.party.quest.RSVPNeeded).to.be.false; + }); + }); +}); diff --git a/website/src/controllers/api-v3/groups.js b/website/src/controllers/api-v3/groups.js index b9b633c111..785ea564ba 100644 --- a/website/src/controllers/api-v3/groups.js +++ b/website/src/controllers/api-v3/groups.js @@ -17,6 +17,8 @@ import { removeFromArray } from '../../libs/api-v3/collectionManipulators'; import * as firebase from '../../libs/api-v3/firebase'; import { sendTxn as sendTxnEmail } from '../../libs/api-v3/email'; import { encrypt } from '../../libs/api-v3/encryption'; +import { quests as questScrolls } from '../../../../common/script/content'; +import { mockAnalyticsService } from '../../libs/api-v3/analyticsService'; let api = {}; @@ -616,4 +618,99 @@ api.inviteToGroup = { }, }; +<<<<<<< e3c7d2834e6e5fa024afb71032c21177ca4124a7 +======= +/** + * @api {post} /groups/:groupId/quests/invite Invite users to a quest + * @apiVersion 3.0.0 + * @apiName InviteToQuest + * @apiGroup Group + * + * @apiParam {string} groupId The group _id (or 'party') + * + * @apiSuccess {Object} Quest Object + */ +api.inviteToQuest = { + method: 'POST', + url: '/groups/:groupId/quests/invite/:questKey', + middlewares: [authWithHeaders(), cron], + async handler (req, res) { + let user = res.locals.user; + let questKey = req.params.questKey; + let quest = questScrolls[questKey]; + + req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); + + let validationErrors = req.validationErrors(); + if (validationErrors) throw validationErrors; + + let group = await Group.getGroup({user, groupId: req.params.groupId, fields: 'type quest'}); + + if (!group) throw new NotFound(res.t('groupNotFound')); + if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); + if (!quest) throw new NotFound(res.t('questNotFound', { key: questKey })); + if (!user.items.quests[questKey]) throw new NotAuthorized(res.t('questNotOwned')); + if (user.stats.lvl < quest.lvl) throw new NotAuthorized(res.t('questLevelTooHigh', { level: quest.lvl })); + if (group.quest.key) throw new NotAuthorized(res.t('questAlreadyUnderway')); + + // TODO Logic for quest invite and send back quest object + res.respond(200, {}); + }, +}; + +/** + * @api {post} /groups/:groupId/quests/reject Reject a quest + * @apiVersion 3.0.0 + * @apiName RejectQuest + * @apiGroup Group + * + * @apiParam {string} groupId The group _id (or 'party') + * @apiParam {string} questKey The quest _id + * + * @apiSuccess {Object} Quest Object + */ +api.rejectQuest = { + method: 'POST', + url: '/groups/:groupId/quests/reject/:questKey', + middlewares: [authWithHeaders(), cron], + async handler (req, res) { + let user = res.locals.user; + let questKey = req.params.questKey; + let quest = questScrolls[questKey]; + + req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); + + let validationErrors = req.validationErrors(); + if (validationErrors) throw validationErrors; + + let group = await Group.getGroup({user, groupId: req.params.groupId, fields: 'type quest'}); + if (!group) throw new NotFound(res.t('groupNotFound')); + if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); + if (!quest) throw new NotFound(res.t('questNotFound', { key: questKey })); + if (!user.items.quests[questKey]) throw new NotAuthorized(res.t('questNotOwned')); + if (!group.quest.key) throw new NotFound(res.t('questInvitationDoesNotExist')); + + let analyticsData = { + category: 'behavior', + owner: false, + response: 'reject', + gaLabel: 'reject', + questName: group.quest.key, + uuid: user._id, + }; + mockAnalyticsService.track('quest', analyticsData); + + // @TODO: Are we tracking members this way? + // group.quest.members[user._id] = false; + + user.party.quest.RSVPNeeded = false; + user.party.quest.key = null; + await user.save(); + + // questStart(req,res,next); + + res.respond(200, {}); + }, +}; +>>>>>>> Added quest reject route and intial tests export default api; From 0684e307909406b41bf11737dc9a0a4471a5b902 Mon Sep 17 00:00:00 2001 From: Keith Holliday Date: Wed, 3 Feb 2016 17:04:57 -0600 Subject: [PATCH 2/8] Added quest cancel route and initial tests --- common/locales/en/api-v3.json | 3 +- .../POST-groups_groupid_quests_cancel.test.js | 66 +++++++++++++++++++ website/src/controllers/api-v3/quests.js | 49 ++++++++++++++ 3 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js diff --git a/common/locales/en/api-v3.json b/common/locales/en/api-v3.json index cdb6718327..5179067850 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.", + "cantCancelActiveQuest": "You can not cancel an active quest" } diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js new file mode 100644 index 0000000000..84111ab5ea --- /dev/null +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js @@ -0,0 +1,66 @@ +import { + createAndPopulateGroup, + translate as t, +} from '../../../../helpers/api-v3-integration.helper'; +import { v4 as generateUUID } from 'uuid'; + +describe('POST /groups/:groupId/quests/leave', () => { + 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/cancel`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('groupNotFound'), + }); + }); + + it('cancels a quest', async () => { + await member.update(userQuestUpdate); + await questingGroup.update({'quest.key': PET_QUEST}); + + let questMembers = {}; + questMembers[member._id] = true; + await questingGroup.update({'quest.members': questMembers}); + + await leader.post(`/groups/${questingGroup._id}/quests/cancel`); + let userThatCanceled = await member.get('/user'); + let updatedGroup = await member.get(`/groups/${questingGroup._id}`); + + expect(userThatCanceled.party.quest.key).to.be.null; + expect(userThatCanceled.party.quest.RSVPNeeded).to.be.false; + expect(updatedGroup.quest.members).to.be.empty; + }); + + it('returns an error when quest is active', async () => { + await questingGroup.update({'quest.active': true}); + await expect(leader.post(`/groups/${questingGroup._id}/quests/cancel`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('cantCancelActiveQuest'), + }); + }); +}); diff --git a/website/src/controllers/api-v3/quests.js b/website/src/controllers/api-v3/quests.js index 38020fcae5..8ebe969071 100644 --- a/website/src/controllers/api-v3/quests.js +++ b/website/src/controllers/api-v3/quests.js @@ -3,6 +3,9 @@ import cron from '../../middlewares/api-v3/cron'; import { model as Group, } from '../../models/group'; +import { + model as User, +} from '../../models/user'; import { NotFound, NotAuthorized, @@ -65,4 +68,50 @@ api.inviteToQuest = { }, }; +/** + * @api {post} /groups/:groupId/quests/cancel Cancels a quest + * @apiVersion 3.0.0 + * @apiName CancelQuest + * @apiGroup Group + * + * @apiParam {string} groupId The group _id (or 'party') + * + * @apiSuccess {Object} Group Object + */ +api.cancelQuest = { + method: 'POST', + url: '/groups/:groupId/quests/cancel', + middlewares: [authWithHeaders(), cron], + async handler (req, res) { + // Cancel a quest BEFORE it has begun (i.e., in the invitation stage) + // Quest scroll has not yet left quest owner's inventory so no need to return it. + // Do not wipe quest progress for members because they'll want it to be applied to the next quest that's started. + 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 NotAuthorized(res.t('cantCancelActiveQuest')); + + group.quest = {key: null, progress: {}, leader: null, members: {}}; + group.markModified('quest'); + await group.save(); + + await User.update( + {'party._id': groupId}, + {$set: {'party.quest.RSVPNeeded': false, 'party.quest.key': null}}, + {multi: true} + ); + + res.respond(200, group); + }, +}; + + export default api; From 442a654e94874586d5a56decef683190b71d9fc9 Mon Sep 17 00:00:00 2001 From: Keith Holliday Date: Thu, 4 Feb 2016 12:27:51 -0600 Subject: [PATCH 3/8] Removed questKey from url, added quest member support, removed extra tests, and fixed analytics import --- .../POST-groups_groupid_quests_reject.test.js | 46 ++------- website/src/controllers/api-v3/groups.js | 97 ------------------- website/src/controllers/api-v3/quests.js | 56 +++++++++++ 3 files changed, 66 insertions(+), 133 deletions(-) diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js index e5f7517eff..a222778948 100644 --- a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js @@ -30,7 +30,7 @@ describe('POST /groups/:groupId/quests/invite/:questKey', () => { context('failure conditions', () => { it('returns an error when group is not found', async () => { - await expect(member.post(`/groups/${generateUUID()}/quests/reject/${PET_QUEST}`)) + await expect(member.post(`/groups/${generateUUID()}/quests/reject`)) .to.eventually.be.rejected.and.eql({ code: 404, error: 'NotFound', @@ -38,43 +38,10 @@ describe('POST /groups/:groupId/quests/invite/:questKey', () => { }); }); - it('returns an error when group is not a party', async () => { - let { group, groupLeader } = await createAndPopulateGroup({ - groupDetails: { type: 'guild', privacy: 'private' }, - }); - - await expect(groupLeader.post(`/groups/${group._id}/quests/reject/${PET_QUEST}`)) - .to.eventually.be.rejected.and.eql({ - code: 401, - error: 'NotAuthorized', - message: t('guildQuestsNotSupported'), - }); - }); - - it('returns an error when quest is not found', async () => { - let questKey = 'fakeQuestName'; - - await expect(member.post(`/groups/${questingGroup._id}/quests/reject/${questKey}`)) - .to.eventually.be.rejected.and.eql({ - code: 404, - error: 'NotFound', - message: t('questNotFound', { key: questKey }), - }); - }); - - it('returns an error when user is not on the quest', async () => { - await expect(member.post(`/groups/${questingGroup._id}/quests/reject/${PET_QUEST}`)) - .to.eventually.be.rejected.and.eql({ - code: 401, - error: 'NotAuthorized', - message: t('questNotOwned'), - }); - }); - it('returns an error when group is not on a quest', async () => { await member.update(userQuestUpdate); - await expect(member.post(`/groups/${questingGroup._id}/quests/reject/${PET_QUEST}`)) + await expect(member.post(`/groups/${questingGroup._id}/quests/reject`)) .to.eventually.be.rejected.and.eql({ code: 404, error: 'NotFound', @@ -88,11 +55,18 @@ describe('POST /groups/:groupId/quests/invite/:questKey', () => { await member.update(userQuestUpdate); await questingGroup.update({'quest.key': PET_QUEST}); - await member.post(`/groups/${questingGroup._id}/quests/reject/${PET_QUEST}`); + let questMembers = {}; + questMembers[member._id] = true; + await questingGroup.update({'quest.members': questMembers}); + let rejectResult = await member.post(`/groups/${questingGroup._id}/quests/reject`); let userWithRejectInvitation = await member.get('/user'); + let updatedGroup = await member.get(`/groups/${questingGroup._id}`); + expect(userWithRejectInvitation.party.quest.key).to.be.null; expect(userWithRejectInvitation.party.quest.RSVPNeeded).to.be.false; + expect(updatedGroup.quest.members[member._id]).to.be.false; + expect(updatedGroup.quest).to.deep.equal(rejectResult); }); }); }); diff --git a/website/src/controllers/api-v3/groups.js b/website/src/controllers/api-v3/groups.js index 785ea564ba..b9b633c111 100644 --- a/website/src/controllers/api-v3/groups.js +++ b/website/src/controllers/api-v3/groups.js @@ -17,8 +17,6 @@ import { removeFromArray } from '../../libs/api-v3/collectionManipulators'; import * as firebase from '../../libs/api-v3/firebase'; import { sendTxn as sendTxnEmail } from '../../libs/api-v3/email'; import { encrypt } from '../../libs/api-v3/encryption'; -import { quests as questScrolls } from '../../../../common/script/content'; -import { mockAnalyticsService } from '../../libs/api-v3/analyticsService'; let api = {}; @@ -618,99 +616,4 @@ api.inviteToGroup = { }, }; -<<<<<<< e3c7d2834e6e5fa024afb71032c21177ca4124a7 -======= -/** - * @api {post} /groups/:groupId/quests/invite Invite users to a quest - * @apiVersion 3.0.0 - * @apiName InviteToQuest - * @apiGroup Group - * - * @apiParam {string} groupId The group _id (or 'party') - * - * @apiSuccess {Object} Quest Object - */ -api.inviteToQuest = { - method: 'POST', - url: '/groups/:groupId/quests/invite/:questKey', - middlewares: [authWithHeaders(), cron], - async handler (req, res) { - let user = res.locals.user; - let questKey = req.params.questKey; - let quest = questScrolls[questKey]; - - req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); - - let validationErrors = req.validationErrors(); - if (validationErrors) throw validationErrors; - - let group = await Group.getGroup({user, groupId: req.params.groupId, fields: 'type quest'}); - - if (!group) throw new NotFound(res.t('groupNotFound')); - if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); - if (!quest) throw new NotFound(res.t('questNotFound', { key: questKey })); - if (!user.items.quests[questKey]) throw new NotAuthorized(res.t('questNotOwned')); - if (user.stats.lvl < quest.lvl) throw new NotAuthorized(res.t('questLevelTooHigh', { level: quest.lvl })); - if (group.quest.key) throw new NotAuthorized(res.t('questAlreadyUnderway')); - - // TODO Logic for quest invite and send back quest object - res.respond(200, {}); - }, -}; - -/** - * @api {post} /groups/:groupId/quests/reject Reject a quest - * @apiVersion 3.0.0 - * @apiName RejectQuest - * @apiGroup Group - * - * @apiParam {string} groupId The group _id (or 'party') - * @apiParam {string} questKey The quest _id - * - * @apiSuccess {Object} Quest Object - */ -api.rejectQuest = { - method: 'POST', - url: '/groups/:groupId/quests/reject/:questKey', - middlewares: [authWithHeaders(), cron], - async handler (req, res) { - let user = res.locals.user; - let questKey = req.params.questKey; - let quest = questScrolls[questKey]; - - req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); - - let validationErrors = req.validationErrors(); - if (validationErrors) throw validationErrors; - - let group = await Group.getGroup({user, groupId: req.params.groupId, fields: 'type quest'}); - if (!group) throw new NotFound(res.t('groupNotFound')); - if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); - if (!quest) throw new NotFound(res.t('questNotFound', { key: questKey })); - if (!user.items.quests[questKey]) throw new NotAuthorized(res.t('questNotOwned')); - if (!group.quest.key) throw new NotFound(res.t('questInvitationDoesNotExist')); - - let analyticsData = { - category: 'behavior', - owner: false, - response: 'reject', - gaLabel: 'reject', - questName: group.quest.key, - uuid: user._id, - }; - mockAnalyticsService.track('quest', analyticsData); - - // @TODO: Are we tracking members this way? - // group.quest.members[user._id] = false; - - user.party.quest.RSVPNeeded = false; - user.party.quest.key = null; - await user.save(); - - // questStart(req,res,next); - - res.respond(200, {}); - }, -}; ->>>>>>> Added quest reject route and intial tests export default api; diff --git a/website/src/controllers/api-v3/quests.js b/website/src/controllers/api-v3/quests.js index 38020fcae5..6a7423bc0a 100644 --- a/website/src/controllers/api-v3/quests.js +++ b/website/src/controllers/api-v3/quests.js @@ -8,6 +8,8 @@ import { NotAuthorized, } from '../../libs/api-v3/errors'; import { quests as questScrolls } from '../../../../common/script/content'; +import { track } from '../../libs/api-v3/analyticsService'; +import Q from 'q'; let api = {}; @@ -65,4 +67,58 @@ api.inviteToQuest = { }, }; +/** + * @api {post} /groups/:groupId/quests/reject Reject a quest + * @apiVersion 3.0.0 + * @apiName RejectQuest + * @apiGroup Group + * + * @apiParam {string} groupId The group _id (or 'party') + * @apiParam {string} questKey The quest _id + * + * @apiSuccess {Object} Quest Object + */ +api.rejectQuest = { + method: 'POST', + url: '/groups/:groupId/quests/reject', + middlewares: [authWithHeaders(), cron], + async handler (req, res) { + let user = res.locals.user; + + req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); + + let validationErrors = req.validationErrors(); + if (validationErrors) throw validationErrors; + + let group = await Group.getGroup({user, groupId: req.params.groupId, fields: 'type quest'}); + if (!group) throw new NotFound(res.t('groupNotFound')); + if (!group.quest.key) throw new NotFound(res.t('questInvitationDoesNotExist')); + + let analyticsData = { + category: 'behavior', + owner: false, + response: 'reject', + gaLabel: 'reject', + questName: group.quest.key, + uuid: user._id, + }; + track('quest', analyticsData); + + group.quest.members[user._id] = false; + group.markModified('quest.members'); + + user.party.quest.RSVPNeeded = false; + user.party.quest.key = null; + + let [savedGroup] = await Q.all([ + group.save(), + user.save(), + ]); + + // questStart(req,res,next); + + res.respond(200, savedGroup.quest); + }, +}; + export default api; From 879506b38a0662b29e4ccc60251758b0d73f886c Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 11 Feb 2016 12:50:28 +0100 Subject: [PATCH 4/8] update reject quest route --- common/locales/en/api-v3.json | 3 +- .../POST-groups_groupid_quests_reject.test.js | 125 +++++++++++++----- website/src/controllers/api-v3/quests.js | 40 +++--- website/src/models/group.js | 1 - 4 files changed, 117 insertions(+), 52 deletions(-) diff --git a/common/locales/en/api-v3.json b/common/locales/en/api-v3.json index a2495529e7..62c4df4d8b 100644 --- a/common/locales/en/api-v3.json +++ b/common/locales/en/api-v3.json @@ -74,5 +74,6 @@ "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.", - "questAlreadyAccepted": "You already accepted the quest invitation." + "questAlreadyAccepted": "You already accepted the quest invitation.", + "questAlreadyRejected": "You already rejected the quest invitation." } diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js index a222778948..84e364f770 100644 --- a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js @@ -1,36 +1,37 @@ import { createAndPopulateGroup, translate as t, + generateUser, } from '../../../../helpers/api-v3-integration.helper'; import { v4 as generateUUID } from 'uuid'; -describe('POST /groups/:groupId/quests/invite/:questKey', () => { +describe('POST /groups/:groupId/quests/reject', () => { let questingGroup; - let member; - const PET_QUEST = 'whale'; - let userQuestUpdate = { - items: { - quests: {}, - }, - 'party.quest.RSVPNeeded': true, - 'party.quest.key': PET_QUEST, - }; + let partyMembers; + let user; + let leader; - before(async () => { - let { group, members } = await createAndPopulateGroup({ + const PET_QUEST = 'whale'; + + beforeEach(async () => { + let { group, groupLeader, members } = await createAndPopulateGroup({ groupDetails: { type: 'party', privacy: 'private' }, - members: 1, + members: 2, }); questingGroup = group; - member = members[0]; + leader = groupLeader; + partyMembers = members; - userQuestUpdate.items.quests[PET_QUEST] = 1; + await leader.update({ + [`items.quests.${PET_QUEST}`]: 1, + }); + user = await generateUser(); }); context('failure conditions', () => { it('returns an error when group is not found', async () => { - await expect(member.post(`/groups/${generateUUID()}/quests/reject`)) + await expect(partyMembers[0].post(`/groups/${generateUUID()}/quests/reject`)) .to.eventually.be.rejected.and.eql({ code: 404, error: 'NotFound', @@ -38,35 +39,97 @@ describe('POST /groups/:groupId/quests/invite/:questKey', () => { }); }); - it('returns an error when group is not on a quest', async () => { - await member.update(userQuestUpdate); + it('does not accept quest for a group in which user is not a member', async () => { + await expect(user.post(`/groups/${questingGroup._id}/quests/accept`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('groupNotFound'), + }); + }); - await expect(member.post(`/groups/${questingGroup._id}/quests/reject`)) + it('returns an error when group is a guild', async () => { + let { group: guild, groupLeader: guildLeader } = await createAndPopulateGroup({ + groupDetails: { type: 'guild', privacy: 'private' }, + }); + + await expect(guildLeader.post(`/groups/${guild._id}/quests/reject`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('guildQuestsNotSupported'), + }); + }); + + it('returns an error when group is not on a quest', async () => { + await expect(partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`)) .to.eventually.be.rejected.and.eql({ code: 404, error: 'NotFound', message: t('questInvitationDoesNotExist'), }); }); + + it('return an error when an user rejects an invite twice', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`); + + await expect(partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`)) + .to.eventually.be.rejected.and.eql({ + code: 400, + error: 'BadRequest', + message: t('questAlreadyRejected'), + }); + }); + + it('return an error when an user rejects an invite already accepted', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/accept`); + + await expect(partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`)) + .to.eventually.be.rejected.and.eql({ + code: 400, + error: 'BadRequest', + message: t('questAlreadyAccepted'), + }); + }); + + it('does not reject invite for a quest already underway', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/accept`); + // quest will start after everyone has accepted + await partyMembers[1].post(`/groups/${questingGroup._id}/quests/accept`); + + await expect(partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('questAlreadyUnderway'), + }); + }); }); context('successfully quest rejection', () => { it('rejects a quest invitation', async () => { - await member.update(userQuestUpdate); - await questingGroup.update({'quest.key': PET_QUEST}); + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); - let questMembers = {}; - questMembers[member._id] = true; - await questingGroup.update({'quest.members': questMembers}); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`); + await partyMembers[0].sync(); + await questingGroup.sync(); - let rejectResult = await member.post(`/groups/${questingGroup._id}/quests/reject`); - let userWithRejectInvitation = await member.get('/user'); - let updatedGroup = await member.get(`/groups/${questingGroup._id}`); + expect(partyMembers[0].party.quest.key).to.be.null; + expect(partyMembers[0].party.quest.RSVPNeeded).to.be.false; + expect(questingGroup.quest.members[partyMembers[0]._id]).to.be.false; + expect(questingGroup.quest.active).to.be.false; + }); - expect(userWithRejectInvitation.party.quest.key).to.be.null; - expect(userWithRejectInvitation.party.quest.RSVPNeeded).to.be.false; - expect(updatedGroup.quest.members[member._id]).to.be.false; - expect(updatedGroup.quest).to.deep.equal(rejectResult); + it('starts the quest when the last user reject', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/accept`); + await partyMembers[1].post(`/groups/${questingGroup._id}/quests/reject`); + await questingGroup.sync(); + + expect(questingGroup.quest.active).to.be.true; }); }); }); diff --git a/website/src/controllers/api-v3/quests.js b/website/src/controllers/api-v3/quests.js index 0f1f991b7b..b4a789b392 100644 --- a/website/src/controllers/api-v3/quests.js +++ b/website/src/controllers/api-v3/quests.js @@ -19,13 +19,11 @@ import { sendTxn as sendTxnEmail, } from '../../libs/api-v3/email'; import { quests as questScrolls } from '../../../../common/script/content'; -import { track } from '../../libs/api-v3/analyticsService'; -import Q from 'q'; function canStartQuestAutomatically (group) { // If all members are either true (accepted) or false (rejected) return true // If any member is null/undefined (undecided) return false - return _.every(group.quest.members, Boolean); + return _.every(group.quest.members, _.isBoolean); } let api = {}; @@ -191,9 +189,8 @@ api.acceptQuest = { * @apiGroup Group * * @apiParam {string} groupId The group _id (or 'party') - * @apiParam {string} questKey The quest _id * - * @apiSuccess {Object} Quest Object + * @apiSuccess {Object} quest Quest Object */ api.rejectQuest = { method: 'POST', @@ -209,32 +206,37 @@ api.rejectQuest = { let group = await Group.getGroup({user, groupId: req.params.groupId, fields: 'type quest'}); if (!group) throw new NotFound(res.t('groupNotFound')); + if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); if (!group.quest.key) throw new NotFound(res.t('questInvitationDoesNotExist')); - - let analyticsData = { - category: 'behavior', - owner: false, - response: 'reject', - gaLabel: 'reject', - questName: group.quest.key, - uuid: user._id, - }; - track('quest', analyticsData); + if (group.quest.active) throw new NotAuthorized(res.t('questAlreadyUnderway')); + if (group.quest.members[user._id]) throw new BadRequest(res.t('questAlreadyAccepted')); + if (group.quest.members[user._id] === false) throw new BadRequest(res.t('questAlreadyRejected')); group.quest.members[user._id] = false; group.markModified('quest.members'); - user.party.quest.RSVPNeeded = false; - user.party.quest.key = null; + user.party.quest = Group.cleanQuestProgress(); + user.markModified('party.quest'); + + if (canStartQuestAutomatically(group)) { + await group.startQuest(user); + } let [savedGroup] = await Q.all([ group.save(), user.save(), ]); - // questStart(req,res,next); - res.respond(200, savedGroup.quest); + + analytics.track('quest', { + category: 'behavior', + owner: false, + response: 'reject', + gaLabel: 'reject', + questName: group.quest.key, + uuid: user._id, + }); }, }; diff --git a/website/src/models/group.js b/website/src/models/group.js index ff7a22b63c..bb2c08d436 100644 --- a/website/src/models/group.js +++ b/website/src/models/group.js @@ -301,7 +301,6 @@ schema.methods.startQuest = async function startQuest (user) { }; function _cleanQuestProgress (merge) { - // TODO clone? (also in sendChat message) let clean = { key: null, progress: { From 6c1950972b8b5a3b61784959ba6402449096ab8f Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 11 Feb 2016 13:19:46 +0100 Subject: [PATCH 5/8] update quest cancel routes --- common/locales/en/api-v3.json | 4 +- .../POST-groups_groupid_quests_cancel.test.js | 139 +++++++++++++----- website/src/controllers/api-v3/quests.js | 12 +- website/src/models/group.js | 15 ++ 4 files changed, 130 insertions(+), 40 deletions(-) diff --git a/common/locales/en/api-v3.json b/common/locales/en/api-v3.json index 7c5cc3b189..ec2be7a366 100644 --- a/common/locales/en/api-v3.json +++ b/common/locales/en/api-v3.json @@ -75,5 +75,7 @@ "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.", "questAlreadyAccepted": "You already accepted the quest invitation.", - "cantCancelActiveQuest": "You can not cancel an active quest, use the abort functionality." + "cantCancelActiveQuest": "You can not cancel an active quest, use the abort functionality.", + "onlyLeaderCancelQuest": "Only the group or quest leader can cancel the quest.", + "questInvitationDoesNotExist": "No quest invitation has been sent out yet." } diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js index 84111ab5ea..76f0102a5f 100644 --- a/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js @@ -1,66 +1,137 @@ import { createAndPopulateGroup, translate as t, + generateUser, } from '../../../../helpers/api-v3-integration.helper'; import { v4 as generateUUID } from 'uuid'; -describe('POST /groups/:groupId/quests/leave', () => { - let questingGroup, member, leader; - const PET_QUEST = 'whale'; - let userQuestUpdate = { - items: { - quests: {}, - }, - 'party.quest.RSVPNeeded': true, - 'party.quest.key': PET_QUEST, - }; +describe('POST /groups/:groupId/quests/cancel', () => { + let questingGroup; + let partyMembers; + let user; + let leader; - before(async () => { + const PET_QUEST = 'whale'; + + beforeEach(async () => { let { group, groupLeader, members } = await createAndPopulateGroup({ groupDetails: { type: 'party', privacy: 'private' }, - members: 1, + members: 2, }); - leader = groupLeader; questingGroup = group; - member = members[0]; + leader = groupLeader; + partyMembers = members; - userQuestUpdate.items.quests[PET_QUEST] = 1; + await leader.update({ + [`items.quests.${PET_QUEST}`]: 1, + }); + user = await generateUser(); }); - it('returns an error when group is not found', async () => { - await expect(leader.post(`/groups/${generateUUID()}/quests/cancel`)) + context('failure conditions', () => { + it('returns an error when group is not found', async () => { + await expect(partyMembers[0].post(`/groups/${generateUUID()}/quests/cancel`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('groupNotFound'), + }); + }); + + it('does not reject quest for a group in which user is not a member', async () => { + await expect(user.post(`/groups/${questingGroup._id}/quests/cancel`)) .to.eventually.be.rejected.and.eql({ code: 404, error: 'NotFound', message: t('groupNotFound'), }); - }); + }); - it('cancels a quest', async () => { - await member.update(userQuestUpdate); - await questingGroup.update({'quest.key': PET_QUEST}); + it('returns an error when group is a guild', async () => { + let { group: guild, groupLeader: guildLeader } = await createAndPopulateGroup({ + groupDetails: { type: 'guild', privacy: 'private' }, + }); - let questMembers = {}; - questMembers[member._id] = true; - await questingGroup.update({'quest.members': questMembers}); + await expect(guildLeader.post(`/groups/${guild._id}/quests/cancel`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('guildQuestsNotSupported'), + }); + }); - await leader.post(`/groups/${questingGroup._id}/quests/cancel`); - let userThatCanceled = await member.get('/user'); - let updatedGroup = await member.get(`/groups/${questingGroup._id}`); + it('returns an error when group is not on a quest', async () => { + await expect(partyMembers[0].post(`/groups/${questingGroup._id}/quests/cancel`)) + .to.eventually.be.rejected.and.eql({ + code: 404, + error: 'NotFound', + message: t('questInvitationDoesNotExist'), + }); + }); - expect(userThatCanceled.party.quest.key).to.be.null; - expect(userThatCanceled.party.quest.RSVPNeeded).to.be.false; - expect(updatedGroup.quest.members).to.be.empty; - }); + it('only the leader can cancel the quest', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); - it('returns an error when quest is active', async () => { - await questingGroup.update({'quest.active': true}); - await expect(leader.post(`/groups/${questingGroup._id}/quests/cancel`)) + await expect(partyMembers[0].post(`/groups/${questingGroup._id}/quests/cancel`)) + .to.eventually.be.rejected.and.eql({ + code: 401, + error: 'NotAuthorized', + message: t('onlyLeaderCancelQuest'), + }); + }); + + it('does not cancel a quest already underway', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/accept`); + // quest will start after everyone has accepted + await partyMembers[1].post(`/groups/${questingGroup._id}/quests/accept`); + + await expect(leader.post(`/groups/${questingGroup._id}/quests/cancel`)) .to.eventually.be.rejected.and.eql({ code: 401, error: 'NotAuthorized', message: t('cantCancelActiveQuest'), }); + }); + }); + + it('cancels a quest', async () => { + await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); + await partyMembers[0].post(`/groups/${questingGroup._id}/quests/accept`); + + await leader.post(`/groups/${questingGroup._id}/quests/cancel`); + + await Promise.all([ + leader.sync(), + partyMembers[0].sync(), + partyMembers[1].sync(), + questingGroup.sync(), + ]); + + let clean = { + key: null, + progress: { + up: 0, + down: 0, + collect: {}, + }, + completed: null, + RSVPNeeded: false, + }; + + expect(leader.party.quest).eql(clean); + expect(partyMembers[1].party.quest).eql(clean); + expect(partyMembers[0].party.quest).eql(clean); + + expect(questingGroup.quest).to.eql({ + key: null, + active: false, + leader: null, + progress: { + collect: {}, + }, + members: {}, + }); }); }); diff --git a/website/src/controllers/api-v3/quests.js b/website/src/controllers/api-v3/quests.js index 3da381e26d..4cfad3155c 100644 --- a/website/src/controllers/api-v3/quests.js +++ b/website/src/controllers/api-v3/quests.js @@ -190,7 +190,7 @@ api.acceptQuest = { * * @apiParam {string} groupId The group _id (or 'party') * - * @apiSuccess {Object} Group Object + * @apiSuccess {Object} quest Quest Object */ api.cancelQuest = { method: 'POST', @@ -210,20 +210,22 @@ api.cancelQuest = { let group = await Group.getGroup({user, groupId, fields: 'type quest'}); if (!group) throw new NotFound(res.t('groupNotFound')); - + if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); + if (!group.quest.key) throw new NotFound(res.t('questInvitationDoesNotExist')); + if (user._id !== group.leader && group.quest.leader !== user._id) throw new NotAuthorized(res.t('onlyLeaderCancelQuest')); if (group.quest.active) throw new NotAuthorized(res.t('cantCancelActiveQuest')); - group.quest = {key: null, progress: {}, leader: null, members: {}}; + group.quest = Group.cleanGroupQuest(); group.markModified('quest'); await group.save(); await User.update( {'party._id': groupId}, - {$set: {'party.quest.RSVPNeeded': false, 'party.quest.key': null}}, + {$set: {'party.quest': Group.cleanQuestProgress()}}, {multi: true} ); - res.respond(200, group); + res.respond(200, group.quest); }, }; diff --git a/website/src/models/group.js b/website/src/models/group.js index ff7a22b63c..1af2c8f7b5 100644 --- a/website/src/models/group.js +++ b/website/src/models/group.js @@ -300,6 +300,7 @@ schema.methods.startQuest = async function startQuest (user) { }); }; +// return a clean object for user.quest function _cleanQuestProgress (merge) { // TODO clone? (also in sendChat message) let clean = { @@ -321,8 +322,22 @@ function _cleanQuestProgress (merge) { return clean; } +// TODO move to User.cleanQuestProgress? schema.statics.cleanQuestProgress = _cleanQuestProgress; +// returns a clean object for group.quest +schema.statics.cleanGroupQuest = function cleanGroupQuest () { + return { + key: null, + active: false, + leader: null, + progress: { + collect: {}, + }, + members: {}, + }; +}; + // Participants: Grant rewards & achievements, finish quest // Returns the promise from update().exec() schema.methods.finishQuest = function finishQuest (quest) { From dfb6ec2f48cea2e205913b74b16901d38285a9b9 Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 11 Feb 2016 15:11:38 +0100 Subject: [PATCH 6/8] cancel quest: test response --- .../quests/POST-groups_groupid_quests_cancel.test.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js index 76f0102a5f..daa995438a 100644 --- a/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_cancel.test.js @@ -100,7 +100,7 @@ describe('POST /groups/:groupId/quests/cancel', () => { await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); await partyMembers[0].post(`/groups/${questingGroup._id}/quests/accept`); - await leader.post(`/groups/${questingGroup._id}/quests/cancel`); + let res = await leader.post(`/groups/${questingGroup._id}/quests/cancel`); await Promise.all([ leader.sync(), @@ -124,6 +124,7 @@ describe('POST /groups/:groupId/quests/cancel', () => { expect(partyMembers[1].party.quest).eql(clean); expect(partyMembers[0].party.quest).eql(clean); + expect(res).to.eql(questingGroup.quest); expect(questingGroup.quest).to.eql({ key: null, active: false, From ab187720a5fcc11f064d8e1654c7d3e84e0a7a71 Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 11 Feb 2016 15:14:07 +0100 Subject: [PATCH 7/8] reject quest: test response --- .../POST-groups_groupid_quests_reject.test.js | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js index 84e364f770..1eb62aa0c6 100644 --- a/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js +++ b/test/api/v3/integration/quests/POST-groups_groupid_quests_reject.test.js @@ -110,17 +110,28 @@ describe('POST /groups/:groupId/quests/reject', () => { }); context('successfully quest rejection', () => { + let cleanUserQuestObj = { + key: null, + progress: { + up: 0, + down: 0, + collect: {}, + }, + completed: null, + RSVPNeeded: false, + }; + it('rejects a quest invitation', async () => { await leader.post(`/groups/${questingGroup._id}/quests/invite/${PET_QUEST}`); - await partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`); + let res = await partyMembers[0].post(`/groups/${questingGroup._id}/quests/reject`); await partyMembers[0].sync(); await questingGroup.sync(); - expect(partyMembers[0].party.quest.key).to.be.null; - expect(partyMembers[0].party.quest.RSVPNeeded).to.be.false; + expect(partyMembers[0].party.quest).to.eql(cleanUserQuestObj); expect(questingGroup.quest.members[partyMembers[0]._id]).to.be.false; expect(questingGroup.quest.active).to.be.false; + expect(res).to.eql(questingGroup.quest); }); it('starts the quest when the last user reject', async () => { From 41c3276e66beed584ff5aabc3928ca8172cad46d Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 11 Feb 2016 15:36:21 +0100 Subject: [PATCH 8/8] fetch leader id when cancelling quest --- website/src/controllers/api-v3/quests.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/controllers/api-v3/quests.js b/website/src/controllers/api-v3/quests.js index 4cfad3155c..fc1555f54d 100644 --- a/website/src/controllers/api-v3/quests.js +++ b/website/src/controllers/api-v3/quests.js @@ -208,7 +208,7 @@ api.cancelQuest = { let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; - let group = await Group.getGroup({user, groupId, fields: 'type quest'}); + let group = await Group.getGroup({user, groupId, fields: 'type leader quest'}); if (!group) throw new NotFound(res.t('groupNotFound')); if (group.type !== 'party') throw new NotAuthorized(res.t('guildQuestsNotSupported')); if (!group.quest.key) throw new NotFound(res.t('questInvitationDoesNotExist'));