c6a95c6478
no issue
- this commit cleans up the usages of `include` and `withRelated`.
### API layer (`include`)
- as request parameter e.g. `?include=roles,tags`
- as theme API parameter e.g. `{{get .... include="author"}}`
- as internal API access e.g. `api.posts.browse({include: 'author,tags'})`
- the `include` notation is more readable than `withRelated`
- and it allows us to use a different easier format (comma separated list)
- the API utility transforms these more readable properties into model style (or into Ghost style)
### Model access (`withRelated`)
- e.g. `models.Post.findPage({withRelated: ['tags']})`
- driven by bookshelf
---
Commits explained.
* Reorder the usage of `convertOptions`
- 1. validation
- 2. options convertion
- 3. permissions
- the reason is simple, the permission layer access the model layer
- we have to prepare the options before talking to the model layer
- added `convertOptions` where it was missed (not required, but for consistency reasons)
* Use `withRelated` when accessing the model layer and use `include` when accessing the API layer
* Change `convertOptions` API utiliy
- API Usage
- ghost.api(..., {include: 'tags,authors'})
- `include` should only be used when calling the API (either via request or via manual usage)
- `include` is only for readability and easier format
- Ghost (Model Layer Usage)
- models.Post.findOne(..., {withRelated: ['tags', 'authors']})
- should only use `withRelated`
- model layer cannot read 'tags,authors`
- model layer has no idea what `include` means, speaks a different language
- `withRelated` is bookshelf
- internal usage
* include-count plugin: use `withRelated` instead of `include`
- imagine you outsource this plugin to git and publish it to npm
- `include` is an unknown option in bookshelf
* Updated `permittedOptions` in base model
- `include` is no longer a known option
* Remove all occurances of `include` in the model layer
* Extend `filterOptions` base function
- this function should be called as first action
- we clone the unfiltered options
- check if you are using `include` (this is a protection which could help us in the beginning)
- check for permitted and (later on default `withRelated`) options
- the usage is coming in next commit
* Ensure we call `filterOptions` as first action
- use `ghostBookshelf.Model.filterOptions` as first action
- consistent naming pattern for incoming options: `unfilteredOptions`
- re-added allowed options for `toJSON`
- one unsolved architecture problem:
- if you override a function e.g. `edit`
- then you should call `filterOptions` as first action
- the base implementation of e.g. `edit` will call it again
- future improvement
* Removed `findOne` from Invite model
- no longer needed, the base implementation is the same
68 lines
2.1 KiB
JavaScript
68 lines
2.1 KiB
JavaScript
var Promise = require('bluebird'),
|
|
ghostBookshelf = require('./base'),
|
|
common = require('../lib/common'),
|
|
Webhook,
|
|
Webhooks;
|
|
|
|
Webhook = ghostBookshelf.Model.extend({
|
|
tableName: 'webhooks',
|
|
|
|
emitChange: function emitChange(event, options) {
|
|
options = options || {};
|
|
|
|
common.events.emit('webhook' + '.' + event, this, options);
|
|
},
|
|
|
|
onCreated: function onCreated(model, response, options) {
|
|
model.emitChange('added', options);
|
|
},
|
|
|
|
onUpdated: function onUpdated(model, response, options) {
|
|
model.emitChange('edited', options);
|
|
},
|
|
|
|
onDestroyed: function onDestroyed(model, response, options) {
|
|
model.emitChange('deleted', options);
|
|
}
|
|
}, {
|
|
findAllByEvent: function findAllByEvent(event, unfilteredOptions) {
|
|
var options = this.filterOptions(unfilteredOptions, 'findAll'),
|
|
webhooksCollection = Webhooks.forge();
|
|
|
|
return webhooksCollection
|
|
.query('where', 'event', '=', event)
|
|
.fetch(options);
|
|
},
|
|
|
|
getByEventAndTarget: function getByEventAndTarget(event, targetUrl, unfilteredOptions) {
|
|
var options = ghostBookshelf.Model.filterOptions(unfilteredOptions, 'getByEventAndTarget');
|
|
options.require = true;
|
|
|
|
return Webhooks.forge().fetch(options).then(function then(webhooks) {
|
|
var webhookWithEventAndTarget = webhooks.find(function findWebhook(webhook) {
|
|
return webhook.get('event').toLowerCase() === event.toLowerCase()
|
|
&& webhook.get('target_url').toLowerCase() === targetUrl.toLowerCase();
|
|
});
|
|
|
|
if (webhookWithEventAndTarget) {
|
|
return webhookWithEventAndTarget;
|
|
}
|
|
}).catch(function (error) {
|
|
if (error.message === 'NotFound' || error.message === 'EmptyResponse') {
|
|
return Promise.resolve();
|
|
}
|
|
|
|
return Promise.reject(error);
|
|
});
|
|
}
|
|
});
|
|
|
|
Webhooks = ghostBookshelf.Collection.extend({
|
|
model: Webhook
|
|
});
|
|
|
|
module.exports = {
|
|
Webhook: ghostBookshelf.model('Webhook', Webhook),
|
|
Webhooks: ghostBookshelf.collection('Webhooks', Webhooks)
|
|
};
|