Better examples

.travis.yml

@@ -9,4 +9,4 @@ notifications:
   irc: "irc.freenode.org#nodejitsu"
 
 script:
-  npm run-script coveralls
+  npm test

examples/balancer/simple-balancer-with-websockets.js

@@ -0,0 +1,84 @@
+/*
+  simple-balancer.js: Example of a simple round robin balancer for websockets
+
+  Copyright (c) Nodejitsu 2013
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+
+var http = require('http'),
+    httpProxy = require('../../lib/http-proxy');
+
+//
+// A simple round-robin load balancing strategy.
+// 
+// First, list the servers you want to use in your rotation.
+//
+var addresses = [
+  {
+    host: 'ws1.0.0.0',
+    port: 80
+  },
+  {
+    host: 'ws2.0.0.0',
+    port: 80
+  }
+];
+
+//
+// Create a HttpProxy object for each target
+//
+
+var proxies = addresses.map(function (target) {
+  return new httpProxy.createProxyServer({
+    target: target
+  });
+});
+
+//
+// Get the proxy at the front of the array, put it at the end and return it
+// If you want a fancier balancer, put your code here
+//
+
+function nextProxy() {
+  var proxy = proxies.shift();
+  proxies.push(proxy);
+  return proxy;
+}
+
+// 
+// Get the 'next' proxy and send the http request 
+//
+
+var server = http.createServer(function (req, res) {    
+  nextProxy().web(req, res);
+});
+
+// 
+// Get the 'next' proxy and send the upgrade request 
+//
+
+server.on('upgrade', function (req, socket, head) {
+  nextProxy().ws(req, socket, head);
+});
+
+server.listen(8001);
+

examples/balancer/simple-balancer.js

@@ -0,0 +1,64 @@
+/*
+  simple-balancer.js: Example of a simple round robin balancer
+
+  Copyright (c) Nodejitsu 2013
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+
+var http = require('http'),
+    httpProxy = require('../../lib/http-proxy');
+//
+// A simple round-robin load balancing strategy.
+// 
+// First, list the servers you want to use in your rotation.
+//
+var addresses = [
+  {
+    host: 'ws1.0.0.0',
+    port: 80
+  },
+  {
+    host: 'ws2.0.0.0',
+    port: 80
+  }
+];
+var proxy = httpProxy.createServer();
+
+http.createServer(function (req, res) {
+  //
+  // On each request, get the first location from the list...
+  //
+  var target = { target: addresses.shift() };
+
+  //
+  // ...then proxy to the server whose 'turn' it is...
+  //
+  console.log('balancing request to: ', target);
+  proxy.web(req, res, target);
+
+  //
+  // ...and then the server you just used becomes the last item in the list.
+  //
+  addresses.push(target);
+}).listen(8021);
+
+// Rinse; repeat; enjoy.

examples/helpers/store.js

@@ -0,0 +1,64 @@
+
+//
+// just to make these example a little bit interesting, 
+// make a little key value store with an http interface
+// (see couchbd for a grown-up version of this)
+//
+// API:
+// GET / 
+// retrive list of keys
+//
+// GET /[url]
+// retrive object stored at [url]
+// will respond with 404 if there is nothing stored at [url]
+//
+// POST /[url]
+// 
+// JSON.parse the body and store it under [url]
+// will respond 400 (bad request) if body is not valid json.
+//
+// TODO: cached map-reduce views and auto-magic sharding.
+//
+var Store = module.exports = function Store () {
+  this.store = {};
+};
+
+Store.prototype = {
+  get: function (key) {
+    return this.store[key]
+  },
+  set: function (key, value) {
+    return this.store[key] = value
+  },
+  handler:function () {
+    var store = this
+    return function (req, res) {
+      function send (obj, status) {
+        res.writeHead(200 || status,{'Content-Type': 'application/json'})
+        res.write(JSON.stringify(obj) + '\n')
+        res.end()
+      }
+      var url = req.url.split('?').shift()
+      if (url === '/') {
+        console.log('get index')
+        return send(Object.keys(store.store))
+      } else if (req.method == 'GET') {
+        var obj = store.get (url)
+        send(obj || {error: 'not_found', url: url}, obj ? 200 : 404)
+      } else {
+        //post: buffer body, and parse.
+        var body = '', obj
+        req.on('data', function (c) { body += c})
+        req.on('end', function (c) {
+          try {
+            obj = JSON.parse(body)
+          } catch (err) {
+            return send (err, 400)
+          }
+          store.set(url, obj)
+          send({ok: true})
+        })
+      } 
+    }
+  }
+}

examples/http/basic-proxy.js

@@ -0,0 +1,60 @@
+/*
+  basic-proxy.js: Basic example of proxying over HTTP
+
+  Copyright (c) Nodejitsu 2013
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+
+var util = require('util'),
+    colors = require('colors'),
+    http = require('http'),
+    httpProxy = require('../../lib/http-proxy');
+
+var welcome = [
+  '#    # ##### ##### #####        #####  #####   ####  #    # #   #',
+  '#    #   #     #   #    #       #    # #    # #    #  #  #   # # ',  
+  '######   #     #   #    # ##### #    # #    # #    #   ##     #  ',   
+  '#    #   #     #   #####        #####  #####  #    #   ##     #  ',   
+  '#    #   #     #   #            #      #   #  #    #  #  #    #  ',   
+  '#    #   #     #   #            #      #    #  ####  #    #   #  '
+].join('\n');
+
+util.puts(welcome.rainbow.bold);
+
+//
+// Basic Http Proxy Server
+//
+httpProxy.createServer({
+  target:'http://localhost:9003'
+}).listen(8003);
+
+//
+// Target Http Server
+//
+http.createServer(function (req, res) {
+  res.writeHead(200, { 'Content-Type': 'text/plain' });
+  res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
+  res.end();
+}).listen(9003);
+
+util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8003'.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9003 '.yellow);