api-tuner 0.6.0 → 0.6.2

package/README.md

@@ -188,6 +188,31 @@ 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.
+
+```turtle
+<#test> tuner:request [
+  a tuner:Request ;
+  tuner:url <http://example.com/api/$PATH> ;
+  tuner:header ( "X-Api-Key" "$API_KEY" ) ;
+  tuner:query ( "q" "$QUERY" ) ;
+] .
+```
+
 ### Assertions
 
 Assertions are performed on the `tuner:Response` object (usually captured in a variable like `?res`).

package/lib/download-eye.js

@@ -1,11 +1,26 @@
 #! /usr/bin/env node
 /* eslint-disable no-console */
 import fs from 'node:fs'
+import { spawnSync } from 'node:child_process'
 import { Readable } from 'node:stream'
 import * as tar from 'tar'
 
 async function main() {
   const EYE_VERSION = process.env.EYE_VERSION
+
+  if (fs.existsSync('eye')) {
+    try {
+      const versionOutput = spawnSync('eye/bin/eye', ['--version'], { encoding: 'utf-8' })
+      if (versionOutput.stderr.includes(EYE_VERSION)) {
+        console.log(`EYE v${EYE_VERSION} already installed`)
+        return
+      }
+    } catch (e) {
+      console.warn(`Failed to check EYE version: ${e.message}`)
+      console.warn('Re-downloading...')
+    }
+  }
+
   const url = `https://github.com/eyereasoner/eye/archive/refs/tags/v${EYE_VERSION}.tar.gz`
 
   // Download and extract tarball directly from stream

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "main": "index.js",
   "type": "module",
   "license": "MIT",
@@ -8,12 +8,12 @@
     "api-tuner": "bin/tuner.sh"
   },
   "scripts": {
-    "download-eye": "EYE_VERSION=11.16.4 ./lib/download-eye.js",
-    "postinstall": "([ -d eye ] || npm run download-eye) && eye/install.sh --prefix=eye",
+    "download-eye": "EYE_VERSION=11.24.3 ./lib/download-eye.js",
+    "postinstall": "npm run download-eye && eye/install.sh --prefix=eye",
     "prepare": "husky",
     "lint": "eslint . --quiet --ignore-path .gitignore",
-    "pre_test": "docker compose up -d && docker compose restart && npx wait-on http-get://localhost:1080/ping -t 10s",
-    "_test": "./bin/tuner.sh --base-iri http://localhost:1080/",
+    "pre_test": "docker compose up -d && docker compose restart && npx wait-on http-get://localhost:1080/ping -t 20s",
+    "_test": "export FOO=BAR; ./bin/tuner.sh --base-iri http://localhost:1080/",
     "test": "npm run _test -- tests/*.n3 tests/**/*.n3",
     "prepack": "tsc",
     "release": "changeset publish"

package/rules/assertions.n3

@@ -1,3 +1,4 @@
+PREFIX math: <http://www.w3.org/2000/10/swap/math#>
 PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 PREFIX list: <http://www.w3.org/2000/10/swap/list#>
 PREFIX tuner: <https://api-tuner.described.at/>
@@ -91,8 +92,11 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
   # remove surrounding quotes added by the shell
   ( ( ?actualRaw '^\"' "")!string:replace '\"$' "") string:replace ?actual .
 
+  ( ?actual ?builtIn ) math:normaliseLiteral ?actualNormalised .
+  ( ?expected ?builtIn ) math:normaliseLiteral ?expectedNormalised .
+
   (
-    { ?actual ?builtIn ?expected }
+    { ?actualNormalised ?builtIn ?expectedNormalised }
     true
     {
       ("Expected JSON path '" ?path "' to satisfy '" ?builtIn " " ?expected "' but got '" ?actual "'")!string:concatenation^tuner:info .
@@ -110,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 [
@@ -120,8 +141,11 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
     ] .
   } .
 
+  ( ?actualValue ?builtIn ) math:normaliseLiteral ?actualNormalised .
+  ( ?value ?builtIn ) math:normaliseLiteral ?expectedNormalised .
+
   (
-    { ?actualValue ?builtIn ?value }
+    { ?actualNormalised ?builtIn ?expectedNormalised }
     true
     {
       ("Expected header '" ?name "' '" ?value "' to satisfy '" ?builtIn "' but got '" ?actualValue "'")!string:concatenation^tuner:info .

package/rules/curl-body.n3

@@ -34,8 +34,14 @@ prefix math: <http://www.w3.org/2000/10/swap/math#>
   ?literalBody </#body> ( ?curlArgs [] ) .
 } <= {
   ?literalBody log:rawType log:Literal .
+  () file:temp ?requestBodyFile .
+
+  # Save body to file so that it can be used in the curl command reliably
+  (
+    "echo '" ?literalBody "' > " ?requestBodyFile
+  )!string:concatenation!e:exec .
 
-  ( " -d '" ?literalBody "'" ) string:concatenation ?curlArgs .
+  ( " --data-binary @" ?requestBodyFile ) string:concatenation ?curlArgs .
 } .
 
 {

package/rules/files.n3

@@ -15,7 +15,7 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
 } <= {
   ?uri log:uri ( "urn:rand:" ( 1000 )!e:random )!string:concatenation .
   # log:shell captures the traling newline
-  ( "mktemp -t api-tuner -d 2>/dev/null || mktemp -d -t api-tuner.XXXXXXXX"!log:shell "\n" "" ) string:replace ?tempDir .
+  ( "mktemp -t api-tuner -d 2>/dev/null || mktemp -d -t api-tuner.XXXXXXXX"!log:shell ("\n") ("") ) string:replaceAll ?tempDir .
 
   (
     ?tempDir

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 .
+  ( ' -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/math.n3

@@ -0,0 +1,19 @@
+PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
+PREFIX log: <http://www.w3.org/2000/10/swap/log#>
+prefix math: <http://www.w3.org/2000/10/swap/math#>
+prefix string: <http://www.w3.org/2000/10/swap/string#>
+
+# See https://github.com/eyereasoner/eye/issues/174#issuecomment-4405018796
+{
+  ( ?value ?builtIn ) math:normaliseLiteral ?normalised
+} <= {
+  (
+    {
+      ?builtIn!log:uri string:startsWith math:!log:uri
+    }
+    {
+      ( ?value xsd:decimal ) log:dtlit ?normalised
+    }
+    { ?value log:equalTo ?normalised }
+  ) log:ifThenElseIn ?SCOPE
+} .

package/rules/queryParams.n3

@@ -4,5 +4,5 @@ prefix string: <http://www.w3.org/2000/10/swap/string#>
 {
   (?name ?value) tuner:queryParamArg ?curlArg .
 } <= {
-  ( " --url-query '" ?name "=" ?value "'" ) string:concatenation ?curlArg .
+  ( ' --url-query "' ?name "=" ?value '"' ) string:concatenation ?curlArg .
 } .

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 [] .
@@ -55,7 +60,7 @@ prefix earl: <http://www.w3.org/ns/earl#>
     ) log:ifThenElseIn [] .
 
     (
-      "curl -s -X " ?method " '" ?endpoint "'"
+      "curl -s -X " ?method ' "' ?endpoint '"'
       ?headersArgs
       ?bodyArgs
       ?queryParamArgs