4.15.2

and Starry Night Hatching Potions

Dockerfile-Production

@@ -20,7 +20,7 @@ RUN npm install -g gulp mocha
 # Clone Habitica repo and install dependencies
 RUN mkdir -p /usr/src/habitrpg
 WORKDIR /usr/src/habitrpg
-RUN git clone --branch v4.13.4 https://github.com/HabitRPG/habitica.git /usr/src/habitrpg
+RUN git clone --branch v4.14.2 https://github.com/HabitRPG/habitica.git /usr/src/habitrpg
 RUN npm install
 RUN gulp build:prod --force
 

config.json.example

@@ -71,6 +71,7 @@
     },
     "IAP_GOOGLE_KEYDIR": "/path/to/google/public/key/dir/",
     "LOGGLY_TOKEN": "token",
+    "LOGGLY_CLIENT_TOKEN": "token",
     "LOGGLY_ACCOUNT": "account",
     "PUSH_CONFIGS": {
         "GCM_SERVER_API_KEY": "",

migrations/migration-runner.js

@@ -17,7 +17,7 @@ function setUpServer () {
 setUpServer();
 
 // Replace this with your migration
-const processUsers = require('./users/account-transfer');
+const processUsers = require('./users/achievement-restore');
 processUsers()
   .then(() => {
     process.exit();

migrations/tasks/tasks-set-everyX.js

@@ -0,0 +1,88 @@
+var migrationName = 'tasks-set-everyX';
+var authorName = ''; // in case script author needs to know when their ...
+var authorUuid = ''; //... own data is done
+
+/*
+ * Iterates over all tasks and sets invalid everyX values (less than 0 or more than 9999 or not an int) field to 0
+ */
+
+var monk = require('monk');
+var connectionString = 'mongodb://localhost:27017/habitrpg?auto_reconnect=true'; // FOR TEST DATABASE
+var dbTasks = monk(connectionString).get('tasks', { castIds: false });
+
+function processTasks(lastId) {
+  // specify a query to limit the affected tasks (empty for all tasks):
+  var query = {
+    type: "daily",
+    everyX: {
+      $not: {
+        $gte: 0,
+        $lte: 9999,
+        $type: "int",
+      }
+    },
+  };
+
+  if (lastId) {
+    query._id = {
+      $gt: lastId
+    }
+  }
+
+  dbTasks.find(query, {
+    sort: {_id: 1},
+    limit: 250,
+    fields: [],
+  })
+  .then(updateTasks)
+  .catch(function (err) {
+    console.log(err);
+    return exiting(1, 'ERROR! ' + err);
+  });
+}
+
+var progressCount = 1000;
+var count = 0;
+
+function updateTasks (tasks) {
+  if (!tasks || tasks.length === 0) {
+    console.warn('All appropriate tasks found and modified.');
+    displayData();
+    return;
+  }
+
+  var taskPromises = tasks.map(updatetask);
+  var lasttask = tasks[tasks.length - 1];
+
+  return Promise.all(taskPromises)
+  .then(function () {
+    processTasks(lasttask._id);
+  });
+}
+
+function updatetask (task) {
+  count++;
+  var set = {'everyX': 0};
+
+  dbTasks.update({_id: task._id}, {$set:set});
+
+  if (count % progressCount == 0) console.warn(count + ' ' + task._id);
+  if (task._id == authorUuid) console.warn(authorName + ' processed');
+}
+
+function displayData() {
+  console.warn('\n' + count + ' tasks processed\n');
+  return exiting(0);
+}
+
+function exiting(code, msg) {
+  code = code || 0; // 0 = success
+  if (code && !msg) { msg = 'ERROR!'; }
+  if (msg) {
+    if (code) { console.error(msg); }
+    else      { console.log(  msg); }
+  }
+  process.exit(code);
+}
+
+module.exports = processTasks;

migrations/users/achievement-restore.js

@@ -0,0 +1,93 @@
+const migrationName = 'AchievementRestore';
+const authorName = 'TheHollidayInn'; // in case script author needs to know when their ...
+const authorUuid = ''; //... own data is done
+
+/*
+ * This migraition will copy user data from prod to test
+ */
+import Bluebird from 'bluebird';
+
+const monk = require('monk');
+const connectionString = 'mongodb://localhost/new-habit';
+const Users = monk(connectionString).get('users', { castIds: false });
+
+const monkOld = require('monk');
+const oldConnectionSting = 'mongodb://localhost/old-habit';
+const UsersOld = monk(oldConnectionSting).get('users', { castIds: false });
+
+function getAchievementUpdate (newUser, oldUser) {
+  const oldAchievements = oldUser.achievements;
+  const newAchievements = newUser.achievements;
+
+  let achievementsUpdate = Object.assign({}, newAchievements);
+
+  // ultimateGearSets
+  if (!achievementsUpdate.ultimateGearSets && oldAchievements.ultimateGearSets) {
+    achievementsUpdate.ultimateGearSets = oldAchievements.ultimateGearSets;
+  } else if (oldAchievements.ultimateGearSets) {
+    for (let index in oldAchievements.ultimateGearSets) {
+      if (oldAchievements.ultimateGearSets[index]) achievementsUpdate.ultimateGearSets[index] = true;
+    }
+  }
+
+  // challenges
+  if (!newAchievements.challenges) newAchievements.challenges = [];
+  if (!oldAchievements.challenges) oldAchievements.challenges = [];
+  achievementsUpdate.challenges = newAchievements.challenges.concat(oldAchievements.challenges);
+
+  // Quests
+  if (!achievementsUpdate.quests) achievementsUpdate.quests = {};
+  for (let index in oldAchievements.quests) {
+    if (!achievementsUpdate.quests[index]) {
+      achievementsUpdate.quests[index] = oldAchievements.quests[index];
+    } else {
+      achievementsUpdate.quests[index] += oldAchievements.quests[index];
+    }
+  }
+
+  // Rebirth level
+  if (achievementsUpdate.rebirthLevel) {
+    achievementsUpdate.rebirthLevel = Math.max(achievementsUpdate.rebirthLevel, oldAchievements.rebirthLevel);
+  } else if (oldAchievements.rebirthLevel) {
+    achievementsUpdate.rebirthLevel = oldAchievements.rebirthLevel;
+  }
+
+  //All others
+  const indexsToIgnore = ['ultimateGearSets', 'challenges', 'quests', 'rebirthLevel'];
+  for (let index in oldAchievements) {
+    if (indexsToIgnore.indexOf(index) !== -1) continue;
+
+    if (!achievementsUpdate[index])  {
+      achievementsUpdate[index] = oldAchievements[index];
+      continue;
+    }
+
+    if (Number.isInteger(oldAchievements[index])) {
+      achievementsUpdate[index] += oldAchievements[index];
+    } else {
+      if (oldAchievements[index] === true) achievementsUpdate[index] = true;
+    }
+  }
+
+  return achievementsUpdate;
+}
+
+module.exports = async function achievementRestore () {
+  const userIds = [
+  ];
+
+  for (let index in userIds) {
+    const userId = userIds[index];
+    const oldUser = await UsersOld.findOne({_id: userId}, 'achievements');
+    const newUser = await Users.findOne({_id: userId}, 'achievements');
+    const achievementUpdate = getAchievementUpdate(newUser, oldUser);
+    await Users.update(
+      {_id: userId},
+      {
+        $set: {
+          'achievements': achievementUpdate,
+        },
+      });
+    console.log(`Updated ${userId}`);
+  }
+};

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "habitica",
-  "version": "4.14.1",
+  "version": "4.15.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "habitica",
   "description": "A habit tracker app which treats your goals like a Role Playing Game.",
-  "version": "4.14.1",
+  "version": "4.15.2",
   "main": "./website/server/index.js",
   "dependencies": {
     "@slack/client": "^3.8.1",

test/api/v3/integration/challenges/GET-challenges_challengeId_export_csv.test.js

@@ -64,11 +64,11 @@ describe('GET /challenges/:challengeId/export/csv', () => {
     let sortedMembers = _.sortBy([members[0], members[1], members[2], groupLeader], '_id');
     let splitRes = res.split('\n');
 
-    expect(splitRes[0]).to.equal('UUID,name,Task,Value,Notes,Task,Value,Notes');
-    expect(splitRes[1]).to.equal(`${sortedMembers[0]._id},${sortedMembers[0].profile.name},habit:Task 1,0,,todo:Task 2,0,`);
-    expect(splitRes[2]).to.equal(`${sortedMembers[1]._id},${sortedMembers[1].profile.name},habit:Task 1,0,,todo:Task 2,0,`);
-    expect(splitRes[3]).to.equal(`${sortedMembers[2]._id},${sortedMembers[2].profile.name},habit:Task 1,0,,todo:Task 2,0,`);
-    expect(splitRes[4]).to.equal(`${sortedMembers[3]._id},${sortedMembers[3].profile.name},habit:Task 1,0,,todo:Task 2,0,`);
+    expect(splitRes[0]).to.equal('UUID,name,Task,Value,Notes,Streak,Task,Value,Notes,Streak');
+    expect(splitRes[1]).to.equal(`${sortedMembers[0]._id},${sortedMembers[0].profile.name},habit:Task 1,0,,0,todo:Task 2,0,,0`);
+    expect(splitRes[2]).to.equal(`${sortedMembers[1]._id},${sortedMembers[1].profile.name},habit:Task 1,0,,0,todo:Task 2,0,,0`);
+    expect(splitRes[3]).to.equal(`${sortedMembers[2]._id},${sortedMembers[2].profile.name},habit:Task 1,0,,0,todo:Task 2,0,,0`);
+    expect(splitRes[4]).to.equal(`${sortedMembers[3]._id},${sortedMembers[3].profile.name},habit:Task 1,0,,0,todo:Task 2,0,,0`);
     expect(splitRes[5]).to.equal('');
   });
 });

test/api/v3/integration/chat/POST-chat.test.js

@@ -1,5 +1,6 @@
 import {
   createAndPopulateGroup,
+  generateUser,
   translate as t,
   sleep,
   server,
@@ -363,6 +364,24 @@ describe('POST /chat', () => {
     expect(message.message.id).to.exist;
   });
 
+  it('adds backer info to chat', async () => {
+    const backerInfo = {
+      npc: 'Town Crier',
+      tier: 800,
+      tokensApplied: true,
+    };
+    const backer = await generateUser({
+      backer: backerInfo,
+    });
+
+    const message = await backer.post(`/groups/${groupWithChat._id}/chat`, { message: testMessage});
+    const messageBackerInfo = message.message.backer;
+
+    expect(messageBackerInfo.npc).to.equal(backerInfo.npc);
+    expect(messageBackerInfo.tier).to.equal(backerInfo.tier);
+    expect(messageBackerInfo.tokensApplied).to.equal(backerInfo.tokensApplied);
+  });
+
   it('sends group chat received webhooks', async () => {
     let userUuid = generateUUID();
     let memberUuid = generateUUID();

test/api/v3/integration/groups/GET-groups_groupId_members.test.js

@@ -161,4 +161,19 @@ describe('GET /groups/:groupId/members', () => {
     let resIds = res.concat(res2).map(member => member._id);
     expect(resIds).to.eql(expectedIds.sort());
   });
+
+  it('searches members', async () => {
+    let group = await generateGroup(user, {type: 'party', name: generateUUID()});
+
+    let usersToGenerate = [];
+    for (let i = 0; i < 2; i++) {
+      usersToGenerate.push(generateUser({party: {_id: group._id}}));
+    }
+    const usersCreated = await Promise.all(usersToGenerate);
+    const userToSearch = usersCreated[0].profile.name;
+
+    let res = await user.get(`/groups/party/members?search=${userToSearch}`);
+    expect(res.length).to.equal(1);
+    expect(res[0].profile.name).to.equal(userToSearch);
+  });
 });

test/api/v3/integration/members/POST-send_private_message.test.js

@@ -118,4 +118,56 @@ describe('POST /members/send-private-message', () => {
     expect(sendersMessageInReceiversInbox).to.exist;
     expect(sendersMessageInSendersInbox).to.exist;
   });
+
+  it('allows admin to send when sender has blocked the admin', async () => {
+    userToSendMessage = await generateUser({
+      'contributor.admin': 1,
+    });
+    const receiver = await generateUser({'inbox.blocks': [userToSendMessage._id]});
+
+    await userToSendMessage.post('/members/send-private-message', {
+      message: messageToSend,
+      toUserId: receiver._id,
+    });
+
+    const updatedReceiver = await receiver.get('/user');
+    const updatedSender = await userToSendMessage.get('/user');
+
+    const sendersMessageInReceiversInbox = _.find(updatedReceiver.inbox.messages, (message) => {
+      return message.uuid === userToSendMessage._id && message.text === messageToSend;
+    });
+
+    const sendersMessageInSendersInbox = _.find(updatedSender.inbox.messages, (message) => {
+      return message.uuid === receiver._id && message.text === messageToSend;
+    });
+
+    expect(sendersMessageInReceiversInbox).to.exist;
+    expect(sendersMessageInSendersInbox).to.exist;
+  });
+
+  it('allows admin to send when to user has opted out of messaging', async () => {
+    userToSendMessage = await generateUser({
+      'contributor.admin': 1,
+    });
+    const receiver = await generateUser({'inbox.optOut': true});
+
+    await userToSendMessage.post('/members/send-private-message', {
+      message: messageToSend,
+      toUserId: receiver._id,
+    });
+
+    const updatedReceiver = await receiver.get('/user');
+    const updatedSender = await userToSendMessage.get('/user');
+
+    const sendersMessageInReceiversInbox = _.find(updatedReceiver.inbox.messages, (message) => {
+      return message.uuid === userToSendMessage._id && message.text === messageToSend;
+    });
+
+    const sendersMessageInSendersInbox = _.find(updatedSender.inbox.messages, (message) => {
+      return message.uuid === receiver._id && message.text === messageToSend;
+    });
+
+    expect(sendersMessageInReceiversInbox).to.exist;
+    expect(sendersMessageInSendersInbox).to.exist;
+  });
 });

test/api/v3/integration/tasks/POST-tasks_user.test.js

@@ -302,6 +302,17 @@ describe('POST /tasks/user', () => {
 
       expect(task.alias).to.eql('a_alias012');
     });
+
+    // This is a special case for iOS requests
+    it('will round a priority (difficulty)', async () => {
+      let task = await user.post('/tasks/user', {
+        text: 'test habit',
+        type: 'habit',
+        priority: 0.10000000000005,
+      });
+
+      expect(task.priority).to.eql(0.1);
+    });
   });
 
   context('habits', () => {
@@ -628,6 +639,43 @@ describe('POST /tasks/user', () => {
       });
     });
 
