Adding support for handlers on routes

avoidwork · Aug 2, 2014 · 4cb2300 · 4cb2300
1 parent 8b15cad
commit 4cb2300
Show file tree

Hide file tree

Showing 10 changed files with 110 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -3,4 +3,49 @@ Tensō
 
 Tensō is a REST framework for node.js, designed to simplify the implementation of APIs.
 
-Coming soon!
+## Example
+Creating an API with Tensō is as simple as three statements.
+
+```javascript
+"use strict";
+
+var tenso  = require( "tenso" ),
+    config = require( __dirname + "/config.json" ),
+    app    = tenso( config );
+```
+
+## Creating Routes
+Routes are loaded as a module, affording a very customizable API server. The following example will return an empty `Array` at `/`, a `String` at `/reports/tps`, & a random number at `/random`.
+
+```javascript
+var random  = require( "keigai" ).util.number.random,
+    prepare = require( "./lib/tenso" ).prepare;
+
+module.exports.get = {
+	"/": [],
+	"/reports/tps": "TPS Cover Sheet not attached",
+	"/random": function ( req, res ) {
+		this.respond( req, res, prepare( random() ) );
+	}
+}
+```
+
+## Configuration
+This is a sample configuration for Tensō, without authentication or SSL. This would be ideal for development, but not production! Enabling is as easy as providing file paths for the two keys.
+
+```json
+{
+	"hostname": "localhost",
+	"pageSize": 5,
+	"port": 8000,
+	"routes": "routes.js",
+	"log": {
+		"dtrace": false,
+		"syslog": false
+	},
+	"ssl": {
+		"key": null,
+		"cert": null
+	}
+}
+```
diff --git a/doc/global.html b/doc/global.html
@@ -349,7 +349,7 @@ <h4 class="name" id="error"><span class="type-signature"></span>error<span class
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tenso.js.html">tenso.js</a>, <a href="tenso.js.html#sunlight-1-line-67">line 67</a>
+        <a href="tenso.js.html">tenso.js</a>, <a href="tenso.js.html#sunlight-1-line-72">line 72</a>
     </li></ul></dd>
 
 
@@ -441,7 +441,7 @@ <h4 class="name" id="factory"><span class="type-signature"></span>factory<span c
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tenso.js.html">tenso.js</a>, <a href="tenso.js.html#sunlight-1-line-77">line 77</a>
+        <a href="tenso.js.html">tenso.js</a>, <a href="tenso.js.html#sunlight-1-line-82">line 82</a>
     </li></ul></dd>
 
 
@@ -628,7 +628,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tenso.js.html">tenso.js</a>, <a href="tenso.js.html#sunlight-1-line-104">line 104</a>
+        <a href="tenso.js.html">tenso.js</a>, <a href="tenso.js.html#sunlight-1-line-109">line 109</a>
     </li></ul></dd>
 
 
@@ -702,7 +702,7 @@ <h5>Returns:</h5>
 
 		<span class="jsdoc-message">
 		Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
-		on Fri Aug 01 2014 23:32:19 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
+		on Fri Aug 01 2014 23:54:57 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
 		</span>
 				</footer>
 			</div>

diff --git a/doc/index.html b/doc/index.html
@@ -101,7 +101,25 @@
     <section>
         <article><h1>Tensō</h1>
 <p>Tensō is a REST framework for node.js, designed to simplify the implementation of APIs.</p>
-<p>Coming soon!</p></article>
+<h2>Example</h2>
+<p>Creating an API with Tensō is as simple as three statements.</p>
+<pre><code class="lang-javascript">&quot;use strict&quot;;
+
+var tenso  = require( &quot;tenso&quot; ),
+    config = require( __dirname + &quot;/config.json&quot; ),
+    app    = tenso( config );</code></pre>
+<h2>Creating Routes</h2>
+<p>Routes are loaded as a module, affording a very customizable API server. The following example will return an empty <code>Array</code> at <code>/</code>, a <code>String</code> at <code>/reports/tps</code>, &amp; a random number at <code>/random</code>.</p>
+<pre><code class="lang-javascript">var random  = require( &quot;keigai&quot; ).util.number.random,
+    prepare = require( &quot;tenso&quot; ).prepare;
+
+module.exports.get = {
+    &quot;/&quot;: [],
+    &quot;/reports/tps&quot;: &quot;TPS Cover Sheet not attached&quot;,
+    &quot;/random&quot;: function ( req, res ) {
+        this.respond( req, res, prepare( random() ) );
+    }
+}</code></pre></article>
     </section>
 
 
