Permalink
Browse files

Initial commit.

  • Loading branch information...
0 parents commit d304a585630bcc30b8ef17051e104d848fc211d5 cloudhead committed May 31, 2010
Showing with 510 additions and 0 deletions.
  1. +179 −0 LICENSE
  2. +129 −0 README.md
  3. +19 −0 bin/http-console
  4. +169 −0 lib/http-console.js
  5. +14 −0 package.json
@@ -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
@@ -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.
+
+
+
@@ -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();
+
+
Oops, something went wrong.

0 comments on commit d304a58

Please sign in to comment.