+    it('returns an error if everyX is a non int', async () => {
+      await expect(user.post('/tasks/user', {
+        text: 'test daily',
+        type: 'daily',
+        everyX: 2.5,
+      })).to.eventually.be.rejected.and.eql({
+        code: 400,
+        error: 'BadRequest',
+        message: 'daily validation failed',
+      });
+    });
+
+    it('returns an error if everyX is negative', async () => {
+      await expect(user.post('/tasks/user', {
+        text: 'test daily',
+        type: 'daily',
+        everyX: -1,
+      })).to.eventually.be.rejected.and.eql({
+        code: 400,
+        error: 'BadRequest',
+        message: 'daily validation failed',
+      });
+    });
+
+    it('returns an error if everyX is above 9999', async () => {
+      await expect(user.post('/tasks/user', {
+        text: 'test daily',
+        type: 'daily',
+        everyX: 10000,
+      })).to.eventually.be.rejected.and.eql({
+        code: 400,
+        error: 'BadRequest',
+        message: 'daily validation failed',
+      });
+    });
+
+
     it('can create checklists', async () => {
       let task = await user.post('/tasks/user', {
         text: 'test daily',

test/api/v3/integration/tasks/groups/POST-group_tasks_id_score_direction.test.js

@@ -41,8 +41,9 @@ describe('POST /tasks/:id/score/:direction', () => {
 
     let memberTasks = await member.get('/tasks/user');
     let syncedTask = find(memberTasks, findAssignedTask);
+    const direction = 'up';
 
-    await expect(member.post(`/tasks/${syncedTask._id}/score/up`))
+    await expect(member.post(`/tasks/${syncedTask._id}/score/${direction}`))
       .to.eventually.be.rejected.and.to.eql({
         code: 401,
         error: 'NotAuthorized',
@@ -58,6 +59,7 @@ describe('POST /tasks/:id/score/:direction', () => {
       user: member.auth.local.username,
       taskName: updatedTask.text,
       taskId: updatedTask._id,
+      direction,
     }, 'cs')); // This test only works if we have the notification translated
     expect(user.notifications[1].data.groupId).to.equal(guild._id);
 
@@ -71,8 +73,9 @@ describe('POST /tasks/:id/score/:direction', () => {
     });
     let memberTasks = await member.get('/tasks/user');
     let syncedTask = find(memberTasks, findAssignedTask);
+    const direction = 'up';
 
-    await expect(member.post(`/tasks/${syncedTask._id}/score/up`))
+    await expect(member.post(`/tasks/${syncedTask._id}/score/${direction}`))
       .to.eventually.be.rejected.and.to.eql({
         code: 401,
         error: 'NotAuthorized',
@@ -88,6 +91,7 @@ describe('POST /tasks/:id/score/:direction', () => {
       user: member.auth.local.username,
       taskName: updatedTask.text,
       taskId: updatedTask._id,
+      direction,
     }));
     expect(user.notifications[1].data.groupId).to.equal(guild._id);
 
@@ -97,6 +101,7 @@ describe('POST /tasks/:id/score/:direction', () => {
       user: member.auth.local.username,
       taskName: updatedTask.text,
       taskId: updatedTask._id,
+      direction,
     }));
     expect(member2.notifications[0].data.groupId).to.equal(guild._id);
   });

test/api/v3/integration/user/GET-user.test.js

@@ -27,4 +27,13 @@ describe('GET /user', () => {
     expect(returnedUser.auth.local.salt).to.not.exist;
     expect(returnedUser.apiToken).to.not.exist;
   });
+
+  it('returns only user properties requested', async () => {
+    let returnedUser = await user.get('/user?userFields=achievements,items.mounts');
+
+    expect(returnedUser._id).to.equal(user._id);
+    expect(returnedUser.achievements).to.exist;
+    expect(returnedUser.items.mounts).to.exist;
+    expect(returnedUser.stats).to.not.exist;
+  });
 });

test/api/v3/integration/user/buy/POST-user_buy_gear.test.js

@@ -25,12 +25,32 @@ describe('POST /user/buy-gear/:key', () => {
       });
   });
 
-  it('buys a piece of gear', async () => {
+  it('buys the first level weapon gear', async () => {
+    let key = 'weapon_warrior_0';
+
+    await user.post(`/user/buy-gear/${key}`);
+    await user.sync();
+
+    expect(user.items.gear.owned[key]).to.eql(true);
+  });
+
+  it('buys the first level armor gear', async () => {
     let key = 'armor_warrior_1';
 
     await user.post(`/user/buy-gear/${key}`);
     await user.sync();
 
-    expect(user.items.gear.owned.armor_warrior_1).to.eql(true);
+    expect(user.items.gear.owned[key]).to.eql(true);
+  });
+
+  it('tries to buy subsequent, level gear', async () => {
+    let key = 'armor_warrior_2';
+
+    return expect(user.post(`/user/buy-gear/${key}`))
+      .to.eventually.be.rejected.and.eql({
+        code: 401,
+        error: 'NotAuthorized',
+        message: 'You need to purchase a lower level gear before this one.',
+      });
   });
 });

test/api/v3/unit/libs/amazonPayments.test.js

@@ -1,739 +0,0 @@
-import moment from 'moment';
-import cc from 'coupon-code';
-import uuid from 'uuid';
-
-import {
-  generateGroup,
-} from '../../../../helpers/api-unit.helper.js';
-import { model as User } from '../../../../../website/server/models/user';
-import { model as Group } from '../../../../../website/server/models/group';
-import { model as Coupon } from '../../../../../website/server/models/coupon';
-import amzLib from '../../../../../website/server/libs/amazonPayments';
-import payments from '../../../../../website/server/libs/payments';
-import common from '../../../../../website/common';
-
-const i18n = common.i18n;
-
-describe('Amazon Payments', () => {
-  let subKey = 'basic_3mo';
-
-  describe('checkout', () => {
-    let user, orderReferenceId, headers;
-    let setOrderReferenceDetailsSpy;
-    let confirmOrderReferenceSpy;
-    let authorizeSpy;
-    let closeOrderReferenceSpy;
-
-    let paymentBuyGemsStub;
-    let paymentCreateSubscritionStub;
-    let amount = 5;
-
-    function expectAmazonStubs () {
-      expect(setOrderReferenceDetailsSpy).to.be.calledOnce;
-      expect(setOrderReferenceDetailsSpy).to.be.calledWith({
-        AmazonOrderReferenceId: orderReferenceId,
-        OrderReferenceAttributes: {
-          OrderTotal: {
-            CurrencyCode: amzLib.constants.CURRENCY_CODE,
-            Amount: amount,
-          },
-          SellerNote: amzLib.constants.SELLER_NOTE,
-          SellerOrderAttributes: {
-            SellerOrderId: common.uuid(),
-            StoreName: amzLib.constants.STORE_NAME,
-          },
-        },
-      });
-
-      expect(confirmOrderReferenceSpy).to.be.calledOnce;
-      expect(confirmOrderReferenceSpy).to.be.calledWith({ AmazonOrderReferenceId: orderReferenceId });
-
-      expect(authorizeSpy).to.be.calledOnce;
-      expect(authorizeSpy).to.be.calledWith({
-        AmazonOrderReferenceId: orderReferenceId,
-        AuthorizationReferenceId: common.uuid().substring(0, 32),
-        AuthorizationAmount: {
-          CurrencyCode: amzLib.constants.CURRENCY_CODE,
-          Amount: amount,
-        },
-        SellerAuthorizationNote: amzLib.constants.SELLER_NOTE,
-        TransactionTimeout: 0,
-        CaptureNow: true,
-      });
-
-      expect(closeOrderReferenceSpy).to.be.calledOnce;
-      expect(closeOrderReferenceSpy).to.be.calledWith({ AmazonOrderReferenceId: orderReferenceId });
-    }
-
-    beforeEach(function () {
-      user = new User();
-      headers = {};
-      orderReferenceId = 'orderReferenceId';
-
-      setOrderReferenceDetailsSpy = sinon.stub(amzLib, 'setOrderReferenceDetails');
-      setOrderReferenceDetailsSpy.returnsPromise().resolves({});
-
-      confirmOrderReferenceSpy = sinon.stub(amzLib, 'confirmOrderReference');
-      confirmOrderReferenceSpy.returnsPromise().resolves({});
-
-      authorizeSpy = sinon.stub(amzLib, 'authorize');
-      authorizeSpy.returnsPromise().resolves({});
-
-      closeOrderReferenceSpy = sinon.stub(amzLib, 'closeOrderReference');
-      closeOrderReferenceSpy.returnsPromise().resolves({});
-
-      paymentBuyGemsStub = sinon.stub(payments, 'buyGems');
-      paymentBuyGemsStub.returnsPromise().resolves({});
-
-      paymentCreateSubscritionStub = sinon.stub(payments, 'createSubscription');
-      paymentCreateSubscritionStub.returnsPromise().resolves({});
-
-      sinon.stub(common, 'uuid').returns('uuid-generated');
-    });
-
-    afterEach(function () {
-      amzLib.setOrderReferenceDetails.restore();
-      amzLib.confirmOrderReference.restore();
-      amzLib.authorize.restore();
-      amzLib.closeOrderReference.restore();
-      payments.buyGems.restore();
-      payments.createSubscription.restore();
-      common.uuid.restore();
-    });
-
-    it('should purchase gems', async () => {
-      sinon.stub(user, 'canGetGems').returnsPromise().resolves(true);
-      await amzLib.checkout({user, orderReferenceId, headers});
-
-      expect(paymentBuyGemsStub).to.be.calledOnce;
-      expect(paymentBuyGemsStub).to.be.calledWith({
-        user,
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        headers,
-      });
-      expectAmazonStubs();
-      expect(user.canGetGems).to.be.calledOnce;
-      user.canGetGems.restore();
-    });
-
-    it('should error if gem amount is too low', async () => {
-      let receivingUser = new User();
-      receivingUser.save();
-      let gift = {
-        type: 'gems',
-        gems: {
-          amount: 0,
-          uuid: receivingUser._id,
-        },
-      };
-
-      await expect(amzLib.checkout({gift, user, orderReferenceId, headers}))
-      .to.eventually.be.rejected.and.to.eql({
-        httpCode: 400,
-        message: 'Amount must be at least 1.',
-        name: 'BadRequest',
-      });
-    });
-
-    it('should error if user cannot get gems gems', async () => {
-      sinon.stub(user, 'canGetGems').returnsPromise().resolves(false);
-      await expect(amzLib.checkout({user, orderReferenceId, headers})).to.eventually.be.rejected.and.to.eql({
-        httpCode: 401,
-        message: i18n.t('groupPolicyCannotGetGems'),
-        name: 'NotAuthorized',
-      });
-      user.canGetGems.restore();
-    });
-
-    it('should gift gems', async () => {
-      let receivingUser = new User();
-      await receivingUser.save();
-      let gift = {
-        type: 'gems',
-        uuid: receivingUser._id,
-        gems: {
-          amount: 16,
-        },
-      };
-      amount = 16 / 4;
-      await amzLib.checkout({gift, user, orderReferenceId, headers});
-
-      expect(paymentBuyGemsStub).to.be.calledOnce;
-      expect(paymentBuyGemsStub).to.be.calledWith({
-        user,
-        paymentMethod: amzLib.constants.PAYMENT_METHOD_GIFT,
-        headers,
-        gift,
-      });
-      expectAmazonStubs();
-    });
-
-    it('should gift a subscription', async () => {
-      let receivingUser = new User();
-      receivingUser.save();
-      let gift = {
-        type: 'subscription',
-        subscription: {
-          key: subKey,
-          uuid: receivingUser._id,
-        },
-      };
-      amount = common.content.subscriptionBlocks[subKey].price;
-
-      await amzLib.checkout({user, orderReferenceId, headers, gift});
-
-      gift.member = receivingUser;
-      expect(paymentCreateSubscritionStub).to.be.calledOnce;
-      expect(paymentCreateSubscritionStub).to.be.calledWith({
-        user,
-        paymentMethod: amzLib.constants.PAYMENT_METHOD_GIFT,
-        headers,
-        gift,
-      });
-      expectAmazonStubs();
-    });
-  });
-
-  describe('subscribe', () => {
-    let user, group, amount, billingAgreementId, sub, coupon, groupId, headers;
-    let amazonSetBillingAgreementDetailsSpy;
-    let amazonConfirmBillingAgreementSpy;
-    let amazongAuthorizeOnBillingAgreementSpy;
-    let createSubSpy;
-
-    beforeEach(async () => {
-      user = new User();
-      user.profile.name = 'sender';
-      user.purchased.plan.customerId = 'customer-id';
-      user.purchased.plan.planId = subKey;
-      user.purchased.plan.lastBillingDate = new Date();
-
-      group = generateGroup({
-        name: 'test group',
-        type: 'guild',
-        privacy: 'public',
-        leader: user._id,
-      });
-      group.purchased.plan.customerId = 'customer-id';
-      group.purchased.plan.planId = subKey;
-      await group.save();
-
-      amount = common.content.subscriptionBlocks[subKey].price;
-      billingAgreementId = 'billingAgreementId';
-      sub = {
-        key: subKey,
-        price: amount,
-      };
-      groupId = group._id;
-      headers = {};
-
-      amazonSetBillingAgreementDetailsSpy = sinon.stub(amzLib, 'setBillingAgreementDetails');
-      amazonSetBillingAgreementDetailsSpy.returnsPromise().resolves({});
-
-      amazonConfirmBillingAgreementSpy = sinon.stub(amzLib, 'confirmBillingAgreement');
-      amazonConfirmBillingAgreementSpy.returnsPromise().resolves({});
-
-      amazongAuthorizeOnBillingAgreementSpy = sinon.stub(amzLib, 'authorizeOnBillingAgreement');
-      amazongAuthorizeOnBillingAgreementSpy.returnsPromise().resolves({});
-
-      createSubSpy = sinon.stub(payments, 'createSubscription');
-      createSubSpy.returnsPromise().resolves({});
-
-      sinon.stub(common, 'uuid').returns('uuid-generated');
-    });
-
-    afterEach(function () {
-      amzLib.setBillingAgreementDetails.restore();
-      amzLib.confirmBillingAgreement.restore();
-      amzLib.authorizeOnBillingAgreement.restore();
-      payments.createSubscription.restore();
-      common.uuid.restore();
-    });
-
-    it('should throw an error if we are missing a subscription', async () => {
-      await expect(amzLib.subscribe({
-        billingAgreementId,
-        coupon,
-        user,
-        groupId,
-        headers,
-      }))
-      .to.eventually.be.rejected.and.to.eql({
-        httpCode: 400,
-        name: 'BadRequest',
-        message: i18n.t('missingSubscriptionCode'),
-      });
-    });
-
-    it('should throw an error if we are missing a billingAgreementId', async () => {
-      await expect(amzLib.subscribe({
-        sub,
-        coupon,
-        user,
-        groupId,
-        headers,
-      }))
-      .to.eventually.be.rejected.and.to.eql({
-        httpCode: 400,
-        name: 'BadRequest',
-        message: 'Missing req.body.billingAgreementId',
-      });
-    });
-
-    it('should throw an error when coupon code is missing', async () => {
-      sub.discount = 40;
-
-      await expect(amzLib.subscribe({
-        billingAgreementId,
-        sub,
-        coupon,
-        user,
-        groupId,
-        headers,
-      }))
-      .to.eventually.be.rejected.and.to.eql({
-        httpCode: 400,
-        name: 'BadRequest',
-        message: i18n.t('couponCodeRequired'),
-      });
-    });
-
-    it('should throw an error when coupon code is invalid', async () => {
-      sub.discount = 40;
-      sub.key = 'google_6mo';
-      coupon = 'example-coupon';
-
-      let couponModel = new Coupon();
-      couponModel.event = 'google_6mo';
-      await couponModel.save();
-
-      sinon.stub(cc, 'validate').returns('invalid');
-
-      await expect(amzLib.subscribe({
-        billingAgreementId,
-        sub,
-        coupon,
-        user,
-        groupId,
-        headers,
-      }))
-      .to.eventually.be.rejected.and.to.eql({
-        httpCode: 401,
-        name: 'NotAuthorized',
-        message: i18n.t('invalidCoupon'),
-      });
-      cc.validate.restore();
-    });
-
-    it('subscribes with amazon with a coupon', async () => {
-      sub.discount = 40;
-      sub.key = 'google_6mo';
-      coupon = 'example-coupon';
-
-      let couponModel = new Coupon();
-      couponModel.event = 'google_6mo';
-      let updatedCouponModel = await couponModel.save();
-
-      sinon.stub(cc, 'validate').returns(updatedCouponModel._id);
-
-      await amzLib.subscribe({
-        billingAgreementId,
-        sub,
-        coupon,
-        user,
-        groupId,
-        headers,
-      });
-
-      expect(createSubSpy).to.be.calledOnce;
-      expect(createSubSpy).to.be.calledWith({
-        user,
-        customerId: billingAgreementId,
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        sub,
-        headers,
-        groupId,
-      });
-
-      cc.validate.restore();
-    });
-
-    it('subscribes with amazon', async () => {
-      await amzLib.subscribe({
-        billingAgreementId,
-        sub,
-        coupon,
-        user,
-        groupId,
-        headers,
-      });
-
-      expect(amazonSetBillingAgreementDetailsSpy).to.be.calledOnce;
-      expect(amazonSetBillingAgreementDetailsSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-        BillingAgreementAttributes: {
-          SellerNote: amzLib.constants.SELLER_NOTE_SUBSCRIPTION,
-          SellerBillingAgreementAttributes: {
-            SellerBillingAgreementId: common.uuid(),
-            StoreName: amzLib.constants.STORE_NAME,
-            CustomInformation: amzLib.constants.SELLER_NOTE_SUBSCRIPTION,
-          },
-        },
-      });
-
-      expect(amazonConfirmBillingAgreementSpy).to.be.calledOnce;
-      expect(amazonConfirmBillingAgreementSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-      });
-
-      expect(amazongAuthorizeOnBillingAgreementSpy).to.be.calledOnce;
-      expect(amazongAuthorizeOnBillingAgreementSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-        AuthorizationReferenceId: common.uuid().substring(0, 32),
-        AuthorizationAmount: {
-          CurrencyCode: amzLib.constants.CURRENCY_CODE,
-          Amount: amount,
-        },
-        SellerAuthorizationNote: amzLib.constants.SELLER_NOTE_ATHORIZATION_SUBSCRIPTION,
-        TransactionTimeout: 0,
-        CaptureNow: true,
-        SellerNote: amzLib.constants.SELLER_NOTE_ATHORIZATION_SUBSCRIPTION,
-        SellerOrderAttributes: {
-          SellerOrderId: common.uuid(),
-          StoreName: amzLib.constants.STORE_NAME,
-        },
-      });
-
-      expect(createSubSpy).to.be.calledOnce;
-      expect(createSubSpy).to.be.calledWith({
-        user,
-        customerId: billingAgreementId,
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        sub,
-        headers,
-        groupId,
-      });
-    });
-
-    it('subscribes with amazon with price to existing users', async () => {
-      user = new User();
-      user.guilds.push(groupId);
-      await user.save();
-      group.memberCount = 2;
-      await group.save();
-      sub.key = 'group_monthly';
-      sub.price = 9;
-      amount = 12;
-
-      await amzLib.subscribe({
-        billingAgreementId,
-        sub,
-        coupon,
-        user,
-        groupId,
-        headers,
-      });
-
-      expect(amazonSetBillingAgreementDetailsSpy).to.be.calledOnce;
-      expect(amazonSetBillingAgreementDetailsSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-        BillingAgreementAttributes: {
-          SellerNote: amzLib.constants.SELLER_NOTE_SUBSCRIPTION,
-          SellerBillingAgreementAttributes: {
-            SellerBillingAgreementId: common.uuid(),
-            StoreName: amzLib.constants.STORE_NAME,
-            CustomInformation: amzLib.constants.SELLER_NOTE_SUBSCRIPTION,
-          },
-        },
-      });
-
-      expect(amazonConfirmBillingAgreementSpy).to.be.calledOnce;
-      expect(amazonConfirmBillingAgreementSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-      });
-
-      expect(amazongAuthorizeOnBillingAgreementSpy).to.be.calledOnce;
-      expect(amazongAuthorizeOnBillingAgreementSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-        AuthorizationReferenceId: common.uuid().substring(0, 32),
-        AuthorizationAmount: {
-          CurrencyCode: amzLib.constants.CURRENCY_CODE,
-          Amount: amount,
-        },
-        SellerAuthorizationNote: amzLib.constants.SELLER_NOTE_ATHORIZATION_SUBSCRIPTION,
-        TransactionTimeout: 0,
-        CaptureNow: true,
-        SellerNote: amzLib.constants.SELLER_NOTE_ATHORIZATION_SUBSCRIPTION,
-        SellerOrderAttributes: {
-          SellerOrderId: common.uuid(),
-          StoreName: amzLib.constants.STORE_NAME,
-        },
-      });
-
-      expect(createSubSpy).to.be.calledOnce;
-      expect(createSubSpy).to.be.calledWith({
-        user,
-        customerId: billingAgreementId,
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        sub,
-        headers,
-        groupId,
-      });
-    });
-  });
-
-  describe('cancelSubscription', () => {
-    let user, group, headers, billingAgreementId, subscriptionBlock, subscriptionLength;
-    let getBillingAgreementDetailsSpy;
-    let paymentCancelSubscriptionSpy;
-
-    function expectAmazonStubs () {
-      expect(getBillingAgreementDetailsSpy).to.be.calledOnce;
-      expect(getBillingAgreementDetailsSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-      });
-    }
-
-    beforeEach(async () => {
-      user = new User();
-      user.profile.name = 'sender';
-      user.purchased.plan.customerId = 'customer-id';
-      user.purchased.plan.planId = subKey;
-      user.purchased.plan.lastBillingDate = new Date();
-
-      group = generateGroup({
-        name: 'test group',
-        type: 'guild',
-        privacy: 'public',
-        leader: user._id,
-      });
-      group.purchased.plan.customerId = 'customer-id';
-      group.purchased.plan.planId = subKey;
-      group.purchased.plan.lastBillingDate = new Date();
-      await group.save();
-
-      subscriptionBlock = common.content.subscriptionBlocks[subKey];
-      subscriptionLength = subscriptionBlock.months * 30;
-
-      headers = {};
-
-      getBillingAgreementDetailsSpy = sinon.stub(amzLib, 'getBillingAgreementDetails');
-      getBillingAgreementDetailsSpy.returnsPromise().resolves({
-        BillingAgreementDetails: {
-          BillingAgreementStatus: {State: 'Closed'},
-        },
-      });
-
-      paymentCancelSubscriptionSpy = sinon.stub(payments, 'cancelSubscription');
-      paymentCancelSubscriptionSpy.returnsPromise().resolves({});
-    });
-
-    afterEach(function () {
-      amzLib.getBillingAgreementDetails.restore();
-      payments.cancelSubscription.restore();
-    });
-
-    it('should throw an error if we are missing a subscription', async () => {
-      user.purchased.plan.customerId = undefined;
-
-      await expect(amzLib.cancelSubscription({user}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 401,
-          name: 'NotAuthorized',
-          message: i18n.t('missingSubscription'),
-        });
-    });
-
-    it('should cancel a user subscription', async () => {
-      billingAgreementId = user.purchased.plan.customerId;
-
-      await amzLib.cancelSubscription({user, headers});
-
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({
-        user,
-        groupId: undefined,
-        nextBill: moment(user.purchased.plan.lastBillingDate).add({ days: subscriptionLength }),
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        headers,
-        cancellationReason: undefined,
-      });
-      expectAmazonStubs();
-    });
-
-    it('should close a user subscription if amazon not closed', async () => {
-      amzLib.getBillingAgreementDetails.restore();
-      getBillingAgreementDetailsSpy = sinon.stub(amzLib, 'getBillingAgreementDetails')
-        .returnsPromise()
-        .resolves({
-          BillingAgreementDetails: {
-            BillingAgreementStatus: {State: 'Open'},
-          },
-        });
-      let closeBillingAgreementSpy = sinon.stub(amzLib, 'closeBillingAgreement').returnsPromise().resolves({});
-      billingAgreementId = user.purchased.plan.customerId;
-
-      await amzLib.cancelSubscription({user, headers});
-
-      expectAmazonStubs();
-      expect(closeBillingAgreementSpy).to.be.calledOnce;
-      expect(closeBillingAgreementSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-      });
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({
-        user,
-        groupId: undefined,
-        nextBill: moment(user.purchased.plan.lastBillingDate).add({ days: subscriptionLength }),
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        headers,
-        cancellationReason: undefined,
-      });
-      amzLib.closeBillingAgreement.restore();
-    });
-
-    it('should throw an error if group is not found', async () => {
-      await expect(amzLib.cancelSubscription({user, groupId: 'fake-id'}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 404,
-          name: 'NotFound',
-          message: i18n.t('groupNotFound'),
-        });
-    });
-
-    it('should throw an error if user is not group leader', async () => {
-      let nonLeader = new User();
-      nonLeader.guilds.push(group._id);
-      await nonLeader.save();
-
-      await expect(amzLib.cancelSubscription({user: nonLeader, groupId: group._id}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 401,
-          name: 'NotAuthorized',
-          message: i18n.t('onlyGroupLeaderCanManageSubscription'),
-        });
-    });
-
-    it('should cancel a group subscription', async () => {
-      billingAgreementId = group.purchased.plan.customerId;
-
-      await amzLib.cancelSubscription({user, groupId: group._id, headers});
-
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({
-        user,
-        groupId: group._id,
-        nextBill: moment(group.purchased.plan.lastBillingDate).add({ days: subscriptionLength }),
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        headers,
-        cancellationReason: undefined,
-      });
-      expectAmazonStubs();
-    });
-
-    it('should close a group subscription if amazon not closed', async () => {
-      amzLib.getBillingAgreementDetails.restore();
-      getBillingAgreementDetailsSpy = sinon.stub(amzLib, 'getBillingAgreementDetails')
-        .returnsPromise()
-        .resolves({
-          BillingAgreementDetails: {
-            BillingAgreementStatus: {State: 'Open'},
-          },
-        });
-      let closeBillingAgreementSpy = sinon.stub(amzLib, 'closeBillingAgreement').returnsPromise().resolves({});
-      billingAgreementId = group.purchased.plan.customerId;
-
-      await amzLib.cancelSubscription({user, groupId: group._id, headers});
-
-      expectAmazonStubs();
-      expect(closeBillingAgreementSpy).to.be.calledOnce;
-      expect(closeBillingAgreementSpy).to.be.calledWith({
-        AmazonBillingAgreementId: billingAgreementId,
-      });
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({
-        user,
-        groupId: group._id,
-        nextBill: moment(group.purchased.plan.lastBillingDate).add({ days: subscriptionLength }),
-        paymentMethod: amzLib.constants.PAYMENT_METHOD,
-        headers,
-        cancellationReason: undefined,
-      });
-      amzLib.closeBillingAgreement.restore();
-    });
-  });
-
-  describe('#upgradeGroupPlan', () => {
-    let spy, data, user, group, uuidString;
-
-    beforeEach(async function () {
-      user = new User();
-      user.profile.name = 'sender';
-
-      data = {
-        user,
-        sub: {
-          key: 'basic_3mo', // @TODO: Validate that this is group
-        },
-        customerId: 'customer-id',
-        paymentMethod: 'Payment Method',
-        headers: {
-          'x-client': 'habitica-web',
-          'user-agent': '',
-        },
-      };
-
-      group = generateGroup({
-        name: 'test group',
-        type: 'guild',
-        privacy: 'public',
-        leader: user._id,
-      });
-      await group.save();
-
-      spy = sinon.stub(amzLib, 'authorizeOnBillingAgreement');
-      spy.returnsPromise().resolves([]);
-
-      uuidString = 'uuid-v4';
-      sinon.stub(uuid, 'v4').returns(uuidString);
-
-      data.groupId = group._id;
-      data.sub.quantity = 3;
-    });
-
-    afterEach(function () {
-      sinon.restore(amzLib.authorizeOnBillingAgreement);
-      uuid.v4.restore();
-    });
-
-    it('charges for a new member', async () => {
-      data.paymentMethod = amzLib.constants.PAYMENT_METHOD;
-      await payments.createSubscription(data);
-
-      let updatedGroup = await Group.findById(group._id).exec();
-
-      updatedGroup.memberCount += 1;
-      await updatedGroup.save();
-
-      await amzLib.chargeForAdditionalGroupMember(updatedGroup);
-
-      expect(spy.calledOnce).to.be.true;
-      expect(spy).to.be.calledWith({
-        AmazonBillingAgreementId: updatedGroup.purchased.plan.customerId,
-        AuthorizationReferenceId: uuidString.substring(0, 32),
-        AuthorizationAmount: {
-          CurrencyCode: amzLib.constants.CURRENCY_CODE,
-          Amount: 3,
-        },
-        SellerAuthorizationNote: amzLib.constants.SELLER_NOTE_GROUP_NEW_MEMBER,
-        TransactionTimeout: 0,
-        CaptureNow: true,
-        SellerNote: amzLib.constants.SELLER_NOTE_GROUP_NEW_MEMBER,
-        SellerOrderAttributes: {
-          SellerOrderId: uuidString,
-          StoreName: amzLib.constants.STORE_NAME,
-        },
-      });
-    });
-  });
-});

test/api/v3/unit/libs/payments/amazon/cancel.test.js

