From 1d50786153c114093028b4cce934cf75dee1cc99 Mon Sep 17 00:00:00 2001 From: Brian Payne Date: Sat, 18 Jan 2020 14:05:07 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Readme=20(#24)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit GH-23 --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++ README.md | 283 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 484 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7880030 --- /dev/null +++ b/README.md @@ -0,0 +1,283 @@ +# dot_http ![Verify build](https://github.com/bayne/dot_http/workflows/Verify/badge.svg) + +![gitmoji](https://img.shields.io/badge/gitmoji-%20%F0%9F%98%9C%20%F0%9F%98%8D-FFDD67.svg?style=flat-square) +![Powered by Rust](https://img.shields.io/badge/Powered%20By-Rust-orange?style=flat-square) + +dot_http is a text-based scriptable HTTP client. It is a simple language that resembles the actual HTTP protocol but with additional features to make it practical for someone who builds and tests APIs. + +``` +# Scripts are built in a language that resembles HTTP +POST http://httpbin.org/post +Content-Type: application/json + +{ + "token": "sometoken", + "id": 237 +} + +# Add a handler to pull data out of the response to be used in future requests +> {% + client.global.set('auth_token', response.body.json.token); + client.global.set('some_id', response.body.json.id); +%} + +### + +# Variables can be used to build requests based on past response data +PUT http://httpbin.org/put +X-Auth-Token: {{auth_token}} + +{ + "id": {{some_id}} # Variables can also be used in the body +} + +``` + +## Installation + +### Script + +Enter the following in a command prompt: + +``` +curl -LSfs https://japaric.github.io/trust/install.sh | sh -s -- --git bayne/dot_http +``` + +### Binary releases + +The easiest way for most users is simply to download the prebuilt binaries. +You can find binaries for various platforms on the +[release](https://github.com/bayne/dot_http/releases) page. + +### Cargo + +First, install [cargo](https://rustup.rs/). Then: + +```bash +$ cargo install dot_http +``` + +You will need to use the nightly release for this to work; if in doubt run + +```bash +rustup run nightly cargo install dot_http +``` + +## Usage + +See `dot_http --help` for usage. + +### Vim + +See this [plugin](https://github.com/bayne/vim_dot_http) to use dot_http within vim. + +### The request + +The request format is intended to resemble HTTP as close as possible. HTTP was initially designed to be human-readable and simple, so why not use that? + +**simple.http** +``` +GET http://httpbin.org +Accept: */* +``` +Executing that script just prints the response to stdout: +``` +$ dot_http simple.http +GET http://httpbin.org/get + +HTTP/1.1 200 OK +access-control-allow-credentials: true +access-control-allow-origin: * +content-type: application/json +date: Sat, 18 Jan 2020 20:48:50 GMT +referrer-policy: no-referrer-when-downgrade +server: nginx +x-content-type-options: nosniff +x-frame-options: DENY +x-xss-protection: 1; mode=block +content-length: 170 +connection: keep-alive + +{ + "args": {}, + "headers": { + "Accept": "*/*", + "Host": "httpbin.org" + }, + "url": "https://httpbin.org/get" +} +``` + +### Variables + +Use variables to build the scripts dynamically, either pulling data from your environment file or from a previous request's response handler. + +**simple_with_variables.http** +``` +POST http://httpbin.org/post +Accept: */* +X-Auth-Token: {{token}} + +{ + "id": {{env_id}} +} +``` + +**http-client.env.json** +``` +{ + "dev": { + "env_id": 42, + "token": "SuperSecretToken" + } +} +``` + +Note that the variables are replaced by their values +``` +$ dot_http simple_with_variables.http +POST http://httpbin.org/post + +HTTP/1.1 200 OK +access-control-allow-credentials: true +access-control-allow-origin: * +content-type: application/json +date: Sat, 18 Jan 2020 20:55:24 GMT +referrer-policy: no-referrer-when-downgrade +server: nginx +x-content-type-options: nosniff +x-frame-options: DENY +x-xss-protection: 1; mode=block +content-length: 342 +connection: keep-alive + +{ + "args": {}, + "data": "{\r\n \"id\": 42\r\n}", + "files": {}, + "form": {}, + "headers": { + "Accept": "*/*", + "Content-Length": "18", + "Host": "httpbin.org", + "X-Auth-Token": "SuperSecretToken" + }, + "json": { + "id": 42 + }, + "url": "https://httpbin.org/post" +} +``` + +### Response handler + +Use previous requests to populate some of the data in future requests + +**response_handler.http** +``` +POST http://httpbin.org/post +Content-Type: application/json + +{ + "token": "sometoken", + "id": 237 +} + +> {% + client.global.set('auth_token', response.body.json.token); + client.global.set('some_id', response.body.json.id); +%} + +### + +PUT http://httpbin.org/put +X-Auth-Token: {{auth_token}} + +{ + "id": {{some_id}} +} +``` + +Data from a previous request + +``` +$ dot_http test.http +POST http://httpbin.org/post + +HTTP/1.1 200 OK +access-control-allow-credentials: true +access-control-allow-origin: * +content-type: application/json +date: Sat, 18 Jan 2020 21:01:59 GMT +referrer-policy: no-referrer-when-downgrade +server: nginx +x-content-type-options: nosniff +x-frame-options: DENY +x-xss-protection: 1; mode=block +content-length: 404 +connection: keep-alive + +{ + "args": {}, + "data": "{\r\n \"token\": \"sometoken\",\r\n \"id\": 237\r\n}", + "files": {}, + "form": {}, + "headers": { + "Accept": "*/*", + "Content-Length": "46", + "Content-Type": "application/json", + "Host": "httpbin.org" + }, + "json": { + "id": 237, + "token": "sometoken" + }, + "url": "https://httpbin.org/post" +} +``` + +Can populate data in a future request + +``` +$ dot_http -l 16 test.http +PUT http://httpbin.org/put + +HTTP/1.1 200 OK +access-control-allow-credentials: true +access-control-allow-origin: * +content-type: application/json +date: Sat, 18 Jan 2020 21:02:28 GMT +referrer-policy: no-referrer-when-downgrade +server: nginx +x-content-type-options: nosniff +x-frame-options: DENY +x-xss-protection: 1; mode=block +content-length: 336 +connection: keep-alive + +{ + "args": {}, + "data": "{\r\n \"id\": 237\r\n}", + "files": {}, + "form": {}, + "headers": { + "Accept": "*/*", + "Content-Length": "19", + "Host": "httpbin.org", + "X-Auth-Token": "sometoken" + }, + "json": { + "id": 237 + }, + "url": "https://httpbin.org/put" +} +``` + +## Contributing + +Contributions and suggestions are very welcome! + +Please create an issue before submitting a PR, PRs will only be accepted if they reference an existing issue. If you have a suggested change please create an issue first so that we can discuss it. + +## License +[Apache License 2.0](https://github.com/bayne/dot_http/blob/master/LICENSE)