cbdc91ce48
refs #2635 - Adds 'Location' header to endpoints which create new resources and have corresponding `GET` endpoint as speced in JSON API - https://jsonapi.org/format/#crud-creating-responses-201. Specifically: /posts/ /pages/ /integrations/ /tags/ /members/ /labels/ /notifications/ /invites/ - Adding the header should allow for better resource discoverability and improved logging readability - Added `url` property to the frame constructor. Data in `url` should give enough information to later build up the `Location` header URL for created resource. - Added Location header to headers handler. The Location value is built up from a combination of request URL and the id that is present in the response for the resource. The header is automatically added to requests coming to `add` controller methods which return `id` property in the frame result - Excluded Webhooks API as there is no "GET" endpoint available to fetch the resource
107 lines
4.2 KiB
JavaScript
107 lines
4.2 KiB
JavaScript
const should = require('should');
|
|
const supertest = require('supertest');
|
|
const testUtils = require('../../utils');
|
|
const config = require('../../../core/shared/config');
|
|
const localUtils = require('./utils');
|
|
|
|
const ghost = testUtils.startGhost;
|
|
let request;
|
|
|
|
describe('Notifications API', function () {
|
|
let ghostServer;
|
|
|
|
before(function () {
|
|
return ghost()
|
|
.then(function (_ghostServer) {
|
|
ghostServer = _ghostServer;
|
|
request = supertest.agent(config.get('url'));
|
|
})
|
|
.then(function () {
|
|
return localUtils.doAuth(request);
|
|
});
|
|
});
|
|
|
|
it('Can add notification', function () {
|
|
const newNotification = {
|
|
type: 'info',
|
|
message: 'test notification',
|
|
custom: true,
|
|
id: 'customId'
|
|
};
|
|
|
|
return request.post(localUtils.API.getApiQuery('notifications/'))
|
|
.set('Origin', config.get('url'))
|
|
.send({notifications: [newNotification]})
|
|
.expect('Content-Type', /json/)
|
|
.expect('Cache-Control', testUtils.cacheRules.private)
|
|
.expect(201)
|
|
.then(function (res) {
|
|
const jsonResponse = res.body;
|
|
|
|
should.exist(jsonResponse.notifications);
|
|
|
|
localUtils.API.checkResponse(jsonResponse.notifications[0], 'notification');
|
|
|
|
jsonResponse.notifications[0].type.should.equal(newNotification.type);
|
|
jsonResponse.notifications[0].message.should.equal(newNotification.message);
|
|
jsonResponse.notifications[0].status.should.equal('alert');
|
|
jsonResponse.notifications[0].dismissible.should.be.true();
|
|
should.exist(jsonResponse.notifications[0].location);
|
|
jsonResponse.notifications[0].location.should.equal('bottom');
|
|
jsonResponse.notifications[0].id.should.be.a.String();
|
|
|
|
should.exist(res.headers.location);
|
|
res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('notifications/')}${res.body.notifications[0].id}/`);
|
|
});
|
|
});
|
|
|
|
it('Can delete notification', function () {
|
|
const newNotification = {
|
|
type: 'info',
|
|
message: 'test notification',
|
|
status: 'alert',
|
|
custom: true
|
|
};
|
|
|
|
// create the notification that is to be deleted
|
|
return request.post(localUtils.API.getApiQuery('notifications/'))
|
|
.set('Origin', config.get('url'))
|
|
.send({notifications: [newNotification]})
|
|
.expect('Content-Type', /json/)
|
|
.expect('Cache-Control', testUtils.cacheRules.private)
|
|
.expect(201)
|
|
.then(function (res) {
|
|
const jsonResponse = res.body;
|
|
|
|
should.exist(jsonResponse.notifications);
|
|
localUtils.API.checkResponse(jsonResponse.notifications[0], 'notification');
|
|
jsonResponse.notifications.length.should.eql(1);
|
|
|
|
jsonResponse.notifications[0].type.should.equal(newNotification.type);
|
|
jsonResponse.notifications[0].message.should.equal(newNotification.message);
|
|
jsonResponse.notifications[0].status.should.equal(newNotification.status);
|
|
|
|
return jsonResponse.notifications[0];
|
|
})
|
|
.then((notification) => {
|
|
return request.del(localUtils.API.getApiQuery(`notifications/${notification.id}/`))
|
|
.set('Origin', config.get('url'))
|
|
.expect(204)
|
|
.then(function (res) {
|
|
res.body.should.be.empty();
|
|
|
|
return notification;
|
|
});
|
|
})
|
|
.then((notification) => {
|
|
return request.get(localUtils.API.getApiQuery(`notifications/`))
|
|
.set('Origin', config.get('url'))
|
|
.expect(200)
|
|
.then(function (res) {
|
|
const deleted = res.body.notifications.filter(n => n.id === notification.id);
|
|
deleted.should.be.empty();
|
|
});
|
|
});
|
|
});
|
|
});
|