place node-http-proxy-simple under version control

.npmignore

@@ -0,0 +1,3 @@
+/node_modules/
+*~
+*#*

Gruntfile.js

@@ -0,0 +1,47 @@
+/*
+**  http-proxy-simple -- Simple HTTP proxy, allowing protocol and payload interception
+**  Copyright (c) 2013 Ralf S. Engelschall <rse@engelschall.com>
+**
+**  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.
+*/
+
+/* global module: true */
+module.exports = function (grunt) {
+    grunt.initConfig({
+        pkg: grunt.file.readJSON("package.json"),
+        jshint: {
+            options: {
+                jshintrc: "jshint.json"
+            },
+            gruntfile:   [ "Gruntfile.js" ],
+            sourcefiles: [ "http-proxy-simple.js" ]
+        },
+        clean: {
+            clean:     [ ],
+            distclean: [ "node_modules" ]
+        }
+    });
+
+    grunt.loadNpmTasks("grunt-contrib-jshint");
+    grunt.loadNpmTasks("grunt-contrib-clean");
+
+    grunt.registerTask("default", [ "jshint" ]);
+};
+

Makefile

@@ -0,0 +1,41 @@
+##
+##  http-proxy-simple -- Simple HTTP proxy, allowing protocol and payload interception
+##  Copyright (c) 2013 Ralf S. Engelschall <rse@engelschall.com>
+##
+##  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.
+##
+
+NPM   = npm
+GRUNT = ./node_modules/grunt-cli/bin/grunt 
+
+all: build
+
+bootstrap:
+	@if [ ! -x $(GRUNT) ]; then $(NPM) install; fi
+
+build: bootstrap
+	@$(GRUNT)
+
+clean: bootstrap
+	@$(GRUNT) clean:clean
+
+distclean: bootstrap
+	@$(GRUNT) clean:clean clean:distclean
+

README.md

@@ -1,4 +1,94 @@
+
 node-http-proxy-simple
 ======================
 
