Build export as an extension of mu-javascript-template v1.0.0

Author: erikap

README.md

@@ -3,19 +3,18 @@ Export JS Template
 
 Microservice to export data using custom defined SPARQL queries.
 
-
 ## Using the template
-Extend the `semtech/mu-export-js-template` and add an export configuration in `/config/queries.js`.
+Run the `semtech/mu-export-js-template` service and mount an export configuration in `/config/export.js`.
 
-The configuration file defines an array of export configuration objects as follows:
+The `export.js` file defines an array of export configuration objects as follows:
 
 ```javascript
 export default [
     {
-        path: '/all',
+        path: '/example',
         format: 'text/csv',
-        file: 'export-100.csv',        
-        query: `SELECT * FROM <http://mu.semte.ch/application> WHERE { ?s ?p ?o } LIMIT 100`
+        query: `SELECT * FROM <http://mu.semte.ch/application> WHERE { ?s ?p ?o } LIMIT 100`,
+        file: 'export-example.csv'
     },
     ...
 ];
@@ -24,14 +23,21 @@ export default [
 
 An export configuration object consists of the following properties:
 * [REQUIRED] `path`: endpoint on which the export will be exposed
-* [REQUIRED] `format`: format of the export (`application/json`, `text/csv`, etc.)
-* [OPTIONAL] `file`: name of the attachment file containing the export. If no filename is provided, the export will be displayed inline in the browser.
+* [REQUIRED] `format`: format of the export (`application/json`, `text/csv`, `text/turtle`, etc.)
 * [REQUIRED] `query`: the SPARQL query to execute. This may be a `SELECT` or a `CONSTRUCT` query.
-
-## Example Dockerfile
-
-```
-FROM semtech/mu-export-js-template:1.0.0
-MAINTAINER Erika Pauwels <erika.pauwels@gmail.com>
-COPY queries.js /config
+* [OPTIONAL] `file`: name of the downloaded file. The filename may also be provided through a query param on the export request (e.g. `/example?file=my-name.csv`). If no filename is provided, the export will be displayed inline in the browser.
+
+## Example docker-compose
+
+```yaml
+version: '2',
+services:
+  export:
+    image: semtech/mu-export-js-template:0.2.0
+    volumes:
+      - ./:/config
+    links:
+      - database:database
 ```
+
+Note: if you extend the `semtech/mu-export-js-template` with an `export.js` file instead of mounting a volume in `/config`, the `ONBUILD` commands of the `semtech/mu-javascript-template` will not be executed in your image since `ONBUILD` is only executed one level deep.

app.js

@@ -1,7 +1,7 @@
 import { app } from 'mu';
 import request from 'request';
 
-import queries from '/config/queries';
+import queries from '/config/export';
 
 queries.map(function(config) {
     app.get(config.path, function(req, res, next) {
@@ -23,7 +23,8 @@ queries.map(function(config) {
                 console.error(`Something went wrong executing the SPARQL query: ${JSON.stringify(error)}`);
                 next(error);
             } else if (response.statusCode == 200) {
-                if (config.file) { res.attachment(config.file); }
+                const filename = req.query.file || config.file;
+                if (filename) { res.attachment(filename); }
                 res.send(body);
             } else {
                 next(new Error(body));