Ghost/core/shared/api.js
2013-06-08 19:36:54 -03:00

122 lines
3.8 KiB
JavaScript

// # Ghost Data API
// Provides access to the data model
/**
* This is intended to replace the old dataProvider files and should access & manipulate the models directly
*/
/*global module, require */
(function () {
"use strict";
var Ghost = require('../ghost'),
_ = require('underscore'),
ghost = new Ghost(),
dataProvider = ghost.dataProvider,
posts,
users,
settings,
requestHandler,
settingsObject,
settingsCollection;
// # Posts
posts = {
// takes filter / pagination parameters
// returns a page of posts in a json response
browse: function (options) {
return dataProvider.Post.findPage(options);
},
// takes an identifier (id or slug?)
// returns a single post in a json response
read: function (args) {
return dataProvider.Post.findOne(args);
},
// takes a json object with all the properties which should be updated
// returns the resulting post in a json response
edit: function (postData) {
return dataProvider.Post.edit(postData);
},
// takes a json object representing a post,
// returns the resulting post in a json response
add: function (postData) {
return dataProvider.Post.add(postData);
},
// takes an identifier (id or slug?)
// returns a json response with the id of the deleted post
destroy: function (args) {
return dataProvider.Post.destroy(args.id);
}
};
// # Users
users = {
add: function (postData) {
return dataProvider.User.add(postData);
},
check: function (postData) {
return dataProvider.User.check(postData);
}
};
// # Settings
// Turn a settings collection into a single object/hashmap
settingsObject = function (settings) {
return (settings.toJSON ? settings.toJSON() : settings).reduce(function (res, item) {
if (item.toJSON) { item = item.toJSON(); }
if (item.key) { res[item.key] = item.value; }
return res;
}, {});
};
// Turn an object into a collection
settingsCollection = function (settings) {
return _.map(settings, function (value, key) {
return { key: key, value: value };
});
};
settings = {
browse: function (options) {
return dataProvider.Settings.browse(options).then(settingsObject);
},
read: function (options) {
return dataProvider.Settings.read(options.key).then(function (setting) {
return _.pick(setting.toJSON(), 'key', 'value');
});
},
edit: function (settings) {
settings = settingsCollection(settings);
return dataProvider.Settings.edit(settings).then(settingsObject);
},
add: function (settings) {
settings = settingsCollection(settings);
return dataProvider.Settings.add(settings).then(settingsObject);
}
};
// categories: {};
// post_categories: {};
// requestHandler
// decorator for api functions which are called via an HTTP request
// takes the API method and wraps it so that it gets data from the request and returns a sensible JSON response
requestHandler = function (apiMethod) {
return function (req, res) {
var options = _.extend(req.body, req.query, req.params);
return apiMethod(options).then(function (result) {
res.json(result || {});
}, function (error) {
res.json(400, {error: error});
});
};
};
module.exports.posts = posts;
module.exports.users = users;
module.exports.settings = settings;
module.exports.requestHandler = requestHandler;
}());