Misc cleanup & consistency amends (#9002)

no issue

- Consistent naming for postLookup
   - makes it easier to search and inspect the various usages
- Cleanup unneeded code
- Make res.render calls more consistent
- add some consistency to the calls to res.render
- Remove ancient reference to dataProvider
- Let's call it models everywhere now...
- Use consistent formatting across the API
- we're no longer using alignment in vars
- Misc other consistency changes in API
- always refer to local utils as apiUtils
- logical grouping of requires - dependencies, utils, "lib common" etc
- use xAPI to refer to API endpoints, e.g. mailAPI, settingsAPI for clarity

core/server/api/authentication.js

@@ -1,19 +1,19 @@
-var _                = require('lodash'),
-    validator        = require('validator'),
-    Promise          = require('bluebird'),
-    pipeline         = require('../utils/pipeline'),
-    settings         = require('./settings'),
-    mail             = require('./../mail'),
-    apiMail          = require('./mail'),
-    globalUtils      = require('../utils'),
-    utils            = require('./utils'),
-    errors           = require('../errors'),
-    models           = require('../models'),
-    logging          = require('../logging'),
-    events           = require('../events'),
-    config           = require('../config'),
-    i18n             = require('../i18n'),
-    spamPrevention   = require('../middleware/api/spam-prevention'),
+var Promise = require('bluebird'),
+    _ = require('lodash'),
+    validator = require('validator'),
+    pipeline = require('../utils/pipeline'),
+    mail = require('./../mail'),
+    globalUtils = require('../utils'),
+    apiUtils = require('./utils'),
+    models = require('../models'),
+    config = require('../config'),
+    errors = require('../errors'),
+    events = require('../events'),
+    i18n = require('../i18n'),
+    logging = require('../logging'),
+    spamPrevention = require('../middleware/api/spam-prevention'),
+    mailAPI = require('./mail'),
+    settingsAPI = require('./settings'),
     authentication,
     tokenSecurity = {};
 
@@ -61,7 +61,7 @@ function setupTasks(setupData) {
     var tasks;
 
     function validateData(setupData) {
-        return utils.checkObject(setupData, 'setup').then(function then(checked) {
+        return apiUtils.checkObject(setupData, 'setup').then(function then(checked) {
             var data = checked.setup[0];
 
             return {
@@ -109,7 +109,7 @@ function setupTasks(setupData) {
             {key: 'description', value: i18n.t('common.api.authentication.sampleBlogDescription')}
         ];
 
-        return settings.edit({settings: userSettings}, context).return(user);
+        return settingsAPI.edit({settings: userSettings}, context).return(user);
     }
 
     function formatResponse(user) {
@@ -141,7 +141,7 @@ authentication = {
         var tasks;
 
         function validateRequest(object) {
-            return utils.checkObject(object, 'passwordreset').then(function then(data) {
+            return apiUtils.checkObject(object, 'passwordreset').then(function then(data) {
                 var email = data.passwordreset[0].email;
 
                 if (typeof email !== 'string' || !validator.isEmail(email)) {
@@ -158,7 +158,7 @@ authentication = {
             var options = {context: {internal: true}},
                 dbHash, token;
 
-            return settings.read(_.merge({key: 'db_hash'}, options))
+            return settingsAPI.read(_.merge({key: 'db_hash'}, options))
                 .then(function fetchedSettings(response) {
                     dbHash = response.settings[0].value;
 
@@ -205,7 +205,7 @@ authentication = {
                     }]
                 };
 
-                return apiMail.send(payload, {context: {internal: true}});
+                return mailAPI.send(payload, {context: {internal: true}});
             });
         }
 
@@ -238,7 +238,7 @@ authentication = {
         var tasks, tokenIsCorrect, dbHash, options = {context: {internal: true}}, tokenParts;
 
         function validateRequest() {
-            return utils.validate('passwordreset')(object, options)
+            return apiUtils.validate('passwordreset')(object, options)
                 .then(function (options) {
                     var data = options.data.passwordreset[0];
 
@@ -286,7 +286,7 @@ authentication = {
                 oldPassword = data.oldPassword,
                 newPassword = data.newPassword;
 
-            return settings.read(_.merge({key: 'db_hash'}, options))
+            return settingsAPI.read(_.merge({key: 'db_hash'}, options))
                 .then(function fetchedSettings(response) {
                     dbHash = response.settings[0].value;
 
@@ -355,7 +355,7 @@ authentication = {
         var tasks, invite, options = {context: {internal: true}};
 
         function validateInvitation(invitation) {
-            return utils.checkObject(invitation, 'invitation')
+            return apiUtils.checkObject(invitation, 'invitation')
                 .then(function () {
                     if (!invitation.invitation[0].token) {
                         return Promise.reject(new errors.ValidationError({message: i18n.t('errors.api.authentication.noTokenProvided')}));
@@ -532,7 +532,7 @@ authentication = {
                             }]
                         };
 
-                    apiMail.send(payload, {context: {internal: true}}).catch(function (error) {
+                    mailAPI.send(payload, {context: {internal: true}}).catch(function (error) {
                         logging.error(new errors.EmailError({
                             err: error,
                             context: i18n.t('errors.api.authentication.unableToSendWelcomeEmail'),

core/server/api/clients.js

@@ -1,14 +1,13 @@
 // # Client API
 // RESTful API for the Client resource
-var Promise      = require('bluebird'),
-    _            = require('lodash'),
-    dataProvider = require('../models'),
-    errors       = require('../errors'),
-    utils        = require('./utils'),
-    pipeline     = require('../utils/pipeline'),
-    i18n         = require('../i18n'),
-
-    docName      = 'clients',
+var Promise = require('bluebird'),
+    _ = require('lodash'),
+    pipeline = require('../utils/pipeline'),
+    apiUtils = require('./utils'),
+    models = require('../models'),
+    errors = require('../errors'),
+    i18n = require('../i18n'),
+    docName = 'clients',
     clients;
 
 /**
@@ -36,12 +35,12 @@ clients = {
         function doQuery(options) {
             // only User Agent (type = `ua`) clients are available at the moment.
             options.data = _.extend(options.data, {type: 'ua'});
-            return dataProvider.Client.findOne(options.data, _.omit(options, ['data']));
+            return models.Client.findOne(options.data, _.omit(options, ['data']));
         }
 
         // Push all of our tasks into a `tasks` array in the correct order
         tasks = [
-            utils.validate(docName, {attrs: attrs}),
+            apiUtils.validate(docName, {attrs: attrs}),
             // TODO: add permissions
             // utils.handlePublicPermissions(docName, 'read'),
             doQuery

core/server/api/configuration.js

@@ -1,13 +1,12 @@
 // # Configuration API
 // RESTful API for browsing the configuration
-var _                  = require('lodash'),
-    config             = require('../config'),
-    settingsCache      = require('../settings/cache'),
-    ghostVersion       = require('../utils/ghost-version'),
-    models             = require('../models'),
-    Promise            = require('bluebird'),
-    utils              = require('../utils'),
-
+var Promise = require('bluebird'),
+    _ = require('lodash'),
+    apiUtils = require('../utils'),
+    models = require('../models'),
+    config = require('../config'),
+    settingsCache = require('../settings/cache'),
+    ghostVersion = require('../utils/ghost-version'),
     configuration;
 
 function fetchAvailableTimezones() {
@@ -36,7 +35,7 @@ function getBaseConfig() {
     return {
         useGravatar:    !config.isPrivacyDisabled('useGravatar'),
         publicAPI:      config.get('publicAPI') === true,
-        blogUrl:        utils.url.urlFor('home', true),
+        blogUrl:        apiUtils.url.urlFor('home', true),
         blogTitle:      settingsCache.get('title'),
         routeKeywords:  config.get('routeKeywords'),
         clientExtensions: config.get('clientExtensions')

core/server/api/db.js

@@ -1,18 +1,18 @@
 // # DB API
 // API for DB operations
-var Promise          = require('bluebird'),
-    exporter         = require('../data/export'),
-    importer         = require('../data/importer'),
-    backupDatabase   = require('../data/db/backup'),
-    models           = require('../models'),
-    errors           = require('../errors'),
-    utils            = require('./utils'),
-    path             = require('path'),
-    fs               = require('fs'),
-    utilsUrl         = require('../utils/url'),
-    config           = require('../config'),
-    pipeline         = require('../utils/pipeline'),
-    docName          = 'db',
+var Promise = require('bluebird'),
+    path = require('path'),
+    fs = require('fs'),
+    pipeline = require('../utils/pipeline'),
+    apiUtils = require('./utils'),
+    exporter = require('../data/export'),
+    importer = require('../data/importer'),
+    backupDatabase = require('../data/db/backup'),
+    models = require('../models'),
+    config = require('../config'),
+    errors = require('../errors'),
+    utilsUrl = require('../utils/url'),
+    docName = 'db',
     db;
 
 /**
@@ -67,7 +67,7 @@ db = {
         }
 
         tasks = [
-            utils.handlePermissions(docName, 'exportContent'),
+            apiUtils.handlePermissions(docName, 'exportContent'),
             exportContent
         ];
 
@@ -94,7 +94,7 @@ db = {
         }
 
         tasks = [
-            utils.handlePermissions(docName, 'importContent'),
+            apiUtils.handlePermissions(docName, 'importContent'),
             importContent
         ];
 
@@ -129,7 +129,7 @@ db = {
         }
 
         tasks = [
-            utils.handlePermissions(docName, 'deleteAllContent'),
+            apiUtils.handlePermissions(docName, 'deleteAllContent'),
             backupDatabase,
             deleteContent
         ];

core/server/api/index.js

@@ -4,30 +4,30 @@
 // Ghost's JSON API is integral to the workings of Ghost, regardless of whether you want to access data internally,
 // from a theme, an app, or from an external app, you'll use the Ghost JSON API to do so.
 
-var _              = require('lodash'),
-    Promise        = require('bluebird'),
-    config         = require('../config'),
-    models         = require('../models'),
-    utils          = require('../utils'),
-    configuration  = require('./configuration'),
-    db             = require('./db'),
-    mail           = require('./mail'),
-    notifications  = require('./notifications'),
-    posts          = require('./posts'),
-    schedules      = require('./schedules'),
-    roles          = require('./roles'),
-    settings       = require('./settings'),
-    tags           = require('./tags'),
-    invites        = require('./invites'),
-    clients        = require('./clients'),
-    users          = require('./users'),
-    slugs          = require('./slugs'),
-    themes         = require('./themes'),
-    subscribers    = require('./subscribers'),
+var _ = require('lodash'),
+    Promise = require('bluebird'),
+    config = require('../config'),
+    models = require('../models'),
+    utils = require('../utils'),
+    configuration = require('./configuration'),
+    db = require('./db'),
+    mail = require('./mail'),
+    notifications = require('./notifications'),
+    posts = require('./posts'),
+    schedules = require('./schedules'),
+    roles = require('./roles'),
+    settings = require('./settings'),
+    tags = require('./tags'),
+    invites = require('./invites'),
+    clients = require('./clients'),
+    users = require('./users'),
+    slugs = require('./slugs'),
+    themes = require('./themes'),
+    subscribers = require('./subscribers'),
     authentication = require('./authentication'),
-    uploads        = require('./upload'),
-    exporter       = require('../data/export'),
-    slack          = require('./slack'),
+    uploads = require('./upload'),
+    exporter = require('../data/export'),
+    slack = require('./slack'),
 
     http,
     addHeaders,