From 9fdd75f6d8cda5a304da33c7359eb271a2ea0f40 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:19:04 +0200 Subject: [PATCH 01/15] Fix typo. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 4883b90..47f0874 100644 --- a/spec/README.md +++ b/spec/README.md @@ -181,7 +181,7 @@ respond to an external event (e.g. an incoming HTTP request). #### List routes Returns JSON with all the data about the current routes. Be aware that the command -field must be a json scaped string. +field must be an escaped JSON string. * **URL**: `/routes` * **Method**: `GET` From 42403fe78cfeaefe3f2f68e503e86991a2570b1a Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:19:32 +0200 Subject: [PATCH 02/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 47f0874..1285b92 100644 --- a/spec/README.md +++ b/spec/README.md @@ -377,7 +377,7 @@ response. ## Design Principles -* According to established best practices we use the HTTP methods as follows: +* According to well-established best practices we use the HTTP methods as follows: * `GET`: Read data without any side-effects. * `PUT`: Overwrite existing data. * The API calls responses will have two distinct parts: From b22f3a5adb09be4aa3645f6f9b5279fdcc117bdb Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:20:14 +0200 Subject: [PATCH 03/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 1285b92..b51677e 100644 --- a/spec/README.md +++ b/spec/README.md @@ -414,7 +414,7 @@ following resource paths: │ ├──── path Complete URL path (URL-unquoted) │ ├──── matches Previously matched URL path parts │ │ └──── -│ ├──── params URL parameters (post ? symbol) +│ ├──── params URL parameters (after the "?" symbol) │ │ └──── │ ├──── headers HTTP request headers │ │ └──── From 36a61285b9970d18f6defe25b095bbfed7f1e14e Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:20:30 +0200 Subject: [PATCH 04/15] Style fix. Note: "midst" tends to be used in more literary settings. --- spec/test/features/control/delete/list_order.feature | 6 +++--- spec/test/features/control/insert/list_order.feature | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/spec/test/features/control/delete/list_order.feature b/spec/test/features/control/delete/list_order.feature index c2f0531..c0197e3 100644 --- a/spec/test/features/control/delete/list_order.feature +++ b/spec/test/features/control/delete/list_order.feature @@ -83,9 +83,9 @@ Feature: Consistent route order after a route deletion in Kapow! server. ] """ - Scenario: Removing a midst route. - After removing a midst route the remaining ones will - maintain their relative order and the indexes of the + Scenario: Removing a route from the middle. + After removing a route from the middle, the remaining ones + will maintain their relative order and the indexes of the following routes will be decreased by one. When I delete the second route diff --git a/spec/test/features/control/insert/list_order.feature b/spec/test/features/control/insert/list_order.feature index 5644736..57ecd90 100644 --- a/spec/test/features/control/insert/list_order.feature +++ b/spec/test/features/control/insert/list_order.feature @@ -99,10 +99,10 @@ Feature: Consistent route ordering after inserting a route in a Kapow! server. ] """ - Scenario: Inserting a midst route. - After inserting a midst route the previous route set - will maintain their relative order and the indexes - of thefollowing routes will be increased by one. + Scenario: Inserting a route in the middle. + After inserting a route in the middle, the previous + route set will maintain their relative order and the indexes + of the following routes will be increased by one. When I insert the route: """ From 0eb51f12ac0bd3621c9a66777286c7986c3c9e9b Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:35:35 +0200 Subject: [PATCH 05/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index b51677e..41bee97 100644 --- a/spec/README.md +++ b/spec/README.md @@ -7,7 +7,7 @@ Because we think that: - UNIX® is great and we love it - The UNIX® shell is great -- HTTP interfaces are convenient and everywhere +- HTTP interfaces are convenient and ubiquitous - CGI is not a good way to mix them From 3a545ac7b33723751f38a9ef7a7deafd85b684b2 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:35:48 +0200 Subject: [PATCH 06/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 41bee97..dbb9588 100644 --- a/spec/README.md +++ b/spec/README.md @@ -40,7 +40,7 @@ allowing the user to express the desired mapping in an explicit way. ### Why not tool "X"? -All the alternatives we found are **rigid** about the way they match between +All the alternatives we found are **rigid** about the way they match HTTP and shell concepts. * [shell2http](https://github.com/msoap/shell2http): HTTP-server to execute From 5c72f3a4980fad5248da65c06c39f38371ed60b0 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:42:43 +0200 Subject: [PATCH 07/15] Style fix. --- spec/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/README.md b/spec/README.md index dbb9588..098dffa 100644 --- a/spec/README.md +++ b/spec/README.md @@ -58,8 +58,8 @@ Settings through two command line arguments, path and shell command. Tools with a rigid matching **can't evade** *[impedance mismatch](https://haacked.com/archive/2004/06/15/impedance-mismatch.aspx/)*. -Resulting in an easy-to-use software, convenient in some scenarios but -incapable in others. +Resulting in software that is convenient and easy-to-use in a handful of scenarios, +but sorely lacking in the vast majority of them. ### Why not my good-old programming language "X"? From 41d8f39c9a83acbc2811ac601a0f595fef09be61 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:43:39 +0200 Subject: [PATCH 08/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 098dffa..2c20af3 100644 --- a/spec/README.md +++ b/spec/README.md @@ -76,7 +76,7 @@ but sorely lacking in the vast majority of them. ### Why not CGI? -* CGI is also **rigid** about how it matches between HTTP and UNIX® process +* CGI is also **rigid** about how it matches HTTP and UNIX® process concepts. Notably CGI *meta-variables* are injected into the script's environment; this behavior can and has been exploited by nasty attacks such as [Shellshock](https://en.wikipedia.org/wiki/Shellshock_(software_bug)). From 249d0f3e9fa88ac40c63b905791a72d154544500 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:44:23 +0200 Subject: [PATCH 09/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 2c20af3..4685815 100644 --- a/spec/README.md +++ b/spec/README.md @@ -77,7 +77,7 @@ but sorely lacking in the vast majority of them. ### Why not CGI? * CGI is also **rigid** about how it matches HTTP and UNIX® process - concepts. Notably CGI *meta-variables* are injected into the script's + concepts. Notably, CGI *meta-variables* are injected into the script's environment; this behavior can and has been exploited by nasty attacks such as [Shellshock](https://en.wikipedia.org/wiki/Shellshock_(software_bug)). * Trying to leverage CGI from a shell script could be less cumbersome in some From ff0f3aefc5ad77dbf2111fe86827c17c7b38f5e1 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 12:46:58 +0200 Subject: [PATCH 10/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 4685815..4c87cc7 100644 --- a/spec/README.md +++ b/spec/README.md @@ -105,7 +105,7 @@ frequently throughout the spec. #### `entrypoint` The entrypoint definition matches *Docker*'s shell form of it. -Technically it's a string which is to be passed to the `command` (`/bin/bash -c` +Technically, it's a string which is to be passed to the `command` (`/bin/bash -c` by default) as the code to be interpreted or executed when attending requests. From 84f6a89c2d73dec638e34228be2bc69f5aae5388 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 13:02:34 +0200 Subject: [PATCH 11/15] Clarify expression. --- spec/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/README.md b/spec/README.md index 4c87cc7..4725d53 100644 --- a/spec/README.md +++ b/spec/README.md @@ -315,9 +315,9 @@ A new id is created for the appended route so it can be referenced later. * **Notes**: * Route numbering starts at zero. * When `index` is not provided or is `0` the route will be inserted - first, effectively making it index `0`. + in the first position, effectively making it index `0`. * Conversely, when `index` is greater than the number of entries on the route - table, it will be inserted last. + table, it will be inserted in the last position. * Finally, when `index` is less than `0` a 422 error is raised. * A successful request will yield a response containing all the effective parameters that were applied. From 28c16409a8d1ed14ee0e75ecd1672537a0b7f54b Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 13:03:33 +0200 Subject: [PATCH 12/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 4725d53..40389d3 100644 --- a/spec/README.md +++ b/spec/README.md @@ -377,7 +377,7 @@ response. ## Design Principles -* According to well-established best practices we use the HTTP methods as follows: +* According to well-established best practices, we use the HTTP methods as follows: * `GET`: Read data without any side-effects. * `PUT`: Overwrite existing data. * The API calls responses will have two distinct parts: From 567f68b6955859cdedce1091fd3fd2cb225cbd14 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Fri, 6 Sep 2019 13:08:00 +0200 Subject: [PATCH 13/15] Style fix. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 40389d3..889571d 100644 --- a/spec/README.md +++ b/spec/README.md @@ -554,7 +554,7 @@ TODO: End-to-end example of the data API. ## Test Suite Notes -The test suite is located on [blebleble] directory. +The test suite is located on [yadda-yadda-yadda] directory. You can run it by ... From 94135c6ab9723c0e6938a5f85c1d0accee4e1fad Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Mon, 9 Sep 2019 14:30:07 +0200 Subject: [PATCH 14/15] Revert "Style fix." Thanks to @nilp0inter for pointing out that this was not Basic English. This reverts commit 0eb51f12ac0bd3621c9a66777286c7986c3c9e9b. --- spec/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/README.md b/spec/README.md index 889571d..83f7da5 100644 --- a/spec/README.md +++ b/spec/README.md @@ -7,7 +7,7 @@ Because we think that: - UNIX® is great and we love it - The UNIX® shell is great -- HTTP interfaces are convenient and ubiquitous +- HTTP interfaces are convenient and everywhere - CGI is not a good way to mix them From b4b5052149340ed5567e60c0ff78b7af98743b46 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Mon, 9 Sep 2019 14:40:52 +0200 Subject: [PATCH 15/15] Revert "Style fix." This reverts commit 5c72f3a4980fad5248da65c06c39f38371ed60b0. Thanks to @nilp0inter for clarifying this one as well. --- spec/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/README.md b/spec/README.md index 83f7da5..ac58106 100644 --- a/spec/README.md +++ b/spec/README.md @@ -58,8 +58,8 @@ Settings through two command line arguments, path and shell command. Tools with a rigid matching **can't evade** *[impedance mismatch](https://haacked.com/archive/2004/06/15/impedance-mismatch.aspx/)*. -Resulting in software that is convenient and easy-to-use in a handful of scenarios, -but sorely lacking in the vast majority of them. +Resulting in an easy-to-use software, convenient in some scenarios but +incapable in others. ### Why not my good-old programming language "X"?