add custom baseURL support, now can custom define "/users/:uid/post/:id" url

Author: fengmk2

README.md

@@ -49,13 +49,22 @@ var server = connect(
   connect.query(),
   connect.bodyParser(),
   urlrouter(function (app) {
-
     app.get('/', function (req, res) {
       res.end('hello world');
     });
 
-    restful(app, 'users', user);
-    restful(app, 'foos', foo);
+    restful({
+      app: app,
+      name: 'users',
+      controller: user
+    });
+    
+    restful({
+      app: app,
+      baseURL: '/users/:uid/',
+      name: 'foos',
+      controller: foo
+    });
 
   })
 ).listen(3000);

example/app.js

@@ -17,19 +17,28 @@ var user = require('./controllers/user');
 var foo = require('./controllers/foo');
 
 var server = connect(
-
-connect.query(),
-connect.bodyParser(),
-urlrouter(function (app) {
-
-  app.get('/', function (req, res) {
-    res.end('hello world');
-  });
-
-  restful(app, 'users', user);
-  restful(app, 'foos', foo);
-
-}));
+  connect.query(),
+  connect.bodyParser(),
+  urlrouter(function (app) {
+    app.get('/', function (req, res) {
+      res.end('hello world');
+    });
+
+    restful({
+      app: app,
+      name: 'users',
+      controller: user
+    });
+
+    restful({
+      app: app,
+      baseURL: '/users/:uid',
+      name: 'foos',
+      controller: foo
+    });
+
+  })
+);
 
 if (process.env.NODE_ENV !== 'test') {
   server.listen(3000);

example/controllers/foo.js

@@ -1,3 +1,3 @@
 exports.list = function (req, res, next) {
-  next(new Error('mock foo.list error'));
+  next(new Error('mock foo.list error, uid: ' + req.params.uid));
 };

lib/restful-router.js

@@ -10,6 +10,8 @@
  * Module dependencies.
  */
 
+var debug = require('debug')('restful-router');
+
 /**
  * Auto generate RESTful url routes.
  *
@@ -23,12 +25,22 @@
  *  PUT    /users/:id       => user.update()
  *  DELETE /users/:id       => user.destroy()
  *
- * @param {Object} app, must impl `app.get(), app.post(), app.put(), app.delete()`.
- * @param {String} name, resource's name. like `users, posts, tweets`.
- * @param {Object} mod, module contains `CRUD List` methods.
+ * @param {Object} options
+ *  - {Object} app, must impl `app.get(), app.post(), app.put(), app.delete()`.
+ *  - {String} name, resource's name. like `users, posts, tweets`.
+ *  - {Object} controller, controller module contains `CRUD List` methods.
+ *  - {String} [baseURL], default is '/'. e.g.: '/posts/:pid/'
  */
-module.exports = function restfulRouter(app, name, mod) {
-  var url = '/' + name;
+module.exports = function restfulRouter(options) {
+  var app = options.app;
+  var controller = options.controller;
+  var name = options.name || controller.name;
+  var baseURL = options.baseURL || '/';
+  if (baseURL[baseURL.length - 1] !== '/') {
+    baseURL += '/';
+  }
+  var url = baseURL + name;
+  debug('%s => %s', name, url);
   var routes = [
     [ 'get', url, 'list' ],
     [ 'get', url + '/new', 'new' ],
@@ -42,9 +54,10 @@ module.exports = function restfulRouter(app, name, mod) {
 
   for (var i = 0; i < routes.length; i++) {
     var route = routes[i];
-    var handle = mod[route[2]];
+    var handle = controller[route[2]];
     if (typeof handle === 'function') {
       app[route[0]](route[1], handle);
+      debug('%s %s', route[0], route[1]);
     }
   }
 };

package.json

@@ -7,6 +7,7 @@
     "test": "make test"
   },
   "dependencies": {
+    "debug": "0.x"
   },
   "devDependencies": {
     "should": "*",

test/restful-router.test.js

@@ -87,15 +87,22 @@ describe('restful-router.test.js', function () {
     .expect(404, done);
   });
 
-  it('should get /foos => 500', function (done) {
+  it('should get /foos => 404', function (done) {
     request(app)
     .get('/foos')
+    .expect(404, done);
+  });
+
+  it('should get /users/mk2/foos => 500', function (done) {
+    request(app)
+    .get('/users/mk2/foos')
+    .expect(/Error: mock foo.list error, uid: mk2/)
     .expect(500, done);
   });
 
-  it('should post /foos => 404', function (done) {
+  it('should post /users/123/foos => 404', function (done) {
     request(app)
-    .post('/foos')
+    .post('/users/123/foos')
     .expect(404, done);
   });