@@ -0,0 +1,180 @@
+import moment from 'moment';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import amzLib from '../../../../../../../website/server/libs/amazonPayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+import { createNonLeaderGroupMember } from '../paymentHelpers';
+
+const i18n = common.i18n;
+
+describe('Amazon Payments - Cancel Subscription', () => {
+  const subKey = 'basic_3mo';
+
+  let user, group, headers, billingAgreementId, subscriptionBlock, subscriptionLength;
+  let getBillingAgreementDetailsSpy;
+  let paymentCancelSubscriptionSpy;
+
+  function expectAmazonStubs () {
+    expect(getBillingAgreementDetailsSpy).to.be.calledOnce;
+    expect(getBillingAgreementDetailsSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+    });
+  }
+
+  function expectAmazonCancelSubscriptionSpy (groupId, lastBillingDate) {
+    expect(paymentCancelSubscriptionSpy).to.be.calledWith({
+      user,
+      groupId,
+      nextBill: moment(lastBillingDate).add({ days: subscriptionLength }),
+      paymentMethod: amzLib.constants.PAYMENT_METHOD,
+      headers,
+      cancellationReason: undefined,
+    });
+  }
+
+  function expectAmazonCancelUserSubscriptionSpy () {
+    expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
+    expectAmazonCancelSubscriptionSpy(undefined, user.purchased.plan.lastBillingDate);
+  }
+
+  function expectAmazonCancelGroupSubscriptionSpy (groupId) {
+    expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
+    expectAmazonCancelSubscriptionSpy(groupId, group.purchased.plan.lastBillingDate);
+  }
+
+  function expectBillingAggreementDetailSpy () {
+    getBillingAgreementDetailsSpy = sinon.stub(amzLib, 'getBillingAgreementDetails')
+      .returnsPromise()
+      .resolves({
+        BillingAgreementDetails: {
+          BillingAgreementStatus: {State: 'Open'},
+        },
+      });
+  }
+
+  beforeEach(async () => {
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = 'customer-id';
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = 'customer-id';
+    group.purchased.plan.planId = subKey;
+    group.purchased.plan.lastBillingDate = new Date();
+    await group.save();
+
+    subscriptionBlock = common.content.subscriptionBlocks[subKey];
+    subscriptionLength = subscriptionBlock.months * 30;
+
+    headers = {};
+
+    getBillingAgreementDetailsSpy = sinon.stub(amzLib, 'getBillingAgreementDetails');
+    getBillingAgreementDetailsSpy.returnsPromise().resolves({
+      BillingAgreementDetails: {
+        BillingAgreementStatus: {State: 'Closed'},
+      },
+    });
+
+    paymentCancelSubscriptionSpy = sinon.stub(payments, 'cancelSubscription');
+    paymentCancelSubscriptionSpy.returnsPromise().resolves({});
+  });
+
+  afterEach(function () {
+    amzLib.getBillingAgreementDetails.restore();
+    payments.cancelSubscription.restore();
+  });
+
+  it('should throw an error if we are missing a subscription', async () => {
+    user.purchased.plan.customerId = undefined;
+
+    await expect(amzLib.cancelSubscription({user}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 401,
+        name: 'NotAuthorized',
+        message: i18n.t('missingSubscription'),
+      });
+  });
+
+  it('should cancel a user subscription', async () => {
+    billingAgreementId = user.purchased.plan.customerId;
+
+    await amzLib.cancelSubscription({user, headers});
+
+    expectAmazonCancelUserSubscriptionSpy();
+    expectAmazonStubs();
+  });
+
+  it('should close a user subscription if amazon not closed', async () => {
+    amzLib.getBillingAgreementDetails.restore();
+    expectBillingAggreementDetailSpy();
+    let closeBillingAgreementSpy = sinon.stub(amzLib, 'closeBillingAgreement').returnsPromise().resolves({});
+    billingAgreementId = user.purchased.plan.customerId;
+
+    await amzLib.cancelSubscription({user, headers});
+
+    expectAmazonStubs();
+    expect(closeBillingAgreementSpy).to.be.calledOnce;
+    expect(closeBillingAgreementSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+    });
+    expectAmazonCancelUserSubscriptionSpy();
+    amzLib.closeBillingAgreement.restore();
+  });
+
+  it('should throw an error if group is not found', async () => {
+    await expect(amzLib.cancelSubscription({user, groupId: 'fake-id'}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 404,
+        name: 'NotFound',
+        message: i18n.t('groupNotFound'),
+      });
+  });
+
+  it('should throw an error if user is not group leader', async () => {
+    let nonLeader = await createNonLeaderGroupMember(group);
+
+    await expect(amzLib.cancelSubscription({user: nonLeader, groupId: group._id}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 401,
+        name: 'NotAuthorized',
+        message: i18n.t('onlyGroupLeaderCanManageSubscription'),
+      });
+  });
+
+  it('should cancel a group subscription', async () => {
+    billingAgreementId = group.purchased.plan.customerId;
+
+    await amzLib.cancelSubscription({user, groupId: group._id, headers});
+
+    expectAmazonCancelGroupSubscriptionSpy(group._id);
+    expectAmazonStubs();
+  });
+
+  it('should close a group subscription if amazon not closed', async () => {
+    amzLib.getBillingAgreementDetails.restore();
+    expectBillingAggreementDetailSpy();
+    let closeBillingAgreementSpy = sinon.stub(amzLib, 'closeBillingAgreement').returnsPromise().resolves({});
+    billingAgreementId = group.purchased.plan.customerId;
+
+    await amzLib.cancelSubscription({user, groupId: group._id, headers});
+
+    expectAmazonStubs();
+    expect(closeBillingAgreementSpy).to.be.calledOnce;
+    expect(closeBillingAgreementSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+    });
+    expectAmazonCancelGroupSubscriptionSpy(group._id);
+    amzLib.closeBillingAgreement.restore();
+  });
+});

test/api/v3/unit/libs/payments/amazon/checkout.test.js

@@ -0,0 +1,193 @@
+import { model as User } from '../../../../../../../website/server/models/user';
+import amzLib from '../../../../../../../website/server/libs/amazonPayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('Amazon Payments - Checkout', () => {
+  const subKey = 'basic_3mo';
+  let user, orderReferenceId, headers;
+  let setOrderReferenceDetailsSpy;
+  let confirmOrderReferenceSpy;
+  let authorizeSpy;
+  let closeOrderReferenceSpy;
+
+  let paymentBuyGemsStub;
+  let paymentCreateSubscritionStub;
+  let amount = 5;
+
+  function expectOrderReferenceSpy () {
+    expect(setOrderReferenceDetailsSpy).to.be.calledOnce;
+    expect(setOrderReferenceDetailsSpy).to.be.calledWith({
+      AmazonOrderReferenceId: orderReferenceId,
+      OrderReferenceAttributes: {
+        OrderTotal: {
+          CurrencyCode: amzLib.constants.CURRENCY_CODE,
+          Amount: amount,
+        },
+        SellerNote: amzLib.constants.SELLER_NOTE,
+        SellerOrderAttributes: {
+          SellerOrderId: common.uuid(),
+          StoreName: amzLib.constants.STORE_NAME,
+        },
+      },
+    });
+  }
+
+  function expectAuthorizeSpy () {
+    expect(authorizeSpy).to.be.calledOnce;
+    expect(authorizeSpy).to.be.calledWith({
+      AmazonOrderReferenceId: orderReferenceId,
+      AuthorizationReferenceId: common.uuid().substring(0, 32),
+      AuthorizationAmount: {
+        CurrencyCode: amzLib.constants.CURRENCY_CODE,
+        Amount: amount,
+      },
+      SellerAuthorizationNote: amzLib.constants.SELLER_NOTE,
+      TransactionTimeout: 0,
+      CaptureNow: true,
+    });
+  }
+
+  function expectAmazonStubs () {
+    expectOrderReferenceSpy();
+
+    expect(confirmOrderReferenceSpy).to.be.calledOnce;
+    expect(confirmOrderReferenceSpy).to.be.calledWith({ AmazonOrderReferenceId: orderReferenceId });
+
+    expectAuthorizeSpy();
+
+    expect(closeOrderReferenceSpy).to.be.calledOnce;
+    expect(closeOrderReferenceSpy).to.be.calledWith({ AmazonOrderReferenceId: orderReferenceId });
+  }
+
+  beforeEach(function () {
+    user = new User();
+    headers = {};
+    orderReferenceId = 'orderReferenceId';
+
+    setOrderReferenceDetailsSpy = sinon.stub(amzLib, 'setOrderReferenceDetails');
+    setOrderReferenceDetailsSpy.returnsPromise().resolves({});
+
+    confirmOrderReferenceSpy = sinon.stub(amzLib, 'confirmOrderReference');
+    confirmOrderReferenceSpy.returnsPromise().resolves({});
+
+    authorizeSpy = sinon.stub(amzLib, 'authorize');
+    authorizeSpy.returnsPromise().resolves({});
+
+    closeOrderReferenceSpy = sinon.stub(amzLib, 'closeOrderReference');
+    closeOrderReferenceSpy.returnsPromise().resolves({});
+
+    paymentBuyGemsStub = sinon.stub(payments, 'buyGems');
+    paymentBuyGemsStub.returnsPromise().resolves({});
+
+    paymentCreateSubscritionStub = sinon.stub(payments, 'createSubscription');
+    paymentCreateSubscritionStub.returnsPromise().resolves({});
+
+    sinon.stub(common, 'uuid').returns('uuid-generated');
+  });
+
+  afterEach(function () {
+    amzLib.setOrderReferenceDetails.restore();
+    amzLib.confirmOrderReference.restore();
+    amzLib.authorize.restore();
+    amzLib.closeOrderReference.restore();
+    payments.buyGems.restore();
+    payments.createSubscription.restore();
+    common.uuid.restore();
+  });
+
+  function expectBuyGemsStub (paymentMethod, gift) {
+    expect(paymentBuyGemsStub).to.be.calledOnce;
+
+    let expectedArgs = {
+      user,
+      paymentMethod,
+      headers,
+    };
+    if (gift) expectedArgs.gift = gift;
+    expect(paymentBuyGemsStub).to.be.calledWith(expectedArgs);
+  }
+
+  it('should purchase gems', async () => {
+    sinon.stub(user, 'canGetGems').returnsPromise().resolves(true);
+    await amzLib.checkout({user, orderReferenceId, headers});
+
+    expectBuyGemsStub(amzLib.constants.PAYMENT_METHOD);
+    expectAmazonStubs();
+    expect(user.canGetGems).to.be.calledOnce;
+    user.canGetGems.restore();
+  });
+
+  it('should error if gem amount is too low', async () => {
+    let receivingUser = new User();
+    receivingUser.save();
+    let gift = {
+      type: 'gems',
+      gems: {
+        amount: 0,
+        uuid: receivingUser._id,
+      },
+    };
+
+    await expect(amzLib.checkout({gift, user, orderReferenceId, headers}))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      message: 'Amount must be at least 1.',
+      name: 'BadRequest',
+    });
+  });
+
+  it('should error if user cannot get gems gems', async () => {
+    sinon.stub(user, 'canGetGems').returnsPromise().resolves(false);
+    await expect(amzLib.checkout({user, orderReferenceId, headers})).to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      message: i18n.t('groupPolicyCannotGetGems'),
+      name: 'NotAuthorized',
+    });
+    user.canGetGems.restore();
+  });
+
+  it('should gift gems', async () => {
+    let receivingUser = new User();
+    await receivingUser.save();
+    let gift = {
+      type: 'gems',
+      uuid: receivingUser._id,
+      gems: {
+        amount: 16,
+      },
+    };
+    amount = 16 / 4;
+    await amzLib.checkout({gift, user, orderReferenceId, headers});
+
+    expectBuyGemsStub(amzLib.constants.PAYMENT_METHOD_GIFT, gift);
+    expectAmazonStubs();
+  });
+
+  it('should gift a subscription', async () => {
+    let receivingUser = new User();
+    receivingUser.save();
+    let gift = {
+      type: 'subscription',
+      subscription: {
+        key: subKey,
+        uuid: receivingUser._id,
+      },
+    };
+    amount = common.content.subscriptionBlocks[subKey].price;
+
+    await amzLib.checkout({user, orderReferenceId, headers, gift});
+
+    gift.member = receivingUser;
+    expect(paymentCreateSubscritionStub).to.be.calledOnce;
+    expect(paymentCreateSubscritionStub).to.be.calledWith({
+      user,
+      paymentMethod: amzLib.constants.PAYMENT_METHOD_GIFT,
+      headers,
+      gift,
+    });
+    expectAmazonStubs();
+  });
+});

test/api/v3/unit/libs/payments/amazon/subscribe.test.js

@@ -0,0 +1,267 @@
+import cc from 'coupon-code';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import { model as Coupon } from '../../../../../../../website/server/models/coupon';
+import amzLib from '../../../../../../../website/server/libs/amazonPayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('Amazon Payments - Subscribe', () => {
+  const subKey = 'basic_3mo';
+  let user, group, amount, billingAgreementId, sub, coupon, groupId, headers;
+  let amazonSetBillingAgreementDetailsSpy;
+  let amazonConfirmBillingAgreementSpy;
+  let amazonAuthorizeOnBillingAgreementSpy;
+  let createSubSpy;
+
+  beforeEach(async () => {
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = 'customer-id';
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = 'customer-id';
+    group.purchased.plan.planId = subKey;
+    await group.save();
+
+    amount = common.content.subscriptionBlocks[subKey].price;
+    billingAgreementId = 'billingAgreementId';
+    sub = {
+      key: subKey,
+      price: amount,
+    };
+    groupId = group._id;
+    headers = {};
+
+    amazonSetBillingAgreementDetailsSpy = sinon.stub(amzLib, 'setBillingAgreementDetails');
+    amazonSetBillingAgreementDetailsSpy.returnsPromise().resolves({});
+
+    amazonConfirmBillingAgreementSpy = sinon.stub(amzLib, 'confirmBillingAgreement');
+    amazonConfirmBillingAgreementSpy.returnsPromise().resolves({});
+
+    amazonAuthorizeOnBillingAgreementSpy = sinon.stub(amzLib, 'authorizeOnBillingAgreement');
+    amazonAuthorizeOnBillingAgreementSpy.returnsPromise().resolves({});
+
+    createSubSpy = sinon.stub(payments, 'createSubscription');
+    createSubSpy.returnsPromise().resolves({});
+
+    sinon.stub(common, 'uuid').returns('uuid-generated');
+  });
+
+  afterEach(function () {
+    amzLib.setBillingAgreementDetails.restore();
+    amzLib.confirmBillingAgreement.restore();
+    amzLib.authorizeOnBillingAgreement.restore();
+    payments.createSubscription.restore();
+    common.uuid.restore();
+  });
+
+  function expectAmazonAuthorizeBillingAgreementSpy () {
+    expect(amazonAuthorizeOnBillingAgreementSpy).to.be.calledOnce;
+    expect(amazonAuthorizeOnBillingAgreementSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+      AuthorizationReferenceId: common.uuid().substring(0, 32),
+      AuthorizationAmount: {
+        CurrencyCode: amzLib.constants.CURRENCY_CODE,
+        Amount: amount,
+      },
+      SellerAuthorizationNote: amzLib.constants.SELLER_NOTE_ATHORIZATION_SUBSCRIPTION,
+      TransactionTimeout: 0,
+      CaptureNow: true,
+      SellerNote: amzLib.constants.SELLER_NOTE_ATHORIZATION_SUBSCRIPTION,
+      SellerOrderAttributes: {
+        SellerOrderId: common.uuid(),
+        StoreName: amzLib.constants.STORE_NAME,
+      },
+    });
+  }
+
+  function expectAmazonSetBillingAgreementDetailsSpy () {
+    expect(amazonSetBillingAgreementDetailsSpy).to.be.calledOnce;
+    expect(amazonSetBillingAgreementDetailsSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+      BillingAgreementAttributes: {
+        SellerNote: amzLib.constants.SELLER_NOTE_SUBSCRIPTION,
+        SellerBillingAgreementAttributes: {
+          SellerBillingAgreementId: common.uuid(),
+          StoreName: amzLib.constants.STORE_NAME,
+          CustomInformation: amzLib.constants.SELLER_NOTE_SUBSCRIPTION,
+        },
+      },
+    });
+  }
+
+  function expectCreateSpy () {
+    expect(createSubSpy).to.be.calledOnce;
+    expect(createSubSpy).to.be.calledWith({
+      user,
+      customerId: billingAgreementId,
+      paymentMethod: amzLib.constants.PAYMENT_METHOD,
+      sub,
+      headers,
+      groupId,
+    });
+  }
+
+  it('should throw an error if we are missing a subscription', async () => {
+    await expect(amzLib.subscribe({
+      billingAgreementId,
+      coupon,
+      user,
+      groupId,
+      headers,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: i18n.t('missingSubscriptionCode'),
+    });
+  });
+
+  it('should throw an error if we are missing a billingAgreementId', async () => {
+    await expect(amzLib.subscribe({
+      sub,
+      coupon,
+      user,
+      groupId,
+      headers,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: 'Missing req.body.billingAgreementId',
+    });
+  });
+
+  it('should throw an error when coupon code is missing', async () => {
+    sub.discount = 40;
+
+    await expect(amzLib.subscribe({
+      billingAgreementId,
+      sub,
+      coupon,
+      user,
+      groupId,
+      headers,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: i18n.t('couponCodeRequired'),
+    });
+  });
+
+  it('should throw an error when coupon code is invalid', async () => {
+    sub.discount = 40;
+    sub.key = 'google_6mo';
+    coupon = 'example-coupon';
+
+    let couponModel = new Coupon();
+    couponModel.event = 'google_6mo';
+    await couponModel.save();
+
+    sinon.stub(cc, 'validate').returns('invalid');
+
+    await expect(amzLib.subscribe({
+      billingAgreementId,
+      sub,
+      coupon,
+      user,
+      groupId,
+      headers,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      name: 'NotAuthorized',
+      message: i18n.t('invalidCoupon'),
+    });
+    cc.validate.restore();
+  });
+
+  it('subscribes with amazon with a coupon', async () => {
+    sub.discount = 40;
+    sub.key = 'google_6mo';
+    coupon = 'example-coupon';
+
+    let couponModel = new Coupon();
+    couponModel.event = 'google_6mo';
+    let updatedCouponModel = await couponModel.save();
+
+    sinon.stub(cc, 'validate').returns(updatedCouponModel._id);
+
+    await amzLib.subscribe({
+      billingAgreementId,
+      sub,
+      coupon,
+      user,
+      groupId,
+      headers,
+    });
+
+    expectCreateSpy();
+
+    cc.validate.restore();
+  });
+
+  it('subscribes with amazon', async () => {
+    await amzLib.subscribe({
+      billingAgreementId,
+      sub,
+      coupon,
+      user,
+      groupId,
+      headers,
+    });
+
+    expectAmazonSetBillingAgreementDetailsSpy();
+
+    expect(amazonConfirmBillingAgreementSpy).to.be.calledOnce;
+    expect(amazonConfirmBillingAgreementSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+    });
+
+    expectAmazonAuthorizeBillingAgreementSpy();
+
+    expectCreateSpy();
+  });
+
+  it('subscribes with amazon with price to existing users', async () => {
+    user = new User();
+    user.guilds.push(groupId);
+    await user.save();
+    group.memberCount = 2;
+    await group.save();
+    sub.key = 'group_monthly';
+    sub.price = 9;
+    amount = 12;
+
+    await amzLib.subscribe({
+      billingAgreementId,
+      sub,
+      coupon,
+      user,
+      groupId,
+      headers,
+    });
+
+    expectAmazonSetBillingAgreementDetailsSpy();
+    expect(amazonConfirmBillingAgreementSpy).to.be.calledOnce;
+    expect(amazonConfirmBillingAgreementSpy).to.be.calledWith({
+      AmazonBillingAgreementId: billingAgreementId,
+    });
+    expectAmazonAuthorizeBillingAgreementSpy();
+    expectCreateSpy();
+  });
+});

test/api/v3/unit/libs/payments/amazon/upgrade-groupplan.test.js

@@ -0,0 +1,83 @@
+import uuid from 'uuid';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import { model as Group } from '../../../../../../../website/server/models/group';
+import amzLib from '../../../../../../../website/server/libs/amazonPayments';
+import payments from '../../../../../../../website/server/libs/payments';
+
+describe('#upgradeGroupPlan', () => {
+  let spy, data, user, group, uuidString;
+
+  beforeEach(async function () {
+    user = new User();
+    user.profile.name = 'sender';
+
+    data = {
+      user,
+      sub: {
+        key: 'basic_3mo', // @TODO: Validate that this is group
+      },
+      customerId: 'customer-id',
+      paymentMethod: 'Payment Method',
+      headers: {
+        'x-client': 'habitica-web',
+        'user-agent': '',
+      },
+    };
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    await group.save();
+
+    spy = sinon.stub(amzLib, 'authorizeOnBillingAgreement');
+    spy.returnsPromise().resolves([]);
+
+    uuidString = 'uuid-v4';
+    sinon.stub(uuid, 'v4').returns(uuidString);
+
+    data.groupId = group._id;
+    data.sub.quantity = 3;
+  });
+
+  afterEach(function () {
+    sinon.restore(amzLib.authorizeOnBillingAgreement);
+    uuid.v4.restore();
+  });
+
+  it('charges for a new member', async () => {
+    data.paymentMethod = amzLib.constants.PAYMENT_METHOD;
+    await payments.createSubscription(data);
+
+    let updatedGroup = await Group.findById(group._id).exec();
+
+    updatedGroup.memberCount += 1;
+    await updatedGroup.save();
+
+    await amzLib.chargeForAdditionalGroupMember(updatedGroup);
+
+    expect(spy.calledOnce).to.be.true;
+    expect(spy).to.be.calledWith({
+      AmazonBillingAgreementId: updatedGroup.purchased.plan.customerId,
+      AuthorizationReferenceId: uuidString.substring(0, 32),
+      AuthorizationAmount: {
+        CurrencyCode: amzLib.constants.CURRENCY_CODE,
+        Amount: 3,
+      },
+      SellerAuthorizationNote: amzLib.constants.SELLER_NOTE_GROUP_NEW_MEMBER,
+      TransactionTimeout: 0,
+      CaptureNow: true,
+      SellerNote: amzLib.constants.SELLER_NOTE_GROUP_NEW_MEMBER,
+      SellerOrderAttributes: {
+        SellerOrderId: uuidString,
+        StoreName: amzLib.constants.STORE_NAME,
+      },
+    });
+  });
+});

test/api/v3/unit/libs/payments/paymentHelpers.js

@@ -0,0 +1,7 @@
+import { model as User } from '../../../../../../website/server/models/user';
+
+export async function createNonLeaderGroupMember (group) {
+  let nonLeader = new User();
+  nonLeader.guilds.push(group._id);
+  return await nonLeader.save();
+}

test/api/v3/unit/libs/payments/paypal/checkout-success.test.js

@@ -0,0 +1,87 @@
+/* eslint-disable camelcase */
+import payments from '../../../../../../../website/server/libs/payments';
+import paypalPayments from '../../../../../../../website/server/libs/paypalPayments';
+import { model as User } from '../../../../../../../website/server/models/user';
+
+describe('checkout success', () => {
+  const subKey = 'basic_3mo';
+  let user, gift, customerId, paymentId;
+  let paypalPaymentExecuteStub, paymentBuyGemsStub, paymentsCreateSubscritionStub;
+
+  beforeEach(() => {
+    user = new User();
+    customerId = 'customerId-test';
+    paymentId = 'paymentId-test';
+
+    paypalPaymentExecuteStub = sinon.stub(paypalPayments, 'paypalPaymentExecute').returnsPromise().resolves({});
+    paymentBuyGemsStub = sinon.stub(payments, 'buyGems').returnsPromise().resolves({});
+    paymentsCreateSubscritionStub = sinon.stub(payments, 'createSubscription').returnsPromise().resolves({});
+  });
+
+  afterEach(() => {
+    paypalPayments.paypalPaymentExecute.restore();
+    payments.buyGems.restore();
+    payments.createSubscription.restore();
+  });
+
+  it('purchases gems', async () => {
+    await paypalPayments.checkoutSuccess({user, gift, paymentId, customerId});
+
+    expect(paypalPaymentExecuteStub).to.be.calledOnce;
+    expect(paypalPaymentExecuteStub).to.be.calledWith(paymentId, { payer_id: customerId });
+    expect(paymentBuyGemsStub).to.be.calledOnce;
+    expect(paymentBuyGemsStub).to.be.calledWith({
+      user,
+      customerId,
+      paymentMethod: 'Paypal',
+    });
+  });
+
+  it('gifts gems', async () => {
+    let receivingUser = new User();
+    await receivingUser.save();
+    gift = {
+      type: 'gems',
+      gems: {
+        amount: 16,
+        uuid: receivingUser._id,
+      },
+    };
+
+    await paypalPayments.checkoutSuccess({user, gift, paymentId, customerId});
+
+    expect(paypalPaymentExecuteStub).to.be.calledOnce;
+    expect(paypalPaymentExecuteStub).to.be.calledWith(paymentId, { payer_id: customerId });
+    expect(paymentBuyGemsStub).to.be.calledOnce;
+    expect(paymentBuyGemsStub).to.be.calledWith({
+      user,
+      customerId,
+      paymentMethod: 'PayPal (Gift)',
+      gift,
+    });
+  });
+
+  it('gifts subscription', async () => {
+    let receivingUser = new User();
+    await receivingUser.save();
+    gift = {
+      type: 'subscription',
+      subscription: {
+        key: subKey,
+        uuid: receivingUser._id,
+      },
+    };
+
+    await paypalPayments.checkoutSuccess({user, gift, paymentId, customerId});
+
+    expect(paypalPaymentExecuteStub).to.be.calledOnce;
+    expect(paypalPaymentExecuteStub).to.be.calledWith(paymentId, { payer_id: customerId });
+    expect(paymentsCreateSubscritionStub).to.be.calledOnce;
+    expect(paymentsCreateSubscritionStub).to.be.calledWith({
+      user,
+      customerId,
+      paymentMethod: 'PayPal (Gift)',
+      gift,
+    });
+  });
+});

test/api/v3/unit/libs/payments/paypal/checkout.test.js

@@ -0,0 +1,127 @@
+/* eslint-disable camelcase */
+import nconf from 'nconf';
+
+import paypalPayments from '../../../../../../../website/server/libs/paypalPayments';
+import { model as User } from '../../../../../../../website/server/models/user';
+import common from '../../../../../../../website/common';
+
+const BASE_URL = nconf.get('BASE_URL');
+const i18n = common.i18n;
+
+describe('checkout', () => {
+  const subKey = 'basic_3mo';
+  let paypalPaymentCreateStub;
+  let approvalHerf;
+
+  function getPaypalCreateOptions (description, amount) {
+    return {
+      intent: 'sale',
+      payer: { payment_method: 'Paypal' },
+      redirect_urls: {
+        return_url: `${BASE_URL}/paypal/checkout/success`,
+        cancel_url: `${BASE_URL}`,
+      },
+      transactions: [{
+        item_list: {
+          items: [{
+            name: description,
+            price: amount,
+            currency: 'USD',
+            quantity: 1,
+          }],
+        },
+        amount: {
+          currency: 'USD',
+          total: amount,
+        },
+        description,
+      }],
+    };
+  }
+
+  beforeEach(() => {
+    approvalHerf = 'approval_href';
+    paypalPaymentCreateStub = sinon.stub(paypalPayments, 'paypalPaymentCreate')
+      .returnsPromise().resolves({
+        links: [{ rel: 'approval_url', href: approvalHerf }],
+      });
+  });
+
+  afterEach(() => {
+    paypalPayments.paypalPaymentCreate.restore();
+  });
+
+  it('creates a link for gem purchases', async () => {
+    let link = await paypalPayments.checkout({user: new User()});
+
+    expect(paypalPaymentCreateStub).to.be.calledOnce;
+    expect(paypalPaymentCreateStub).to.be.calledWith(getPaypalCreateOptions('Habitica Gems', 5.00));
+    expect(link).to.eql(approvalHerf);
+  });
+
+  it('should error if gem amount is too low', async () => {
+    let receivingUser = new User();
+    receivingUser.save();
+    let gift = {
+      type: 'gems',
+      gems: {
+        amount: 0,
+        uuid: receivingUser._id,
+      },
+    };
+
+    await expect(paypalPayments.checkout({gift}))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      message: 'Amount must be at least 1.',
+      name: 'BadRequest',
+    });
+  });
+
+  it('should error if the user cannot get gems', async () => {
+    let user = new User();
+    sinon.stub(user, 'canGetGems').returnsPromise().resolves(false);
+
+    await expect(paypalPayments.checkout({user})).to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      message: i18n.t('groupPolicyCannotGetGems'),
+      name: 'NotAuthorized',
+    });
+  });
+
+  it('creates a link for gifting gems', async () => {
+    let receivingUser = new User();
+    await receivingUser.save();
+    let gift = {
+      type: 'gems',
+      uuid: receivingUser._id,
+      gems: {
+        amount: 16,
+      },
+    };
+
+    let link = await paypalPayments.checkout({gift});
+
+    expect(paypalPaymentCreateStub).to.be.calledOnce;
+    expect(paypalPaymentCreateStub).to.be.calledWith(getPaypalCreateOptions('Habitica Gems (Gift)', '4.00'));
+    expect(link).to.eql(approvalHerf);
+  });
+
+  it('creates a link for gifting a subscription', async () => {
+    let receivingUser = new User();
+    receivingUser.save();
+    let gift = {
+      type: 'subscription',
+      subscription: {
+        key: subKey,
+        uuid: receivingUser._id,
+      },
+    };
+
+    let link = await paypalPayments.checkout({gift});
+
+    expect(paypalPaymentCreateStub).to.be.calledOnce;
+    expect(paypalPaymentCreateStub).to.be.calledWith(getPaypalCreateOptions('mo. Habitica Subscription (Gift)', '15.00'));
+    expect(link).to.eql(approvalHerf);
+  });
+});

