From dd7bbaaee58b63811ae192256decd92e97477a1f Mon Sep 17 00:00:00 2001 From: David Diaz Date: Wed, 1 Mar 2017 18:38:36 -0600 Subject: [PATCH 1/6] Updated README and added licensing information --- LICENSE | 7 +++++++ README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8da5195 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2017 David Sergio Díaz + +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. \ No newline at end of file diff --git a/README.md b/README.md index 5ebf3db..45eda28 100644 --- a/README.md +++ b/README.md @@ -1 +1,57 @@ -# Sleepy Cat's Backend +# Beau +Testing JSON APIs made easy. + +## What is Beau? +Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo. + +![A Gif showing how beau works](http://files.martianwabbit.com/beau.gif) + +## Usage + beau [options] -r + + Options: + + -h, --help output usage information + -V, --version output the version number + -r, --request [request] The alias for the request you'd like to trigger. + -v, --verbose Show all the information related to the current request and it's response. + -c, --config [file] Specify your request config file. Defaults to beau.yml in the current directory. + -l, --list List all requests in the config file. + -t, --truncate [length] Truncate the content to the given length + +## Example Configuration File + + VERSION: 1 + HOST: https://example.com/api/ + + POST /session: + ALIAS: $session + PAYLOAD: + username: seich + password: hello01 + + GET /profile + ALIAS: $profile + HEADERS: + authorization: Bearer $session.response.body.token + + GET /user/$profile.response.body.id/posts + ALIAS: $friends + HEADERS: + authorization: Bearer $session.response.body.token + PARAMS: + archived: true + +## Example Usage + beau -r profile + +That would execute the profile request along with it´s dependencies. In this case, the session request would be made as well since we are using it´s response value as part of our current request. + +## License +Copyright 2017 David Sergio Díaz + +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. \ No newline at end of file From 16030925ea0bf828e48181d96590a1b10a33c106 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20D=C3=ADaz?= Date: Thu, 2 Mar 2017 10:03:29 -0600 Subject: [PATCH 2/6] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 45eda28..1ae1913 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ -# Beau -Testing JSON APIs made easy. +
+ +
+ +

Beau

+

Testing JSON APIs made easy.

## What is Beau? Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo. @@ -54,4 +58,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of 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. \ No newline at end of file +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. From 60ea0d5f7f7d655e451ac53413b672f9d14a0b81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20D=C3=ADaz?= Date: Thu, 2 Mar 2017 10:16:23 -0600 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ae1913..8198216 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +

Beau

From 4f946eeafae0bebbeb21d37b20827c82536804c5 Mon Sep 17 00:00:00 2001 From: David Diaz Date: Thu, 2 Mar 2017 10:20:01 -0600 Subject: [PATCH 4/6] Updated package version. --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8c4a8de..792aea6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "beau", - "version": "0.0.1", - "description": "A tool for testing RESTful APIs", + "version": "0.1.0", + "description": "A tool for testing JSON APIs", "main": "beau.js", "author": "Sergio Diaz ", "license": "MIT", From 088b76be6b8fd63f5d78e61b6803a3b31cefd842 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20D=C3=ADaz?= Date: Thu, 2 Mar 2017 10:25:00 -0600 Subject: [PATCH 5/6] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 8198216..ee53aaa 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,9 @@ Beau, is a CLI that executes HTTP requests based on a YAML configuration file. T ![A Gif showing how beau works](http://files.martianwabbit.com/beau.gif) +## Installation + npm install -g beau + ## Usage beau [options] -r From c93ca76d4d208aa5ecd063cfb513048a26477f93 Mon Sep 17 00:00:00 2001 From: David Diaz Date: Thu, 2 Mar 2017 10:25:31 -0600 Subject: [PATCH 6/6] 0.1.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 792aea6..5b46405 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "beau", - "version": "0.1.0", + "version": "0.1.1", "description": "A tool for testing JSON APIs", "main": "beau.js", "author": "Sergio Diaz ",