Release v0.5.0 (#61)

* remove explicit ID from events in timemap setup

* Fixed internal anchor link headline

* update fmt

* Bump lodash from 4.17.15 to 4.17.19

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>

* Wrote validation functions and getter to grab appropriate validation function

* Collapsed filters and narratives into associations; modified default tabs to reflect

* Refactoring events to have only associations; created associations tab and related export tab

* Clean up with event related associations

* Delete validation for now; not relevant to this PR

* Bump node-fetch from 2.6.0 to 2.6.1

Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1.
- [Release notes](https://github.com/bitinn/node-fetch/releases)
- [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md)
- [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1)

Signed-off-by: dependabot[bot] <support@github.com>

* Removed gsheets tab in config, unused import in package json

* try/catch to prioritise local.config.js

* Removing export categories endpoint

* Removed categories from list and using test_export_events

* Test associations

* Removed comment regarding categories endpoint

* Removing unnecessary test_export_events endpoint

* Linting threw error stating that we use path module to join instead of +

* generalise LocalFetcher to support many sheet types (xlsx, ods, etc)

* rm getFileExt

* use tab as delimiter in intermediate representation

* Bump googleapis from 32.0.0 to 39.1.0

Bumps [googleapis](https://github.com/googleapis/google-api-nodejs-client) from 32.0.0 to 39.1.0.
- [Release notes](https://github.com/googleapis/google-api-nodejs-client/releases)
- [Changelog](https://github.com/googleapis/google-api-nodejs-client/blob/master/CHANGELOG.md)
- [Commits](https://github.com/googleapis/google-api-nodejs-client/compare/v32.0.0...v39.1.0)

Signed-off-by: dependabot[bot] <support@github.com>

* Fixed tests

* fix example sheet

Co-authored-by: Christoph Knoth <github@christoph-knoth.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: efarooqui <efarooqui@pandora.com>
Co-authored-by: Ebrahem Farooqui <ebefarooqui@gmail.com>
Co-authored-by: Lachlan <Kermode>

.github/workflows/cd.yml

@@ -1,19 +0,0 @@
-name: CD
-on:
-  push:
-    branches: [ develop ]
-#  pull_request:
-#    branches: [ develop ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Trigger CD build
-        uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.CI_DISPATCH_TOKEN }}
-          repository: forensic-architecture/configs
-          event-type: remote-build
-          client-payload: '{"runtime_args": "datasheet", "branch": "${GITHUB_REF##*/}"}'
-

.github/workflows/ci.yml

@@ -1,25 +0,0 @@
-name: CI
-on:
-  push:
-    branches: [ develop ]
-  pull_request:
-    branches: [ develop ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: ${{ github.head_ref }}
-      - uses: actions/setup-node@v2-beta
-        with:
-          node-version: '12'
-
-      - run: npm install
-      - run: npm test
-        env:
-          CI: true
-      - run: npm run lint
-        env:
-          CI: true

.gitignore

@@ -15,4 +15,3 @@ tags.lock
 tags.temp
 src/config.js
 src/local.config.js
-src/config.js

.travis.yml

@@ -0,0 +1,14 @@
+language: node_js
+node_js:
+- stable
+cache:
+  directories:
+  - node_modules
+before_script:
+- npm install -g yarn
+install:
+- yarn
+script:
+- yarn build
+- yarn lint
+- yarn test

Dockerfile

@@ -4,17 +4,17 @@ LABEL authors="Lachlan Kermode <lk@forensic-architecture.org>"
 
 # Install app dependencies
 COPY package.json /www/package.json
-RUN cd /www; npm install
+RUN cd /www; yarn
 
 # Copy app source
 COPY . /www
 WORKDIR /www
-RUN npm run build
+RUN yarn build
 RUN mkdir -p data
 
 # set your port
-ENV PORT 4040
-EXPOSE 4040
+ENV PORT 8080
+EXPOSE  8080
 
 # start command as per package.json
-CMD ["npm", "start"]
+CMD ["yarn", "start"]

README.md

@@ -59,11 +59,6 @@ Clone the repository to your local:
 git clone https://www.github.com/forensic-architecture/datasheet-server
 ```
 
-Copy [src/example.config.js](src/example.config.js) into `src/config.js` and modify
-```
-cp src/example.config.js src/config.js
-```
-
 Follow the steps in the [configuration](#configuration) section of this
 document.
 

scripts/check-branch.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+ENCRYPT_MESSAGE="\nThe .env.enc file has not changed its contents from the version on origin/develop.\nTo ensure that tests pass in Travis, you need to encrypt the contents of .env  before pushing to the remote, so that the Travis server can use your service account credentials.\nEnsure that the Travis CLI is installed on your local, run\n\n\tnpm run travis-encrypt\n\nand then push to the remote again.\nIf you don't care whether your build passes on Travis, you can run:\n\n\tgit push --no-verify\n\nand bypass this check.\n\n"
+
+# check whether .env.enc has changed
+if [ -z "`git diff origin/develop -- .env.enc`" ]; then
+	echo $ENCRYPT_MESSAGE
+	exit 1
+fi
+
+

scripts/encrypt.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+echo "Encrypting .env file for Travis..."
+
+# confirm that the user has the core repo as origin, and is therefore a maintainer
+# if [ -z `git config --get remote.origin.url | grep "forensic-architecture/datasheet-server"` ]; then
+# 	echo "Travis encryption not required for satellite contributors, continuing.."
+# 	exit 0
+# fi
+
+# confirm travis is installed
+if [ ! hash travis 2>/dev/null ]; then
+	echo "============================================================================================"
+	echo "ERROR: Travis CLI is not installed on your local. Please install from:"
+	echo "\thttps://github.com/travis-ci/travis.rb"
+	echo "After installing, make sure that you login with:"
+	echo "\ttravis login --pro"
+	echo "============================================================================================"
+	exit 3
+fi
+
+# confirm there is a .env file to encrypt
+if [ ! -f .env ]; then
+	echo "============================================================================================"
+	echo "ERROR: You must create a .env file and add your credentials. See .env.example for an example"
+	echo "============================================================================================"
+	exit 3
+fi
+
+# regex to match and delete 'before_install' and everything after it
+# necessary to delete these lines to get Travis to build for multiple accounts
+echo "creating new .travis.yml configuration"
+sed -i.old '/^before_install.*/,$ d' .travis.yml
+echo "old config file saved as .travis.yml.old"
+
+travis encrypt-file .env --add --force --org
+git add .env.enc
+git add .travis.yml
+echo ".env.enc created and added to commit"

src/api/index.js

@@ -30,10 +30,10 @@ export default ({ config, controller }) => {
           success: msg
         })
       )
-      .catch(err => {
+      .catch(err =>
         res.status(404)
           .send({ error: err.message, err })
-      })
+      )
   })
 
   api.get('/:sheet/:tab/:resource/:frag', (req, res) => {

src/blueprinters/deeprows.js

@@ -63,7 +63,10 @@ export default (data) => {
     structure.__flat.forEach(label => {
       deepRow[label] = baseRow[label]
     })
-    if (!Object.keys(deepRow).every(k => deepRow[k] === '')) {
+    if (!Object.keys(deepRow).every(k => (
+      (deepRow[k] === '') ||
+      (Array.isArray(deepRow[k]) && deepRow[k].length === 0)
+    ))) {
       output.push(deepRow)
     }
   })

src/config.js

@@ -0,0 +1,12 @@
+import { timemap } from './lib'
+
+export default {
+  gsheets: [],
+  xlsx: [
+    {
+      name: 'timemap_data',
+      path: 'data/timemap_data.xlsx',
+      tabs: timemap.default
+    }
+  ]
+}

src/example.config.js

@@ -1,19 +0,0 @@
-import { timemap } from './lib'
-
-export default {
-  gsheets: [],
-  xlsx: [
-    {
-      name: 'timemap_data',
-      path: 'data/timemap_data.xlsx',
-      tabs: timemap.default
-    }
-  ],
-  cors: {
-    active: false,
-    corsOptions: { // meaningless unless active=true
-      origin: 'http://example.com',
-      optionsSuccessStatus: 200 // some legacy browsers (IE11, various SmartTVs) choke on 204
-    }
-  }
-}

src/index.js

@@ -7,14 +7,6 @@ import api from './api'
 import dotenv from 'dotenv'
 const hbs = require('express-handlebars')
 
-
-let configJS
-try {
-  configJS = require('./local.config.js').default
-} catch (_) {
-  configJS = require('./config.js').default
-}
-
 dotenv.config()
 
 let app = express()
@@ -25,17 +17,13 @@ app.engine('.hbs', hbs({
 }))
 app.set('view engine', '.hbs')
 
-// enable cross origin requests explicitly in development OR if active in prod
-const cors = require('cors')
+// enable cross origin requests explicitly in development
 if (process.env.NODE_ENV === 'development') {
+  const cors = require('cors')
   console.log('Enabling CORS in development...')
   app.use(cors())
-} else if (configJS.cors.active === true) {
-  console.log('Enabling CORS in from config.js in prod...')
-  app.use(cors(configJS.cors.corsOptions))
 }
 
-
 const config = process.env
 
 initialize(controller => {

src/lib.js

@@ -7,7 +7,6 @@ function prefixedTabs (prefix, cfg) {
     [`${prf('events')}export_events`]: BP.deeprows,
     [`${prf('associations')}export_associations`]: BP.deeprows,
     [`${prf('sources')}export_sources`]: BP.deepids,
-    [`${prf('shapes')}export_shapes`]: BP.deeprows,
     [`${prf('sites')}export_sites`]: BP.rows
   }
 }

src/lib/Controller.js

@@ -1,7 +1,7 @@
 import copy from '../copy/en'
 
 /**
- * Controller class
+ * Controller
  *
  */
 class Controller {

src/lib/Fetcher.js

@@ -217,10 +217,7 @@ class GsheetFetcher extends Fetcher {
       })
       .then(this._buildBlueprintsAsync())
       .then(() => true)
-      .catch((err) => {
-        console.log(`Error fetching gsheets: ${err.message} `)
-        return false
-      })
+      .catch(() => false)
   }
 }
 

src/models/StoreJson.js

@@ -19,6 +19,7 @@ class StoreJson {
 
   save (url, data) {
     const parts = url.split('/')
+
     return fs.writeFile(
       `${STORAGE_DIRNAME}/${parts[0]}__${parts[1]}__${parts[2]}.json`,
       JSON.stringify(data)

test/internals.js

@@ -12,8 +12,6 @@ const egInput1 = [
   [4, 5, 6]
 ]
 
-// Test default blueprint exports
-// Smoke tests
 test('defaultBlueprint exports', t => {
   const expected = {
     sheet: {

test/serverProcess.js

@@ -3,7 +3,7 @@ import fetch from 'node-fetch'
 import childProcess from 'child_process'
 
 const SERVER_LAUNCH_WAIT_TIME = 10 * 1000
-const SERVER_ROOT = ''
+const SERVER_ROOT = 'http://localhost:4040'
 let serverProc = null
 let serverExited = false
 function checkStatus (res) {
@@ -54,7 +54,7 @@ test('should launch', t => {
 })
 
 const passUrls = [
-  '/api/'
+  '/api/',
 ]
 
 const failUrls = [

views/blueprints.hbs

@@ -8,7 +8,7 @@
       <div class="bp-source">{{ source }}</div>
     </div>
     {{#each urls}}
-    <div><a target="_blank" href="{{ this }}">{{ this }}</a></div>
+    <div><a target="_blank" href="http://localhost:4040{{ this }}">{{ this }}</a></div>
     {{/each}}
   </div>
   {{ else }}
@@ -16,7 +16,7 @@
   {{/each}}
 </div>
 
-<a class="bp-update-container" target="_blank" href="/api/update">
+<a class="bp-update-container" target="_blank" href="http://localhost:4040/api/update">
   <div class="bp-button">Update</div>
 </div>