Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial commit.

  • Loading branch information...
commit d304a585630bcc30b8ef17051e104d848fc211d5 0 parents
cloudhead authored
179 LICENSE
@@ -0,0 +1,179 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright (c) 2009-2010 Alexis Sellier
129 README.md
@@ -0,0 +1,129 @@
+http-console
+============
+
+> Speak HTTP like a local
+
+synopsis
+--------
+
+ $ http-console 127.0.0.1:5984
+
+ http://127.0.0.1:5984/>
+ http://127.0.0.1:5984/> GET /
+
+ HTTP/1.1 200 OK
+ Date: Mon, 31 May 2010 04:43:39 GMT
+ Content-Type: text/plain;charset=utf-8
+ Content-Length: 41
+
+ {
+ couchdb: "Welcome",
+ version: "0.11.0"
+ }
+
+installation
+------------
+
+ $ npm install http-console
+
+introduction
+------------
+
+Let's assume we have a [CouchDB](http://couchdb.apache.org) instance running locally.
+
+### connecting #
+
+To connect, we run `http-console`, passing it the server host and port as such:
+
+ $ http-console 127.0.0.1:5984
+
+To have line-editing and command history, we can run it through `rlwrap`:
+
+ $ rlwrap http-console 127.0.0.1:5984
+
+### navigating #
+
+Once connected, we should see the *http prompt*:
+
+ http://127.0.0.1:5984/>
+
+server navigation is similar to directory navigation, except a little simpler:
+
+ http://127.0.0.1:5984/> /logs
+ http://127.0.0.1:5984/logs> /46
+ http://127.0.0.1:5984/logs/46> ..
+ http://127.0.0.1:5984/logs> ..
+ http://127.0.0.1:5984/>
+
+### requesting #
+
+HTTP requests are issued with the HTTP verbs *GET*, *PUT*, *POST*, *HEAD* and *DELETE*, and
+a relative path:
+
+ http://127.0.0.1:5984/> GET /
+ HTTP/1.1 200 OK
+ Date: Mon, 31 May 2010 04:43:39 GMT
+ Content-Length: 41
+
+ {
+ couchdb: "Welcome",
+ version: "0.11.0"
+ }
+
+ http://127.0.0.1:5984/> GET /bob
+ HTTP/1.1 404 Not Found
+ Date: Mon, 31 May 2010 04:45:32 GMT
+ Content-Length: 44
+
+ {
+ error: "not_found",
+ reason: "no_db_file"
+ }
+
+When issuing *POST* and *PUT* commands, we have the opportunity to send data too:
+
+ http://127.0.0.1:5984/> /rabbits
+ http://127.0.0.1:5984/rabbits> POST
+ ... {"name":"Roger"}
+
+ HTTP/1.1 201 Created
+ Location: http://127.0.0.1/test/2fd9db055885e6982462a10e54003127
+ Date: Mon, 31 May 2010 05:09:15 GMT
+ Content-Length: 95
+
+ {
+ ok: true,
+ id: "2fd9db055885e6982462a10e54003127",
+ rev: "1-0c3db91854f26486d1c3922f1a651d86"
+ }
+
+Note that `POST /` is equivalent to just `POST`. This applies to all methods.
+
+### setting headers #
+
+Sometimes, it's useful to set HTTP headers:
+
+ http://127.0.0.1:5984/> Accept: application/json
+ http://127.0.0.1:5984/> X-Lodge: black
+
+These headers are sent with all requests in this session. To see all active headers,
+run the `\headers` command:
+
+ http://127.0.0.1:5984/> \headers
+ Accept: application/json
+ X-Lodge: black
+
+Removing headers is just as easy:
+
+ http://127.0.0.1:5984/> Accept:
+ http://127.0.0.1:5984/> \headers
+ X-Lodge: black
+
+### quitting #
+
+ Ctrl-D
+
+nuff' said.
+
+
+
19 bin/http-console
@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+var path = require('path');
+
+require.paths.unshift(path.join(__dirname, '..', 'lib'));
+
+var parselmouth = require('parselmouth');
+
+var argv = process.argv.slice(2),
+ hostPort = argv.length ? argv.shift().replace('http://', '').split(':') : [],
+ host = hostPort[0] || '127.0.0.1',
+ port = hostPort[1] || 80
+ options = {};
+
+var console = new(parselmouth.Console)(host, port, options);
+
+console.initialize();
+
+
169 lib/http-console.js
@@ -0,0 +1,169 @@
+
+var http = require('http'),
+ events = require('events'),
+ sys = require('sys');
+
+var inspect = require('eyes').inspector();
+var consoles = [];
+
+this.Console = function (host, port, options) {
+ this.host = host;
+ this.port = port;
+ this.options = options;
+ this.path = [];
+ this.socket = null;
+ consoles.push(this);
+};
+
+this.Console.prototype = new(function () {
+ this.initialize = function () {
+ var that = this;
+
+ this.socket = http.createClient(this.port, this.host);
+ this.headers = { 'Accept':'*/*' };
+
+ this.stdin = process.openStdin();
+ this.stdin.setEncoding('ascii');

I am curious about this. Why 'ascii' vs 'utf8' or even 'binary'?

@cloudhead Owner

Ah yes, I think it's my irrational fear of unicode. I'll change it to utf8.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+ this.stdin.addListener('data', function (str) {
+ that.exec(str.trim());
+ });
+ this.prompt();
+
+ return this;
+ };
+ this.request = function (method, path, callback) {
+ var request;
+
+ this.headers['Host'] = this.host;
+
+ request = this.socket.request(method.toUpperCase(),
+ path.replace('//', '/'),
+ this.headers);
+
+ request.addListener('response', function (res) {
+ var body = "";
+ res.addListener('data', function (chunk) { body += chunk });
+ res.addListener('end', function () { callback(res, body) });
+ });
+
+ return request;
+ };
+ this.exec = function (command) {
+ var method, headers = {}, path = this.path, body,
+ that = this;
+
+ if (this.waitingForData) {
+ this.waitingForData.write(command);
+ this.waitingForData.end();
+ this.waitingForData = false;
+ return;
+ } else if (command[0] === '/') {
+ Array.prototype.push.apply(
+ this.path, command.split('/').filter(function (e) { return e })
+ );
+ } else if (command === '..') {
+ this.path.pop();
+ } else if (command[0] === '\\') {
+ switch (command.slice(1)) {
+ case 'headers':
+ this.printHeaders(this.headers);
+ break;
+ }
+ } else if (match = command.match(/([a-zA-Z-]+):\s*(.*)/)) {
+ if (match[2]) {
+ this.headers[match[1]] = match[2];
+ } else {
+ delete(this.headers[match[1]]);
+ }
+ } else if (/^(GET|POST|PUT|HEAD|DELETE)/.test(command)) {
+ command = command.split(/\s+/);
+ method = command.shift();
+ path = '/' + this.path.concat(command.shift()).join('/');
+
+ if (method === 'PUT' || method === 'POST') {
+ this.waitingForData = this.request(method, path, function (res, body) {
+ that.printResponse.call(that, res, body);
+ that.prompt();
+ });
+ this.dataPrompt();
+ } else {
+ this.request(method, path, function (res, body) {
+ that.printResponse.call(that, res, body);
+ that.prompt();
+ }).end();
+ }
+ return;
+ } else if (command) {
+ sys.puts(("unknown command '" + command + "'").yellow.bold);
+ }
+ this.prompt();
+ };
+ this.printResponse = function (res, body) {
+ var status = ('HTTP/' + res.httpVersion +
+ ' ' + res.statusCode +
+ ' ' + http.STATUS_CODES[res.statusCode]).bold;
+
+ if (res.statusCode >= 500) { status = status.red }
+ else if (res.statusCode >= 400) { status = status.yellow }
+ else { status = status.green }
+
+ sys.puts(status);
+
+ this.printHeaders(res.headers);
+
+ sys.print('\n');
+
+ try { inspect(JSON.parse(body)) }
+ catch (_) { sys.print(body.trim().cyan + '\n') }
+ };
+ this.prompt = function () {
+ sys.print(('http://' + this.host + ':' + this.port + '/' + this.path.join('/') + '> ').grey);
+ };
+ this.dataPrompt = function () {
+ sys.print('... '.grey);
+ };
+ this.printHeaders = function (headers) {
+ Object.keys(headers).forEach(function (k) {
+ var key = k.replace(/\b([a-z])/g, function (_, m) {
+ return m.toUpperCase();
+ }).bold;
+ sys.puts(key + ': ' + headers[k]);
+ });
+ };
+});
+
+process.addListener('uncaughtException', function (e) {
+ sys.puts(('Error: ' + e.message).red);
+ process.exit(-1);
+});
+
+process.addListener('exit', function () {
+ consoles.forEach(function (c) {
+ c.socket.destroy();
+ });
+ sys.print('\n');
+});
+
+['bold', 'grey', 'yellow', 'green', 'cyan'].forEach(function (style) {
+ Object.defineProperty(String.prototype, style, {
+ get: function () {
+ return stylize(this, style);
+ }
+ });
+});
+
+
+function stylize(str, style) {
+ var styles = {
+ 'bold' : [1, 22],
+ 'italic' : [3, 23],
+ 'underline' : [4, 24],
+ 'yellow' : [33, 39],
+ 'cyan' : [37, 39],
+ 'green' : [32, 39],
+ 'red' : [31, 39],
+ 'grey' : [90, 39],
+ };
+ return '\033[' + styles[style][0] + 'm' + str +
+ '\033[' + styles[style][1] + 'm';
+};
14 package.json
@@ -0,0 +1,14 @@
+{
+ "name" : "http-console",
+ "description" : "Speak HTTP like a native",
+ "url" : "http://github.com/cloudhead/http-console",
+ "keywords" : ["http", "console"],
+ "author" : "Alexis Sellier <self@cloudhead.net>",
+ "contributors" : [],
+ "dependencies" : { "eyes": ">=0.1.0" },
+ "version" : "0.1.0",
+ "main" : "./lib/http-console",
+ "directories" : { "lib": "./lib", "test": "./test" },
+ "bin" : { "http-console": "./bin/http-console" },
+ "engines" : { "node": ">=0.1.93" }
+}
@fictorial

I am curious about this. Why 'ascii' vs 'utf8' or even 'binary'?

@cloudhead

Ah yes, I think it's my irrational fear of unicode. I'll change it to utf8.

Please sign in to comment.
Something went wrong with that request. Please try again.