[RT] v0.2.0 (#15)

* refactored response files into separate files * adds the hability to define custom routes through the faux object (#14) * added api.prefix to the config and added prefix to routes (#16) * added relationship routes * added relationship routes (#17) * removed unecessary Faux.js file * removed test file * removed test file * fixed unparsed id on hasMany delete route
olavoasantos · Aug 31, 2018 · af0ce18 · af0ce18
1 parent 38625e2
commit af0ce18
Show file tree

Hide file tree

Showing 32 changed files with 493 additions and 310 deletions.
diff --git a/.gitignore b/.gitignore
@@ -46,4 +46,5 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-node_modules
+node_modules
+/test.js
diff --git a/Faux.js b/Faux.js
diff --git a/README.md b/README.md
@@ -102,6 +102,9 @@ const UserModel = {
   // Generate attribute routes (e.g. /users/1/email)
   // Bool
   attributeRoutes: true,
+  // Generate relationship routes (e.g. /users/1/profile)
+  // Bool
+  relationshipRoutes: true,
   // Protect attributes (dont send it nor create attribute routes)
   // Array [(Column)<Strings>]
   protected: ['password'],

diff --git a/config/base.config.js b/config/base.config.js
@@ -1,4 +1,6 @@
 module.exports = {
+  'api.prefix': '/',
+
   'auth.namespace': '/',
   'token.header': 'Authorization',
 

diff --git a/database/Table.js b/database/Table.js
@@ -42,7 +42,7 @@ class Table {
     const entry = {
       ...oldData,
       ...data,
-      id,
+      id: parseInt(id),
       updated_at: (new Date).getTime()
     };
 

diff --git a/generators/Generator.js b/generators/Generator.js
@@ -7,7 +7,12 @@ const Database = require('../database');
 const App = require('../server');
 const Auth = require('../auth');
 const Config = require('../config');
-const { Routes, CreateRoute, CreateAttributeRoute } = require('../routes');
+const {
+  Routes,
+  CreateRoute,
+  CreateAttributeRoute,
+  CreateRelationshipRoute
+} = require('../routes');
 
 /**
  *  Generator
@@ -51,8 +56,87 @@ const Generator = Model => {
   if (Model.attributeRoutes) {
     Model.columns.forEach(column => {
       if (!Model.protected.includes(column)) {
-        CreateAttributeRoute('show', 'get', `${Model.route}/:id/${column}`, Model);
-        CreateAttributeRoute('update', 'patch', `${Model.route}/:id/${column}`, Model);
+        CreateAttributeRoute(
+          'show',
+          'get',
+          `${Model.route}/:id/${column}`,
+          Model
+        );
+        CreateAttributeRoute(
+          'update',
+          'patch',
+          `${Model.route}/:id/${column}`,
+          Model
+        );
+      }
+    });
+  }
+
+  if (Model.relationshipRoutes) {
+    Object.keys(Model.hasOne).forEach(relationship => {
+      if (!Model.protected.includes(relationship)) {
+        const Relationship = Config.get('models')[relationship];
+        CreateRelationshipRoute(
+          'hasOneIndexResponse',
+          'get',
+          `${Model.route}/:id/${relationship.toLowerCase()}`,
+          Model,
+          Relationship
+        );
+        CreateRelationshipRoute(
+          'hasOneStoreResponse',
+          'post',
+          `${Model.route}/:id/${relationship.toLowerCase()}`,
+          Model,
+          Relationship
+        );
+        CreateRelationshipRoute(
+          'hasOneUpdateResponse',
+          'patch',
+          `${Model.route}/:id/${relationship.toLowerCase()}/:relationshipId`,
+          Model,
+          Relationship
+        );
+        CreateRelationshipRoute(
+          'hasOneDeleteResponse',
+          'delete',
+          `${Model.route}/:id/${relationship.toLowerCase()}/:relationshipId`,
+          Model,
+          Relationship
+        );
+      }
+    });
+    Object.keys(Model.hasMany).forEach(relationship => {
+      if (!Model.protected.includes(relationship)) {
+        const Relationship = Config.get('models')[relationship];
+        CreateRelationshipRoute(
+          'hasManyIndexResponse',
+          'get',
+          `${Model.route}/:id/${relationship.toLowerCase()}`,
+          Model,
+          Relationship
+        );
+        CreateRelationshipRoute(
+          'hasManyStoreResponse',
+          'post',
+          `${Model.route}/:id/${relationship.toLowerCase()}`,
+          Model,
+          Relationship
+        );
+        CreateRelationshipRoute(
+          'hasManyUpdateResponse',
+          'patch',
+          `${Model.route}/:id/${relationship.toLowerCase()}/:relationshipId`,
+          Model,
+          Relationship
+        );
+        CreateRelationshipRoute(
+          'hasManyDeleteResponse',
+          'delete',
+          `${Model.route}/:id/${relationship.toLowerCase()}/:relationshipId`,
+          Model,
+          Relationship
+        );
       }
     });
   }

diff --git a/helpers/getDataFromBody.js b/helpers/getDataFromBody.js
@@ -5,7 +5,7 @@
   const getDataFromBody = (columns, body, shouldIncludeNull = true) =>
     columns.reduce((data, column) => {
       if (shouldIncludeNull || body[column]) {
-        data[column] = isNaN(parseFloat(body[column])) ? body[column] : parseInt(body[column]);
+        data[column] = body[column];
       }
       return data;
     }, {});

diff --git a/index.js b/index.js
@@ -1,10 +1,11 @@
-const { Config, Start, Register } = require('./Faux');
+const { Start, Register, App, Config } = require('./main');
 
 /** Base faux wrapper */
 const faux = {
   config: Config,
   register: Register,
   start: Start,
+  route: App,
 }
 
 module.exports = faux;
diff --git a/main/index.js b/main/index.js
@@ -1,4 +1,6 @@
 const Start = require('./Start');
 const Register = require('./Register');
+const App = require('../server');
+const Config = require('../config');
 
-module.exports = { Start, Register };
+module.exports = { Config, App, Start, Register };
diff --git a/model/Model.js b/model/Model.js
@@ -12,6 +12,7 @@ class Model {
     this.columns = [];
     this.factory = () => ({});
     this.attributeRoutes = false;
+    this.relationshipRoutes = false;
     this.protected = [];
     this.middlewares = [];
     this.encrypt = [];
@@ -28,15 +29,30 @@ class Model {
 
   hydrate(ModelSchema) {
     this.name = Validate.name(ModelSchema.name);
-    this.route = Validate.route(ModelSchema.route);
+    this.route = this.generateRoute(Validate.route(ModelSchema.route));
     this.columns = Validate.columns(ModelSchema.columns);
     Object.keys(ModelSchema).forEach(property => {
-      if (check.isSet(Validate[property])) {
+      if (
+        !['name', 'route', 'columns'].includes(property) &&
+        check.isSet(Validate[property])
+      ) {
         this[property] = Validate[property](ModelSchema[property]);
       }
     });
   }
 
+  generateRoute(route) {
+    const prefix = Config.get('api.prefix')
+      .replace(/  +/g, '-')
+      .replace(/^\/|\/$/g, '')
+      .toLowerCase();
+    const uri = route
+      .replace(/  +/g, '-')
+      .replace(/^\/|\/$/g, '')
+      .toLowerCase();
+    return `/${prefix}/${uri}`.replace(/\/\//g, '/');
+  }
+
   validate(data) {
     return Object.keys(this.validation).reduce((errors, column) => {
       const rule = this.validation[column];
@@ -60,16 +76,25 @@ class Model {
     const eagerLoad = check.isObject(relationship)
       ? relationship
       : {
-          model: relationship,
+          model: relationship
         };
+
     let relationshipModel;
-    if (this.hasOne[relationship.model]) {
-      relationshipModel = Config.get('models')[relationship.model];
-      return relationshipModel.database.where(this.hasOne[relationship.model], model_id);
+    if (this.hasOne[eagerLoad.model]) {
+      relationshipModel = Config.get('models')[eagerLoad.model];
+      return relationshipModel.database.where(
+        this.hasOne[eagerLoad.model],
+        model_id
+      );
     }
-    if (this.hasMany[relationship.model]) {
-      relationshipModel = Config.get('models')[relationship.model];
-      return relationshipModel.database.whereAll(this.hasMany[relationship.model], model_id) || [];
+    if (this.hasMany[eagerLoad.model]) {
+      relationshipModel = Config.get('models')[eagerLoad.model];
+      return (
+        relationshipModel.database.whereAll(
+          this.hasMany[eagerLoad.model],
+          model_id
+        ) || []
+      );
     }
   }
 
@@ -78,7 +103,11 @@ class Model {
       this.eagerLoad.forEach(relationship => {
         const relationshipData = this.loadRelationship(row.id, relationship);
         if (relationshipData) {
-          row[relationship.model.toLowerCase()] = relationshipData;
+          row[
+            relationship.model
+              ? relationship.model.toLowerCase()
+              : relationship.toLowerCase()
+          ] = relationshipData;
         }
       });
     }

diff --git a/model/ValidateSchema.js b/model/ValidateSchema.js
@@ -155,6 +155,14 @@ module.exports = (() => {
       return attributeRoutes;
     },
 
+    relationshipRoutes: relationshipRoutes => {
+      if (!check.isBool(relationshipRoutes)) {
+        error(`The ${name} model's relationshipRoutes should be a boolean.`);
+      }
+
+      return relationshipRoutes;
+    },
+
     factory: modelFactory => {
       if (!check.isFunction(modelFactory)) {
         error(`The ${name} model's factory should be a function.`);

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "faux-call",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Simple mock server for your convenience and testing",
   "main": "index.js",
   "keywords": [