-Node extension module for simple HTTP proxy
+Abstract
+--------
+
+This is a [Node.js](http://nodejs.org/) extension module for
+implementing a very simple HTTP proxy which allows you to on-the-fly
+intercept and modify HTTP request/response header and payload
+information. It is primarily intended for development scenarios where
+a full-featured HTTP proxy is not necessary but the data of an
+own application needs to be on-the-fly modified for testing
+and instrumentation purposes.
+
+Installation
+------------
+
+Use the Node Package Manager (NPM) to install this module
+locally (default) or globally (with option `-g`):
+
+    $ npm install [-g] node-http-proxy-simple
+
+Usage
+-----
+
+var proxy = request("http-proxy-simple").createProxyServer({
+    host: "127.0.0.1",
+    port: 3128,
+    servername: os.hostname().
+    id: "my-proxy/1.0",
+    proxy: "proxy.example.com:3128",
+});
+
+proxy.on("request", function (request, response) {
+   console.log("request: " + JSON.stringify(request.connection));
+});
+
+proxy.on("error", function (error, socket) {
+   console.log("error: " + error + ": " + JSON.stringify(socket));
+});
+
+Application Programming Interface (API)
+---------------------------------------
+
+### Method: `createProxyServer(options: Options): ProxyServer`
+
+Create a proxy server. The following options are supported:
+
+- `host`: IP address (or name) for listening for HTTP proxy requests. Defaults to `127.0.0.1`.
+- `port`: TCP port for listening for HTTP proxy requests. Defaults to `3128`.
+- `servername`: server host name for identification purposes in HTTP `Via` headers. Defaults to the result of `os.hostname()`.
+- `id`: optional software name/version pair for identification purposes in HTTP `Via`headers. Defaults to `node-http-proxy-simple/X.X.X`.
+- `proxy`: optional upstream proxy to forward requests to. Defaults to `""` (no forward proxy).
+
+See Also
+--------
+
+- [node http.Server](http://nodejs.org/api/http.html#http_class_http_server)
+- [node request](https://github.com/mikeal/request)
+
+Credits
+-------
+
+Thanks to [Michael C. Axiak](mailto:mike@axiak.net) for its
+[FilterNet](https://github.com/axiak/filternet) module which inspired
+this module. FilterNet is more feature-packed (it also provides SSL/TLS
+support, compression support, etc) but had too much dependencies
+and especially did not support proxy forwarding.
+
+License
+-------
+
+Copyright (c) 2013 Ralf S. Engelschall (http://engelschall.com/)
+
+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.
+

http-proxy-simple.js

@@ -0,0 +1,189 @@
+/*
+**  http-proxy-simple -- Simple HTTP proxy, allowing protocol and payload interception
+**  Copyright (c) 2013 Ralf S. Engelschall <rse@engelschall.com>
+**
+**  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.
+*/
+
+/* global require: true */
+/* global module: true */
+
+/*  load Node module requirements (built-in)  */
+var os     = require("os");
+var fs     = require("fs");
+var http   = require("http");
+var events = require("events");
+
+/*  load Node module requirements (external)  */
+var req    = require("request");
+
+/*  export the API  */
+module.exports = {
+    createProxyServer: function (opts) {
+        /*  prepare settings  */
+        opts = opts || {};
+        var serverHost   = opts.host               || "127.0.0.1";
+        var serverPort   = parseInt(opts.port, 10) || 3128;
+        var serverName   = opts.servername         || os.hostname();
+        var proxy        = opts.proxy              || "";
+
+        /*  determine service identifier  */
+        var id = opts.id;
+        if (typeof id === "undefined" || (id + "").match(/^[a-zA-Z0-9_-]+\/[0-9](?:\.[0-9])*$/) === null) {
+            var pjson = JSON.parse(fs.readFileSync("package.json", "utf8"));
+            id = pjson.name + "/" + pjson.version;
+        }
+
+        /*  create event emitting proxy object  */
+        var proxyserver = new events.EventEmitter();
+
+        /*  helper function: emit event or run fallback action  */
+        var emitOrRun = function (eventName, callback) {
+            if (!proxyserver.listeners(eventName).length)
+                callback();
+            else {
+                var args = Array.prototype.slice.call(arguments, 2);
+                args.unshift(eventName);
+                proxyserver.emit.apply(proxyserver, args);
+            }
+        };
+
+        /*  create HTTP server  */
+        var httpServer = http.createServer(function (request, response) {
+            /*  determine connection id  */
+            var cid = request.connection.remoteAddress + ":" + request.connection.remotePort;
+
+            /*  for interception ensure there is no compression  */
+            request.headers["accept-encoding"] = "identity";
+            delete request.headers["proxy-connection"];
+
+            /*  provide forwarding information (1/2)  */
+            var clientIp = request.connection.remoteAddress;
+            if (request.headers["x-forwarded-for"])
+                request.headers["x-forwarded-for"] += ", " + clientIp;
+            else
+                request.headers["x-forwarded-for"] = clientIp;
+            request.headers["forwarded-for"] = request.headers["x-forwarded-for"];
+
+            /*  provide forwarding information (2/2)  */
+            request.headers.via = request.httpVersion + " " + serverName;
+            var localAddr = request.connection.address();
+            if (localAddr !== null)
+                request.headers.via += ":" + request.connection.address().port;
+            request.headers.via += " (" + id + ")";
+
+            /*  assemble request information  */
+            var remoteRequest = {
+                url:            request.url,
+                method:         request.method,
+                headers:        request.headers,
+                body:           request.body,
+                followRedirect: false,
+                encoding:       null
+            };
+            if (proxy !== "" && remoteRequest.url.href.indexOf("localhost") === -1)
+                remoteRequest.proxy = proxy;
+
+            /*  helper function for fixing the upper/lower cases of headers  */
+            var fixHeaderCase = function (headers) {
+                var result = {};
+                for (var key in headers) {
+                    if (!headers.hasOwnProperty(key))
+                        continue;
+                    var newKey = key.split("-")
+                        .map(function(token) { return token[0].toUpperCase() + token.slice(1); })
+                        .join("-");
+                    result[newKey] = headers[key];
+                }
+                return result;
+            };
+
+            /*  perform the HTTP client request  */
+            var performRequest = function (remoteRequest) {
+                /*  adjust headers  */
+                remoteRequest.headers = fixHeaderCase(remoteRequest.headers);
+                try {
+                    req(remoteRequest, function (error, remoteResponse, remoteResponseBody) {
+                        /*  perform the HTTP client response  */
+                        if (error) {
+                            proxyserver.emit("http-error", cid, error, request, response);
+                            response.writeHead(400, {});
+                            response.end();
+                        }
+                        else {
+                            var performResponse = function (remoteResponse, remoteResponseBody) {
+                                response.writeHead(remoteResponse.statusCode, remoteResponse.headers);
+                                response.write(remoteResponseBody);
+                                response.end();
+                            };
+                            emitOrRun("http-intercept-response", function () {
+                                performResponse(remoteResponse, remoteResponseBody);
+                            }, cid, request, response, remoteResponse, remoteResponseBody, performResponse);
+                        }
+                    });
+                }
+                catch (error) {
+                    proxyserver.emit("http-error", cid, error, request, response);
+                    response.writeHead(400, {});
+                    response.end();
+                }
+            };
+            emitOrRun("http-intercept-request", function () {
+                performRequest(remoteRequest);
+            }, cid, request, response, remoteRequest, performRequest);
+        });
+
+        /*  react upon HTTP server events  */
+        httpServer.on("connection", function (socket) {
+            var cid = socket.remoteAddress + ":" + socket.remotePort;
+            proxyserver.emit("connection-open", cid, socket);
+            socket.on("close", function (had_error) {
+                proxyserver.emit("connection-close", cid, socket, had_error);
+            });
+            socket.on("error", function (error) {
+                proxyserver.emit("connection-error", cid, socket, error);
+            });
+        });
+        httpServer.on("clientError", function () {
+            /*  already handled above on socket directly  */
+        });
+        httpServer.on("request", function (request, response) {
+            if (typeof request.connection.remoteAddress === "undefined" ||
+                typeof request.connection.remotePort    === "undefined"   )
+                return;
+            var cid = request.connection.remoteAddress + ":" + request.connection.remotePort;
+            proxyserver.emit("http-request", cid, request, response);
+        });
+        httpServer.on("connect", function (request, socket) {
+            var cid = request.connection.remoteAddress + ":" + request.connection.remotePort;
+            proxyserver.emit("http-error", cid, "CONNECT method not supported", request, socket);
+        });
+        httpServer.on("upgrade", function (request, socket) {
+            var cid = request.connection.remoteAddress + ":" + request.connection.remotePort;
+            proxyserver.emit("http-error", cid, "protocol upgrade not supported", request, socket);
+        });
+
+        /*  listen for connections  */
+        httpServer.listen(serverPort, serverHost);
+
+        return proxyserver;
+    }
+};
+