@lblod/mu-auth-sudo 0.2.0 → 0.5.0

package/README.md

@@ -1,2 +1,41 @@
 # mu-auth-sudo
 NPM package for a sparql client for mu.semte.ch that overrules access rights in queries through a mu-auth-sudo header.
+
+## Usage
+```
+npm install @lblod/mu-auth-sudo
+```
+
+Include the following in your code
+```
+import { querySudo as query, updateSudo as update } from '@lblod/mu-auth-sudo';
+
+
+//Examples
+
+// To run a normal query
+
+const queryString = `SELECT * FROM { GRAPH ?g { ?s ?p ?o. } } LIMIT 1`;
+await query(queryString);
+
+// To pass extra headers
+
+const updateString = `INSERT DATA { GRAPH <http://foo> { <http://bar> <http://baz> <http://boom>. } }`;
+const extraHeaders = { 'mu-call-scope-id':  'http://foo/bar', 'other-info'; 'hello' };
+await update(updateString, extraHeaders);
+
+// With custom sparqlEndpoint (this should be exceptional, make sure you know what you're doing)
+
+await update(updateString, extraHeaders, 'http://the.sparql.endpoint/sparql');
+```
+
+## Logging
+
+The verbosity of logging can be configured as in the [javascript template](https://github.com/mu-semtech/mu-javascript-template/blob/6ff43eaf51856783c6946e82344e31a3348ce4a3/README.md#logging) through following environment variables:
+
+- `LOG_SPARQL_ALL`: Logging of all executed SPARQL queries, read as well as update (default `true`)
+- `LOG_SPARQL_QUERIES`: Logging of executed SPARQL read queries (default: `undefined`). Overrules `LOG_SPARQL_ALL`.
+- `LOG_SPARQL_UPDATES`: Logging of executed SPARQL update queries (default `undefined`). Overrules `LOG_SPARQL_ALL`.
+- `DEBUG_AUTH_HEADERS`: Debugging of [mu-authorization](https://github.com/mu-semtech/mu-authorization) access-control related headers (default `true`)
+
+Following values are considered true: [`"true"`, `"TRUE"`, `"1"`].

package/dist/auth-sudo.js

@@ -11,14 +11,20 @@ var _expressHttpContext2 = _interopRequireDefault(_expressHttpContext);
 
 var _sparqlClient = require('sparql-client-2');
 
-var _sparqlClient2 = _interopRequireDefault(_sparqlClient);
+var _envVar = require('env-var');
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _envVar2 = _interopRequireDefault(_envVar);
 
-var SparqlClient = _sparqlClient2.default.SparqlClient;
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+var LOG_SPARQL_QUERIES = process.env.LOG_SPARQL_QUERIES != undefined ? _envVar2.default.get('LOG_SPARQL_QUERIES').asBool() : _envVar2.default.get('LOG_SPARQL_ALL').asBool();
+var LOG_SPARQL_UPDATES = process.env.LOG_SPARQL_UPDATES != undefined ? _envVar2.default.get('LOG_SPARQL_UPDATES').asBool() : _envVar2.default.get('LOG_SPARQL_ALL').asBool();
+var DEBUG_AUTH_HEADERS = _envVar2.default.get('DEBUG_AUTH_HEADERS').asBool();
 
 function sudoSparqlClient() {
+  var extraHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var sparqlEndpoint = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : process.env.MU_SPARQL_ENDPOINT;
+
   var options = {
     requestDefaults: {
       headers: {
@@ -32,28 +38,75 @@ function sudoSparqlClient() {
     options.requestDefaults.headers['mu-call-id'] = _expressHttpContext2.default.get('request').get('mu-call-id');
   }
 
-  console.log('Headers set on SPARQL client: ' + JSON.stringify(options));
+  if (extraHeaders) {
+    var _iteratorNormalCompletion = true;
+    var _didIteratorError = false;
+    var _iteratorError = undefined;
 
-  return new SparqlClient(process.env.MU_SPARQL_ENDPOINT, options);
-}
+    try {
+      for (var _iterator = Object.keys(extraHeaders)[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+        var key = _step.value;
 
-function querySudo(queryString) {
-  console.log(queryString);
-  return sudoSparqlClient().query(queryString).executeRaw().then(function (response) {
-    function maybeParseJSON(body) {
-      // Catch invalid JSON
+        options.requestDefaults.headers[key] = extraHeaders[key];
+      }
+    } catch (err) {
+      _didIteratorError = true;
+      _iteratorError = err;
+    } finally {
       try {
-        return JSON.parse(body);
-      } catch (ex) {
-        return null;
+        if (!_iteratorNormalCompletion && _iterator.return) {
+          _iterator.return();
+        }
+      } finally {
+        if (_didIteratorError) {
+          throw _iteratorError;
+        }
       }
     }
+  }
+
+  if (DEBUG_AUTH_HEADERS) {
+    console.log('Headers set on SPARQL client: ' + JSON.stringify(options));
+  }
+
+  return new _sparqlClient.SparqlClient(sparqlEndpoint, options);
+}
+
+async function executeRawQuery(queryString) {
+  var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var sparqlEndpoint = arguments[2];
 
-    return maybeParseJSON(response.body);
-  });
+
+  if (LOG_SPARQL_QUERIES) {
+    console.log(queryString);
+  }
+
+  var response = await sudoSparqlClient(extraHeaders, sparqlEndpoint).query(queryString).executeRaw();
+  return maybeParseJSON(response.body);
+}
+
+function querySudo(queryString) {
+  var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var sparqlEndpoint = arguments[2];
+
+  return executeRawQuery(queryString, extraHeaders, sparqlEndpoint);
+}
+
+function updateSudo(queryString) {
+  var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var sparqlEndpoint = arguments[2];
+
+  return executeRawQuery(queryString, extraHeaders, sparqlEndpoint);
 }
 
-var updateSudo = querySudo;
+function maybeParseJSON(body) {
+  // Catch invalid JSON
+  try {
+    return JSON.parse(body);
+  } catch (ex) {
+    return null;
+  }
+}
 
 var _exports = {
   querySudo: querySudo,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/mu-auth-sudo",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "this package provides an alternative sparql client for the mu-javascript-template that has sudo rights.",
   "main": "dist/auth-sudo.js",
   "scripts": {
@@ -33,12 +33,13 @@
   "homepage": "https://github.com/lblod/mu-auth-sudo#readme",
   "devDependencies": {
     "babel-cli": "^6.26.0",
+    "babel-plugin-add-module-exports": "^1.0.4",
     "babel-preset-env": "^1.7.0",
-    "babel-plugin-add-module-exports": "^1.0.0",
     "babel-preset-es2015": "^6.24.1",
     "babel-register": "^6.26.0"
   },
   "dependencies": {
+    "env-var": "^7.0.1",
     "sparql-client-2": "https://github.com/erikap/node-sparql-client.git"
   }
 }