Merge branch 'api-v3-open-mystery-item' of https://github.com/TheHollidayInn/habitrpg into TheHollidayInn-api-v3-open-mystery-item3

common/locales/en/api-v3.json

@@ -140,5 +140,7 @@
   "notAllowedHourglass": "Pet/Mount not available for purchase with Mystic Hourglass.",
   "readCard": "<%= cardType %> has been read",
   "cardTypeRequired": "Card type required",
-  "cardTypeNotAllowed": "Unkown card type."
+  "cardTypeNotAllowed": "Unkown card type.",
+  "mysteryItemIsEmpty": "Mystery items are empty",
+  "mysteryItemOpened": "Mystery item opened."
 }

common/script/index.js

@@ -117,6 +117,7 @@ import disableClasses from './ops/disableClasses';
 import purchase from './ops/purchase';
 import purchaseHourglass from './ops/hourglassPurchase';
 import readCard from './ops/readCard';
+import openMysteryItem from './ops/openMysteryItem';
 
 api.ops = {
   scoreTask,
@@ -135,6 +136,7 @@ api.ops = {
   purchase,
   purchaseHourglass,
   readCard,
+  openMysteryItem,
 };
 
 import handleTwoHanded from './fns/handleTwoHanded';

common/script/ops/openMysteryItem.js

@@ -1,32 +1,40 @@
 import content from '../content/index';
+import i18n from '../i18n';
+import {
+  BadRequest,
+} from '../libs/errors';
+import _ from 'lodash';
+
+module.exports = function openMysteryItem (user, req = {}, analytics) {
+  let item = user.purchased.plan.mysteryItems.shift();
 
-module.exports = function(user, req, cb, analytics) {
-  var analyticsData, item, ref, ref1;
-  item = (ref = user.purchased.plan) != null ? (ref1 = ref.mysteryItems) != null ? ref1.shift() : void 0 : void 0;
   if (!item) {
-    return typeof cb === "function" ? cb({
-      code: 400,
-      message: "Empty"
-    }) : void 0;
-  }
-  item = content.gear.flat[item];
-  user.items.gear.owned[item.key] = true;
-  if (typeof user.markModified === "function") {
-    user.markModified('purchased.plan.mysteryItems');
+    throw new BadRequest(i18n.t('mysteryItemIsEmpty', req.language));
   }
+
+  item = _.cloneDeep(content.gear.flat[item]);
   item.notificationType = 'Mystery';
-  analyticsData = {
+  user.items.gear.owned[item.key] = true;
+
+  user.markModified('purchased.plan.mysteryItems');
+
+  if (analytics) {
+    analytics.track('open mystery item', {
       uuid: user._id,
       itemKey: item,
       itemType: 'Subscriber Gear',
       acquireMethod: 'Subscriber',
-    category: 'behavior'
-  };
-  if (analytics != null) {
-    analytics.track('open mystery item', analyticsData);
+      category: 'behavior',
+    });
   }
+
   if (typeof window !== 'undefined') {
-    (user._tmp != null ? user._tmp : user._tmp = {}).drop = item;
+    if (!user._tmp) user._tmp = {};
+    user._tmp.drop = item;
   }
-  return typeof cb === "function" ? cb(null, user.items.gear.owned) : void 0;
+
+  return {
+    message: i18n.t('mysteryItemOpened', req.language),
+    data: user.items.gear.owned,
+  };
 };

tasks/gulp-eslint.js

@@ -28,8 +28,6 @@ const COMMON_FILES = [
   '!./common/script/ops/deleteWebhook.js',
   '!./common/script/ops/getTag.js',
   '!./common/script/ops/getTags.js',
-  '!./common/script/ops/openMysteryItem.js',
-  '!./common/script/ops/readCard.js',
   '!./common/script/ops/rebirth.js',
   '!./common/script/ops/releaseBoth.js',
   '!./common/script/ops/releaseMounts.js',

test/api/v3/integration/user/POST-user_open_mystery_item.test.js

@@ -0,0 +1,26 @@
+import {
+  generateUser,
+  translate as t,
+} from '../../../../helpers/api-integration/v3';
+
+describe('POST /user/open-mystery-item', () => {
+  let user;
+  let mysteryItemKey = 'eyewear_special_summerRogue';
+
+  beforeEach(async () => {
+    user = await generateUser({
+      'purchased.plan.mysteryItems': [mysteryItemKey],
+    });
+  });
+
+  // More tests in common code unit tests
+
+  it('opens a mystery item', async () => {
+    let response = await user.post(`/user/open-mystery-item`);
+    await user.sync();
+
+    expect(user.items.gear.owned[mysteryItemKey]).to.be.true;
+    expect(response.message).to.equal(t('mysteryItemOpened'));
+    expect(response.data).to.deep.equal(user.items.gear.owned);
+  });
+});

test/common/ops/openMysteryItem.js

@@ -0,0 +1,38 @@
+import openMysteryItem from '../../../common/script/ops/openMysteryItem';
+import {
+  generateUser,
+} from '../../helpers/common.helper';
+import {
+  BadRequest,
+} from '../../../common/script/libs/errors';
+import i18n from '../../../common/script/i18n';
+
+describe('shared.ops.openMysteryItem', () => {
+  let user;
+
+  beforeEach(() => {
+    user = generateUser();
+  });
+
+  it('returns error when item key is empty', (done) => {
+    try {
+      openMysteryItem(user);
+    } catch (err) {
+      expect(err).to.be.an.instanceof(BadRequest);
+      expect(err.message).to.equal(i18n.t('mysteryItemIsEmpty'));
+      done();
+    }
+  });
+
+  it('opens mystery item', () => {
+    let mysteryItemKey = 'eyewear_special_summerRogue';
+
+    user.purchased.plan.mysteryItems = [mysteryItemKey];
+
+    let response = openMysteryItem(user);
+
+    expect(user.items.gear.owned[mysteryItemKey]).to.be.true;
+    expect(response.message).to.equal(i18n.t('mysteryItemOpened'));
+    expect(response.data).to.equal(user.items.gear.owned);
+  });
+});

website/src/controllers/api-v3/user.js

@@ -677,7 +677,6 @@ api.disableClasses = {
 };
 
 /**
-<<<<<<< HEAD
 * @api {post} /user/purchase/:type/:key Purchase Gem Items.
 * @apiVersion 3.0.0
 * @apiName UserPurchase
@@ -745,4 +744,24 @@ api.readCard = {
   },
 };
 
+/**
+* @api {post} /user/open-mystery-item Open the mystery item.
+* @apiVersion 3.0.0
+* @apiName UserOpenMysteryItem
+* @apiGroup User
+*
+* @apiSuccess {Object} data `user.items.gear.owned`
+*/
+api.userOpenMysteryItem = {
+  method: 'POST',
+  middlewares: [authWithHeaders(), cron],
+  url: '/user/open-mystery-item',
+  async handler (req, res) {
+    let user = res.locals.user;
+    let openMysteryItemResponse = common.ops.openMysteryItem(user, req, res.analytics);
+    await user.save();
+    res.respond(200, openMysteryItemResponse);
+  },
+};
+
 module.exports = api;