@@ -123,7 +141,7 @@
 
 		<span class="jsdoc-message">
 		Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
-		on Fri Aug 01 2014 23:32:19 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
+		on Fri Aug 01 2014 23:54:57 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
 		</span>
 				</footer>
 			</div>

diff --git a/doc/module-tenso.html b/doc/module-tenso.html
@@ -186,7 +186,7 @@ <h2>
 
 		<span class="jsdoc-message">
 		Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
-		on Fri Aug 01 2014 23:32:19 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
+		on Fri Aug 01 2014 23:54:57 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
 		</span>
 				</footer>
 			</div>

diff --git a/doc/modules.list.html b/doc/modules.list.html
@@ -163,7 +163,7 @@ <h2>
 
 		<span class="jsdoc-message">
 		Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
-		on Fri Aug 01 2014 23:32:19 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
+		on Fri Aug 01 2014 23:54:57 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
 		</span>
 				</footer>
 			</div>

diff --git a/doc/tenso.js.html b/doc/tenso.js.html
@@ -130,9 +130,14 @@ <h1 class="page-title">Source: tenso.js</h1>
 	if ( config.routes instanceof Object ) {
 		iterate( config.routes, function ( routes, method ) {
 			iterate( routes, function ( arg, route ) {
-				obj.server[method]( route, function ( res, req ) {
-					this.respond( res, req, prepare( arg ) );
-				} );
+				if ( typeof arg == "function" ) {
+					obj.server[method]( route, arg );
+				}
+				else {
+					obj.server[method]( route, function ( req, res ) {
+						this.respond( req, res, prepare( arg ) );
+					} );
+				}
 			} );
 		} );
 	}
@@ -203,7 +208,8 @@ <h1 class="page-title">Source: tenso.js</h1>
 	};
 }
 
-module.exports = factory;
+factory.prepare = prepare;
+module.exports  = factory;
 } )();
 </pre>
         </article>
@@ -226,7 +232,7 @@ <h1 class="page-title">Source: tenso.js</h1>
 
 		<span class="jsdoc-message">
 		Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
-		on Fri Aug 01 2014 23:32:19 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
+		on Fri Aug 01 2014 23:54:57 GMT-0400 (EDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
 		</span>
 				</footer>
 			</div>

diff --git a/lib/tenso.js b/lib/tenso.js
@@ -49,9 +49,14 @@ function bootstrap( obj, config ) {
 	if ( config.routes instanceof Object ) {
 		iterate( config.routes, function ( routes, method ) {
 			iterate( routes, function ( arg, route ) {
-				obj.server[method]( route, function ( res, req ) {
-					this.respond( res, req, prepare( arg ) );
-				} );
+				if ( typeof arg == "function" ) {
+					obj.server[method]( route, arg );
+				}
+				else {
+					obj.server[method]( route, function ( req, res ) {
+						this.respond( req, res, prepare( arg ) );
+					} );
+				}
 			} );
 		} );
 	}
@@ -122,5 +127,6 @@ function prepare ( data, error, status ) {
 	};
 }
 
-module.exports = factory;
+factory.prepare = prepare;
+module.exports  = factory;
 } )();
diff --git a/routes.js b/routes.js
@@ -1,4 +1,10 @@
+var random  = require( "keigai" ).util.number.random,
+    prepare = require( "./lib/tenso" ).prepare;
+
 module.exports.get = {
 	"/": [],
-	"/reports/tps": "TPS Cover Sheet not attached"
+	"/reports/tps": "TPS Cover Sheet not attached",
+	"/random": function ( req, res ) {
+		this.respond( req, res, prepare( random() ) );
+	}
 }
diff --git a/src/bootstrap.js b/src/bootstrap.js
@@ -19,9 +19,14 @@ function bootstrap( obj, config ) {
 	if ( config.routes instanceof Object ) {
 		iterate( config.routes, function ( routes, method ) {
 			iterate( routes, function ( arg, route ) {
-				obj.server[method]( route, function ( res, req ) {
-					this.respond( res, req, prepare( arg ) );
-				} );
+				if ( typeof arg == "function" ) {
+					obj.server[method]( route, arg );
+				}
+				else {
+					obj.server[method]( route, function ( req, res ) {
+						this.respond( req, res, prepare( arg ) );
+					} );
+				}
 			} );
 		} );
 	}

diff --git a/src/outro.js b/src/outro.js
@@ -1,2 +1,3 @@
-module.exports = factory;
+factory.prepare = prepare;
+module.exports  = factory;
 } )();