api-tuner 0.6.1 → 0.6.2

package/README.md

@@ -188,6 +188,18 @@ Query parameters can be added to a request using `tuner:query`.
 ?req tuner:query ( "name" "value" ) .
 ```
 
+#### Basic Authentication
+
+Use `tuner:basicAuth` to add HTTP Basic Authentication to a request. It takes a list of `( username password )` and automatically sets the `Authorization: Basic ...` header.
+
+```turtle
+<#test> tuner:request [
+  a tuner:Request ;
+  tuner:url <http://example.com/api> ;
+  tuner:basicAuth ( "admin" "secret" ) ;
+] .
+```
+
 #### Shell Variables
 
 Values used in request URL, headers and query params are resolved from the shell environment.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "main": "index.js",
   "type": "module",
   "license": "MIT",

package/rules/assertions.n3

@@ -114,8 +114,25 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
 {
   ?res tuner:header ( ?name ?value ?builtIn ) .
 } <= {
+  ?name log:rawType log:Literal .
   ?name string:lowerCase ?nameLower .
 
+  (
+    {
+      ?res log:notIncludes {
+        [] a tuner:Response ;
+        tuner:headers [
+          tuner:name ?nameLower ;
+        ] .
+      } .
+    }
+    {
+      ("Expected header '" ?name "' but it was not present in the response")!string:concatenation^tuner:info .
+      true log:equalTo false .
+    }
+    true
+  ) log:ifThenElseIn [] .
+
   ?res log:includes {
     [] a tuner:Response ;
     tuner:headers [

package/rules/headers.n3

@@ -1,8 +1,25 @@
+PREFIX log: <http://www.w3.org/2000/10/swap/log#>
 prefix tuner: <https://api-tuner.described.at/>
 prefix string: <http://www.w3.org/2000/10/swap/string#>
 
+tuner:header a tuner:HeaderRule ; tuner:headerArgsRule <#defaultHeader> .
+
 {
-  (?fieldName ?fieldValue) tuner:headerArg ?curlArg .
+  (?fieldName ?fieldValue) <#defaultHeader> ?curlArg .
 } <= {
   ( ' -H "' ?fieldName ":" ?fieldValue '"' ) string:concatenation ?curlArg .
 } .
+
+####
+
+tuner:basicAuth a tuner:HeaderRule ; tuner:headerArgsRule <#basicAuth> .
+
+{
+  ( ?user ?password ) <#basicAuth> ?curlArgs .
+} <= {
+  ( ?user ":" ?password ) string:concatenation ?credentials .
+
+  ( "node -e 'console.log(Buffer.from(\"" ?credentials "\").toString(\"base64\"))'" )!string:concatenation log:shell ?encoded .
+
+  ( "Authorization" ("Basic " (?encoded "\n$" "")!string:replace)!string:concatenation ) <#defaultHeader> ?curlArgs .
+} .

package/rules/requests.n3

@@ -1,3 +1,4 @@
+PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
 PREFIX list: <http://www.w3.org/2000/10/swap/list#>
 prefix e: <http://eulersharp.sourceforge.net/2003/03swap/log-rules#>
 prefix log: <http://www.w3.org/2000/10/swap/log#>
@@ -20,10 +21,14 @@ prefix earl: <http://www.w3.org/ns/earl#>
   true log:becomes { ?req tuner:done true } .
 
   (
-    { ?req tuner:header [] . }
     {
-      ( ?header { ?req tuner:header ?header } ?headers ) log:collectAllIn [] .
-      ( ?headers tuner:headerArg )!list:map string:concatenation ?headersArgs .
+      ?req ?headerRule [] .
+      ?headerRule a tuner:HeaderRule .
+      ?headerRule tuner:headerArgsRule ?headerRuleFn .
+    }
+    {
+      ( ?header { ?req ?headerRule ?header } ?headers ) log:collectAllIn [] .
+      ( ?headers ?headerRuleFn )!list:map string:concatenation ?headersArgs .
     }
     { ?headersArgs log:equalTo "" }
   ) log:ifThenElseIn [] .