test/api/v3/unit/libs/payments/paypal/ipn.test.js

@@ -0,0 +1,66 @@
+/* eslint-disable camelcase */
+import payments from '../../../../../../../website/server/libs/payments';
+import paypalPayments from '../../../../../../../website/server/libs/paypalPayments';
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+
+describe('ipn', () => {
+  const subKey = 'basic_3mo';
+  let user, group, txn_type, userPaymentId, groupPaymentId;
+  let ipnVerifyAsyncStub, paymentCancelSubscriptionSpy;
+
+  beforeEach(async () => {
+    txn_type = 'recurring_payment_profile_cancel';
+    userPaymentId = 'userPaymentId-test';
+    groupPaymentId = 'groupPaymentId-test';
+
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = userPaymentId;
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+    await user.save();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = groupPaymentId;
+    group.purchased.plan.planId = subKey;
+    group.purchased.plan.lastBillingDate = new Date();
+    await group.save();
+
+    ipnVerifyAsyncStub = sinon.stub(paypalPayments, 'ipnVerifyAsync').returnsPromise().resolves({});
+    paymentCancelSubscriptionSpy = sinon.stub(payments, 'cancelSubscription').returnsPromise().resolves({});
+  });
+
+  afterEach(function () {
+    paypalPayments.ipnVerifyAsync.restore();
+    payments.cancelSubscription.restore();
+  });
+
+  it('should cancel a user subscription', async () => {
+    await paypalPayments.ipn({txn_type, recurring_payment_id: userPaymentId});
+
+    expect(ipnVerifyAsyncStub).to.be.calledOnce;
+    expect(ipnVerifyAsyncStub).to.be.calledWith({txn_type, recurring_payment_id: userPaymentId});
+
+    expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
+    expect(paymentCancelSubscriptionSpy.args[0][0].user._id).to.eql(user._id);
+    expect(paymentCancelSubscriptionSpy.args[0][0].paymentMethod).to.eql('Paypal');
+  });
+
+  it('should cancel a group subscription', async () => {
+    await paypalPayments.ipn({txn_type, recurring_payment_id: groupPaymentId});
+
+    expect(ipnVerifyAsyncStub).to.be.calledOnce;
+    expect(ipnVerifyAsyncStub).to.be.calledWith({txn_type, recurring_payment_id: groupPaymentId});
+
+    expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
+    expect(paymentCancelSubscriptionSpy).to.be.calledWith({ groupId: group._id, paymentMethod: 'Paypal' });
+  });
+});

test/api/v3/unit/libs/payments/paypal/subscribe-cancel.test.js

@@ -0,0 +1,124 @@
+/* eslint-disable camelcase */
+import payments from '../../../../../../../website/server/libs/payments';
+import paypalPayments from '../../../../../../../website/server/libs/paypalPayments';
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import common from '../../../../../../../website/common';
+import { createNonLeaderGroupMember } from '../paymentHelpers';
+
+const i18n = common.i18n;
+
+describe('subscribeCancel', () => {
+  const subKey = 'basic_3mo';
+  let user, group, groupId, customerId, groupCustomerId, nextBillingDate;
+  let paymentCancelSubscriptionSpy, paypalBillingAgreementCancelStub, paypalBillingAgreementGetStub;
+
+  beforeEach(async () => {
+    customerId = 'customer-id';
+    groupCustomerId = 'groupCustomerId-test';
+
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = customerId;
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = groupCustomerId;
+    group.purchased.plan.planId = subKey;
+    group.purchased.plan.lastBillingDate = new Date();
+    await group.save();
+
+    nextBillingDate = new Date();
+
+    paypalBillingAgreementCancelStub = sinon.stub(paypalPayments, 'paypalBillingAgreementCancel').returnsPromise().resolves({});
+    paypalBillingAgreementGetStub = sinon.stub(paypalPayments, 'paypalBillingAgreementGet')
+      .returnsPromise().resolves({
+        agreement_details: {
+          next_billing_date: nextBillingDate,
+          cycles_completed: 1,
+        },
+      });
+    paymentCancelSubscriptionSpy = sinon.stub(payments, 'cancelSubscription').returnsPromise().resolves({});
+  });
+
+  afterEach(function () {
+    paypalPayments.paypalBillingAgreementGet.restore();
+    paypalPayments.paypalBillingAgreementCancel.restore();
+    payments.cancelSubscription.restore();
+  });
+
+  it('should throw an error if we are missing a subscription', async () => {
+    user.purchased.plan.customerId = undefined;
+
+    await expect(paypalPayments.subscribeCancel({user}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 401,
+        name: 'NotAuthorized',
+        message: i18n.t('missingSubscription'),
+      });
+  });
+
+  it('should throw an error if group is not found', async () => {
+    await expect(paypalPayments.subscribeCancel({user, groupId: 'fake-id'}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 404,
+        name: 'NotFound',
+        message: i18n.t('groupNotFound'),
+      });
+  });
+
+  it('should throw an error if user is not group leader', async () => {
+    let nonLeader = await createNonLeaderGroupMember(group);
+
+    await expect(paypalPayments.subscribeCancel({user: nonLeader, groupId: group._id}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 401,
+        name: 'NotAuthorized',
+        message: i18n.t('onlyGroupLeaderCanManageSubscription'),
+      });
+  });
+
+  it('should cancel a user subscription', async () => {
+    await paypalPayments.subscribeCancel({user});
+
+    expect(paypalBillingAgreementGetStub).to.be.calledOnce;
+    expect(paypalBillingAgreementGetStub).to.be.calledWith(customerId);
+    expect(paypalBillingAgreementCancelStub).to.be.calledOnce;
+    expect(paypalBillingAgreementCancelStub).to.be.calledWith(customerId, { note: i18n.t('cancelingSubscription') });
+
+    expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
+    expect(paymentCancelSubscriptionSpy).to.be.calledWith({
+      user,
+      groupId,
+      paymentMethod: 'Paypal',
+      nextBill: nextBillingDate,
+      cancellationReason: undefined,
+    });
+  });
+
+  it('should cancel a group subscription', async () => {
+    await paypalPayments.subscribeCancel({user, groupId: group._id});
+
+    expect(paypalBillingAgreementGetStub).to.be.calledOnce;
+    expect(paypalBillingAgreementGetStub).to.be.calledWith(groupCustomerId);
+    expect(paypalBillingAgreementCancelStub).to.be.calledOnce;
+    expect(paypalBillingAgreementCancelStub).to.be.calledWith(groupCustomerId, { note: i18n.t('cancelingSubscription') });
+
+    expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
+    expect(paymentCancelSubscriptionSpy).to.be.calledWith({
+      user,
+      groupId: group._id,
+      paymentMethod: 'Paypal',
+      nextBill: nextBillingDate,
+      cancellationReason: undefined,
+    });
+  });
+});

test/api/v3/unit/libs/payments/paypal/subscribe-success.test.js

@@ -0,0 +1,77 @@
+/* eslint-disable camelcase */
+import payments from '../../../../../../../website/server/libs/payments';
+import paypalPayments from '../../../../../../../website/server/libs/paypalPayments';
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import common from '../../../../../../../website/common';
+
+describe('subscribeSuccess', () => {
+  const subKey = 'basic_3mo';
+  let user, group, block, groupId, token, headers, customerId;
+  let paypalBillingAgreementExecuteStub, paymentsCreateSubscritionStub;
+
+  beforeEach(async () => {
+    user = new User();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+
+    token = 'test-token';
+    headers = {};
+    block = common.content.subscriptionBlocks[subKey];
+    customerId = 'test-customerId';
+
+    paypalBillingAgreementExecuteStub = sinon.stub(paypalPayments, 'paypalBillingAgreementExecute')
+      .returnsPromise({}).resolves({
+        id: customerId,
+      });
+    paymentsCreateSubscritionStub = sinon.stub(payments, 'createSubscription').returnsPromise().resolves({});
+  });
+
+  afterEach(() => {
+    paypalPayments.paypalBillingAgreementExecute.restore();
+    payments.createSubscription.restore();
+  });
+
+  it('creates a user subscription', async () => {
+    await paypalPayments.subscribeSuccess({user, block, groupId, token, headers});
+
+    expect(paypalBillingAgreementExecuteStub).to.be.calledOnce;
+    expect(paypalBillingAgreementExecuteStub).to.be.calledWith(token, {});
+
+    expect(paymentsCreateSubscritionStub).to.be.calledOnce;
+    expect(paymentsCreateSubscritionStub).to.be.calledWith({
+      user,
+      groupId,
+      customerId,
+      paymentMethod: 'Paypal',
+      sub: block,
+      headers,
+    });
+  });
+
+  it('create a group subscription', async () => {
+    groupId = group._id;
+
+    await paypalPayments.subscribeSuccess({user, block, groupId, token, headers});
+
+    expect(paypalBillingAgreementExecuteStub).to.be.calledOnce;
+    expect(paypalBillingAgreementExecuteStub).to.be.calledWith(token, {});
+
+    expect(paymentsCreateSubscritionStub).to.be.calledOnce;
+    expect(paymentsCreateSubscritionStub).to.be.calledWith({
+      user,
+      groupId,
+      customerId,
+      paymentMethod: 'Paypal',
+      sub: block,
+      headers,
+    });
+  });
+});

test/api/v3/unit/libs/payments/paypal/subscribe.test.js

@@ -0,0 +1,112 @@
+/* eslint-disable camelcase */
+import moment from 'moment';
+import cc from 'coupon-code';
+
+import paypalPayments from '../../../../../../../website/server/libs/paypalPayments';
+import { model as Coupon } from '../../../../../../../website/server/models/coupon';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('subscribe', () => {
+  const subKey = 'basic_3mo';
+  let coupon, sub, approvalHerf;
+  let paypalBillingAgreementCreateStub;
+
+  beforeEach(() => {
+    approvalHerf = 'approvalHerf-test';
+    sub = Object.assign({}, common.content.subscriptionBlocks[subKey]);
+
+    paypalBillingAgreementCreateStub = sinon.stub(paypalPayments, 'paypalBillingAgreementCreate')
+      .returnsPromise().resolves({
+        links: [{ rel: 'approval_url', href: approvalHerf }],
+      });
+  });
+
+  afterEach(() => {
+    paypalPayments.paypalBillingAgreementCreate.restore();
+  });
+
+  it('should throw an error when coupon code is missing', async () => {
+    sub.discount = 40;
+
+    await expect(paypalPayments.subscribe({sub, coupon}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 400,
+        name: 'BadRequest',
+        message: i18n.t('couponCodeRequired'),
+      });
+  });
+
+  it('should throw an error when coupon code is invalid', async () => {
+    sub.discount = 40;
+    sub.key = 'google_6mo';
+    coupon = 'example-coupon';
+
+    let couponModel = new Coupon();
+    couponModel.event = 'google_6mo';
+    await couponModel.save();
+
+    sinon.stub(cc, 'validate').returns('invalid');
+
+    await expect(paypalPayments.subscribe({sub, coupon}))
+      .to.eventually.be.rejected.and.to.eql({
+        httpCode: 401,
+        name: 'NotAuthorized',
+        message: i18n.t('invalidCoupon'),
+      });
+    cc.validate.restore();
+  });
+
+  it('subscribes with amazon with a coupon', async () => {
+    sub.discount = 40;
+    sub.key = 'google_6mo';
+    coupon = 'example-coupon';
+
+    let couponModel = new Coupon();
+    couponModel.event = 'google_6mo';
+    let updatedCouponModel = await couponModel.save();
+
+    sinon.stub(cc, 'validate').returns(updatedCouponModel._id);
+
+    let link = await paypalPayments.subscribe({sub, coupon});
+
+    expect(link).to.eql(approvalHerf);
+    expect(paypalBillingAgreementCreateStub).to.be.calledOnce;
+    let billingPlanTitle = `Habitica Subscription ($${sub.price} every ${sub.months} months, recurring)`;
+    expect(paypalBillingAgreementCreateStub).to.be.calledWith({
+      name: billingPlanTitle,
+      description: billingPlanTitle,
+      start_date: moment().add({ minutes: 5 }).format(),
+      plan: {
+        id: sub.paypalKey,
+      },
+      payer: {
+        payment_method: 'Paypal',
+      },
+    });
+
+    cc.validate.restore();
+  });
+
+  it('creates a link for a subscription', async () => {
+    delete sub.discount;
+
+    let link = await paypalPayments.subscribe({sub, coupon});
+
+    expect(link).to.eql(approvalHerf);
+    expect(paypalBillingAgreementCreateStub).to.be.calledOnce;
+    let billingPlanTitle = `Habitica Subscription ($${sub.price} every ${sub.months} months, recurring)`;
+    expect(paypalBillingAgreementCreateStub).to.be.calledWith({
+      name: billingPlanTitle,
+      description: billingPlanTitle,
+      start_date: moment().add({ minutes: 5 }).format(),
+      plan: {
+        id: sub.paypalKey,
+      },
+      payer: {
+        payment_method: 'Paypal',
+      },
+    });
+  });
+});

test/api/v3/unit/libs/payments/stripe/cancel-subscription.test.js

