Ghost/core/server/api/clients.js
kirrg001 6f6c8f4521 Import lib/common only
refs #9178

- avoid importing 4 modules (logging, errors, events and i18n)
- simply require common in each file
2017-12-12 10:28:13 +01:00

66 lines
1.9 KiB
JavaScript

// # Client API
// RESTful API for the Client resource
var Promise = require('bluebird'),
_ = require('lodash'),
pipeline = require('../utils/pipeline'),
apiUtils = require('./utils'),
models = require('../models'),
common = require('../lib/common'),
docName = 'clients',
clients;
/**
* ### Clients API Methods
*
* **See:** [API Methods](events.js.html#api%20methods)
*/
clients = {
/**
* ## Read
* @param {{id}} options
* @return {Promise<Client>} Client
*/
read: function read(options) {
var attrs = ['id', 'slug'],
tasks;
/**
* ### Model Query
* Make the call to the Model layer
* @param {Object} options
* @returns {Object} options
*/
function doQuery(options) {
// only User Agent (type = `ua`) clients are available at the moment.
options.data = _.extend(options.data, {type: 'ua'});
return models.Client.findOne(options.data, _.omit(options, ['data']))
.then(function onModelResponse(model) {
if (!model) {
return Promise.reject(new common.errors.NotFoundError({
message: common.i18n.t('common.api.clients.clientNotFound')
}));
}
return {
clients: [model.toJSON(options)]
};
});
}
// Push all of our tasks into a `tasks` array in the correct order
tasks = [
apiUtils.validate(docName, {attrs: attrs}),
// TODO: add permissions
// utils.handlePublicPermissions(docName, 'read'),
doQuery
];
// Pipeline calls each task passing the result of one to be the arguments for the next
return pipeline(tasks, options);
}
};
module.exports = clients;