const path = require('path'); const should = require('should'); const supertest = require('supertest'); const sinon = require('sinon'); const testUtils = require('../../utils'); const localUtils = require('./utils'); const config = require('../../../core/shared/config'); const labs = require('../../../core/server/services/labs'); const Papa = require('papaparse'); const settingsCache = require('../../../core/server/services/settings/cache'); const moment = require('moment-timezone'); describe('Members API', function () { let request; after(function () { sinon.restore(); }); before(async function () { await testUtils.startGhost(); request = supertest.agent(config.get('url')); await localUtils.doAuth(request, 'members', 'members:emails'); sinon.stub(labs, 'isSet').withArgs('members').returns(true); }); it('Can browse', async function () { const res = await request .get(localUtils.API.getApiQuery('members/')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(4); localUtils.API.checkResponse(jsonResponse.members[0], 'member', 'stripe'); testUtils.API.isISO8601(jsonResponse.members[0].created_at).should.be.true(); jsonResponse.members[0].created_at.should.be.an.instanceof(String); jsonResponse.meta.pagination.should.have.property('page', 1); jsonResponse.meta.pagination.should.have.property('limit', 15); jsonResponse.meta.pagination.should.have.property('pages', 1); jsonResponse.meta.pagination.should.have.property('total', 4); jsonResponse.meta.pagination.should.have.property('next', null); jsonResponse.meta.pagination.should.have.property('prev', null); }); it('Can browse with filter', async function () { const res = await request .get(localUtils.API.getApiQuery('members/?filter=label:label-1')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(1); localUtils.API.checkResponse(jsonResponse, 'members'); localUtils.API.checkResponse(jsonResponse.members[0], 'member', 'stripe'); localUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination'); }); it('Can browse with search', async function () { const res = await request .get(localUtils.API.getApiQuery('members/?search=member1')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(1); jsonResponse.members[0].email.should.equal('member1@test.com'); localUtils.API.checkResponse(jsonResponse, 'members'); localUtils.API.checkResponse(jsonResponse.members[0], 'member', 'stripe'); localUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination'); }); it('Can browse with paid', async function () { const res = await request .get(localUtils.API.getApiQuery('members/?paid=true')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(2); jsonResponse.members[0].email.should.equal('paid@test.com'); jsonResponse.members[1].email.should.equal('trialing@test.com'); localUtils.API.checkResponse(jsonResponse, 'members'); localUtils.API.checkResponse(jsonResponse.members[0], 'member', 'stripe'); localUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination'); }); it('Can read', async function () { const res = await request .get(localUtils.API.getApiQuery(`members/${testUtils.DataGenerator.Content.members[0].id}/`)) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(1); localUtils.API.checkResponse(jsonResponse.members[0], 'member', 'stripe'); }); it('Can read and include email_recipients', async function () { const res = await request .get(localUtils.API.getApiQuery(`members/${testUtils.DataGenerator.Content.members[0].id}/?include=email_recipients`)) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(1); localUtils.API.checkResponse(jsonResponse.members[0], 'member', ['stripe', 'email_recipients']); jsonResponse.members[0].email_recipients.length.should.equal(1); localUtils.API.checkResponse(jsonResponse.members[0].email_recipients[0], 'email_recipient', ['email']); localUtils.API.checkResponse(jsonResponse.members[0].email_recipients[0].email, 'email'); }); it('Can add', async function () { const member = { name: 'test', email: 'memberTestAdd@test.com', note: 'test note', subscribed: false, labels: ['test-label'] }; const res = await request .post(localUtils.API.getApiQuery(`members/`)) .send({members: [member]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(201); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(1); jsonResponse.members[0].name.should.equal(member.name); jsonResponse.members[0].email.should.equal(member.email); jsonResponse.members[0].note.should.equal(member.note); jsonResponse.members[0].subscribed.should.equal(member.subscribed); testUtils.API.isISO8601(jsonResponse.members[0].created_at).should.be.true(); jsonResponse.members[0].labels.length.should.equal(1); jsonResponse.members[0].labels[0].name.should.equal('test-label'); should.exist(res.headers.location); res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('members/')}${res.body.members[0].id}/`); await request .post(localUtils.API.getApiQuery(`members/`)) .send({members: [member]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(422); }); it('Can edit by id', async function () { const memberToChange = { name: 'change me', email: 'member2Change@test.com', note: 'initial note', subscribed: true }; const memberChanged = { name: 'changed', email: 'cantChangeMe@test.com', note: 'edited note', subscribed: false }; const res = await request .post(localUtils.API.getApiQuery(`members/`)) .send({members: [memberToChange]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(201); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(1); should.exist(res.headers.location); res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('members/')}${res.body.members[0].id}/`); const newMember = jsonResponse.members[0]; const res2 = await request .put(localUtils.API.getApiQuery(`members/${newMember.id}/`)) .send({members: [memberChanged]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res2.headers['x-cache-invalidate']); const jsonResponse2 = res2.body; should.exist(jsonResponse2); should.exist(jsonResponse2.members); jsonResponse2.members.should.have.length(1); localUtils.API.checkResponse(jsonResponse2.members[0], 'member', 'stripe'); jsonResponse2.members[0].name.should.equal(memberChanged.name); jsonResponse2.members[0].email.should.equal(memberChanged.email); jsonResponse2.members[0].email.should.not.equal(memberToChange.email); jsonResponse2.members[0].note.should.equal(memberChanged.note); jsonResponse2.members[0].subscribed.should.equal(memberChanged.subscribed); }); it('Can destroy', async function () { const member = { name: 'test', email: 'memberTestDestroy@test.com' }; const res = await request .post(localUtils.API.getApiQuery(`members/`)) .send({members: [member]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(201); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); const newMember = jsonResponse.members[0]; await request .delete(localUtils.API.getApiQuery(`members/${newMember.id}`)) .set('Origin', config.get('url')) .expect('Cache-Control', testUtils.cacheRules.private) .expect(204); await request .get(localUtils.API.getApiQuery(`members/${newMember.id}/`)) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(404); }); it('Can export CSV', async function () { const res = await request .get(localUtils.API.getApiQuery(`members/upload/`)) .set('Origin', config.get('url')) .expect('Content-Type', /text\/csv/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); res.headers['content-disposition'].should.match(/Attachment;\sfilename="members/); res.text.should.match(/id,email,name,note,subscribed_to_emails,complimentary_plan,stripe_customer_id,created_at,deleted_at/); const csv = Papa.parse(res.text, {header: true}); should.exist(csv.data.find(row => row.name === 'Mr Egg')); should.exist(csv.data.find(row => row.name === 'Egon Spengler')); should.exist(csv.data.find(row => row.name === 'Ray Stantz')); should.exist(csv.data.find(row => row.email === 'member2@test.com')); }); it('Can export a filtered CSV', async function () { const res = await request .get(localUtils.API.getApiQuery(`members/upload/?search=Egg`)) .set('Origin', config.get('url')) .expect('Content-Type', /text\/csv/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); res.headers['content-disposition'].should.match(/Attachment;\sfilename="members/); res.text.should.match(/id,email,name,note,subscribed_to_emails,complimentary_plan,stripe_customer_id,created_at,deleted_at/); const csv = Papa.parse(res.text, {header: true}); should.exist(csv.data.find(row => row.name === 'Mr Egg')); should.not.exist(csv.data.find(row => row.name === 'Egon Spengler')); should.not.exist(csv.data.find(row => row.name === 'Ray Stantz')); should.not.exist(csv.data.find(row => row.email === 'member2@test.com')); }); it('Can import CSV', async function () { const res = await request .post(localUtils.API.getApiQuery(`members/upload/`)) .attach('membersfile', path.join(__dirname, '/../../utils/fixtures/csv/valid-members-import.csv')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(201); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.meta); should.exist(jsonResponse.meta.stats); jsonResponse.meta.stats.imported.should.equal(2); jsonResponse.meta.stats.invalid.length.should.equal(0); jsonResponse.meta.import_label.name.should.match(/^Import \d{4}-\d{2}-\d{2} \d{2}:\d{2}$/); const importLabel = jsonResponse.meta.import_label; // check that members had the auto-generated label attached const res2 = await request.get(localUtils.API.getApiQuery(`members/?filter=label:${importLabel.slug}`)) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); const jsonResponse2 = res2.body; should.exist(jsonResponse2); should.exist(jsonResponse2.members); jsonResponse2.members.should.have.length(2); const importedMember1 = jsonResponse2.members.find(m => m.email === 'jbloggs@example.com'); should.exist(importedMember1); importedMember1.name.should.equal('joe'); should(importedMember1.note).equal(null); importedMember1.subscribed.should.equal(true); importedMember1.labels.length.should.equal(1); testUtils.API.isISO8601(importedMember1.created_at).should.be.true(); importedMember1.comped.should.equal(false); importedMember1.stripe.should.not.be.undefined(); importedMember1.stripe.subscriptions.length.should.equal(0); const importedMember2 = jsonResponse2.members.find(m => m.email === 'test@example.com'); should.exist(importedMember2); importedMember2.name.should.equal('test'); should(importedMember2.note).equal('test note'); importedMember2.subscribed.should.equal(false); importedMember2.labels.length.should.equal(2); testUtils.API.isISO8601(importedMember2.created_at).should.be.true(); importedMember2.created_at.should.equal('1991-10-02T20:30:31.000Z'); importedMember2.comped.should.equal(false); importedMember2.stripe.should.not.be.undefined(); importedMember2.stripe.subscriptions.length.should.equal(0); }); async function fetchStats() { const res = await request .get(localUtils.API.getApiQuery('members/stats/')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200); should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.total); should.exist(jsonResponse.total_in_range); should.exist(jsonResponse.total_on_date); should.exist(jsonResponse.new_today); // 4 from fixtures, 2 from above posts, 2 from above import jsonResponse.total.should.equal(8); return jsonResponse; } function parseTotalOnDate(jsonResponse) { // replicate default look back date of 30 days const days = 30; // grab the timezone as mocked above const siteTimezone = settingsCache.get('timezone'); // rebuild a valid response object such that works on any date-time... // get the start date let currentRangeDate = moment.tz(siteTimezone).subtract(days - 1, 'days'); // get the end date but ignore today because we want to set that value ourselves let endDate = moment.tz(siteTimezone).subtract(1, 'hour'); const output = {}; let dateStr; // set user count to be 1 for all dates before today to match date as outlined // for the user in valid-members-import.csv who was imported with a start date of '91 while (currentRangeDate.isBefore(endDate)) { dateStr = currentRangeDate.format('YYYY-MM-DD'); output[dateStr] = 1; currentRangeDate = currentRangeDate.add(1, 'day'); } // format the date for the end date (right now) dateStr = currentRangeDate.format('YYYY-MM-DD'); // set the end date to match the number of members added from fixtures posts and imports // 4 from fixtures, 2 from above posts, 2 from above import output[dateStr] = 8; // deep equality check that the objects match... jsonResponse.total_on_date.should.eql(output); } it('Can fetch stats', function () { return fetchStats(); }); it('Can render stats in GMT -X timezones', async function () { // stub the method const stub = sinon.stub(settingsCache, 'get'); // this was just a GMT -X Timezone picked at random for the test below... stub .withArgs('timezone') .returns('America/Caracas'); const jsonResponse = await fetchStats(); parseTotalOnDate(jsonResponse); // restore the stub so we can use it in other tests stub.restore(); }); it('Can render stats in GMT +X timezones', async function () { // stub the method const stub = sinon.stub(settingsCache, 'get'); // the tester that wrote this lives in Adelaide so shoutout to this (random) timezone! stub .withArgs('timezone') .returns('Australia/Adelaide'); const jsonResponse = await fetchStats(); parseTotalOnDate(jsonResponse); // restore the stub so we can use it in other tests stub.restore(); }); });