@@ -0,0 +1,143 @@
+import stripeModule from 'stripe';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import stripePayments from '../../../../../../../website/server/libs/stripePayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('cancel subscription', () => {
+  const subKey = 'basic_3mo';
+  const stripe = stripeModule('test');
+  let user, groupId, group;
+
+  beforeEach(async () => {
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = 'customer-id';
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = 'customer-id';
+    group.purchased.plan.planId = subKey;
+    await group.save();
+
+    groupId = group._id;
+  });
+
+  it('throws an error if there is no customer id', async () => {
+    user.purchased.plan.customerId = undefined;
+
+    await expect(stripePayments.cancelSubscription({
+      user,
+      groupId: undefined,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      name: 'NotAuthorized',
+      message: i18n.t('missingSubscription'),
+    });
+  });
+
+  it('throws an error if the group is not found', async () => {
+    await expect(stripePayments.cancelSubscription({
+      user,
+      groupId: 'fake-group',
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 404,
+      name: 'NotFound',
+      message: i18n.t('groupNotFound'),
+    });
+  });
+
+  it('throws an error if user is not the group leader', async () => {
+    let nonLeader = new User();
+    nonLeader.guilds.push(groupId);
+    await nonLeader.save();
+
+    await expect(stripePayments.cancelSubscription({
+      user: nonLeader,
+      groupId,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      name: 'NotAuthorized',
+      message: i18n.t('onlyGroupLeaderCanManageSubscription'),
+    });
+  });
+
+  describe('success', () => {
+    let stripeDeleteCustomerStub, paymentsCancelSubStub, stripeRetrieveStub, subscriptionId, currentPeriodEndTimeStamp;
+
+    beforeEach(() => {
+      subscriptionId = 'subId';
+      stripeDeleteCustomerStub = sinon.stub(stripe.customers, 'del').returnsPromise().resolves({});
+      paymentsCancelSubStub = sinon.stub(payments, 'cancelSubscription').returnsPromise().resolves({});
+
+      currentPeriodEndTimeStamp = (new Date()).getTime();
+      stripeRetrieveStub = sinon.stub(stripe.customers, 'retrieve')
+        .returnsPromise().resolves({
+          subscriptions: {
+            data: [{id: subscriptionId, current_period_end: currentPeriodEndTimeStamp}], // eslint-disable-line camelcase
+          },
+        });
+    });
+
+    afterEach(() => {
+      stripe.customers.del.restore();
+      stripe.customers.retrieve.restore();
+      payments.cancelSubscription.restore();
+    });
+
+    it('cancels a user subscription', async () => {
+      await stripePayments.cancelSubscription({
+        user,
+        groupId: undefined,
+      }, stripe);
+
+      expect(stripeDeleteCustomerStub).to.be.calledOnce;
+      expect(stripeDeleteCustomerStub).to.be.calledWith(user.purchased.plan.customerId);
+      expect(stripeRetrieveStub).to.be.calledOnce;
+      expect(stripeRetrieveStub).to.be.calledWith(user.purchased.plan.customerId);
+      expect(paymentsCancelSubStub).to.be.calledOnce;
+      expect(paymentsCancelSubStub).to.be.calledWith({
+        user,
+        groupId: undefined,
+        nextBill: currentPeriodEndTimeStamp * 1000, // timestamp in seconds
+        paymentMethod: 'Stripe',
+        cancellationReason: undefined,
+      });
+    });
+
+    it('cancels a group subscription', async () => {
+      await stripePayments.cancelSubscription({
+        user,
+        groupId,
+      }, stripe);
+
+      expect(stripeDeleteCustomerStub).to.be.calledOnce;
+      expect(stripeDeleteCustomerStub).to.be.calledWith(group.purchased.plan.customerId);
+      expect(stripeRetrieveStub).to.be.calledOnce;
+      expect(stripeRetrieveStub).to.be.calledWith(user.purchased.plan.customerId);
+      expect(paymentsCancelSubStub).to.be.calledOnce;
+      expect(paymentsCancelSubStub).to.be.calledWith({
+        user,
+        groupId,
+        nextBill: currentPeriodEndTimeStamp * 1000, // timestamp in seconds
+        paymentMethod: 'Stripe',
+        cancellationReason: undefined,
+      });
+    });
+  });
+});

test/api/v3/unit/libs/payments/stripe/checkout-subscription.test.js

@@ -0,0 +1,307 @@
+import stripeModule from 'stripe';
+import cc from 'coupon-code';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import { model as Coupon } from '../../../../../../../website/server/models/coupon';
+import stripePayments from '../../../../../../../website/server/libs/stripePayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('checkout with subscription', () => {
+  const subKey = 'basic_3mo';
+  const stripe = stripeModule('test');
+  let user, group, data, gift, sub, groupId, email, headers, coupon, customerIdResponse, subscriptionId, token;
+  let spy;
+  let stripeCreateCustomerSpy;
+  let stripePaymentsCreateSubSpy;
+
+  beforeEach(async () => {
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = 'customer-id';
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = 'customer-id';
+    group.purchased.plan.planId = subKey;
+    await group.save();
+
+    sub = {
+      key: 'basic_3mo',
+    };
+
+    data = {
+      user,
+      sub,
+      customerId: 'customer-id',
+      paymentMethod: 'Payment Method',
+    };
+
+    email = 'example@example.com';
+    customerIdResponse = 'test-id';
+    subscriptionId = 'test-sub-id';
+    token = 'test-token';
+
+    spy = sinon.stub(stripe.subscriptions, 'update');
+    spy.returnsPromise().resolves;
+
+    stripeCreateCustomerSpy = sinon.stub(stripe.customers, 'create');
+    let stripCustomerResponse = {
+      id: customerIdResponse,
+      subscriptions: {
+        data: [{id: subscriptionId}],
+      },
+    };
+    stripeCreateCustomerSpy.returnsPromise().resolves(stripCustomerResponse);
+
+    stripePaymentsCreateSubSpy = sinon.stub(payments, 'createSubscription');
+    stripePaymentsCreateSubSpy.returnsPromise().resolves({});
+
+    data.groupId = group._id;
+    data.sub.quantity = 3;
+  });
+
+  afterEach(function () {
+    sinon.restore(stripe.subscriptions.update);
+    stripe.customers.create.restore();
+    payments.createSubscription.restore();
+  });
+
+  it('should throw an error if we are missing a token', async () => {
+    await expect(stripePayments.checkout({
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: 'Missing req.body.id',
+    });
+  });
+
+  it('should throw an error when coupon code is missing', async () => {
+    sub.discount = 40;
+
+    await expect(stripePayments.checkout({
+      token,
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: i18n.t('couponCodeRequired'),
+    });
+  });
+
+  it('should throw an error when coupon code is invalid', async () => {
+    sub.discount = 40;
+    sub.key = 'google_6mo';
+    coupon = 'example-coupon';
+
+    let couponModel = new Coupon();
+    couponModel.event = 'google_6mo';
+    await couponModel.save();
+
+    sinon.stub(cc, 'validate').returns('invalid');
+
+    await expect(stripePayments.checkout({
+      token,
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: i18n.t('invalidCoupon'),
+    });
+    cc.validate.restore();
+  });
+
+  it('subscribes with amazon with a coupon', async () => {
+    sub.discount = 40;
+    sub.key = 'google_6mo';
+    coupon = 'example-coupon';
+
+    let couponModel = new Coupon();
+    couponModel.event = 'google_6mo';
+    let updatedCouponModel = await couponModel.save();
+
+    sinon.stub(cc, 'validate').returns(updatedCouponModel._id);
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    expect(stripeCreateCustomerSpy).to.be.calledOnce;
+    expect(stripeCreateCustomerSpy).to.be.calledWith({
+      email,
+      metadata: { uuid: user._id },
+      card: token,
+      plan: sub.key,
+    });
+
+    expect(stripePaymentsCreateSubSpy).to.be.calledOnce;
+    expect(stripePaymentsCreateSubSpy).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Stripe',
+      sub,
+      headers,
+      groupId: undefined,
+      subscriptionId: undefined,
+    });
+
+    cc.validate.restore();
+  });
+
+  it('subscribes a user', async () => {
+    sub = data.sub;
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    expect(stripeCreateCustomerSpy).to.be.calledOnce;
+    expect(stripeCreateCustomerSpy).to.be.calledWith({
+      email,
+      metadata: { uuid: user._id },
+      card: token,
+      plan: sub.key,
+    });
+
+    expect(stripePaymentsCreateSubSpy).to.be.calledOnce;
+    expect(stripePaymentsCreateSubSpy).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Stripe',
+      sub,
+      headers,
+      groupId: undefined,
+      subscriptionId: undefined,
+    });
+  });
+
+  it('subscribes a group', async () => {
+    token = 'test-token';
+    sub = data.sub;
+    groupId = group._id;
+    email = 'test@test.com';
+    headers = {};
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    expect(stripeCreateCustomerSpy).to.be.calledOnce;
+    expect(stripeCreateCustomerSpy).to.be.calledWith({
+      email,
+      metadata: { uuid: user._id },
+      card: token,
+      plan: sub.key,
+      quantity: 3,
+    });
+
+    expect(stripePaymentsCreateSubSpy).to.be.calledOnce;
+    expect(stripePaymentsCreateSubSpy).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Stripe',
+      sub,
+      headers,
+      groupId,
+      subscriptionId,
+    });
+  });
+
+  it('subscribes a group with the correct number of group members', async () => {
+    token = 'test-token';
+    sub = data.sub;
+    groupId = group._id;
+    email = 'test@test.com';
+    headers = {};
+    user = new User();
+    user.guilds.push(groupId);
+    await user.save();
+    group.memberCount = 2;
+    await group.save();
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      sub,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    expect(stripeCreateCustomerSpy).to.be.calledOnce;
+    expect(stripeCreateCustomerSpy).to.be.calledWith({
+      email,
+      metadata: { uuid: user._id },
+      card: token,
+      plan: sub.key,
+      quantity: 4,
+    });
+
+    expect(stripePaymentsCreateSubSpy).to.be.calledOnce;
+    expect(stripePaymentsCreateSubSpy).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Stripe',
+      sub,
+      headers,
+      groupId,
+      subscriptionId,
+    });
+  });
+});

test/api/v3/unit/libs/payments/stripe/checkout.test.js

@@ -0,0 +1,193 @@
+import stripeModule from 'stripe';
+
+import { model as User } from '../../../../../../../website/server/models/user';
+import stripePayments from '../../../../../../../website/server/libs/stripePayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('checkout', () => {
+  const subKey = 'basic_3mo';
+  const stripe = stripeModule('test');
+  let stripeChargeStub, paymentBuyGemsStub, paymentCreateSubscritionStub;
+  let user, gift, groupId, email, headers, coupon, customerIdResponse, token;
+
+  beforeEach(() => {
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = 'customer-id';
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    token = 'test-token';
+
+    customerIdResponse = 'example-customerIdResponse';
+    let stripCustomerResponse = {
+      id: customerIdResponse,
+    };
+    stripeChargeStub = sinon.stub(stripe.charges, 'create').returnsPromise().resolves(stripCustomerResponse);
+    paymentBuyGemsStub = sinon.stub(payments, 'buyGems').returnsPromise().resolves({});
+    paymentCreateSubscritionStub = sinon.stub(payments, 'createSubscription').returnsPromise().resolves({});
+  });
+
+  afterEach(() => {
+    stripe.charges.create.restore();
+    payments.buyGems.restore();
+    payments.createSubscription.restore();
+  });
+
+  it('should error if gem amount is too low', async () => {
+    let receivingUser = new User();
+    receivingUser.save();
+    gift = {
+      type: 'gems',
+      gems: {
+        amount: 0,
+        uuid: receivingUser._id,
+      },
+    };
+
+    await expect(stripePayments.checkout({
+      token,
+      user,
+      gift,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      message: 'Amount must be at least 1.',
+      name: 'BadRequest',
+    });
+  });
+
+
+  it('should error if user cannot get gems', async () => {
+    gift = undefined;
+    sinon.stub(user, 'canGetGems').returnsPromise().resolves(false);
+
+    await expect(stripePayments.checkout({
+      token,
+      user,
+      gift,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe)).to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      message: i18n.t('groupPolicyCannotGetGems'),
+      name: 'NotAuthorized',
+    });
+  });
+
+  it('should purchase gems', async () => {
+    gift = undefined;
+    sinon.stub(user, 'canGetGems').returnsPromise().resolves(true);
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    expect(stripeChargeStub).to.be.calledOnce;
+    expect(stripeChargeStub).to.be.calledWith({
+      amount: 500,
+      currency: 'usd',
+      card: token,
+    });
+
+    expect(paymentBuyGemsStub).to.be.calledOnce;
+    expect(paymentBuyGemsStub).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Stripe',
+      gift,
+    });
+    expect(user.canGetGems).to.be.calledOnce;
+    user.canGetGems.restore();
+  });
+
+  it('should gift gems', async () => {
+    let receivingUser = new User();
+    await receivingUser.save();
+    gift = {
+      type: 'gems',
+      uuid: receivingUser._id,
+      gems: {
+        amount: 16,
+      },
+    };
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    expect(stripeChargeStub).to.be.calledOnce;
+    expect(stripeChargeStub).to.be.calledWith({
+      amount: '400',
+      currency: 'usd',
+      card: token,
+    });
+
+    expect(paymentBuyGemsStub).to.be.calledOnce;
+    expect(paymentBuyGemsStub).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Gift',
+      gift,
+    });
+  });
+
+  it('should gift a subscription', async () => {
+    let receivingUser = new User();
+    receivingUser.save();
+    gift = {
+      type: 'subscription',
+      subscription: {
+        key: subKey,
+        uuid: receivingUser._id,
+      },
+    };
+
+    await stripePayments.checkout({
+      token,
+      user,
+      gift,
+      groupId,
+      email,
+      headers,
+      coupon,
+    }, stripe);
+
+    gift.member = receivingUser;
+    expect(stripeChargeStub).to.be.calledOnce;
+    expect(stripeChargeStub).to.be.calledWith({
+      amount: '1500',
+      currency: 'usd',
+      card: token,
+    });
+
+    expect(paymentCreateSubscritionStub).to.be.calledOnce;
+    expect(paymentCreateSubscritionStub).to.be.calledWith({
+      user,
+      customerId: customerIdResponse,
+      paymentMethod: 'Gift',
+      gift,
+    });
+  });
+});

test/api/v3/unit/libs/payments/stripe/edit-subscription.test.js

