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 ghost = testUtils.startGhost; let request; describe('Members API', function () { before(function () { sinon.stub(labs, 'isSet').withArgs('members').returns(true); }); after(function () { sinon.restore(); }); before(function () { return ghost() .then(function () { request = supertest.agent(config.get('url')); }) .then(function () { return localUtils.doAuth(request, 'members'); }); }); it('Can browse', function () { return request .get(localUtils.API.getApiQuery('members/')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200) .then((res) => { 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', function () { return 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) .then((res) => { 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', function () { return 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) .then((res) => { 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', function () { return 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) .then((res) => { 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', function () { return 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) .then((res) => { 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 add', function () { const member = { name: 'test', email: 'memberTestAdd@test.com', note: 'test note', subscribed: false, labels: ['test-label'] }; return 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) .then((res) => { 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}/`); }) .then(() => { return 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', 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 }; return 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) .then((res) => { 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}/`); return jsonResponse.members[0]; }) .then((newMember) => { return 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) .then((res) => { 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'); jsonResponse.members[0].name.should.equal(memberChanged.name); jsonResponse.members[0].email.should.equal(memberChanged.email); jsonResponse.members[0].email.should.not.equal(memberToChange.email); jsonResponse.members[0].note.should.equal(memberChanged.note); jsonResponse.members[0].subscribed.should.equal(memberChanged.subscribed); }); }); }); it('Can destroy', function () { const member = { name: 'test', email: 'memberTestDestroy@test.com' }; return 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) .then((res) => { should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); return jsonResponse.members[0]; }) .then((newMember) => { return request .delete(localUtils.API.getApiQuery(`members/${newMember.id}`)) .set('Origin', config.get('url')) .expect('Cache-Control', testUtils.cacheRules.private) .expect(204) .then(() => newMember); }) .then((newMember) => { return 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 validate import data', function () { const member = { name: 'test', email: 'memberTestAdd@test.com' }; return request .post(localUtils.API.getApiQuery(`members/upload/validate`)) .send({members: [member]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200) .then((res) => { should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.not.exist(jsonResponse.members); }); }); it('Fails to validate import data when stripe_customer_id is present but Stripe is not connected', function () { const member = { name: 'test', email: 'memberTestAdd@test.com', stripe_customer_id: 'cus_XXXXX' }; return request .post(localUtils.API.getApiQuery(`members/upload/validate`)) .send({members: [member]}) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(422) .then((res) => { should.not.exist(res.headers['x-cache-invalidate']); const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.errors); jsonResponse.errors[0].message.should.match(/Missing Stripe connection/i); jsonResponse.errors[0].context.should.match(/no Stripe account connected/i); }); }); 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', function () { return 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) .then((res) => { 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.count.should.equal(2); jsonResponse.meta.stats.invalid.count.should.equal(0); jsonResponse.meta.import_label.name.should.match(/^Import \d{4}-\d{2}-\d{2} \d{2}:\d{2}$/); return jsonResponse.meta.import_label; }).then((importLabel) => { // check that members had the auto-generated label attached return 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) .then((res) => { const jsonResponse = res.body; should.exist(jsonResponse); should.exist(jsonResponse.members); jsonResponse.members.should.have.length(2); const importedMember1 = jsonResponse.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 = jsonResponse.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); }); }); }); it('Can fetch stats', function () { return request .get(localUtils.API.getApiQuery('members/stats/')) .set('Origin', config.get('url')) .expect('Content-Type', /json/) .expect('Cache-Control', testUtils.cacheRules.private) .expect(200) .then((res) => { 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); }); }); });