mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-10 23:36:14 -05:00
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
88 lines
2.2 KiB
JavaScript
88 lines
2.2 KiB
JavaScript
const should = require('should');
|
|
const sinon = require('sinon');
|
|
const shared = require('../../../../core/server/api/shared');
|
|
|
|
describe('Unit: api/shared/http', function () {
|
|
let req;
|
|
let res;
|
|
let next;
|
|
|
|
beforeEach(function () {
|
|
req = sinon.stub();
|
|
res = sinon.stub();
|
|
next = sinon.stub();
|
|
|
|
req.body = {
|
|
a: 'a'
|
|
};
|
|
req.vhost = {
|
|
host: 'example.com'
|
|
};
|
|
req.url = 'https://example.com/ghost/api/canary/',
|
|
|
|
res.status = sinon.stub();
|
|
res.json = sinon.stub();
|
|
res.set = sinon.stub();
|
|
res.send = sinon.stub();
|
|
|
|
sinon.stub(shared.headers, 'get').resolves();
|
|
});
|
|
|
|
afterEach(function () {
|
|
sinon.restore();
|
|
});
|
|
|
|
it('check options', function () {
|
|
const apiImpl = sinon.stub().resolves();
|
|
shared.http(apiImpl)(req, res, next);
|
|
|
|
Object.keys(apiImpl.args[0][0]).should.eql([
|
|
'original',
|
|
'options',
|
|
'data',
|
|
'user',
|
|
'file',
|
|
'files',
|
|
'apiType'
|
|
]);
|
|
|
|
apiImpl.args[0][0].data.should.eql({a: 'a'});
|
|
apiImpl.args[0][0].options.should.eql({
|
|
context: {
|
|
api_key: null,
|
|
integration: null,
|
|
user: null,
|
|
member: null
|
|
}
|
|
});
|
|
});
|
|
|
|
it('api response is fn', function (done) {
|
|
const response = sinon.stub().callsFake(function (req, res, next) {
|
|
should.exist(req);
|
|
should.exist(res);
|
|
should.exist(next);
|
|
apiImpl.calledOnce.should.be.true();
|
|
res.json.called.should.be.false();
|
|
done();
|
|
});
|
|
|
|
const apiImpl = sinon.stub().resolves(response);
|
|
shared.http(apiImpl)(req, res, next);
|
|
});
|
|
|
|
it('api response is fn', function (done) {
|
|
const apiImpl = sinon.stub().resolves('data');
|
|
|
|
next.callsFake(done);
|
|
|
|
res.json.callsFake(function () {
|
|
shared.headers.get.calledOnce.should.be.true();
|
|
res.status.calledOnce.should.be.true();
|
|
res.send.called.should.be.false();
|
|
done();
|
|
});
|
|
|
|
shared.http(apiImpl)(req, res, next);
|
|
});
|
|
});
|