@@ -0,0 +1,147 @@
+import stripeModule from 'stripe';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import stripePayments from '../../../../../../../website/server/libs/stripePayments';
+import common from '../../../../../../../website/common';
+
+const i18n = common.i18n;
+
+describe('edit subscription', () => {
+  const subKey = 'basic_3mo';
+  const stripe = stripeModule('test');
+  let user, groupId, group, token;
+
+  beforeEach(async () => {
+    user = new User();
+    user.profile.name = 'sender';
+    user.purchased.plan.customerId = 'customer-id';
+    user.purchased.plan.planId = subKey;
+    user.purchased.plan.lastBillingDate = new Date();
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    group.purchased.plan.customerId = 'customer-id';
+    group.purchased.plan.planId = subKey;
+    await group.save();
+
+    groupId = group._id;
+
+    token = 'test-token';
+  });
+
+  it('throws an error if there is no customer id', async () => {
+    user.purchased.plan.customerId = undefined;
+
+    await expect(stripePayments.editSubscription({
+      user,
+      groupId: undefined,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      name: 'NotAuthorized',
+      message: i18n.t('missingSubscription'),
+    });
+  });
+
+  it('throws an error if a token is not provided', async () => {
+    await expect(stripePayments.editSubscription({
+      user,
+      groupId: undefined,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 400,
+      name: 'BadRequest',
+      message: 'Missing req.body.id',
+    });
+  });
+
+  it('throws an error if the group is not found', async () => {
+    await expect(stripePayments.editSubscription({
+      token,
+      user,
+      groupId: 'fake-group',
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 404,
+      name: 'NotFound',
+      message: i18n.t('groupNotFound'),
+    });
+  });
+
+  it('throws an error if user is not the group leader', async () => {
+    let nonLeader = new User();
+    nonLeader.guilds.push(groupId);
+    await nonLeader.save();
+
+    await expect(stripePayments.editSubscription({
+      token,
+      user: nonLeader,
+      groupId,
+    }))
+    .to.eventually.be.rejected.and.to.eql({
+      httpCode: 401,
+      name: 'NotAuthorized',
+      message: i18n.t('onlyGroupLeaderCanManageSubscription'),
+    });
+  });
+
+  describe('success', () => {
+    let stripeListSubscriptionStub, stripeUpdateSubscriptionStub, subscriptionId;
+
+    beforeEach(() => {
+      subscriptionId = 'subId';
+      stripeListSubscriptionStub = sinon.stub(stripe.customers, 'listSubscriptions')
+        .returnsPromise().resolves({
+          data: [{id: subscriptionId}],
+        });
+
+      stripeUpdateSubscriptionStub = sinon.stub(stripe.customers, 'updateSubscription').returnsPromise().resolves({});
+    });
+
+    afterEach(() => {
+      stripe.customers.listSubscriptions.restore();
+      stripe.customers.updateSubscription.restore();
+    });
+
+    it('edits a user subscription', async () => {
+      await stripePayments.editSubscription({
+        token,
+        user,
+        groupId: undefined,
+      }, stripe);
+
+      expect(stripeListSubscriptionStub).to.be.calledOnce;
+      expect(stripeListSubscriptionStub).to.be.calledWith(user.purchased.plan.customerId);
+      expect(stripeUpdateSubscriptionStub).to.be.calledOnce;
+      expect(stripeUpdateSubscriptionStub).to.be.calledWith(
+        user.purchased.plan.customerId,
+        subscriptionId,
+        { card: token }
+      );
+    });
+
+    it('edits a group subscription', async () => {
+      await stripePayments.editSubscription({
+        token,
+        user,
+        groupId,
+      }, stripe);
+
+      expect(stripeListSubscriptionStub).to.be.calledOnce;
+      expect(stripeListSubscriptionStub).to.be.calledWith(group.purchased.plan.customerId);
+      expect(stripeUpdateSubscriptionStub).to.be.calledOnce;
+      expect(stripeUpdateSubscriptionStub).to.be.calledWith(
+        group.purchased.plan.customerId,
+        subscriptionId,
+        { card: token }
+      );
+    });
+  });
+});

test/api/v3/unit/libs/payments/stripe/handle-webhook.test.js

@@ -0,0 +1,257 @@
+import stripeModule from 'stripe';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import stripePayments from '../../../../../../../website/server/libs/stripePayments';
+import payments from '../../../../../../../website/server/libs/payments';
+import common from '../../../../../../../website/common';
+import logger from '../../../../../../../website/server/libs/logger';
+import { v4 as uuid } from 'uuid';
+import moment from 'moment';
+
+const i18n = common.i18n;
+
+describe('Stripe - Webhooks', () => {
+  const stripe = stripeModule('test');
+
+  describe('all events', () => {
+    const eventType = 'account.updated';
+    const event = {id: 123};
+    const eventRetrieved = {type: eventType};
+
+    beforeEach(() => {
+      sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves(eventRetrieved);
+      sinon.stub(logger, 'error');
+    });
+
+    afterEach(() => {
+      stripe.events.retrieve.restore();
+      logger.error.restore();
+    });
+
+    it('logs an error if an unsupported webhook event is passed', async () => {
+      const error = new Error(`Missing handler for Stripe webhook ${eventType}`);
+      await stripePayments.handleWebhooks({requestBody: event}, stripe);
+      expect(logger.error).to.have.been.called.once;
+      expect(logger.error).to.have.been.calledWith(error, {event: eventRetrieved});
+    });
+
+    it('retrieves and validates the event from Stripe', async () => {
+      await stripePayments.handleWebhooks({requestBody: event}, stripe);
+      expect(stripe.events.retrieve).to.have.been.called.once;
+      expect(stripe.events.retrieve).to.have.been.calledWith(event.id);
+    });
+  });
+
+  describe('customer.subscription.deleted', () => {
+    const eventType = 'customer.subscription.deleted';
+
+    beforeEach(() => {
+      sinon.stub(stripe.customers, 'del').returnsPromise().resolves({});
+      sinon.stub(payments, 'cancelSubscription').returnsPromise().resolves({});
+    });
+
+    afterEach(() => {
+      stripe.customers.del.restore();
+      payments.cancelSubscription.restore();
+    });
+
+    it('does not do anything if event.request is null (subscription cancelled manually)', async () => {
+      sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves({
+        id: 123,
+        type: eventType,
+        request: 123,
+      });
+
+      await stripePayments.handleWebhooks({requestBody: {}}, stripe);
+
+      expect(stripe.events.retrieve).to.have.been.called.once;
+      expect(stripe.customers.del).to.not.have.been.called;
+      expect(payments.cancelSubscription).to.not.have.been.called;
+      stripe.events.retrieve.restore();
+    });
+
+    describe('user subscription', () => {
+      it('throws an error if the user is not found', async () => {
+        const customerId = 456;
+        sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves({
+          id: 123,
+          type: eventType,
+          data: {
+            object: {
+              plan: {
+                id: 'basic_earned',
+              },
+              customer: customerId,
+            },
+          },
+          request: null,
+        });
+
+        await expect(stripePayments.handleWebhooks({requestBody: {}}, stripe)).to.eventually.be.rejectedWith({
+          message: i18n.t('userNotFound'),
+          httpCode: 404,
+          name: 'NotFound',
+        });
+
+        expect(stripe.customers.del).to.not.have.been.called;
+        expect(payments.cancelSubscription).to.not.have.been.called;
+
+        stripe.events.retrieve.restore();
+      });
+
+      it('deletes the customer on Stripe and calls payments.cancelSubscription', async () => {
+        const customerId = '456';
+
+        let subscriber = new User();
+        subscriber.purchased.plan.customerId = customerId;
+        subscriber.purchased.plan.paymentMethod = 'Stripe';
+        await subscriber.save();
+
+        sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves({
+          id: 123,
+          type: eventType,
+          data: {
+            object: {
+              plan: {
+                id: 'basic_earned',
+              },
+              customer: customerId,
+            },
+          },
+          request: null,
+        });
+
+        await stripePayments.handleWebhooks({requestBody: {}}, stripe);
+
+        expect(stripe.customers.del).to.have.been.calledOnce;
+        expect(stripe.customers.del).to.have.been.calledWith(customerId);
+        expect(payments.cancelSubscription).to.have.been.calledOnce;
+
+        let cancelSubscriptionOpts = payments.cancelSubscription.lastCall.args[0];
+        expect(cancelSubscriptionOpts.user._id).to.equal(subscriber._id);
+        expect(cancelSubscriptionOpts.paymentMethod).to.equal('Stripe');
+        expect(Math.round(moment(cancelSubscriptionOpts.nextBill).diff(new Date(), 'days', true))).to.equal(3);
+        expect(cancelSubscriptionOpts.groupId).to.be.undefined;
+
+        stripe.events.retrieve.restore();
+      });
+    });
+
+    describe('group plan subscription', () => {
+      it('throws an error if the group is not found', async () => {
+        const customerId = 456;
+        sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves({
+          id: 123,
+          type: eventType,
+          data: {
+            object: {
+              plan: {
+                id: 'group_monthly',
+              },
+              customer: customerId,
+            },
+          },
+          request: null,
+        });
+
+        await expect(stripePayments.handleWebhooks({requestBody: {}}, stripe)).to.eventually.be.rejectedWith({
+          message: i18n.t('groupNotFound'),
+          httpCode: 404,
+          name: 'NotFound',
+        });
+
+        expect(stripe.customers.del).to.not.have.been.called;
+        expect(payments.cancelSubscription).to.not.have.been.called;
+
+        stripe.events.retrieve.restore();
+      });
+
+      it('throws an error if the group leader is not found', async () => {
+        const customerId = 456;
+
+        let subscriber = generateGroup({
+          name: 'test group',
+          type: 'guild',
+          privacy: 'public',
+          leader: uuid(),
+        });
+        subscriber.purchased.plan.customerId = customerId;
+        subscriber.purchased.plan.paymentMethod = 'Stripe';
+        await subscriber.save();
+
+        sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves({
+          id: 123,
+          type: eventType,
+          data: {
+            object: {
+              plan: {
+                id: 'group_monthly',
+              },
+              customer: customerId,
+            },
+          },
+          request: null,
+        });
+
+        await expect(stripePayments.handleWebhooks({requestBody: {}}, stripe)).to.eventually.be.rejectedWith({
+          message: i18n.t('userNotFound'),
+          httpCode: 404,
+          name: 'NotFound',
+        });
+
+        expect(stripe.customers.del).to.not.have.been.called;
+        expect(payments.cancelSubscription).to.not.have.been.called;
+
+        stripe.events.retrieve.restore();
+      });
+
+      it('deletes the customer on Stripe and calls payments.cancelSubscription', async () => {
+        const customerId = '456';
+
+        let leader = new User();
+        await leader.save();
+
+        let subscriber = generateGroup({
+          name: 'test group',
+          type: 'guild',
+          privacy: 'public',
+          leader: leader._id,
+        });
+        subscriber.purchased.plan.customerId = customerId;
+        subscriber.purchased.plan.paymentMethod = 'Stripe';
+        await subscriber.save();
+
+        sinon.stub(stripe.events, 'retrieve').returnsPromise().resolves({
+          id: 123,
+          type: eventType,
+          data: {
+            object: {
+              plan: {
+                id: 'group_monthly',
+              },
+              customer: customerId,
+            },
+          },
+          request: null,
+        });
+
+        await stripePayments.handleWebhooks({requestBody: {}}, stripe);
+
+        expect(stripe.customers.del).to.have.been.calledOnce;
+        expect(stripe.customers.del).to.have.been.calledWith(customerId);
+        expect(payments.cancelSubscription).to.have.been.calledOnce;
+
+        let cancelSubscriptionOpts = payments.cancelSubscription.lastCall.args[0];
+        expect(cancelSubscriptionOpts.user._id).to.equal(leader._id);
+        expect(cancelSubscriptionOpts.paymentMethod).to.equal('Stripe');
+        expect(Math.round(moment(cancelSubscriptionOpts.nextBill).diff(new Date(), 'days', true))).to.equal(3);
+        expect(cancelSubscriptionOpts.groupId).to.equal(subscriber._id);
+
+        stripe.events.retrieve.restore();
+      });
+    });
+  });
+});

test/api/v3/unit/libs/payments/stripe/upgrade-group-plan.test.js

@@ -0,0 +1,66 @@
+import stripeModule from 'stripe';
+
+import {
+  generateGroup,
+} from '../../../../../../helpers/api-unit.helper.js';
+import { model as User } from '../../../../../../../website/server/models/user';
+import { model as Group } from '../../../../../../../website/server/models/group';
+import stripePayments from '../../../../../../../website/server/libs/stripePayments';
+import payments from '../../../../../../../website/server/libs/payments';
+
+describe('Stripe - Upgrade Group Plan', () => {
+  const stripe = stripeModule('test');
+  let spy, data, user, group;
+
+  beforeEach(async function () {
+    user = new User();
+    user.profile.name = 'sender';
+
+    data = {
+      user,
+      sub: {
+        key: 'basic_3mo', // @TODO: Validate that this is group
+      },
+      customerId: 'customer-id',
+      paymentMethod: 'Payment Method',
+      headers: {
+        'x-client': 'habitica-web',
+        'user-agent': '',
+      },
+    };
+
+    group = generateGroup({
+      name: 'test group',
+      type: 'guild',
+      privacy: 'public',
+      leader: user._id,
+    });
+    await group.save();
+
+    spy = sinon.stub(stripe.subscriptions, 'update');
+    spy.returnsPromise().resolves([]);
+    data.groupId = group._id;
+    data.sub.quantity = 3;
+    stripePayments.setStripeApi(stripe);
+  });
+
+  afterEach(function () {
+    sinon.restore(stripe.subscriptions.update);
+  });
+
+  it('updates a group plan quantity', async () => {
+    data.paymentMethod = 'Stripe';
+    await payments.createSubscription(data);
+
+    let updatedGroup = await Group.findById(group._id).exec();
+    expect(updatedGroup.purchased.plan.quantity).to.eql(3);
+
+    updatedGroup.memberCount += 1;
+    await updatedGroup.save();
+
+    await stripePayments.chargeForAdditionalGroupMember(updatedGroup);
+
+    expect(spy.calledOnce).to.be.true;
+    expect(updatedGroup.purchased.plan.quantity).to.eql(4);
+  });
+});

test/api/v3/unit/libs/paypalPayments.test.js

@@ -1,561 +0,0 @@
-/* eslint-disable camelcase */
-import nconf from 'nconf';
-import moment from 'moment';
-import cc from 'coupon-code';
-
-import payments from '../../../../../website/server/libs/payments';
-import paypalPayments from '../../../../../website/server/libs/paypalPayments';
-import {
-  generateGroup,
-} from '../../../../helpers/api-unit.helper.js';
-import { model as User } from '../../../../../website/server/models/user';
-import { model as Coupon } from '../../../../../website/server/models/coupon';
-import common from '../../../../../website/common';
-
-const BASE_URL = nconf.get('BASE_URL');
-const i18n = common.i18n;
-
-describe('Paypal Payments', ()  => {
-  let subKey = 'basic_3mo';
-
-  describe('checkout', () => {
-    let paypalPaymentCreateStub;
-    let approvalHerf;
-
-    function getPaypalCreateOptions (description, amount) {
-      return {
-        intent: 'sale',
-        payer: { payment_method: 'Paypal' },
-        redirect_urls: {
-          return_url: `${BASE_URL}/paypal/checkout/success`,
-          cancel_url: `${BASE_URL}`,
-        },
-        transactions: [{
-          item_list: {
-            items: [{
-              name: description,
-              price: amount,
-              currency: 'USD',
-              quantity: 1,
-            }],
-          },
-          amount: {
-            currency: 'USD',
-            total: amount,
-          },
-          description,
-        }],
-      };
-    }
-
-    beforeEach(() => {
-      approvalHerf = 'approval_href';
-      paypalPaymentCreateStub = sinon.stub(paypalPayments, 'paypalPaymentCreate')
-        .returnsPromise().resolves({
-          links: [{ rel: 'approval_url', href: approvalHerf }],
-        });
-    });
-
-    afterEach(() => {
-      paypalPayments.paypalPaymentCreate.restore();
-    });
-
-    it('creates a link for gem purchases', async () => {
-      let link = await paypalPayments.checkout({user: new User()});
-
-      expect(paypalPaymentCreateStub).to.be.calledOnce;
-      expect(paypalPaymentCreateStub).to.be.calledWith(getPaypalCreateOptions('Habitica Gems', 5.00));
-      expect(link).to.eql(approvalHerf);
-    });
-
-    it('should error if gem amount is too low', async () => {
-      let receivingUser = new User();
-      receivingUser.save();
-      let gift = {
-        type: 'gems',
-        gems: {
-          amount: 0,
-          uuid: receivingUser._id,
-        },
-      };
-
-      await expect(paypalPayments.checkout({gift}))
-      .to.eventually.be.rejected.and.to.eql({
-        httpCode: 400,
-        message: 'Amount must be at least 1.',
-        name: 'BadRequest',
-      });
-    });
-
-    it('should error if the user cannot get gems', async () => {
-      let user = new User();
-      sinon.stub(user, 'canGetGems').returnsPromise().resolves(false);
-
-      await expect(paypalPayments.checkout({user})).to.eventually.be.rejected.and.to.eql({
-        httpCode: 401,
-        message: i18n.t('groupPolicyCannotGetGems'),
-        name: 'NotAuthorized',
-      });
-    });
-
-    it('creates a link for gifting gems', async () => {
-      let receivingUser = new User();
-      await receivingUser.save();
-      let gift = {
-        type: 'gems',
-        uuid: receivingUser._id,
-        gems: {
-          amount: 16,
-        },
-      };
-
-      let link = await paypalPayments.checkout({gift});
-
-      expect(paypalPaymentCreateStub).to.be.calledOnce;
-      expect(paypalPaymentCreateStub).to.be.calledWith(getPaypalCreateOptions('Habitica Gems (Gift)', '4.00'));
-      expect(link).to.eql(approvalHerf);
-    });
-
-    it('creates a link for gifting a subscription', async () => {
-      let receivingUser = new User();
-      receivingUser.save();
-      let gift = {
-        type: 'subscription',
-        subscription: {
-          key: subKey,
-          uuid: receivingUser._id,
-        },
-      };
-
-      let link = await paypalPayments.checkout({gift});
-
-      expect(paypalPaymentCreateStub).to.be.calledOnce;
-      expect(paypalPaymentCreateStub).to.be.calledWith(getPaypalCreateOptions('mo. Habitica Subscription (Gift)', '15.00'));
-      expect(link).to.eql(approvalHerf);
-    });
-  });
-
-  describe('checkout success', () => {
-    let user, gift, customerId, paymentId;
-    let paypalPaymentExecuteStub, paymentBuyGemsStub, paymentsCreateSubscritionStub;
-
-    beforeEach(() => {
-      user = new User();
-      customerId = 'customerId-test';
-      paymentId = 'paymentId-test';
-
-      paypalPaymentExecuteStub = sinon.stub(paypalPayments, 'paypalPaymentExecute').returnsPromise().resolves({});
-      paymentBuyGemsStub = sinon.stub(payments, 'buyGems').returnsPromise().resolves({});
-      paymentsCreateSubscritionStub = sinon.stub(payments, 'createSubscription').returnsPromise().resolves({});
-    });
-
-    afterEach(() => {
-      paypalPayments.paypalPaymentExecute.restore();
-      payments.buyGems.restore();
-      payments.createSubscription.restore();
-    });
-
-    it('purchases gems', async () => {
-      await paypalPayments.checkoutSuccess({user, gift, paymentId, customerId});
-
-      expect(paypalPaymentExecuteStub).to.be.calledOnce;
-      expect(paypalPaymentExecuteStub).to.be.calledWith(paymentId, { payer_id: customerId });
-      expect(paymentBuyGemsStub).to.be.calledOnce;
-      expect(paymentBuyGemsStub).to.be.calledWith({
-        user,
-        customerId,
-        paymentMethod: 'Paypal',
-      });
-    });
-
-    it('gifts gems', async () => {
-      let receivingUser = new User();
-      await receivingUser.save();
-      gift = {
-        type: 'gems',
-        gems: {
-          amount: 16,
-          uuid: receivingUser._id,
-        },
-      };
-
-      await paypalPayments.checkoutSuccess({user, gift, paymentId, customerId});
-
-      expect(paypalPaymentExecuteStub).to.be.calledOnce;
-      expect(paypalPaymentExecuteStub).to.be.calledWith(paymentId, { payer_id: customerId });
-      expect(paymentBuyGemsStub).to.be.calledOnce;
-      expect(paymentBuyGemsStub).to.be.calledWith({
-        user,
-        customerId,
-        paymentMethod: 'PayPal (Gift)',
-        gift,
-      });
-    });
-
-    it('gifts subscription', async () => {
-      let receivingUser = new User();
-      await receivingUser.save();
-      gift = {
-        type: 'subscription',
-        subscription: {
-          key: subKey,
-          uuid: receivingUser._id,
-        },
-      };
-
-      await paypalPayments.checkoutSuccess({user, gift, paymentId, customerId});
-
-      expect(paypalPaymentExecuteStub).to.be.calledOnce;
-      expect(paypalPaymentExecuteStub).to.be.calledWith(paymentId, { payer_id: customerId });
-      expect(paymentsCreateSubscritionStub).to.be.calledOnce;
-      expect(paymentsCreateSubscritionStub).to.be.calledWith({
-        user,
-        customerId,
-        paymentMethod: 'PayPal (Gift)',
-        gift,
-      });
-    });
-  });
-
-  describe('subscribe', () => {
-    let coupon, sub, approvalHerf;
-    let paypalBillingAgreementCreateStub;
-
-    beforeEach(() => {
-      approvalHerf = 'approvalHerf-test';
-      sub = common.content.subscriptionBlocks[subKey];
-
-      paypalBillingAgreementCreateStub = sinon.stub(paypalPayments, 'paypalBillingAgreementCreate')
-        .returnsPromise().resolves({
-          links: [{ rel: 'approval_url', href: approvalHerf }],
-        });
-    });
-
-    afterEach(() => {
-      paypalPayments.paypalBillingAgreementCreate.restore();
-    });
-
-    it('should throw an error when coupon code is missing', async () => {
-      sub.discount = 40;
-
-      await expect(paypalPayments.subscribe({sub, coupon}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 400,
-          name: 'BadRequest',
-          message: i18n.t('couponCodeRequired'),
-        });
-    });
-
-    it('should throw an error when coupon code is invalid', async () => {
-      sub.discount = 40;
-      sub.key = 'google_6mo';
-      coupon = 'example-coupon';
-
-      let couponModel = new Coupon();
-      couponModel.event = 'google_6mo';
-      await couponModel.save();
-
-      sinon.stub(cc, 'validate').returns('invalid');
-
-      await expect(paypalPayments.subscribe({sub, coupon}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 401,
-          name: 'NotAuthorized',
-          message: i18n.t('invalidCoupon'),
-        });
-      cc.validate.restore();
-    });
-
-    it('subscribes with amazon with a coupon', async () => {
-      sub.discount = 40;
-      sub.key = 'google_6mo';
-      coupon = 'example-coupon';
-
-      let couponModel = new Coupon();
-      couponModel.event = 'google_6mo';
-      let updatedCouponModel = await couponModel.save();
-
-      sinon.stub(cc, 'validate').returns(updatedCouponModel._id);
-
-      let link = await paypalPayments.subscribe({sub, coupon});
-
-      expect(link).to.eql(approvalHerf);
-      expect(paypalBillingAgreementCreateStub).to.be.calledOnce;
-      let billingPlanTitle = `Habitica Subscription ($${sub.price} every ${sub.months} months, recurring)`;
-      expect(paypalBillingAgreementCreateStub).to.be.calledWith({
-        name: billingPlanTitle,
-        description: billingPlanTitle,
-        start_date: moment().add({ minutes: 5 }).format(),
-        plan: {
-          id: sub.paypalKey,
-        },
-        payer: {
-          payment_method: 'Paypal',
-        },
-      });
-
-      cc.validate.restore();
-    });
-
-    it('creates a link for a subscription', async () => {
-      delete sub.discount;
-
-      let link = await paypalPayments.subscribe({sub, coupon});
-
-      expect(link).to.eql(approvalHerf);
-      expect(paypalBillingAgreementCreateStub).to.be.calledOnce;
-      let billingPlanTitle = `Habitica Subscription ($${sub.price} every ${sub.months} months, recurring)`;
-      expect(paypalBillingAgreementCreateStub).to.be.calledWith({
-        name: billingPlanTitle,
-        description: billingPlanTitle,
-        start_date: moment().add({ minutes: 5 }).format(),
-        plan: {
-          id: sub.paypalKey,
-        },
-        payer: {
-          payment_method: 'Paypal',
-        },
-      });
-    });
-  });
-
-  describe('subscribeSuccess', () => {
-    let user, group, block, groupId, token, headers, customerId;
-    let paypalBillingAgreementExecuteStub, paymentsCreateSubscritionStub;
-
-    beforeEach(async () => {
-      user = new User();
-
-      group = generateGroup({
-        name: 'test group',
-        type: 'guild',
-        privacy: 'public',
-        leader: user._id,
-      });
-
-      token = 'test-token';
-      headers = {};
-      block = common.content.subscriptionBlocks[subKey];
-      customerId = 'test-customerId';
-
-      paypalBillingAgreementExecuteStub = sinon.stub(paypalPayments, 'paypalBillingAgreementExecute')
-        .returnsPromise({}).resolves({
-          id: customerId,
-        });
-      paymentsCreateSubscritionStub = sinon.stub(payments, 'createSubscription').returnsPromise().resolves({});
-    });
-
-    afterEach(() => {
-      paypalPayments.paypalBillingAgreementExecute.restore();
-      payments.createSubscription.restore();
-    });
-
-    it('creates a user subscription', async () => {
-      await paypalPayments.subscribeSuccess({user, block, groupId, token, headers});
-
-      expect(paypalBillingAgreementExecuteStub).to.be.calledOnce;
-      expect(paypalBillingAgreementExecuteStub).to.be.calledWith(token, {});
-
-      expect(paymentsCreateSubscritionStub).to.be.calledOnce;
-      expect(paymentsCreateSubscritionStub).to.be.calledWith({
-        user,
-        groupId,
-        customerId,
-        paymentMethod: 'Paypal',
-        sub: block,
-        headers,
-      });
-    });
-
-    it('create a group subscription', async () => {
-      groupId = group._id;
-
-      await paypalPayments.subscribeSuccess({user, block, groupId, token, headers});
-
-      expect(paypalBillingAgreementExecuteStub).to.be.calledOnce;
-      expect(paypalBillingAgreementExecuteStub).to.be.calledWith(token, {});
-
-      expect(paymentsCreateSubscritionStub).to.be.calledOnce;
-      expect(paymentsCreateSubscritionStub).to.be.calledWith({
-        user,
-        groupId,
-        customerId,
-        paymentMethod: 'Paypal',
-        sub: block,
-        headers,
-      });
-    });
-  });
-
-  describe('subscribeCancel', () => {
-    let user, group, groupId, customerId, groupCustomerId, nextBillingDate;
-    let paymentCancelSubscriptionSpy, paypalBillingAgreementCancelStub, paypalBillingAgreementGetStub;
-
-    beforeEach(async () => {
-      customerId = 'customer-id';
-      groupCustomerId = 'groupCustomerId-test';
-
-      user = new User();
-      user.profile.name = 'sender';
-      user.purchased.plan.customerId = customerId;
-      user.purchased.plan.planId = subKey;
-      user.purchased.plan.lastBillingDate = new Date();
-
-      group = generateGroup({
-        name: 'test group',
-        type: 'guild',
-        privacy: 'public',
-        leader: user._id,
-      });
-      group.purchased.plan.customerId = groupCustomerId;
-      group.purchased.plan.planId = subKey;
-      group.purchased.plan.lastBillingDate = new Date();
-      await group.save();
-
-      nextBillingDate = new Date();
-
-      paypalBillingAgreementCancelStub = sinon.stub(paypalPayments, 'paypalBillingAgreementCancel').returnsPromise().resolves({});
-      paypalBillingAgreementGetStub = sinon.stub(paypalPayments, 'paypalBillingAgreementGet')
-        .returnsPromise().resolves({
-          agreement_details: {
-            next_billing_date: nextBillingDate,
-            cycles_completed: 1,
-          },
-        });
-      paymentCancelSubscriptionSpy = sinon.stub(payments, 'cancelSubscription').returnsPromise().resolves({});
-    });
-
-    afterEach(function () {
-      paypalPayments.paypalBillingAgreementGet.restore();
-      paypalPayments.paypalBillingAgreementCancel.restore();
-      payments.cancelSubscription.restore();
-    });
-
-    it('should throw an error if we are missing a subscription', async () => {
-      user.purchased.plan.customerId = undefined;
-
-      await expect(paypalPayments.subscribeCancel({user}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 401,
-          name: 'NotAuthorized',
-          message: i18n.t('missingSubscription'),
-        });
-    });
-
-    it('should throw an error if group is not found', async () => {
-      await expect(paypalPayments.subscribeCancel({user, groupId: 'fake-id'}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 404,
-          name: 'NotFound',
-          message: i18n.t('groupNotFound'),
-        });
-    });
-
-    it('should throw an error if user is not group leader', async () => {
-      let nonLeader = new User();
-      nonLeader.guilds.push(group._id);
-      await nonLeader.save();
-
-      await expect(paypalPayments.subscribeCancel({user: nonLeader, groupId: group._id}))
-        .to.eventually.be.rejected.and.to.eql({
-          httpCode: 401,
-          name: 'NotAuthorized',
-          message: i18n.t('onlyGroupLeaderCanManageSubscription'),
-        });
-    });
-
-    it('should cancel a user subscription', async () => {
-      await paypalPayments.subscribeCancel({user});
-
-      expect(paypalBillingAgreementGetStub).to.be.calledOnce;
-      expect(paypalBillingAgreementGetStub).to.be.calledWith(customerId);
-      expect(paypalBillingAgreementCancelStub).to.be.calledOnce;
-      expect(paypalBillingAgreementCancelStub).to.be.calledWith(customerId, { note: i18n.t('cancelingSubscription') });
-
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({
-        user,
-        groupId,
-        paymentMethod: 'Paypal',
-        nextBill: nextBillingDate,
-        cancellationReason: undefined,
-      });
-    });
-
-    it('should cancel a group subscription', async () => {
-      await paypalPayments.subscribeCancel({user, groupId: group._id});
-
-      expect(paypalBillingAgreementGetStub).to.be.calledOnce;
-      expect(paypalBillingAgreementGetStub).to.be.calledWith(groupCustomerId);
-      expect(paypalBillingAgreementCancelStub).to.be.calledOnce;
-      expect(paypalBillingAgreementCancelStub).to.be.calledWith(groupCustomerId, { note: i18n.t('cancelingSubscription') });
-
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({
-        user,
-        groupId: group._id,
-        paymentMethod: 'Paypal',
-        nextBill: nextBillingDate,
-        cancellationReason: undefined,
-      });
-    });
-  });
-
-  describe('ipn', () => {
-    let user, group, txn_type, userPaymentId, groupPaymentId;
-    let ipnVerifyAsyncStub, paymentCancelSubscriptionSpy;
-
-    beforeEach(async () => {
-      txn_type = 'recurring_payment_profile_cancel';
-      userPaymentId = 'userPaymentId-test';
-      groupPaymentId = 'groupPaymentId-test';
-
-      user = new User();
-      user.profile.name = 'sender';
-      user.purchased.plan.customerId = userPaymentId;
-      user.purchased.plan.planId = subKey;
-      user.purchased.plan.lastBillingDate = new Date();
-      await user.save();
-
-      group = generateGroup({
-        name: 'test group',
-        type: 'guild',
-        privacy: 'public',
-        leader: user._id,
-      });
-      group.purchased.plan.customerId = groupPaymentId;
-      group.purchased.plan.planId = subKey;
-      group.purchased.plan.lastBillingDate = new Date();
-      await group.save();
-
-      ipnVerifyAsyncStub = sinon.stub(paypalPayments, 'ipnVerifyAsync').returnsPromise().resolves({});
-      paymentCancelSubscriptionSpy = sinon.stub(payments, 'cancelSubscription').returnsPromise().resolves({});
-    });
-
-    afterEach(function () {
-      paypalPayments.ipnVerifyAsync.restore();
-      payments.cancelSubscription.restore();
-    });
-
-    it('should cancel a user subscription', async () => {
-      await paypalPayments.ipn({txn_type, recurring_payment_id: userPaymentId});
-
-      expect(ipnVerifyAsyncStub).to.be.calledOnce;
-      expect(ipnVerifyAsyncStub).to.be.calledWith({txn_type, recurring_payment_id: userPaymentId});
-
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy.args[0][0].user._id).to.eql(user._id);
-      expect(paymentCancelSubscriptionSpy.args[0][0].paymentMethod).to.eql('Paypal');
-    });
-
-    it('should cancel a group subscription', async () => {
-      await paypalPayments.ipn({txn_type, recurring_payment_id: groupPaymentId});
-
-      expect(ipnVerifyAsyncStub).to.be.calledOnce;
-      expect(ipnVerifyAsyncStub).to.be.calledWith({txn_type, recurring_payment_id: groupPaymentId});
-
-      expect(paymentCancelSubscriptionSpy).to.be.calledOnce;
-      expect(paymentCancelSubscriptionSpy).to.be.calledWith({ groupId: group._id, paymentMethod: 'Paypal' });
-    });
-  });
-});

test/api/v3/unit/models/group.test.js

@@ -391,6 +391,20 @@ describe('Group Model', () => {
           expect(party.quest.progress.collect.soapBars).to.eq(5);
         });
 
+        it('does not drop an item if not need when on a collection quest', async () => {
+          party.quest.key = 'dilatoryDistress1';
+          party.quest.active = false;
+          await party.startQuest(questLeader);
+          party.quest.progress.collect.fireCoral = 20;
+          await party.save();
+
+          await Group.processQuestProgress(participatingMember, progress);
+
+          party = await Group.findOne({_id: party._id});
+
+          expect(party.quest.progress.collect.fireCoral).to.eq(20);
+        });
+
         it('sends a chat message about progress', async () => {
           await Group.processQuestProgress(participatingMember, progress);
 

test/api/v3/unit/models/user.test.js

@@ -323,4 +323,48 @@ describe('User Model', () => {
       expect(user.achievements.beastMaster).to.not.equal(true);
     });
   });
+
+  context('days missed', () => {
+    // http://forbrains.co.uk/international_tools/earth_timezones
+    let user;
+
+    beforeEach(() => {
+      user = new User();
+    });
+
+    it('should not cron early when going back a timezone', () => {
+      const yesterday = moment('2017-12-05T00:00:00.000-06:00'); // 11 pm on 4 Texas
+      const timezoneOffset = moment().zone('-06:00').zone();
+      user.lastCron = yesterday;
+      user.preferences.timezoneOffset = timezoneOffset;
+
+      const today = moment('2017-12-06T00:00:00.000-06:00'); // 11 pm on 4 Texas
+      const req = {};
+      req.header = () => {
+        return timezoneOffset + 60;
+      };
+
+      const {daysMissed} = user.daysUserHasMissed(today, req);
+
+      expect(daysMissed).to.eql(0);
+    });
+
+    it('should not cron early when going back a timezone with a custom day start', () => {
+      const yesterday = moment('2017-12-05T02:00:00.000-08:00');
+      const timezoneOffset = moment().zone('-08:00').zone();
+      user.lastCron = yesterday;
+      user.preferences.timezoneOffset = timezoneOffset;
+      user.preferences.dayStart = 2;
+
+      const today = moment('2017-12-06T02:00:00.000-08:00');
+      const req = {};
+      req.header = () => {
+        return timezoneOffset + 60;
+      };
+
+      const {daysMissed} = user.daysUserHasMissed(today, req);
+
+      expect(daysMissed).to.eql(0);
+    });
+  });
 });

