Merge pull request #8 from neonexus/master

Added pagination helpers. Fixed create user action (added role). Removed some unused code. Updated NPM packages.

Author: neonexus

.idea/README.md

@@ -1,16 +1,17 @@
 bail: false #stop on first error
 async-only: true # require use of "done" cb or an async function (a Promise)
 require:
-    - 'test/hooks.js'
+    - 'test/hooks.js' # starting point for tests
 spec:  'test/**/*.test.js'
 timeout: 10000 # Give Sails some breathing room... We are building schemas / data fixtures.
 checkLeaks: true
 global:
-    - '_'
+    - '_' # Lodash global
     - 'sails'
     - '__core-js_shared__'
     - 'Archive' # Sails' built-in archive
     - 'User'
     - 'Session'
     - 'RequestLog'
     - 'Log'
+    - '__coverage__' # NYC coverage global

.idea/codeStyles/codeStyleConfig.xml

@@ -25,6 +25,9 @@ This repo is not installable via `npm`. Instead, Github provides a handy "Use th
 ### Configuration
 In the `config` folder, there is `local.js.sample` file, which is meant to be copied to `local.js`. This file is ignored by Git, and intended for use in local development, not remote servers.
 
+#### Want to configure the "X-Powered-By" header?
+Sails, by default, has middleware (akin to [Express.js Middleware](https://expressjs.com/en/guide/using-middleware.html), Sails is built on Express.js after all...). Inside of [`config/http.js`](config/http.js) we disable the default middleware, and create our own `X-Powered-By` header, using Express.js Middleware.
+
 ### Scripts built into [`package.json`](package.json):
 
 | Command       | Description
@@ -89,6 +92,29 @@ module.exports.bootstrap = function(next) {
 };
 ```
 
+## What about SEO?
+I recommend looking at [prerender.io](https://prerender.io). They offer a service (free up to 250 pages) that caches the end result of a JavaScript-rendered view (React, Vue, Angular), allowing search engines to crawl otherwise un-crawlable web views. You can use the service in a number of ways. One way, is to use the [prerender-node](https://www.npmjs.com/package/prerender-node) package. To use it with Sails, you'll have to add it to the [HTTP Middleware](https://sailsjs.com/documentation/concepts/middleware#?http-middleware). Here's a quick example:
+
+```javascript
+middleware: {
+
+    order: [
+        'cookieParser',
+        'session',
+        'bodyParser',
+        'prerender', // reference our custom middleware found below
+        'compress',
+        'router',
+        'assetLog',
+        'www',
+        'favicon'
+    ],
+
+    prerender: require('prerender-node').set('prerenderToken', 'YOUR_TOKEN')
+
+}
+```
+
 ### Useful Links
 
 + [Sails Framework Documentation](https://sailsjs.com/get-started)

.idea/runConfigurations/Run_Tests_w__Coverage.xml

@@ -27,6 +27,11 @@ module.exports = {
             isEmail: true,
             required: true,
             maxLength: 191
+        },
+
+        role: {
+            type: 'string',
+            defaultsTo: 'user'
         }
     },
 
@@ -63,7 +68,7 @@ module.exports = {
             firstName: inputs.firstName,
             lastName: inputs.lastName,
             password: inputs.password,
-            role: 'user',
+            role: inputs.role,
             email: inputs.email
         }).meta({fetch: true}).exec((err, newUser) => {
             if (err) {

.mocharc.yaml

@@ -0,0 +1,60 @@
+module.exports = {
+    friendlyName: 'Paginate for JSON',
+
+    description: 'Expects the query from sails.helpers.paginateForQuery().',
+
+    inputs: {
+        query: {
+            description: 'This should be the value returned from sails.helpers.paginateForQuery()',
+            type: 'json',
+            required: true,
+            // this is a custom validator, which returns true or false
+            custom: (thisQuery) => (
+                _.isObject(thisQuery) && _.isNumber(thisQuery.limit) &&
+                _.isNumber(thisQuery.page) && _.isString(thisQuery.sort) &&
+                _.isObject(thisQuery.where)
+            )
+        },
+
+        model: { // must be a reference to a Sails model, like User or sails.models.user
+            type: 'ref',
+            required: true
+        },
+
+        objToWrap: { // the response to be given to the end-user
+            type: 'json',
+            required: true
+        }
+    },
+
+    exits: {},
+
+    fn: (inputs, exits) => {
+        let query = inputs.query;
+
+        const limit = query.limit;
+        const page = query.page;
+        const sort = query.sort;
+
+        delete query.limit;
+        delete query.page;
+        delete query.skip;
+        delete query.sort;
+
+        inputs.model.count(query).exec((err, totalCount) => {
+            if (err) {
+                throw new Error(err);
+            }
+
+            let objToWrap = _.merge({}, inputs.objToWrap); // copy the object
+
+            objToWrap.totalFound = totalCount;
+            objToWrap.totalPages = Math.ceil(totalCount / limit);
+            objToWrap.limit = limit;
+            objToWrap.page = page;
+            objToWrap.sort = sort;
+
+            return exits.success(objToWrap);
+        });
+    }
+};

README.md

@@ -0,0 +1,47 @@
+module.exports = {
+    sync: true, // is a synchronous
+
+    friendlyName: 'Paginate for query',
+
+    description: 'Takes in pagination options, and returns query for .find() calls.',
+
+    inputs: {
+        page: {
+            type: 'number',
+            defaultsTo: 1
+        },
+        limit: {
+            type: 'number',
+            defaultsTo: 25
+        },
+        sort: {
+            type: 'string',
+            defaultsTo: 'createdAt DESC'
+        },
+        where: {
+            type: 'ref', // JavaScript reference to an object
+            defaultsTo: null
+        }
+    },
+
+    exits: {},
+
+    fn: (inputs, exits) => {
+        let baseObj = {
+            limit: inputs.limit,
+            page: inputs.page,
+            skip: (inputs.page - 1) * inputs.limit,
+            sort: inputs.sort,
+            where: inputs.where
+        };
+
+        if (!baseObj.where) {
+            baseObj.where = {deletedAt: null};
+        } else if (baseObj.where.sort && baseObj.sort === 'createdAt DESC') { // if sort is the default, and the where contains a sort, use the where.sort, otherwise, use inputs.sort
+            baseObj.sort = baseObj.where.sort;
+            delete baseObj.where.sort;
+        }
+
+        return exits.success(baseObj);
+    }
+};

api/controllers/admin/create-user.js

@@ -18,43 +18,10 @@ import {UserProvider, UserConsumer} from '../data/userContext';
 class AdminRouter extends React.Component {
     constructor(props) {
         super(props);
-
-        // this.state = {
-        //     isAuthenticated: false,
-        //     user: sessionStorage.getItem('user')
-        // };
-
-        // this.userLogin = this.userLogin.bind(this);
-        // this.userLogout = this.userLogout.bind(this);
     }
 
-    // userLogin(user) {
-    //     this.setState({user, isAuthenticated: true});
-    //     sessionStorage.setItem('user', user);
-    // }
-    //
-    // userLogout() {
-    //     this.setState({user: {}, isAuthenticated: false});
-    //     sessionStorage.removeItem('user');
-    // }
-
     render() {
-        const that = this;
-
         function RenderOrLogin(props) {
-            // if (that.state.isAuthenticated) {
-            //     return props.children;
-            // }
-
-            // return (
-            //     <Redirect
-            //         to={{
-            //             pathname: '/admin/login',
-            //             state: {from: props.location}
-            //         }}
-            //     />
-            // );
-
             return (
                 <UserConsumer>
                     {

api/helpers/paginate-for-json.js

@@ -78,11 +78,11 @@ module.exports = {
          * If, in production, this app has access to physical-layer CASCADE         *
          * constraints (e.g. PostgreSQL or MySQL), then set those up in the         *
          * database and uncomment this to disable Waterline's `cascadeOnDestroy`    *
-         * polyfill.  (Otherwise, if you are using a databse like Mongo, you might  *
+         * polyfill.  (Otherwise, if you are using a database like Mongo, you might *
          * choose to keep this enabled.)                                            *
          *                                                                          *
          ***************************************************************************/
-        // cascadeOnDestroy: false,
+        cascadeOnDestroy: false,
 
         /*dataEncryptionKeys: {
             default: process.env.DATA_ENCRYPTION_KEY