feat(template): Support any named path parameter

Handle path parameters other than `{id}` and `{parentId}` such that
individual API developers can choose to name parameters as they see
fit.

Currently the paths only support 2 levels, after the 2nd path
parameter the generator will fall back to the default handlers.

closes #8

handlers/templates/_handler.js

@@ -7,7 +7,8 @@ var <%=dbmodel.name%> = require('<%=dbmodel.path%>');<%})%>
  * Operations on <%=path%>
  */
 module.exports = {
-<% _.forEach(methods, function (method, i) {%>
+<% var metadata = helpers.getPathMetadata(path);
+   _.forEach(methods, function (method, i) {%>
     /**
      * <%=method.description%>
      *
@@ -23,42 +24,42 @@ module.exports = {
     var includeOpts = {
         Model: dbmodels[0].name,
         method: method,
-        formatSuccessResponse: helpers.formatSuccessResponse
+        formatSuccessResponse: helpers.formatSuccessResponse,
+        subModelAttribute: metadata.subResource,
+        id: metadata.id,
+        parentId: metadata.parentId
     };
-    var includeSubOpts = _.defaults({
-        subModelAttribute: helpers.getSubResourceAttribute(path)
-    }, includeOpts);
 
-    switch (helpers.getPathType(path, method.method)) {
+    switch (method.method + metadata.type) {
         case 'getResources':%>
         <%- include('getResources', includeOpts); %>
         <%break;
         case 'getResource':%>
         <%- include('getResource', includeOpts); %>
         <%break;
         case 'getSubResources':%>
-        <%- include('getSubResources', includeSubOpts); %>
+        <%- include('getSubResources', includeOpts); %>
         <%break;
         case 'getSubResource':%>
-        <%- include('getSubResource', includeSubOpts); %>
+        <%- include('getSubResource', includeOpts); %>
         <%break;
         case 'putResource':%>
         <%- include('putResource', includeOpts); %>
         <%break;
         case 'putSubResource':%>
-        <%- include('putSubResource', includeSubOpts); %>
+        <%- include('putSubResource', includeOpts); %>
         <%break;
         case 'deleteResource':%>
         <%- include('deleteResource', includeOpts); %>
         <%break;
         case 'deleteSubResource':%>
-        <%- include('deleteSubResource', includeSubOpts); %>
+        <%- include('deleteSubResource', includeOpts); %>
         <%break;
-        case 'postResource':%>
-        <%- include('postResource', includeOpts); %>
+        case 'postResources':%>
+        <%- include('postResources', includeOpts); %>
         <%break;
-        case 'postSubResource':%>
-        <%- include('postSubResource', includeSubOpts); %>
+        case 'postSubResources':%>
+        <%- include('postSubResources', includeOpts); %>
         <%break;
         default:%>
         <%- include('default'); %>

handlers/templates/deleteResource.ejs

@@ -1,4 +1,4 @@
-        <%=Model%>.findByIdAndRemove(req.params.id).exec().then(function (item) {
+        <%=Model%>.findByIdAndRemove(req.params.<%=id%>).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();

handlers/templates/deleteSubResource.ejs

@@ -1,9 +1,9 @@
-        <%=Model%>.findById(req.params.parentId).exec().then(function (item) {
+        <%=Model%>.findById(req.params.<%=parentId%>).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();
             }
-            item.<%=subModelAttribute%>.id(req.params.id).remove();
+            item.<%=subModelAttribute%>.id(req.params.<%=id%>).remove();
             item.save(function (saveErr) {
                 return next(saveErr);
             });

handlers/templates/getResource.ejs

@@ -1,5 +1,5 @@
         var fields = !req.query.fields ? null : req.query.fields.replace(',', ' ');
-        <%=Model%>.findById(req.params.id, fields).exec().then(function (item) {
+        <%=Model%>.findById(req.params.<%=id%>, fields).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();

handlers/templates/getSubResource.ejs

@@ -1,10 +1,10 @@
-        <%=Model%>.findById(req.params.parentId).exec().then(function (item) {
+        <%=Model%>.findById(req.params.<%=parentId%>).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();
             }
 
-            var subDoc = item.<%=subModelAttribute%>.id(req.params.id);
+            var subDoc = item.<%=subModelAttribute%>.id(req.params.<%=id%>);
             if (!subDoc) {
                 res.sendStatus(404);
                 return next();

handlers/templates/getSubResources.ejs

@@ -1,4 +1,4 @@
-        <%=Model%>.findById(req.params.id).exec().then(function (item) {
+        <%=Model%>.findById(req.params.<%=id%>).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();

handlers/templates/postSubResource.ejs → handlers/templates/postSubResources.ejs

@@ -1,4 +1,4 @@
-        <%=Model%>.findById(req.params.parentId).exec().then(function (item) {
+        <%=Model%>.findById(req.params.<%=parentId%>).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();

handlers/templates/putResource.ejs

@@ -1,4 +1,4 @@
-        <%=Model%>.findByIdAndUpdate(req.params.id, req.body, {'new': true}).exec().then(function (item) {
+        <%=Model%>.findByIdAndUpdate(req.params.<%=id%>, req.body, {'new': true}).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();

handlers/templates/putSubResource.ejs

@@ -1,10 +1,10 @@
-        <%=Model%>.findById(req.params.parentId).exec().then(function (item) {
+        <%=Model%>.findById(req.params.<%=parentId%>).exec().then(function (item) {
             if (!item) {
                 res.sendStatus(404);
                 return next();
             }
 
-            var subDoc = item.<%=subModelAttribute%>.id(req.params.id);
+            var subDoc = item.<%=subModelAttribute%>.id(req.params.<%=id%>);
             if (!subDoc) {
                 res.sendStatus(404);
                 return next();

lib/specutil.js

@@ -10,6 +10,8 @@ var helpers = module.exports;
 
 
 var refRegExp = /^#\/definitions\/(\w*)$/;
+var pathParamRegExp = /^{.*}$/;
+
 
 var simpleTypes = {
     integer: 'Number',
@@ -150,66 +152,47 @@ helpers.getRespSchema = function getRespSchema(object) {
     return _.uniq(schemas);
 };
 
-helpers.getPathType = function getPathType(routePath, verb) {
-    var parent = false;
-    var byId = false;
-    var subDoc = false;
-    routePath.split('/').forEach(function (element) {
-        if (element) {
-            if (element === '{parentId}') {
-                parent = true;
-            } else if (element === '{id}') {
-                byId = true;
-            } else {
-                if (byId) {
-                    subDoc = true;
-                }
+helpers.getPathMetadata = function getPathMetadata(routePath) {
+    var totParam = 0;
+    var totPaths = 0;
+    var metadata = {
+        type: null,
+        subResource: null,
+        parentId: null,
+        id: null
+    };
+
+    _.compact(routePath.split('/')).forEach(function (element) {
+        if (pathParamRegExp.test(element)) {
+            element = element.replace(/{/g, '').replace(/}/g, '');
+            totParam += 1;
+            if (!metadata.id) {
+                metadata.id = element;
+            } else if (!metadata.parentId) {
+                metadata.parentId = metadata.id;
+                metadata.id = element;
             }
+        } else {
+            totPaths += 1;
+            metadata.subResource = element;
         }
     });
 
-    switch (verb) {
-        case 'get':
-            if (!byId && !parent) {
-                return 'getResources';
-            }
-            if (byId) {
-                if (parent) {
-                    return 'getSubResource';
-                }
-                return subDoc ? 'getSubResources' : 'getResource';
-            }
-            break;
-        case 'put':
-            if (byId && !subDoc) {
-                return parent ? 'putSubResource' : 'putResource';
-            }
-            break;
-        case 'delete':
-            if (byId && !subDoc) {
-                return parent ? 'deleteSubResource' : 'deleteResource';
-            }
-            break;
-        case 'post':
-            return byId ? 'postSubResource' : 'postResource';
-        default:
-            break;
-    }
-    return null;
-};
-
-helpers.getSubResourceAttribute = function getSubResourceAttribute(routePath) {
-    var parts = routePath.split('/');
-    var subattr = null;
-
-    while (parts) {
-        var part = parts.pop();
-        if (part && part !== '{parentId}' && part !== '{id}') {
-            subattr = part;
-            break;
+    if (totParam === 0 && totPaths > 0) {
+        metadata.type = 'Resources';
+    } else if (totParam === 1) {
+        if (totPaths === 1) {
+            metadata.type = 'Resource';
+        }
+        if (totPaths === 2) {
+            metadata.type = 'SubResources';
         }
+    } else if (totParam === 2) {
+        metadata.type = 'SubResource';
     }
-    return subattr;
+
+    debug('path metadata', metadata);
+    return metadata;
 };
 
 helpers.formatSuccessResponse = function formatSuccessResponse(responses, returnKey) {