test/common/ops/addTask.js

@@ -38,7 +38,7 @@ describe('shared.ops.addTask', () => {
     expect(habit.counterDown).to.equal(0);
   });
 
-  it('adds an habtit when type is invalid', () => {
+  it('adds a habit when type is invalid', () => {
     let habit = addTask(user, {
       body: {
         type: 'invalid',

webpack/config/prod.env.js

@@ -34,7 +34,7 @@ let env = {
   },
 };
 
-'NODE_ENV BASE_URL GA_ID STRIPE_PUB_KEY FACEBOOK_KEY GOOGLE_CLIENT_ID AMPLITUDE_KEY PUSHER:KEY PUSHER:ENABLED'
+'NODE_ENV BASE_URL GA_ID STRIPE_PUB_KEY FACEBOOK_KEY GOOGLE_CLIENT_ID AMPLITUDE_KEY PUSHER:KEY PUSHER:ENABLED LOGGLY_CLIENT_TOKEN'
   .split(' ')
   .forEach(key => {
     env[key] = `"${nconf.get(key)}"`;

website/client/app.vue

@@ -1,38 +1,68 @@
 <template lang="pug">
-#app(:class='{"casting-spell": castingSpell}')
-  amazon-payments-modal
-  snackbars
-  router-view(v-if="!isUserLoggedIn || isStaticPage")
-  template(v-else)
-    template(v-if="isUserLoaded")
-      notifications-display
-      app-menu
-      .container-fluid
-        app-header
-        buyModal(
-          :item="selectedItemToBuy || {}",
-          :withPin="true",
-          @change="resetItemToBuy($event)",
-          @buyPressed="customPurchase($event)",
-          :genericPurchase="genericPurchase(selectedItemToBuy)",
+div
+  #loading-screen-inapp(v-if='loading')
+    .row
+      .col-12.text-center
+        svg#melior(xmlns='http://www.w3.org/2000/svg', viewbox='0 0 61.91 64')
+          path(d='M61.82,64H51.59c-3.08,0-3.72.37-3.67-1,0.07-1.87.67-1.94,2.63-2.49,1.63-.45,1-3.35-0.8-5.88-1.28-1.76-3.89-3.81-7.31-2.22a10.75,10.75,0,0,0-4.56,3.52c-1.68,2.33-1.59,4.54,1,4.54s5.39-1.5,6.23.64c1,2.64.33,2.89-.18,2.89H28.55v0C19.77,64,11,63.93,9,58.38c-2.82-7.68,7.43-10.64,7.75-15.46,0.13-2-1-2.85-2.34-2.85h-6V36.41H4.7v-11H8.36V29.1H12v3.65h3.65v5.08a5.76,5.76,0,0,1,3.07,5.05c-0.17,5.51-9.5,8.57-7.79,14.35,1.56,5.29,13.37,4,13,.74L23.7,56.1c-0.06-2.62-.47-6.12.08-9.22C24.64,42,27.67,37.78,33,37.74c1,0,1.78-.21,1.78-1s-1.55-.84-2.64-0.95a23.35,23.35,0,0,1-12.56-5c-2.43-2-6.21-8.3-3.74-7.83a21.74,21.74,0,0,0,4.06.4c1.24,0,4.44-.35,4.44-1.11,0-1-1.85-.42-4.57-0.68C16.48,21.22,9.6,19.83,6,9.35,4.71,5.43,3.83-1.91,6,.46c12.46,13.7,16.69,11.47,23.84,16.16,3.15,2.06,5.19,7,7,6.58,1.2-.27.46-1.37,0.64-3.93C37.66,17,38.75,16.48,36,15.79c-3.26-.81-6.52-4.38-4.39-4.33a11.89,11.89,0,0,0,5.53-.76c1.87-.81,6.43-4.28,9.18-2.89s5.08-.6,6.94-0.25c2.71,0.51,3.41,4.24,3.05,6.42-0.22,1.38-.22,1.38-2,1.28-3.61-.21-4.53,2.67-2,4.25,3.87,2.42,5.51,4.23,6.56,9.58,0.51,2.6.1,3.2-.76,2.72s-2.34-.72-0.29,4-1.29,10.28-2.39,10.9a1.3,1.3,0,0,0-.91,1.34c0,11.42,0,12.27,1.92,12.48,2.9,0.31,4.14-1.44,5.27.06C63.29,62.73,63.41,64,61.82,64ZM4.7,21.28H1v3.65H4.7V21.28Z', transform='translate(-1.05)', fill='#fff')
+      .col-12.text-center
+        h2 {{$t('tipTitle', {tipNumber: currentTipNumber})}}
+        p {{currentTip}}
+  #app(:class='{"casting-spell": castingSpell}')
+    amazon-payments-modal
+    snackbars
+    router-view(v-if="!isUserLoggedIn || isStaticPage")
+    template(v-else)
+        template(v-if="isUserLoaded")
+          notifications-display
+          app-menu
+          .container-fluid
+            app-header
+            buyModal(
+              :item="selectedItemToBuy || {}",
+              :withPin="true",
+              @change="resetItemToBuy($event)",
+              @buyPressed="customPurchase($event)",
+              :genericPurchase="genericPurchase(selectedItemToBuy)",
 
-        )
-        selectMembersModal(
-          :item="selectedSpellToBuy || {}",
-          :group="user.party",
-          @memberSelected="memberSelected($event)",
-        )
+            )
+            selectMembersModal(
+              :item="selectedSpellToBuy || {}",
+              :group="user.party",
+              @memberSelected="memberSelected($event)",
+            )
 
-        div(:class='{sticky: user.preferences.stickyHeader}')
-          router-view
-        app-footer
+            div(:class='{sticky: user.preferences.stickyHeader}')
+              router-view
+            app-footer
 
-        audio#sound(autoplay, ref="sound")
-          source#oggSource(type="audio/ogg", :src="sound.oggSource")
-          source#mp3Source(type="audio/mp3", :src="sound.mp3Source")
+            audio#sound(autoplay, ref="sound")
+              source#oggSource(type="audio/ogg", :src="sound.oggSource")
+              source#mp3Source(type="audio/mp3", :src="sound.mp3Source")
 </template>
 
-<style scoped>
+<style lang='scss' scoped>
+  #loading-screen-inapp {
+    #melior {
+      margin: 0 auto;
+      width: 70.9px;
+      margin-bottom: 1em;
+    }
+
+    h2 {
+      color: #fff;
+      font-size: 32px;
+      font-weight: bold;
+    }
+
+    p {
+      margin: 0 auto;
+      width: 448px;
+      font-size: 24px;
+      color: #d5c8ff;
+    }
+  }
+
   .casting-spell {
     cursor: crosshair;
   }
@@ -107,6 +137,8 @@ export default {
         oggSource: '',
         mp3Source: '',
       },
+      loading: true,
+      currentTipNumber: 0,
     };
   },
   computed: {
@@ -118,6 +150,15 @@ export default {
     castingSpell () {
       return this.$store.state.spellOptions.castingSpell;
     },
+    currentTip () {
+      const numberOfTips = 35 + 1;
+      const min = 1;
+      const randomNumber = Math.random() * (numberOfTips - min) + min;
+      const tipNumber = Math.floor(randomNumber);
+      this.currentTipNumber = tipNumber;
+
+      return this.$t(`tip${tipNumber}`);
+    },
   },
   created () {
     this.$root.$on('playSound', (sound) => {
@@ -314,6 +355,11 @@ export default {
       if (modalOnTop) this.$root.$emit('bv::show::modal', modalOnTop, {fromRoot: true});
     });
   },
+  mounted () {
+    // Remove the index.html loading screen and now show the inapp loading
+    const loadingScreen = document.getElementById('loading-screen');
+    if (loadingScreen) document.body.removeChild(loadingScreen);
+  },
   methods: {
     resetItemToBuy ($event) {
       // @TODO: Do we need this? I think selecting a new item
@@ -353,8 +399,7 @@ export default {
       this.$root.$emit('bv::hide::modal', 'select-member-modal');
     },
     hideLoadingScreen () {
-      const loadingScreen = document.getElementById('loading-screen');
-      if (loadingScreen) document.body.removeChild(loadingScreen);
+      this.loading = false;
     },
   },
 };

website/client/assets/css/sprites/spritesmith-largeSprites-0.css

@@ -1,12 +1,18 @@
+.promo_starry_potions {
+  background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
+  background-position: 0px -679px;
+  width: 423px;
+  height: 147px;
+}
 .promo_take_this {
   background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
-  background-position: -741px -442px;
+  background-position: -883px -566px;
   width: 114px;
   height: 87px;
 }
 .promo_winter_quests {
   background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
-  background-position: -741px 0px;
+  background-position: -883px 0px;
   width: 141px;
   height: 441px;
 }
@@ -16,12 +22,30 @@
   width: 740px;
   height: 309px;
 }
+.promo_winter_seasonal_shop {
+  background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
+  background-position: -437px -461px;
+  width: 162px;
+  height: 138px;
+}
 .promo_winter_subscriptions {
   background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
   background-position: -437px -310px;
   width: 237px;
   height: 150px;
 }
+.promo_winter_tavern {
+  background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
+  background-position: -883px -442px;
+  width: 135px;
+  height: 123px;
+}
+.promo_winter_wonderland_2018 {
+  background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
+  background-position: -741px 0px;
+  width: 141px;
+  height: 588px;
+}
 .scene_calendar {
   background-image: url('~assets/images/sprites/spritesmith-largeSprites-0.png');
   background-position: 0px -310px;

website/client/assets/scss/loading-screen.scss

@@ -1,4 +1,4 @@
-#loading-screen {
+#loading-screen, #loading-screen-inapp {
   z-index: 1050;
   position: absolute;
   top: 0;
@@ -32,4 +32,4 @@
   animation: fadeColor 2.4s infinite;
   height: 4rem;
   margin-left: -1rem;
-}
+}

website/client/assets/scss/tiers.scss

@@ -0,0 +1,41 @@
+.tier1 {
+  color: #c42870;
+}
+
+.tier2 {
+  color: #b01515;
+}
+
+.tier3 {
+  color: #d70e14;
+}
+
+.tier4 {
+  color: #c24d00;
+}
+
+.tier5 {
+  color: #9e650f;
+}
+
+.tier6 {
+  color: #2b8363;
+}
+
+.tier7 {
+  color: #167e87;
+}
+
+.tier8 {
+  color: #277eab;
+}
+
+.tier9 {
+  color: #6133b4;
+}
+
+.tierNPC, .npc {
+  color: #77f4c7;
+  fill: #77f4c7;
+  stroke: #005737;
+}

website/client/assets/scss/variables.scss

@@ -1,9 +1,9 @@
 // this variables are used to determine which shop npc/backgrounds should be loaded
-// possible values are: normal, fall, habitoween, thanksgiving
+// possible values are: normal, fall, habitoween, thanksgiving, winter
 // more to be added on future seasons
 
-$npc_market_flavor: 'normal';
-$npc_quests_flavor: 'normal';
-$npc_seasonal_flavor: 'normal';
-$npc_timetravelers_flavor: 'normal';
-$npc_tavern_flavor: 'normal';
+$npc_market_flavor: 'winter';
+$npc_quests_flavor: 'winter';
+$npc_seasonal_flavor: 'winter';
+$npc_timetravelers_flavor: 'winter';
+$npc_tavern_flavor: 'winter';

website/client/assets/svg/gift.svg

@@ -1,3 +1,3 @@
 <svg xmlns="http://www.w3.org/2000/svg" width="14" height="16" viewBox="0 0 14 16">
-    <path fill="#686274" fill-rule="evenodd" d="M8 8.807h4v-3H8v3zm0 5h4v-3H8v3zm-6-5h4v-3H2v3zm0 5h4v-3H2v3zm10-12h-2V.501a.5.5 0 0 0-.658-.475L7 .807 4.658.027A.5.5 0 0 0 4 .5v1.306H2a2 2 0 0 0-2 2v10a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2v-10a2 2 0 0 0-2-2z"/>
+    <path fill-rule="evenodd" d="M8 8.807h4v-3H8v3zm0 5h4v-3H8v3zm-6-5h4v-3H2v3zm0 5h4v-3H2v3zm10-12h-2V.501a.5.5 0 0 0-.658-.475L7 .807 4.658.027A.5.5 0 0 0 4 .5v1.306H2a2 2 0 0 0-2 2v10a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2v-10a2 2 0 0 0-2-2z"/>
 </svg>

website/client/assets/svg/remove.svg

@@ -1,3 +1,3 @@
 <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16">
-    <path fill="#878190" fill-rule="evenodd" d="M8 14a5.96 5.96 0 0 1-3.327-1.011l8.316-8.316A5.96 5.96 0 0 1 14 8c0 3.309-2.691 6-6 6M8 2a5.96 5.96 0 0 1 3.327 1.011l-8.316 8.316A5.96 5.96 0 0 1 2 8c0-3.309 2.691-6 6-6m0-2a8 8 0 1 0 0 16A8 8 0 0 0 8 0"/>
+    <path fill-rule="evenodd" d="M8 14a5.96 5.96 0 0 1-3.327-1.011l8.316-8.316A5.96 5.96 0 0 1 14 8c0 3.309-2.691 6-6 6M8 2a5.96 5.96 0 0 1 3.327 1.011l-8.316 8.316A5.96 5.96 0 0 1 2 8c0-3.309 2.691-6 6-6m0-2a8 8 0 1 0 0 16A8 8 0 0 0 8 0"/>
 </svg>

website/client/components/achievements/chooseClass.vue

@@ -163,30 +163,30 @@ export default {
     classGear (heroClass) {
       if (heroClass === 'rogue') {
         return {
-          armor: 'armor_rogue_5',
-          head: 'head_rogue_5',
-          shield: 'shield_rogue_6',
-          weapon: 'weapon_rogue_6',
+          armor: 'armor_special_winter2018Rogue',
+          head: 'head_special_winter2018Rogue',
+          shield: 'shield_special_winter2018Rogue',
+          weapon: 'weapon_special_winter2018Rogue',
         };
       } else if (heroClass === 'wizard') {
         return {
-          armor: 'armor_wizard_5',
-          head: 'head_wizard_5',
-          weapon: 'weapon_wizard_6',
+          armor: 'armor_special_winter2018Mage',
+          head: 'head_special_winter2018Mage',
+          weapon: 'weapon_special_winter2018Mage',
         };
       } else if (heroClass === 'healer') {
         return {
-          armor: 'armor_healer_5',
-          head: 'head_healer_5',
-          shield: 'shield_healer_5',
-          weapon: 'weapon_healer_6',
+          armor: 'armor_special_winter2018Healer',
+          head: 'head_special_winter2018Healer',
+          shield: 'shield_special_winter2018Healer',
+          weapon: 'weapon_special_winter2018Healer',
         };
       } else {
         return {
-          head: 'head_warrior_5',
-          weapon: 'weapon_warrior_6',
-          shield: 'shield_warrior_5',
-          armor: 'armor_warrior_5',
+          armor: 'armor_special_winter2018Warrior',
+          head: 'head_special_winter2018Warrior',
+          shield: 'shield_special_winter2018Warrior',
+          weapon: 'weapon_special_winter2018Warrior',
         };
       }
     },

website/client/components/avatar.vue

@@ -7,14 +7,14 @@
 
     // Buffs that cause visual changes to avatar: Snowman, Ghost, Flower, etc
     template(v-for="(klass, item) in visualBuffs")
-      span(v-if="member.stats.buffs[item]", :class="klass")
+      span(v-if="member.stats.buffs[item] && showVisualBuffs", :class="klass")
 
     // Show flower ALL THE TIME!!!
     // See https://github.com/HabitRPG/habitica/issues/7133
     span(:class="'hair_flower_' + member.preferences.hair.flower")
 
     // Show avatar only if not currently affected by visual buff
-    template(v-if!="!member.stats.buffs.snowball && !member.stats.buffs.spookySparkles && !member.stats.buffs.shinySeed && !member.stats.buffs.seafoam")
+    template(v-if="showAvatar()")
       span(:class="'chair_' + member.preferences.chair")
       span(:class="getGearClass('back')")
       span(:class="skinClass")
@@ -30,8 +30,8 @@
       span(:class="getGearClass('head')")
       span(:class="getGearClass('headAccessory')")
       span(:class="'hair_flower_' + member.preferences.hair.flower")
-      span(:class="getGearClass('shield')")
-      span(:class="getGearClass('weapon')")
+      span(v-if="!hideGear('shield')", :class="getGearClass('shield')")
+      span(v-if="!hideGear('weapon')", :class="getGearClass('weapon')")
 
     // Resting
     span.zzz(v-if="member.preferences.sleep")
@@ -71,6 +71,8 @@
 </style>
 
 <script>
+import { mapState } from 'client/libs/store';
+
 import ClassBadge from 'client/components/members/classBadge';
 
 export default {
@@ -111,8 +113,15 @@ export default {
     overrideTopPadding: {
       type: String,
     },
+    showVisualBuffs: {
+      type: Boolean,
+      default: true,
+    },
   },
   computed: {
+    ...mapState({
+      flatGear: 'content.gear.flat',
+    }),
     hasClass () {
       return this.$store.getters['members:hasClass'](this.member);
     },
@@ -175,10 +184,37 @@ export default {
 
       return result;
     },
+    hideGear (gearType) {
+      if (gearType === 'weapon') {
+        let equippedWeapon = this.member.items.gear[this.costumeClass][gearType];
+
+        if (!equippedWeapon) {
+          return false;
+        }
+
+        let equippedIsTwoHanded = this.flatGear[equippedWeapon].twoHanded;
+        let hasOverrideShield = this.overrideAvatarGear && this.overrideAvatarGear.shield;
+
+        return equippedIsTwoHanded && hasOverrideShield;
+      } else if (gearType === 'shield') {
+        let overrideWeapon = this.overrideAvatarGear && this.overrideAvatarGear.weapon;
+        let overrideIsTwoHanded = overrideWeapon && this.flatGear[overrideWeapon].twoHanded;
+
+        return overrideIsTwoHanded;
+      }
+    },
     castEnd (e) {
       if (!this.$store.state.spellOptions.castingSpell) return;
       this.$root.$emit('castEnd', this.member, 'user', e);
     },
+    showAvatar () {
+      if (!this.showVisualBuffs)
+        return true;
+
+      let buffs = this.member.stats.buffs;
+
+      return !buffs.snowball && !buffs.spookySparkles && !buffs.shinySeed && !buffs.seafoam;
+    },
   },
 };
 </script>

website/client/components/challenges/challengeDetail.vue

@@ -33,10 +33,7 @@
       .col-7.offset-5
         span.view-progress
           strong {{ $t('viewProgressOf') }}
-        b-dropdown.create-dropdown(text="Select a Participant")
-          input.form-control(type='text', v-model='searchTerm')
-          b-dropdown-item(v-for="member in memberResults", :key="member._id", @click="openMemberProgressModal(member._id)")
-            | {{ member.profile.name }}
+        member-search-dropdown(:text="$t('selectParticipant')", :members='members', :challengeId='challengeId', @member-selected='openMemberProgressModal')
         span(v-if='isLeader || isAdmin')
           b-dropdown.create-dropdown(:text="$t('addTaskToChallenge')", :variant="'success'")
             b-dropdown-item(v-for="type in columns", :key="type", @click="createTask(type)")
@@ -51,7 +48,6 @@
             v-on:taskEdited='taskEdited',
             @taskDestroyed='taskDestroyed'
           )
-
     .row
       task-column.col-12.col-sm-6(
         v-for="column in columns",
@@ -185,6 +181,7 @@ import omit from 'lodash/omit';
 import uuid from 'uuid';
 
 import { mapState } from 'client/libs/store';
+import memberSearchDropdown from 'client/components/members/memberSearchDropdown';
 import closeChallengeModal from './closeChallengeModal';
 import Column from '../tasks/column';
 import TaskModal from '../tasks/taskModal';
@@ -211,6 +208,7 @@ export default {
     leaveChallengeModal,
     challengeModal,
     challengeMemberProgressModal,
+    memberSearchDropdown,
     TaskColumn: Column,
     TaskModal,
   },
@@ -388,8 +386,8 @@ export default {
     updatedChallenge (eventData) {
       Object.assign(this.challenge, eventData.challenge);
     },
-    openMemberProgressModal (memberId) {
-      this.progressMemberId = memberId;
+    openMemberProgressModal (member) {
+      this.progressMemberId = member._id;
       this.$root.$emit('bv::show::modal', 'challenge-member-modal');
     },
     async exportChallengeCsv () {

website/client/components/challenges/closeChallengeModal.vue

@@ -10,10 +10,7 @@ div
       .col-12
         strong(v-once) {{$t('selectChallengeWinnersDescription')}}
       .col-12
-        b-dropdown.create-dropdown(:text="winnerText")
-          input.form-control(type='text', v-model='searchTerm')
-          b-dropdown-item(v-for="member in memberResults", :key="member._id", @click="selectMember(member)")
-            | {{ member.profile.name }}
+        member-search-dropdown(:text='winnerText', :members='members', :challengeId='challengeId', @member-selected='selectMember')
       .col-12
         button.btn.btn-primary(v-once, @click='closeChallenge') {{$t('awardWinners')}}
       .col-12
@@ -74,16 +71,16 @@ div
 </style>
 
 <script>
-import challengeMemberSearchMixin from 'client/mixins/challengeMemberSearch';
+import memberSearchDropdown from 'client/components/members/memberSearchDropdown';
 
 export default {
   props: ['challengeId', 'members'],
-  mixins: [challengeMemberSearchMixin],
+  components: {
+    memberSearchDropdown,
+  },
   data () {
     return {
       winner: {},
-      searchTerm: '',
-      memberResults: [],
     };
   },
   computed: {

website/client/components/chat/chatMessages.vue

@@ -29,7 +29,7 @@
               v-b-tooltip.hover.top="('contributor' in msg) ? msg.contributor.text : ''",
             )
               | {{msg.user}}
-              .svg-icon(v-html="icons[`tier${msg.contributor.level}`]", v-if='msg.contributor && msg.contributor.level')
+              .svg-icon(v-html="getTierIcon(msg)", v-if='showShowTierStyle(msg)')
             p.time {{msg.timestamp | timeAgo}}
             .text(v-markdown='msg.text')
             hr
@@ -67,7 +67,7 @@
               v-b-tooltip.hover.top="('contributor' in msg) ? msg.contributor.text : ''",
             )
               | {{msg.user}}
-              .svg-icon(v-html="icons[`tier${msg.contributor.level}`]", v-if='msg.contributor && msg.contributor.level')
+              .svg-icon(v-html="getTierIcon(msg)", v-if='showShowTierStyle(msg)')
             p.time {{msg.timestamp | timeAgo}}
             .text(v-markdown='msg.text')
             hr
@@ -103,50 +103,7 @@
 
 <style lang="scss" scoped>
   @import '~client/assets/scss/colors.scss';
-
-  // @TODO: Move this to an scss
-  .tier1 {
-    color: #c42870;
-  }
-
-  .tier2 {
-    color: #b01515;
-  }
-
-  .tier3 {
-    color: #d70e14;
-  }
-
-  .tier4 {
-    color: #c24d00;
-  }
-
-  .tier5 {
-    color: #9e650f;
-  }
-
-  .tier6 {
-    color: #2b8363;
-  }
-
-  .tier7 {
-    color: #167e87;
-  }
-
-  .tier8 {
-    color: #277eab;
-  }
-
-  .tier9 {
-    color: #6133b4;
-  }
-
-  .tier10 {
-    color: #77f4c7;
-    fill: #77f4c7;
-    stroke: #005737;
-  }
-  // End of tier colors
+  @import '~client/assets/scss/tiers.scss';
 
   .leader {
     margin-bottom: 0;
@@ -271,7 +228,7 @@ import tier6 from 'assets/svg/tier-6.svg';
 import tier7 from 'assets/svg/tier-7.svg';
 import tier8 from 'assets/svg/tier-mod.svg';
 import tier9 from 'assets/svg/tier-staff.svg';
-import tier10 from 'assets/svg/tier-npc.svg';
+import tierNPC from 'assets/svg/tier-npc.svg';
 
 export default {
   props: ['chat', 'groupId', 'groupName', 'inbox'],
@@ -310,7 +267,7 @@ export default {
         tier7,
         tier8,
         tier9,
-        tier10,
+        tierNPC,
       }),
       copyingMessage: {},
       currentDayDividerDisplay: moment().day(),
@@ -487,6 +444,18 @@ export default {
         });
       }
     },
+    showShowTierStyle (message) {
+      const isContributor = Boolean(message.contributor && message.contributor.level);
+      const isNPC = Boolean(message.backer && message.backer.npc);
+      return isContributor || isNPC;
+    },
+    getTierIcon (message) {
+      const isNPC = Boolean(message.backer && message.backer.npc);
+      if (isNPC) {
+        return this.icons.tierNPC;
+      }
+      return this.icons[`tier${message.contributor.level}`];
+    },
   },
 };
 </script>

website/client/components/groups/group.vue

@@ -28,23 +28,19 @@
     .row.chat-row
       .col-12
         h3(v-once) {{ $t('chat') }}
-
         .row.new-message-row
-          textarea(:placeholder="!isParty ? $t('chatPlaceholder') : $t('partyChatPlaceholder')", v-model='newMessage', @keydown='updateCarretPosition')
+          textarea(:placeholder="!isParty ? $t('chatPlaceholder') : $t('partyChatPlaceholder')", v-model='newMessage', @keydown='updateCarretPosition', @keyup.ctrl.enter='sendMessage()')
           autocomplete(:text='newMessage', v-on:select="selectedAutocomplete", :coords='coords', :chat='group.chat')
-
         .row
           .col-6
             button.btn.btn-secondary.float-left.fetch(v-once, @click='fetchRecentMessages()') {{ $t('fetchRecentMessages') }}
             button.btn.btn-secondary.float-left(v-once, @click='reverseChat()') {{ $t('reverseChat') }}
           .col-6
             button.btn.btn-secondary.send-chat.float-right(v-once, @click='sendMessage()') {{ $t('send') }}
-
         .row.community-guidelines(v-if='!communityGuidelinesAccepted')
           div.col-8(v-once, v-html="$t('communityGuidelinesIntro')")
           div.col-4
             button.btn.btn-info(@click='acceptCommunityGuidelines()', v-once) {{ $t('acceptCommunityGuidelines') }}
-
         .row
           .col-12.hr
           chat-message(:chat.sync='group.chat', :group-id='group._id', group-name='group.name')
@@ -66,75 +62,8 @@
           // @TODO: V2 button.btn.btn-primary(v-once, v-if='!isLeader') {{$t('messageGuildLeader')}} // Suggest making the button visible to the leader too - useful for them to test how the feature works or to send a note to themself. -- Alys
         .button-container
           // @TODO: V2 button.btn.btn-primary(v-once, v-if='isMember && !isParty') {{$t('donateGems')}} // Suggest removing the isMember restriction - it's okay if non-members donate to a public guild. Also probably allow it for parties if parties can buy imagery. -- Alys
-
     .section-header(v-if='isParty')
-      .row
-        .col-10
-          h3(v-once) {{ $t('questDetailsTitle') }}
-        .col-2
-          .toggle-up(@click="sections.quest = !sections.quest", v-if="sections.quest")
-            .svg-icon(v-html="icons.upIcon")
-          .toggle-down(@click="sections.quest = !sections.quest", v-if="!sections.quest")
-            .svg-icon(v-html="icons.downIcon")
-      .section(v-if="sections.quest")
-        .row.no-quest-section(v-if='isParty && !onPendingQuest && !onActiveQuest')
-          .col-12.text-center
-            .svg-icon(v-html="icons.questIcon")
-            h4(v-once) {{ $t('youAreNotOnQuest') }}
-            p(v-once) {{ $t('questDescription') }}
-            button.btn.btn-secondary(v-once, @click="openStartQuestModal()") {{ $t('startAQuest') }}
-        .row.quest-active-section(v-if='isParty && onPendingQuest && !onActiveQuest')
-          .col-2
-            .quest(:class='`inventory_quest_scroll_${questData.key}`')
-          .col-6.titles
-            strong {{ questData.text() }}
-            p {{acceptedCount}} / {{group.memberCount}}
-          .col-4
-            button.btn.btn-secondary(@click="openQuestDetails()") {{ $t('details') }}
-        .row.quest-active-section.quest-invite(v-if='user.party.quest && user.party.quest.RSVPNeeded')
-          span {{ $t('wouldYouParticipate') }}
-          button.btn.btn-primary.accept(@click='questAccept(group._id)') {{$t('accept')}}
-          button.btn.btn-primary.reject(@click='questReject(group._id)') {{$t('reject')}}
-        .row.quest-active-section(v-if='isParty && !onPendingQuest && onActiveQuest')
-          .col-12.text-center
-            .quest-boss(:class="'quest_' + questData.key")
-            h3(v-once) {{ questData.text() }}
-            .quest-box
-              .collect-info(v-if='questData.collect')
-                .row(v-for='(value, key) in questData.collect')
-                  .col-2
-                    div(:class="'quest_' + questData.key + '_' + key")
-                  .col-10
-                    strong {{value.text()}}
-                    .grey-progress-bar
-                      .collect-progress-bar(:style="{width: (group.quest.progress.collect[key] / value.count) * 100 + '%'}")
-                    strong {{group.quest.progress.collect[key]}} / {{value.count}}
-              .boss-info(v-if='questData.boss')
-                .row
-                  .col-6
-                    h4.float-left(v-once) {{ questData.boss.name() }}
-                  .col-6
-                    span.float-right(v-once) {{ $t('participantsTitle') }}
-                .row
-                  .col-12
-                    .grey-progress-bar
-                      .boss-health-bar(:style="{width: (group.quest.progress.hp / questData.boss.hp) * 100 + '%'}")
-                .row.boss-details
-                    .col-6
-                      span.float-left
-                        | {{parseFloat(group.quest.progress.hp).toFixed(2)}} / {{parseFloat(questData.boss.hp).toFixed(2)}}
-                    .col-6(v-if='userIsOnQuest')
-                      // @TODO: Why do we not sync quset progress on the group doc? Each user could have different progress
-                      span.float-right {{parseFloat(user.party.quest.progress.up).toFixed(1) || 0}} pending damage
-                .row.rage-bar-row(v-if='questData.boss.rage')
-                  .col-12
-                    .grey-progress-bar
-                      .boss-health-bar.rage-bar(:style="{width: (group.quest.progress.rage / questData.boss.rage.value) * 100 + '%'}")
-                .row.boss-details.rage-details(v-if='questData.boss.rage')
-                    .col-6
-                      span.float-left {{ $t('rage') }} {{ parseFloat(group.quest.progress.rage).toFixed(2) }} / {{ questData.boss.rage.value }}
-            button.btn.btn-secondary(v-once, @click="questAbort()", v-if='canEditQuest') {{ $t('abort') }}
-
+      quest-sidebar-section(@toggle='toggleQuestSection', :show='sections.quest', :group='group')
     .section-header(v-if='!isParty')
       .row
         .col-10
@@ -146,7 +75,6 @@
             .svg-icon(v-html="icons.downIcon")
       .section(v-if="sections.summary")
         p(v-markdown='group.summary')
-
     .section-header
       .row
         .col-10
@@ -158,7 +86,6 @@
             .svg-icon(v-html="icons.downIcon")
       .section(v-if="sections.description")
         p(v-markdown='group.description')
-
     .section-header.challenge
       .row
         .col-10.information-header
@@ -335,26 +262,6 @@
     margin-right: .3em;
   }
 
-  .no-quest-section {
-    padding: 2em;
-    color: $gray-300;
-
-    h4 {
-      color: $gray-300;
-    }
-
-    p {
-      margin-bottom: 2em;
-    }
-
-    .svg-icon {
-      height: 30px;
-      width: 30px;
-      margin: 0 auto;
-      margin-bottom: 2em;
-    }
-  }
-
   .information-header {
     h3, .tooltip-wrapper {
       display: inline-block;
@@ -366,62 +273,6 @@
     }
   }
 
-  .quest-active-section {
-    .titles {
-        padding-top: .5em;
-    }
-
-    .quest-box {
-      background-image: url('~client/assets/svg/for-css/quest-border.svg');
-      background-size: 100% 100%;
-      width: 100%;
-      padding: .5em;
-      margin-bottom: 1em;
-
-      svg: {
-        width: 100%;
-        height: 100%;
-      }
-    }
-
-    .boss-info, .collect-info {
-      width: 90%;
-      margin: 0 auto;
-      text-align: left;
-    }
-  }
-
-  .quest-invite {
-    background-color: #2995cd;
-    color: #fff;
-    padding: 1em;
-
-    span {
-      margin-top: .3em;
-    	font-size: 14px;
-    	font-weight: bold;
-    }
-
-    .accept, .reject {
-      padding: .2em 1em;
-      font-size: 12px;
-      height: 24px;
-    	border-radius: 2px;
-      box-shadow: 0 2px 2px 0 rgba(26, 24, 29, 0.16), 0 1px 4px 0 rgba(26, 24, 29, 0.12);
-    }
-
-    .accept {
-    	background-color: #24cc8f;
-    	margin-left: 4em;
-      margin-right: .5em;
-    }
-
-    .reject {
-    	border-radius: 2px;
-    	background-color: #f74e52;
-    }
-  }
-
   .section-header {
     border-top: 1px solid #e1e0e3;
     margin-top: 1em;
@@ -438,38 +289,6 @@
     cursor: pointer;
   }
 
-  .quest-boss {
-    margin: 0 auto;
-  }
-
-  .boss-health-bar {
-    width: 80%;
-    background-color: red;
-    height: 15px;
-    margin-bottom: .5em;
-  }
-
-  .rage-details {
-    margin-bottom: 1em;
-  }
-
-  .boss-health-bar.rage-bar {
-    margin-top: 1em;
-    background-color: orange;
-  }
-
-  .grey-progress-bar {
-    width: 100%;
-    height: 15px;
-    background-color: #e1e0e3;
-  }
-
-  .collect-progress-bar {
-    background-color: #24cc8f;
-    height: 15px;
-    max-width: 100%;
-  }
-
   .hr {
     width: 100%;
     height: 20px;
@@ -491,14 +310,13 @@ import * as Analytics from 'client/libs/analytics';
 import membersModal from './membersModal';
 import startQuestModal from './startQuestModal';
 import questDetailsModal from './questDetailsModal';
-import quests from 'common/script/content/quests';
-import percent from 'common/script/libs/percent';
 import groupFormModal from './groupFormModal';
 import inviteModal from './inviteModal';
 import chatMessage from '../chat/chatMessages';
 import autocomplete from '../chat/autoComplete';
 import groupChallenges from '../challenges/groupChallenges';
 import groupGemsModal from 'client/components/groups/groupGemsModal';
+import questSidebarSection from 'client/components/groups/questSidebarSection';
 import markdownDirective from 'client/directives/markdown';
 
 import deleteIcon from 'assets/svg/delete.svg';
@@ -529,6 +347,7 @@ export default {
     autocomplete,
     questDetailsModal,
     groupGemsModal,
+    questSidebarSection,
   },
   directives: {
     markdown: markdownDirective,
@@ -569,21 +388,6 @@ export default {
   },
   computed: {
     ...mapState({user: 'user.data'}),
-    userIsOnQuest () {
-      if (!this.group.quest || !this.group.quest.members) return false;
-      return Boolean(this.group.quest.members[this.user._id]);
-    },
-    acceptedCount () {
-      let count = 0;
-
-      if (!this.group || !this.group.quest) return count;
-
-      for (let uuid in this.group.quest.members) {
-        if (this.group.quest.members[uuid]) count += 1;
-      }
-
-      return count;
-    },
     communityGuidelinesAccepted () {
       return this.user.flags.communityGuidelinesAccepted;
     },
@@ -593,12 +397,6 @@ export default {
     isParty () {
       return this.$route.path.startsWith('/party');
     },
-    onPendingQuest () {
-      return Boolean(this.group.quest.key) && !this.group.quest.active;
-    },
-    onActiveQuest () {
-      return this.group.quest.active;
-    },
     isLeader () {
       return this.user._id === this.group.leader._id;
     },
@@ -608,26 +406,6 @@ export default {
     isMember () {
       return this.isMemberOfGroup(this.user, this.group);
     },
-    canEditQuest () {
-      if (!this.group.quest) return false;
-      let isQuestLeader = this.group.quest.leader === this.user._id;
-      let isPartyLeader = this.group.leader._id === this.user._id;
-      return isQuestLeader || isPartyLeader;
-    },
-    isMemberOfPendingQuest () {
-      let userid = this.user._id;
-      let group = this.group;
-      if (!group.quest || !group.quest.members) return false;
-      if (group.quest.active) return false; // quest is started, not pending
-      return userid in group.quest.members && group.quest.members[userid] !== false;
-    },
-    isMemberOfRunningQuest () {
-      let userid = this.user._id;
-      let group = this.group;
-      if (!group.quest || !group.quest.members) return false;
-      if (!group.quest.active) return false; // quest is pending, not started
-      return group.quest.members[userid];
-    },
     memberProfileName (memberId) {
       let foundMember = find(this.group.members, function findMember (member) {
         return member._id === memberId;
@@ -647,13 +425,6 @@ export default {
       if (!this.group.challenges) return false;
       return this.group.challenges.length === 0;
     },
-    bossHpPercent () {
-      return percent(this.group.quest.progress.hp, this.questData.boss.hp);
-    },
-    questData () {
-      if (!this.group.quest) return {};
-      return quests.quests[this.group.quest.key];
-    },
   },
   mounted () {
     if (!this.searchId) this.searchId = this.groupId;
@@ -726,11 +497,6 @@ export default {
       this._updateCarretPosition(eventUpdate);
     }, 250),
     _updateCarretPosition (eventUpdate) {
-      if (eventUpdate.metaKey && eventUpdate.keyCode === 13) {
-        this.sendMessage();
-        return;
-      }
-
       let text = eventUpdate.target;
       this.getCoord(eventUpdate, text);
     },
@@ -787,12 +553,6 @@ export default {
         // User.clearPMs();
       }
     },
-    openStartQuestModal () {
-      this.$root.$emit('bv::show::modal', 'start-quest-modal');
-    },
-    openQuestDetails () {
-      this.$root.$emit('bv::show::modal', 'quest-details');
-    },
     checkForAchievements () {
       // Checks if user's party has reached 2 players for the first time.
       if (!this.user.achievements.partyUp && this.group.memberCount >= 2) {
@@ -888,28 +648,12 @@ export default {
         startingPage: 'profile',
       });
     },
-    async questAbort () {
-      if (!confirm(this.$t('sureAbort'))) return;
-      if (!confirm(this.$t('doubleSureAbort'))) return;
-      let quest = await this.$store.dispatch('quests:sendAction', {groupId: this.group._id, action: 'quests/abort'});
-      this.group.quest = quest;
-    },
-    async questLeave () {
-      if (!confirm(this.$t('sureLeave'))) return;
-      let quest = await this.$store.dispatch('quests:sendAction', {groupId: this.group._id, action: 'quests/leave'});
-      this.group.quest = quest;
-    },
-    async questAccept (partyId) {
-      let quest = await this.$store.dispatch('quests:sendAction', {groupId: partyId, action: 'quests/accept'});
-      this.user.party.quest = quest;
-    },
-    async questReject (partyId) {
-      let quest = await this.$store.dispatch('quests:sendAction', {groupId: partyId, action: 'quests/reject'});
-      this.user.party.quest = quest;
-    },
     showGroupGems () {
       this.$root.$emit('bv::show::modal', 'group-gems-modal');
     },
+    toggleQuestSection () {
+      this.sections.quest = !this.sections.quest;
+    },
   },
 };
 </script>

website/client/components/groups/groupFormModal.vue

@@ -8,9 +8,7 @@
       .form-group(v-if='workingGroup.id && members.length > 0')
         label
           strong(v-once) {{$t('guildOrPartyLeader')}} *
-        select.form-control(v-model="workingGroup.newLeader")
-          option(v-for='potentialLeader in potentialLeaders', :value="potentialLeader._id") {{ potentialLeader.name }}
-
+        group-member-search-dropdown(:text="currentLeader", :members='members', :groupId='workingGroup.id', @member-selected='selectNewLeader')
       .form-group
         label
           strong(v-once) {{$t('privacySettings')}} *
@@ -170,6 +168,7 @@
 <script>
 import { mapState } from 'client/libs/store';
 import toggleSwitch from 'client/components/ui/toggleSwitch';
+import groupMemberSearchDropdown from 'client/components/members/groupMemberSearchDropdown';
 import markdownDirective from 'client/directives/markdown';
 import gemIcon from 'assets/svg/gem.svg';
 import informationIcon from 'assets/svg/information.svg';
@@ -185,6 +184,7 @@ import { MAX_SUMMARY_SIZE_FOR_GUILDS } from '../../../common/script/constants';
 export default {
   components: {
     toggleSwitch,
+    groupMemberSearchDropdown,
   },
   directives: {
     markdown: markdownDirective,
@@ -307,16 +307,12 @@ export default {
     isParty () {
       return this.workingGroup.type === 'party';
     },
-    potentialLeaders () {
-      let leaders = [{ _id: this.user._id, name: this.user.profile.name }];
-      // @TODO consider pushing all recent posters to the top of the list if they are guild members - more likely to be the ones the leader wants to see (and then ignore them in the while below)
-      let i = 0;
-      while (this.members[i]) {
-        let memb = this.members[i];
-        i++;
-        if (memb._id !== this.user._id) leaders.push({_id: memb._id, name: memb.profile.name});
-      }
-      return leaders;
+    currentLeader () {
+      const currentLeader = this.members.find(member => {
+        return member._id === this.workingGroup.newLeader;
+      });
+      const currentLeaderName = currentLeader.profile ? currentLeader.profile.name : '';
+      return currentLeaderName;
     },
   },
   watch: {
@@ -356,6 +352,9 @@ export default {
     },
   },
   methods: {
+    selectNewLeader (member) {
+      this.workingGroup.newLeader = member._id;
+    },
     async getMembers () {
       if (!this.workingGroup.id) return;
       let members = await this.$store.dispatch('members:getGroupMembers', {

website/client/components/groups/membersModal.vue

@@ -36,7 +36,7 @@ div
               span.dropdown-icon-item
                 .svg-icon.inline(v-html="icons.messageIcon")
                 span.text {{$t('sendMessage')}}
-            b-dropdown-item(@click='promoteToLeader(member._id)', v-if='isLeader')
+            b-dropdown-item(@click='promoteToLeader(member)', v-if='isLeader || isAdmin')
               span.dropdown-icon-item
                 .svg-icon.inline(v-html="icons.starIcon")
                 span.text {{$t('promoteToLeader')}}
@@ -290,6 +290,9 @@ export default {
       if (!this.group || !this.group.leader) return false;
       return this.user._id === this.group.leader || this.user._id === this.group.leader._id;
     },
+    isAdmin () {
+      return Boolean(this.user.contributor.admin);
+    },
     groupIsSubscribed () {
       return this.group.purchased.active;
     },
@@ -440,10 +443,15 @@ export default {
       });
       this.viewMembers();
     },
-    async promoteToLeader (memberId) {
+    async promoteToLeader (member) {
       let groupData = Object.assign({}, this.group);
-      groupData.leader = memberId;
+
+      groupData.leader = member._id;
       await this.$store.dispatch('guilds:update', {group: groupData});
+
+      alert(this.$t('leaderChanged'));
+
+      groupData.leader = member;
       this.$root.$emit('updatedGroup', groupData);
     },
   },