[minor] Style updates and whitespace cleaning for consistency

Author: indexzero

examples/body-decoder.js

@@ -1,11 +1,34 @@
-#!/usr/local/bin/node
+/*
+  body-decoder.js: Example of body-decoder middleware with node-http-proxy 
+
+  Copyright (c) 2010 Charlie Robbins, Mikeal Rogers, Fedor Indutny, & Marak Squires.
+
+  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 httpProxy = require('http-proxy'),
     http = require('http'),
     util = require('util'),
     colors = require('colors');
 
-
 exports.bodyMod = function () {
   console.log('middleware has been started.'.green);
   return function (req, res, next) {
@@ -16,16 +39,22 @@ exports.bodyMod = function () {
       console.log('ON DATA')
       total += data;
     });
+    
     req.on('end', function () {
       console.log('ON END')
       console.log(total);
+      //
       // This line, uncommented, hangs forever.
       // proxy.proxyRequest(req, res, { port: 9000, host: 'localhost' });
       // The following also hangs forever.
       // next.proxyRequest(req, res, { port: 9000, host: 'localhost' });
-    })
+      //
+    });
+    
+    //
     // The following fires just fine.
     //proxy.proxyRequest(req, res, { port: 9000, host: 'localhost' });
+    //
     console.log('request proxied...'.blue); 
   }
 }

examples/gzip-middleware.js

@@ -1,5 +1,5 @@
 /*
-  gzip-middleware.js: Basic example of middleware in node-http-proxy
+  gzip-middleware.js: Basic example of `connect-gzip` middleware in node-http-proxy
 
   Copyright (c) 2010 Charlie Robbins, Mikeal Rogers, Fedor Indutny, Marak Squires, & Dominic Tarr.
 
@@ -32,7 +32,6 @@ var util = require('util'),
 //
 // Basic Http Proxy Server
 //
-
 httpProxy.createServer(
   require('connect-gzip').gzip({ matchType: /.?/ }),
   9000, 'localhost'
@@ -41,12 +40,11 @@ httpProxy.createServer(
 //
 // 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(9000);
+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(9000);
 
 util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
 util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);

examples/url-middleware.js

@@ -1,3 +1,29 @@
+/*
+  url-middleware.js: Example of a simple url routing middleware for node-http-proxy
+
+  Copyright (c) 2010 Charlie Robbins, Mikeal Rogers, Fedor Indutny, & Marak Squires.
+
+  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'),
@@ -10,21 +36,29 @@ var util = require('util'),
 //
 
 function matcher (url, dest) {
+  //
   // First, turn the URL into a regex.  
   // NOTE: Turning user input directly into a Regular Expression is NOT SAFE.
+  //
   var r = new RegExp(url.replace(/\//, '\\/'));
+  
+  //
   // This next block of code may look a little confusing. 
   // It returns a closure (anonymous function) for each URL to be matched,
   // storing them in an array - on each request, if the URL matches one that has
   // a function stored for it, the function will be called.
+  //
   return function (url) {
     var m = r(url)
     if (!m) {
       return;
     }
     var path = url.slice(m[0].length);
     console.log('proxy:', url, '->', dest);
-    return {url: path, dest: dest};
+    return {
+      url: path, 
+      dest: dest
+    };
   }
 }
 
@@ -61,26 +95,29 @@ exports.urls = function (urls) {
   }
 }
 
+//
 // Now we set up our proxy.
+//
 httpProxy.createServer(
+  //
   // This is where our middlewares go, with any options desired - in this case,
   // the list of routes/URLs and their destinations.
+  //
   exports.urls({
     '/hello': { port: 9000, host: 'localhost' },
     '/charlie': { port: 80, host: 'charlieistheman.com' },
     '/google': { port: 80, host: 'google.com' } 
-  })
+  });
 ).listen(8000);
 
 //
 // Target Http Server (to listen for requests on 'localhost')
 //
-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(9000);
+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(9000);
 
 // And finally, some colored startup output.
 util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);

examples/web-socket-proxy.js

@@ -47,6 +47,7 @@ var server = http.createServer(function (req, res) {
   res.writeHead(200);
   res.end();
 });
+
 server.listen(8080);
 
 //