Ghost/test/api-acceptance/admin/integrations_spec.js

const _ = require('lodash');
const should = require('should');
const supertest = require('supertest');
const config = require('../../../core/shared/config');
const testUtils = require('../../utils');
const localUtils = require('./utils');

const ghost = testUtils.startGhost;

describe('Integrations API', function () {
    let request;

    before(function () {
        return ghost()
            .then(() => {
                request = supertest.agent(config.get('url'));
            })
            .then(() => {
                return localUtils.doAuth(request, 'integrations');
            });
    });

    const findBy = (prop, val) => object => object[prop] === val;

    it('Can browse all integrations', function (done) {
        request.get(localUtils.API.getApiQuery(`integrations/`))
            .set('Origin', config.get('url'))
            .expect('Content-Type', /json/)
            .expect('Cache-Control', testUtils.cacheRules.private)
            .expect(200)
            .end(function (err, {body}) {
                if (err) {
                    return done(err);
                }

                should.equal(body.integrations.length, 2);

                // there is no enforced order for integrations which makes order different on SQLite and MySQL
                const zapierIntegration = _.find(body.integrations, {name: 'Zapier'}); // from migrations
                should.exist(zapierIntegration);

                const testIntegration = _.find(body.integrations, {name: 'Test Integration'}); // from fixtures
                should.exist(testIntegration);

                done();
            });
    });

    it('Can not read internal integration', function () {
        return request.get(localUtils.API.getApiQuery(`integrations/${testUtils.DataGenerator.Content.integrations[1].id}/`))
            .set('Origin', config.get('url'))
            .expect('Content-Type', /json/)
            .expect('Cache-Control', testUtils.cacheRules.private)
            .expect(404);
    });

    it('Can successfully create a single integration with auto generated content and admin api key', function (done) {
        request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Dis-Integrate!!'
                }]
            })
            .expect('Content-Type', /json/)
            .expect('Cache-Control', testUtils.cacheRules.private)
            .expect(201)
            .end(function (err, res) {
                if (err) {
                    return done(err);
                }

                should.equal(res.body.integrations.length, 1);

                const [integration] = res.body.integrations;
                should.equal(integration.name, 'Dis-Integrate!!');

                should.equal(integration.api_keys.length, 2);

                const contentApiKey = integration.api_keys.find(findBy('type', 'content'));
                should.equal(contentApiKey.integration_id, integration.id);

                const adminApiKey = integration.api_keys.find(findBy('type', 'admin'));
                should.equal(adminApiKey.integration_id, integration.id);
                should.exist(adminApiKey.secret);

                // check Admin API key secret format
                const [id, secret] = adminApiKey.secret.split(':');
                should.exist(id);
                should.equal(id, adminApiKey.id);
                should.exist(secret);
                secret.length.should.equal(64);

                should.exist(res.headers.location);
                res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('integrations/')}${res.body.integrations[0].id}/`);

                done();
            });
    });

    it('Can successfully create a single integration with a webhook', function (done) {
        request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Integratatron4000',
                    webhooks: [{
                        event: 'something',
                        target_url: 'http://example.com'
                    }]
                }]
            })
            .expect('Content-Type', /json/)
            .expect('Cache-Control', testUtils.cacheRules.private)
            .expect(201)
            .end(function (err, res) {
                if (err) {
                    return done(err);
                }

                should.equal(res.body.integrations.length, 1);

                const [integration] = res.body.integrations;
                should.equal(integration.name, 'Integratatron4000');

                should.equal(integration.webhooks.length, 1);

                const webhook = integration.webhooks[0];
                should.equal(webhook.integration_id, integration.id);

                should.exist(res.headers.location);
                res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('integrations/')}${res.body.integrations[0].id}/`);

                done();
            });
    });

    it('Can successfully get a created integration', function () {
        return request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Interrogation Integration'
                }]
            })
            .expect(201)
            .then(function ({body}) {
                const [createdIntegration] = body.integrations;

                return createdIntegration;
            })
            .then((createdIntegration) => {
                return request.get(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200)
                    .then(function ({body}) {
                        should.equal(body.integrations.length, 1);

                        const [integration] = body.integrations;

                        should.equal(integration.id, createdIntegration.id);
                        should.equal(integration.name, createdIntegration.name);
                        should.equal(integration.slug, createdIntegration.slug);
                        should.equal(integration.description, createdIntegration.description);
                        should.equal(integration.icon_image, createdIntegration.icon_image);
                    });
            });
    });

    it('Can successfully get *all* created integrations with api_keys', function () {
        return request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Integrate with this!'
                }]
            })
            .expect(201)
            .then(function () {
                return request.post(localUtils.API.getApiQuery('integrations/'))
                    .set('Origin', config.get('url'))
                    .send({
                        integrations: [{
                            name: 'Winter-(is)-great'
                        }]
                    })
                    .expect(201);
            })
            .then(function () {
                return request.get(localUtils.API.getApiQuery(`integrations/?include=api_keys&limit=all`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200)
                    .then(function ({body}) {
                        // This is the only page
                        should.equal(body.meta.pagination.page, 1);
                        should.equal(body.meta.pagination.pages, 1);
                        should.equal(body.meta.pagination.next, null);
                        should.equal(body.meta.pagination.prev, null);

                        body.integrations.forEach((integration) => {
                            should.exist(integration.api_keys);
                        });
                    });
            });
    });

    it('Can successfully edit a created integration', function () {
        let createdIntegration;

        return request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Rubbish Integration Name'
                }]
            })
            .expect(201)
            .then(function ({body}) {
                [createdIntegration] = body.integrations;

                return request.put(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                    .set('Origin', config.get('url'))
                    .send({
                        integrations: [{
                            name: 'Awesome Integration Name',
                            description: 'Finally got round to writing this...'
                        }]
                    })
                    .expect(200);
            })
            .then(function () {
                return request.get(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200);
            })
            .then(function ({body}) {
                const [updatedIntegration] = body.integrations;

                should.equal(updatedIntegration.id, createdIntegration.id);
                should.equal(updatedIntegration.name, 'Awesome Integration Name');
                should.equal(updatedIntegration.description, 'Finally got round to writing this...');
            });
    });

    it('Can successfully refresh an integration api key', function () {
        let createdIntegration;
        let apiKeys;
        let adminApiKey;

        return request.post(localUtils.API.getApiQuery('integrations/?include=api_keys'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Rubbish Integration Name'
                }]
            })
            .expect(201)
            .then(function ({body}) {
                [createdIntegration] = body.integrations;
                apiKeys = createdIntegration.api_keys;
                adminApiKey = apiKeys.find(key => key.type === 'admin');

                return request.post(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/api_key/${adminApiKey.id}/refresh`))
                    .set('Origin', config.get('url'))
                    .send({
                        integrations: [{
                            id: createdIntegration.id
                        }]
                    })
                    .expect(200);
            })
            .then(function () {
                return request.get(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/?include=api_keys`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200);
            })
            .then(function ({body}) {
                const [updatedIntegration] = body.integrations;
                const updatedAdminApiKey = updatedIntegration.api_keys.find(key => key.type === 'admin');
                should.equal(updatedIntegration.id, createdIntegration.id);
                updatedAdminApiKey.secret.should.not.eql(adminApiKey.secret);
            })
            .then(() => {
                return request.get(localUtils.API.getApiQuery(`actions/?filter=resource_id:${adminApiKey.id}&include=actor`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200)
                    .then(function ({body}) {
                        const actions = body.actions;
                        const refreshedAction = actions.find((action) => {
                            return action.event === 'refreshed';
                        });
                        should.exist(refreshedAction);
                    });
            });
    });

    it('Can successfully add and delete a created integrations webhooks', function () {
        let createdIntegration;

        return request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Webhook-less Integration'
                }]
            })
            .expect(201)
            .then(function ({body}) {
                [createdIntegration] = body.integrations;

                return request.put(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                    .set('Origin', config.get('url'))
                    .send({
                        integrations: [{
                            webhooks: [{
                                event: 'somestuff',
                                target_url: 'http://example.com'
                            }]
                        }]
                    })
                    .expect(200);
            })
            .then(function () {
                return request.get(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/?include=webhooks`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200);
            })
            .then(function ({body}) {
                const [updatedIntegration] = body.integrations;

                should.equal(updatedIntegration.webhooks.length, 1);

                const webhook = updatedIntegration.webhooks[0];
                should.equal(webhook.integration_id, updatedIntegration.id);

                return request.put(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                    .set('Origin', config.get('url'))
                    .send({
                        integrations: [{
                            webhooks: []
                        }]
                    })
                    .expect(200);
            })
            .then(function () {
                return request.get(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/?include=webhooks`))
                    .set('Origin', config.get('url'))
                    .expect('Content-Type', /json/)
                    .expect('Cache-Control', testUtils.cacheRules.private)
                    .expect(200)
                    .then(function ({body}) {
                        const [updatedIntegration] = body.integrations;

                        should.equal(updatedIntegration.webhooks.length, 0);
                    });
            });
    });

    it('Can succesfully delete a created integration', function () {
        return request.post(localUtils.API.getApiQuery('integrations/'))
            .set('Origin', config.get('url'))
            .send({
                integrations: [{
                    name: 'Short Lived Integration'
                }]
            })
            .expect(201)
            .then(function ({body}) {
                const [createdIntegration] = body.integrations;

                return request.del(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                    .set('Origin', config.get('url'))
                    .expect(204)
                    .then(function () {
                        return request.get(localUtils.API.getApiQuery(`integrations/${createdIntegration.id}/`))
                            .set('Origin', config.get('url'))
                            .expect(404);
                    });
            });
    });
});