Ghost/test/regression/api/v2/content/utils.js
Nazar Gargol eb8c0fcff9 🐛 Fixed Tags API v2 to return posts count
closes #12167

- Tags API v2 was ignoring `count.posts` include parameter.
- Regression was introduced with a3f693b472
- Introduced regression tests across all Content API versions to avoid similar bug in the future
2020-08-31 18:46:35 +12:00

109 lines
3.1 KiB
JavaScript

const url = require('url');
const _ = require('lodash');
const testUtils = require('../../../../utils');
const schema = require('../../../../../core/server/data/schema').tables;
const API_URL = '/ghost/api/v2/content/';
const expectedProperties = {
// API top level
posts: ['posts', 'meta'],
tags: ['tags', 'meta'],
authors: ['authors', 'meta'],
pagination: ['page', 'limit', 'pages', 'total', 'next', 'prev'],
post: _(schema.posts)
.keys()
// by default we only return html
.without('mobiledoc', 'plaintext')
// v2 doesn't return author_id OR author
.without('author_id', 'author')
// and always returns computed properties: url, primary_tag, primary_author
.concat('url', 'primary_tag', 'primary_author')
// v2 API doesn't return unused fields
.without('locale', 'visibility')
// emails are not supported in API v2
.without('send_email_when_published')
// These fields aren't useful as they always have known values
.without('status')
.concat('page')
.without('type')
// v2 returns a calculated excerpt field
.concat('excerpt')
// returns meta fields from `posts_meta` schema
.concat(
..._(schema.posts_meta).keys()
.without('post_id', 'id')
// emails are not supported in API v2
.without('email_subject')
)
,
author: _(schema.users)
.keys()
.without(
'password',
'email',
'ghost_auth_id',
'created_at',
'created_by',
'updated_at',
'updated_by',
'last_seen',
'status'
)
// v2 API doesn't return unused fields
.without('accessibility', 'locale', 'tour', 'visibility')
,
tag: _(schema.tags)
.keys()
// v2 Tag API doesn't return parent_id or parent
.without('parent_id', 'parent')
// v2 Tag API doesn't return date fields
.without('created_at', 'updated_at')
// v2 Tag API doesn't return extended meta fields
.without(
'og_image',
'og_title',
'og_description',
'twitter_image',
'twitter_title',
'twitter_description',
'codeinjection_head',
'codeinjection_foot',
'canonical_url',
'accent_color'
)
};
_.each(expectedProperties, (value, key) => {
if (!value.__wrapped__) {
return;
}
/**
* @deprecated: x_by
*/
expectedProperties[key] = value
.without(
'created_by',
'updated_by',
'published_by'
)
.value();
});
module.exports = {
API: {
getApiQuery(route) {
return url.resolve(API_URL, route);
},
checkResponse(...args) {
this.expectedProperties = expectedProperties;
return testUtils.API.checkResponse.call(this, ...args);
}
},
getValidKey() {
return testUtils.DataGenerator.Content.api_keys[1].secret;
}
};