Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-03-11 02:12:21 -05:00
Code Issues Activity

Added webhooks controller to API v2

Browse source 
refs #9866

- Added new webhooks controller to v2 API
- Added webhooks tests to v2 API
This commit is contained in:
Rish 2018-10-12 00:22:38 +05:30 • committed by Rishabh Garg
parent 5683204371
commit 0a834d4223
6 changed files with 177 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/server/api/v2/index.js
View file

@ -21,5 +21,9 @@ module.exports = {
get slugs() {
return shared.pipeline(require('./slugs'), localUtils);
},
get webhooks() {
return shared.pipeline(require('./webhooks'), localUtils);
}
};

4
core/server/api/v2/utils/serializers/output/index.js
View file

@ -9,5 +9,9 @@ module.exports = {
get slugs() {
return require('./slugs');
},
get webhooks() {
return require('./webhooks');
}
};

17
core/server/api/v2/utils/serializers/output/webhooks.js Normal file
View file

@ -0,0 +1,17 @@
const debug = require('ghost-ignition').debug('api:v2:utils:serializers:output:webhooks');
module.exports = {
all(models, apiConfig, frame) {
debug('all');
// CASE: e.g. destroy returns null
if (!models) {
return;
}
frame.response = {
webhooks: [models.toJSON(frame.options)]
};
debug(frame.response);
}
};

46
core/server/api/v2/webhooks.js Normal file
View file

@ -0,0 +1,46 @@
const models = require('../../models');
const common = require('../../lib/common');
module.exports = {
docName: 'webhooks',
add: {
statusCode: 201,
headers: {},
options: [],
permissions: true,
query(frame) {
return models.Webhook.getByEventAndTarget(
frame.data.webhooks[0].event,
frame.data.webhooks[0].target_url,
frame.options
).then((webhook) => {
if (webhook) {
return Promise.reject(
new common.errors.ValidationError({message: common.i18n.t('errors.api.webhooks.webhookAlreadyExists')})
);
}
return models.Webhook.add(frame.data.webhooks[0], frame.options);
});
}
},
destroy: {
statusCode: 204,
headers: {},
options: [
'id'
],
validation: {
options: {
id: {
required: true
}
}
},
permissions: true,
query(frame) {
frame.options.require = true;
return models.Webhook.destroy(frame.options).return(null);
}
}
};

4
core/server/web/api/v2/admin/routes.js
View file

@ -210,8 +210,8 @@ module.exports = function apiRoutes() {
);
// ## Webhooks (RESTHooks)
router.post('/webhooks', mw.authAdminAPI, api.http(api.webhooks.add));
router.del('/webhooks/:id', mw.authAdminAPI, api.http(api.webhooks.destroy));
router.post('/webhooks', mw.authAdminAPI, apiv2.http(apiv2.webhooks.add));
router.del('/webhooks/:id', mw.authAdminAPI, apiv2.http(apiv2.webhooks.destroy));
// ## Oembed (fetch response from oembed provider)
router.get('/oembed', mw.authAdminAPI, api.http(api.oembed.read));

104
core/test/functional/api/v2/admin/webhooks_spec.js Normal file
View file

@ -0,0 +1,104 @@
const should = require('should');
const supertest = require('supertest');
const testUtils = require('../../../../utils');
const localUtils = require('./utils');
const config = require('../../../../../../core/server/config');
const ghost = testUtils.startGhost;
let request;
describe('Webhooks API', function () {
var ghostServer;
describe('As Owner', function () {
var ownerAccessToken = '';
before(function () {
return ghost()
.then(function (_ghostServer) {
ghostServer = _ghostServer;
request = supertest.agent(config.get('url'));
})
.then(function () {
return localUtils.doAuth(request);
});
});
describe('Add', function () {
var newWebhook = {
event: 'test.create',
target_url: 'http://example.com/webhooks/test/1'
};
it('creates a new webhook', function (done) {
request.post(localUtils.API.getApiQuery('webhooks/'))
.set('Origin', config.get('url'))
.send({webhooks: [newWebhook]})
.expect('Content-Type', /json/)
.expect('Cache-Control', testUtils.cacheRules.private)
.expect(201)
.end(function (err, res) {
if (err) {
return done(err);
}
var jsonResponse = res.body;
should.exist(jsonResponse.webhooks);
testUtils.API.checkResponse(jsonResponse.webhooks[0], 'webhook');
jsonResponse.webhooks[0].event.should.equal(newWebhook.event);
jsonResponse.webhooks[0].target_url.should.equal(newWebhook.target_url);
done();
});
});
});
describe('Delete', function () {
var newWebhook = {
event: 'test.create',
// a different target_url from above is needed to avoid an "already exists" error
target_url: 'http://example.com/webhooks/test/2'
};
it('deletes a webhook', function (done) {
// create the webhook that is to be deleted
request.post(localUtils.API.getApiQuery('webhooks/'))
.set('Origin', config.get('url'))
.send({webhooks: [newWebhook]})
.expect('Content-Type', /json/)
.expect('Cache-Control', testUtils.cacheRules.private)
.expect(201)
.end(function (err, res) {
if (err) {
return done(err);
}
var location = res.headers.location;
var jsonResponse = res.body;
should.exist(jsonResponse.webhooks);
testUtils.API.checkResponse(jsonResponse.webhooks[0], 'webhook');
jsonResponse.webhooks[0].event.should.equal(newWebhook.event);
jsonResponse.webhooks[0].target_url.should.equal(newWebhook.target_url);
// begin delete test
request.del(localUtils.API.getApiQuery('webhooks/' + jsonResponse.webhooks[0].id + '/'))
.set('Origin', config.get('url'))
.expect(204)
.end(function (err, res) {
if (err) {
return done(err);
}
res.body.should.be.empty();
done();
});
});
});
});
});
});