From 81ac45f2a7ccabc8b31ae5856592894ff3a24109 Mon Sep 17 00:00:00 2001 From: Blade Barringer Date: Sun, 26 Jun 2016 08:08:49 -0500 Subject: [PATCH] fix(api): Grant remaining perks when canceling an Amazon subscription * Add tests for payments lib * Add placeholder it blocks to be filled in closes #7660 closes #4840 --- test/api/v3/unit/libs/payments.test.js | 239 ++++++++++++++---- .../controllers/top-level/payments/amazon.js | 5 +- website/server/libs/api-v3/payments.js | 6 +- website/server/models/user/schema.js | 2 +- 4 files changed, 203 insertions(+), 49 deletions(-) diff --git a/test/api/v3/unit/libs/payments.test.js b/test/api/v3/unit/libs/payments.test.js index c5553c3e77..cd4d52face 100644 --- a/test/api/v3/unit/libs/payments.test.js +++ b/test/api/v3/unit/libs/payments.test.js @@ -4,84 +4,233 @@ import { model as User } from '../../../../../website/server/models/user'; import moment from 'moment'; describe('payments/index', () => { - let fakeSend; - let data; - let user; - describe('#createSubscription', () => { - const MYSTERY_AWARD_COUNT = 2; - const MYSTERY_AWARD_UNIX_TIME = 1464725113000; - let fakeClock; + let user; beforeEach(async () => { user = new User(); - fakeClock = sinon.useFakeTimers(MYSTERY_AWARD_UNIX_TIME); }); - afterEach(() => { - fakeClock.restore(); + context('Purchasing a subscription as a gift', () => { + it('adds extra months to an existing subscription'); + + it('sets a dateTerminated date for a user without an existing subscription'); + + it('sets plan.dateUpdated if it did not previously exist'); + + it('does not change plan.customerId if it already exists'); + + it('sets plan.customerId to "Gift" if it does not already exist'); + + it('increases the buyer\'s transaction count'); + + it('sends a private message about the gift'); + + it('sends an email about the gift'); + + it('sends a push notification about the gift'); + + it('tracks subscription purchase as gift (if prod)'); }); - it('succeeds', async () => { - data = { user, sub: { key: 'basic_3mo' } }; - expect(user.purchased.plan.planId).to.not.exist; - await api.createSubscription(data); - expect(user.purchased.plan.planId).to.exist; + context('Purchasing a subscription for self', () => { + it('creates a subscription', async () => { + let data = { + user, + sub: { + key: 'basic_3mo', + }, + customerId: 'customer-id', + paymentMethod: 'Payment Method', + }; + + expect(user.purchased.plan.planId).to.not.exist; + + await api.createSubscription(data); + + expect(user.purchased.plan.planId).to.eql('basic_3mo'); + expect(user.purchased.plan.customerId).to.eql('customer-id'); + expect(user.purchased.plan.dateUpdated).to.exist; + expect(user.purchased.plan.gemsBought).to.eql(0); + expect(user.purchased.plan.paymentMethod).to.eql('Payment Method'); + expect(user.purchased.plan.extraMonths).to.eql(0); + expect(user.purchased.plan.dateTerminated).to.eql(null); + expect(user.purchased.plan.lastBillingDate).to.not.exist; + expect(user.purchased.plan.dateCreated).to.exist; + }); + + it('sets extraMonths if plan has dateTerminated date'); + + it('sets lastBillingDate if payment method is "Amazon Payments"'); + + it('increases the user\'s transcation count'); + + it('sends a transaction email (if prod)'); + + it('tracks subscription purchase (if prod)'); }); - it('awards mystery items', async () => { - data = { user, sub: { key: 'basic_3mo' } }; - await api.createSubscription(data); - expect(user.purchased.plan.mysteryItems.length).to.eql(MYSTERY_AWARD_COUNT); + context('Block subscription perks', () => { + it('adds block months to plan.consecutive.offset'); + + it('does not add to plans.consecutive.offset if 1 month subscription'); + + it('adds 5 to plan.consecutive.gemCapExtra for every 3 months'); + + it('does not raise plan.consecutive.gemCapExtra higher than 25'); + + it('adds a plan.consecutive.trinkets for every 3 months'); + }); + + context('Mystery Items', () => { + it('awards mystery items when within the timeframe for a mystery item', async () => { + let mayMysteryItemTimeframe = 1464725113000; // May 31st 2016 + let fakeClock = sinon.useFakeTimers(mayMysteryItemTimeframe); + let data = { user, sub: { key: 'basic_3mo' } }; + + await api.createSubscription(data); + + expect(user.purchased.plan.mysteryItems).to.have.a.lengthOf(2); + expect(user.purchased.plan.mysteryItems).to.include('armor_mystery_201605'); + expect(user.purchased.plan.mysteryItems).to.include('head_mystery_201605'); + + fakeClock.restore(); + }); + + it('does not awards mystery items when not within the timeframe for a mystery item', async () => { + const noMysteryItemTimeframe = 1462183920000; // May 2nd 2016 + let fakeClock = sinon.useFakeTimers(noMysteryItemTimeframe); + let data = { user, sub: { key: 'basic_3mo' } }; + + await api.createSubscription(data); + + expect(user.purchased.plan.mysteryItems).to.have.a.lengthOf(0); + + fakeClock.restore(); + }); + + it('does not award mystery item when user already owns the item', async () => { + let mayMysteryItemTimeframe = 1464725113000; // May 31st 2016 + let fakeClock = sinon.useFakeTimers(mayMysteryItemTimeframe); + let mayMysteryItem = 'armor_mystery_201605'; + user.items.gear.owned[mayMysteryItem] = true; + + let data = { user, sub: { key: 'basic_3mo' } }; + + await api.createSubscription(data); + + expect(user.purchased.plan.mysteryItems).to.have.a.lengthOf(1); + expect(user.purchased.plan.mysteryItems).to.include('head_mystery_201605'); + + fakeClock.restore(); + }); + + it('does not award mystery item when user already has the item in the mystery box', async () => { + let mayMysteryItemTimeframe = 1464725113000; // May 31st 2016 + let fakeClock = sinon.useFakeTimers(mayMysteryItemTimeframe); + let mayMysteryItem = 'armor_mystery_201605'; + user.purchased.plan.mysteryItems = [mayMysteryItem]; + + sandbox.spy(user.purchased.plan.mysteryItems, 'push'); + + let data = { user, sub: { key: 'basic_3mo' } }; + + await api.createSubscription(data); + + expect(user.purchased.plan.mysteryItems.push).to.be.calledOnce; + expect(user.purchased.plan.mysteryItems.push).to.be.calledWith('head_mystery_201605'); + + fakeClock.restore(); + }); }); }); describe('#cancelSubscription', () => { + let data, user; + beforeEach(() => { - fakeSend = sinon.spy(sender, 'sendTxn'); - data = { user: new User() }; + sandbox.spy(sender, 'sendTxn'); + user = new User(); + data = { user }; }); afterEach(() => { - fakeSend.restore(); + sandbox.restore(); }); - it('plan.extraMonths is defined', () => { + it('adds a month termination date by default', () => { api.cancelSubscription(data); - let terminated = data.user.purchased.plan.dateTerminated; - data.user.purchased.plan.extraMonths = 2; - api.cancelSubscription(data); - let difference = Math.abs(moment(terminated).diff(data.user.purchased.plan.dateTerminated, 'days')); - expect(difference - 60).to.be.lessThan(3); // the difference is approximately two months, +/- 2 days + + let now = new Date(); + let daysTillTermination = moment(user.purchased.plan.dateTerminated).diff(now, 'days'); + + expect(daysTillTermination).to.be.within(29, 30); // 1 month +/- 1 days }); - it('plan.extraMonth is a fraction', () => { + it('adds extraMonths to dateTerminated value', () => { + user.purchased.plan.extraMonths = 2; + api.cancelSubscription(data); - let terminated = data.user.purchased.plan.dateTerminated; - data.user.purchased.plan.extraMonths = 0.3; - api.cancelSubscription(data); - let difference = Math.abs(moment(terminated).diff(data.user.purchased.plan.dateTerminated, 'days')); - expect(difference - 10).to.be.lessThan(3); // the difference should be 10 days. + + let now = new Date(); + let daysTillTermination = moment(user.purchased.plan.dateTerminated).diff(now, 'days'); + + expect(daysTillTermination).to.be.within(89, 90); // 3 months +/- 1 days }); - it('nextBill is defined', () => { + it('handles extra month fractions', () => { + user.purchased.plan.extraMonths = 0.3; + api.cancelSubscription(data); - let terminated = data.user.purchased.plan.dateTerminated; - data.nextBill = moment().add({ days: 25 }); - api.cancelSubscription(data); - let difference = Math.abs(moment(terminated).diff(data.user.purchased.plan.dateTerminated, 'days')); - expect(difference - 5).to.be.lessThan(2); // the difference should be 5 days, +/- 1 day + + let now = new Date(); + let daysTillTermination = moment(user.purchased.plan.dateTerminated).diff(now, 'days'); + + expect(daysTillTermination).to.be.within(38, 39); // should be about 1 month + 1/3 month }); - it('saves the canceled subscription for the user', () => { - expect(data.user.purchased.plan.dateTerminated).to.not.exist; + it('terminates at next billing date if it exists', () => { + data.nextBill = moment().add({ days: 15 }); + api.cancelSubscription(data); - expect(data.user.purchased.plan.dateTerminated).to.exist; + + let now = new Date(); + let daysTillTermination = moment(user.purchased.plan.dateTerminated).diff(now, 'days'); + + expect(daysTillTermination).to.be.within(13, 15); }); - it('sends a text', async () => { + it('resets plan.extraMonths', () => { + user.purchased.plan.extraMonths = 5; + + api.cancelSubscription(data); + + expect(user.purchased.plan.extraMonths).to.eql(0); + }); + + it('sends an email', async () => { await api.cancelSubscription(data); - sinon.assert.called(fakeSend); + + expect(sender.sendTxn).to.be.calledOnce; + expect(sender.sendTxn).to.be.calledWith(user, 'cancel-subscription'); + }); + }); + + describe('#buyGems', () => { + context('Self Purchase', () => { + it('amount property defaults to 5'); + + it('sends a donation email (if prod)'); + }); + + context('Gift', () => { + it('calculates balance from gem amount if gift'); + + it('sends a gifted-gems email (if prod)'); + + it('sends a message from purchaser to recipient'); + + it('sends a push notification if user did not gift to self'); }); }); }); diff --git a/website/server/controllers/top-level/payments/amazon.js b/website/server/controllers/top-level/payments/amazon.js index a22618fa23..b1bf9390bb 100644 --- a/website/server/controllers/top-level/payments/amazon.js +++ b/website/server/controllers/top-level/payments/amazon.js @@ -239,9 +239,12 @@ api.subscribeCancel = { AmazonBillingAgreementId: billingAgreementId, }); + let subscriptionBlock = shared.content.subscriptionBlocks[user.purchased.plan.planId]; + let subscriptionLength = subscriptionBlock.months * 30; + await payments.cancelSubscription({ user, - nextBill: moment(user.purchased.plan.lastBillingDate).add({ days: 30 }), + nextBill: moment(user.purchased.plan.lastBillingDate).add({ days: subscriptionLength }), paymentMethod: 'Amazon Payments', }); diff --git a/website/server/libs/api-v3/payments.js b/website/server/libs/api-v3/payments.js index ea1a979a30..4e45870f81 100644 --- a/website/server/libs/api-v3/payments.js +++ b/website/server/libs/api-v3/payments.js @@ -127,14 +127,16 @@ api.cancelSubscription = async function cancelSubscription (data) { let plan = data.user.purchased.plan; let now = moment(); let remaining = data.nextBill ? moment(data.nextBill).diff(new Date(), 'days') : 30; + let extraDays = Math.ceil(30 * plan.extraMonths); let nowStr = `${now.format('MM')}/${moment(plan.dateUpdated).format('DD')}/${now.format('YYYY')}`; let nowStrFormat = 'MM/DD/YYYY'; plan.dateTerminated = moment(nowStr, nowStrFormat) - .add({days: remaining}) // end their subscription 1mo from their last payment - .add({days: Math.ceil(30 * plan.extraMonths)}) // plus any extra time (carry-over, gifted subscription, etc) they have. + .add({days: remaining}) + .add({days: extraDays}) .toDate(); + plan.extraMonths = 0; // clear extra time. If they subscribe again, it'll be recalculated from p.dateTerminated await data.user.save(); diff --git a/website/server/models/user/schema.js b/website/server/models/user/schema.js index 803d2ed1f4..ab827c4405 100644 --- a/website/server/models/user/schema.js +++ b/website/server/models/user/schema.js @@ -523,4 +523,4 @@ let schema = new Schema({ minimize: false, // So empty objects are returned }); -module.exports = schema; \ No newline at end of file +module.exports = schema;