mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-12 16:14:25 +03:00
e26e83d40a
refs #2330 - Pass through `options` to all toJSON calls on posts, tags, and users - Use options.context.user to determine whether it's OK to return user.email - Remove author.email handling code from frontend.js
87 lines
3.6 KiB
JavaScript
87 lines
3.6 KiB
JavaScript
var _ = require('lodash'),
|
|
url = require('url'),
|
|
moment = require('moment'),
|
|
config = require('../../server/config'),
|
|
ApiRouteBase = '/ghost/api/v0.1/',
|
|
host = config.server.host,
|
|
port = config.server.port,
|
|
schema = 'http://',
|
|
expectedProperties = {
|
|
configuration: ['key', 'value'],
|
|
posts: ['posts', 'meta'],
|
|
users: ['users', 'meta'],
|
|
roles: ['roles'],
|
|
pagination: ['page', 'limit', 'pages', 'total', 'next', 'prev'],
|
|
post: ['id', 'uuid', 'title', 'slug', 'markdown', 'html', 'meta_title', 'meta_description',
|
|
'featured', 'image', 'status', 'language', 'created_at', 'created_by', 'updated_at',
|
|
'updated_by', 'published_at', 'published_by', 'page', 'author', 'url'
|
|
],
|
|
settings: ['settings', 'meta'],
|
|
setting: ['id', 'uuid', 'key', 'value', 'type', 'created_at', 'created_by', 'updated_at', 'updated_by'],
|
|
tag: ['id', 'uuid', 'name', 'slug', 'description', 'parent', 'image', 'hidden',
|
|
'meta_title', 'meta_description', 'created_at', 'created_by', 'updated_at', 'updated_by'
|
|
],
|
|
theme: ['uuid', 'name', 'version', 'active'],
|
|
user: ['id', 'uuid', 'name', 'slug', 'email', 'image', 'cover', 'bio', 'website',
|
|
'location', 'accessibility', 'status', 'language', 'meta_title', 'meta_description', 'last_login',
|
|
'created_at', 'created_by', 'updated_at', 'updated_by'
|
|
],
|
|
notification: ['type', 'message', 'status', 'id', 'dismissible', 'location'],
|
|
slugs: ['slugs'],
|
|
slug: ['slug'],
|
|
accesstoken: ['access_token', 'refresh_token', 'expires_in', 'token_type'],
|
|
role: ['id', 'uuid', 'name', 'description', 'created_at', 'created_by', 'updated_at', 'updated_by'],
|
|
permission: ['id', 'uuid', 'name', 'object_type', 'action_type', 'object_id', 'created_at', 'created_by',
|
|
'updated_at', 'updated_by'
|
|
]
|
|
};
|
|
|
|
function getApiQuery(route) {
|
|
return url.resolve(ApiRouteBase, route);
|
|
}
|
|
|
|
function getApiURL(route) {
|
|
var baseURL = url.resolve(schema + host + ':' + port, ApiRouteBase);
|
|
return url.resolve(baseURL, route);
|
|
}
|
|
function getSigninURL() {
|
|
return url.resolve(schema + host + ':' + port, 'ghost/signin/');
|
|
}
|
|
function getAdminURL() {
|
|
return url.resolve(schema + host + ':' + port, 'ghost/');
|
|
}
|
|
|
|
// make sure the API only returns expected properties only
|
|
function checkResponseValue(jsonResponse, properties) {
|
|
for (var i = 0; i < properties.length; i = i + 1) {
|
|
// For some reason, settings response objects do not have the 'hasOwnProperty' method
|
|
if (Object.prototype.hasOwnProperty.call(jsonResponse, properties[i])) {
|
|
continue;
|
|
}
|
|
jsonResponse.should.have.property(properties[i]);
|
|
}
|
|
Object.keys(jsonResponse).length.should.eql(properties.length);
|
|
}
|
|
|
|
function checkResponse(jsonResponse, objectType, additionalProperties, missingProperties) {
|
|
var checkProperties = expectedProperties[objectType];
|
|
checkProperties = additionalProperties ? checkProperties.concat(additionalProperties) : checkProperties;
|
|
checkProperties = missingProperties ? _.xor(checkProperties, missingProperties) : checkProperties;
|
|
|
|
checkResponseValue(jsonResponse, checkProperties);
|
|
}
|
|
|
|
function isISO8601(date) {
|
|
return moment(date).parsingFlags().iso;
|
|
}
|
|
|
|
module.exports = {
|
|
getApiURL: getApiURL,
|
|
getApiQuery: getApiQuery,
|
|
getSigninURL: getSigninURL,
|
|
getAdminURL: getAdminURL,
|
|
checkResponse: checkResponse,
|
|
checkResponseValue: checkResponseValue,
|
|
isISO8601: isISO8601
|
|
};
|