[doc] Breakout demo.js into files in example/. Add web-socket-proxy.j…

…s example
http-party · Apr 16, 2011 · 6e4bf6a · 6e4bf6a
1 parent b0b0183
commit 6e4bf6a
Show file tree

Hide file tree

Showing 7 changed files with 914 additions and 54 deletions.
diff --git a/examples/basic-proxy.js b/examples/basic-proxy.js
@@ -0,0 +1,47 @@
+/*
+  demo.js: http proxy for node.js
+
+  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'),
+    httpProxy = require('./../lib/node-http-proxy');
+
+//
+// Basic Http Proxy Server
+//
+httpProxy.createServer(9000, 'localhost').listen(8000);
+
+//
+// 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);
+
+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);
diff --git a/demo.js → examples/forward-proxy.js b/demo.js → examples/forward-proxy.js
@@ -27,67 +27,17 @@
 var util = require('util'),
     colors = require('colors')
     http = require('http'),
-    httpProxy = require('./lib/node-http-proxy');
-
-// ascii art from http://github.com/marak/asciimo
-var welcome = '\
-#    # ##### ##### #####        #####  #####   ####  #    # #   # \n\
-#    #   #     #   #    #       #    # #    # #    #  #  #   # #  \n\
-######   #     #   #    # ##### #    # #    # #    #   ##     #   \n\
-#    #   #     #   #####        #####  #####  #    #   ##     #   \n\
-#    #   #     #   #            #      #   #  #    #  #  #    #   \n\
-#    #   #     #   #            #      #    #  ####  #    #   #   \n';
-util.puts(welcome.rainbow.bold);
-
-//
-// Basic Http Proxy Server
-//
-httpProxy.createServer(9000, 'localhost').listen(8000);
-util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
-
-//
-// Http Proxy Server with Proxy Table
-//
-httpProxy.createServer({
-  router: {
-    'localhost': 'localhost:9000'
-  }
-}).listen(8001);
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8001 '.yellow + 'with proxy table'.magenta.underline)
-
-//
-// Http Proxy Server with Latency
-//
-httpProxy.createServer(function (req, res, proxy) {
-  var buffer = proxy.buffer(req);
-  setTimeout(function() {
-    proxy.proxyRequest(req, res, 9000, 'localhost', buffer);
-  }, 200)
-}).listen(8002);
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8002 '.yellow + 'with latency'.magenta.underline);
-
-//
+    httpProxy = require('./../lib/node-http-proxy');
+
 //
+// Setup proxy server with forwarding
 //
 httpProxy.createServer(9000, 'localhost', {
   forward: {
     port: 9001,
     host: 'localhost'
   }
 }).listen(8003);
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8003 '.yellow + 'with forward proxy'.magenta.underline)
-
-//
-// Http Server with proxyRequest Handler and Latency
-//
-var standAloneProxy = new httpProxy.HttpProxy();
-http.createServer(function (req, res) {
-  var buffer = standAloneProxy.buffer(req);
-  setTimeout(function() {
-    proxy.proxyRequest(req, res, 9000, 'localhost', buffer);
-  }, 200);
-}).listen(8004);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '8004 '.yellow + 'with proxyRequest handler'.cyan.underline + ' and latency'.magenta);
 
 //
 // Target Http Server
@@ -97,7 +47,6 @@ http.createServer(function (req, res) {
   res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
 }).listen(9000);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
 
 //
 // Target Http Forwarding Server
@@ -108,4 +57,7 @@ http.createServer(function (req, res) {
   res.write('request successfully forwarded to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
 }).listen(9001);
+
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8003 '.yellow + 'with forward proxy'.magenta.underline)
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
 util.puts('http forward server '.blue + 'started '.green.bold + 'on port '.blue + '9001 '.yellow);
diff --git a/examples/latent-proxy.js b/examples/latent-proxy.js
@@ -0,0 +1,52 @@
+/*
+  demo.js: http proxy for node.js
+
+  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'),
+    httpProxy = require('./../lib/node-http-proxy');
+
+//
+// Http Proxy Server with Latency
+//
+httpProxy.createServer(function (req, res, proxy) {
+  var buffer = proxy.buffer(req);
+  setTimeout(function() {
+    proxy.proxyRequest(req, res, 9000, 'localhost', buffer);
+  }, 200)
+}).listen(8002);
+
+//
+// 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);
+
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8002 '.yellow + 'with latency'.magenta.underline);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
diff --git a/examples/proxy-table.js b/examples/proxy-table.js
@@ -0,0 +1,51 @@
+/*
+  demo.js: http proxy for node.js
+
+  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'),
+    httpProxy = require('./../lib/node-http-proxy');
+
+//
+// Http Proxy Server with Proxy Table
+//
+httpProxy.createServer({
+  router: {
+    'localhost': 'localhost:9000'
+  }
+}).listen(8001);
+
+//
+// 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);
+
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8001 '.yellow + 'with proxy table'.magenta.underline)
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
diff --git a/examples/standalone-proxy.js b/examples/standalone-proxy.js
@@ -0,0 +1,53 @@
+/*
+  demo.js: http proxy for node.js
+
+  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'),
+    httpProxy = require('./../lib/node-http-proxy');
+
+//
+// Http Server with proxyRequest Handler and Latency
+//
+var proxy = new httpProxy.HttpProxy();
+http.createServer(function (req, res) {
+  var buffer = proxy.buffer(req);
+  setTimeout(function() {
+    proxy.proxyRequest(req, res, 9000, 'localhost', buffer);
+  }, 200);
+}).listen(8004);
+
+//
+// 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);
+
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '8004 '.yellow + 'with proxyRequest handler'.cyan.underline + ' and latency'.magenta);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
diff --git a/examples/web-socket-proxy.js b/examples/web-socket-proxy.js
@@ -0,0 +1,74 @@
+/*
+  demo.js: http proxy for node.js
+
+  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 sys = require('sys'),
+    http = require('http'),
+    websocket = require('./websocket'),
+    utils = require('socket.io/lib/socket.io/utils'),
+    io = require('socket.io'),
+    httpProxy = require('./../lib/node-http-proxy');
+
+//
+// Create the target HTTP server
+//
+var server = http.createServer(function (req, res) {
+  res.writeHead(200);
+  res.end();
+});
+server.listen(8080);
+
+//
+// Setup socket.io on the target HTTP server
+//
+var socket = io.listen(server);
+socket.on('connection', function (client) {
+  sys.debug('Got websocket connection');
+
+  client.on('message', function (msg) {
+    sys.debug('Got message from client: ' + msg);
+  });
+
+  socket.broadcast('from server');
+});
+
+//
+// Create a proxy server with node-http-proxy
+//
+var proxy = httpProxy.createServer(8080, 'localhost');
+proxy.listen(8081);
+
+//
+// Setup the web socket against our proxy
+//
+var ws = new websocket.WebSocket('ws://localhost:8081/socket.io/websocket/', 'borf');
+
+ws.on('open', function () {
+  ws.send(utils.encode('from client'));
+});
+
+ws.on('message', function (msg) {
+  sys.debug('Got message: ' + utils.decode(msg));
+});