feat!: refactor server script, update validation

Author: snvfk1n

README.md

@@ -7,7 +7,7 @@ The server is in active development and its API is subject to frequent change.
 
 ### Usage
 
-With a recent version of Node.js installed (`v12` should be sufficient), install all dependencies via `npm install`. Then, start the annotation server via `node index.js`—3000 will be its default port. With each start, the annotation server will generate a new, random API token which will be reported in its terminal output during startup.
+With a recent version of Node.js installed (`v12` should be sufficient), install all dependencies via `npm install`. Then, start the annotation server via `./bin/server.js index.js`—3000 will be its default port. With each start, the annotation server will generate a new, random API token which will be reported in its terminal output during startup.
 
 #### Creating Users
 

args.js

@@ -2,17 +2,18 @@ const os = require('os')
 const parseArgs = require('minimist')
 
 const args = parseArgs(process.argv.slice(2), {
-  boolean: ['x', 'ssl'],
+  boolean: ['x', 'ssl', 'help'],
   string: ['port', 'host'],
   alias: {
+    help: 'h',
     port: 'p',
     ssl: 's',
   },
   default: {
+    host: undefined,
     port: 3000,
-    x: false,
     ssl: false,
-    host: undefined,
+    x: false,
   },
 })
 
@@ -29,4 +30,5 @@ module.exports = {
   port,
   open: args.x,
   ssl: args.ssl,
+  help: args.help,
 }

index.js renamed to bin/server.js

@@ -1,23 +1,19 @@
-const Hapi = require('@hapi/hapi')
-const AuthBasic = require('@hapi/basic')
-const AuthBearer = require('hapi-auth-bearer-token')
-const { createAuthDummy, validateToken, validateUser } = require('./auth')
-const { createUser, getUser, deleteUser } = require('./handlers/user')
+#!/usr/bin/env node
+const { createServer } = require('../server')
+const { createUser, getUser, deleteUser } = require('../handlers/user')
 const {
   createCollection,
   getCollection,
   deleteCollection,
-} = require('./handlers/collection')
+} = require('../handlers/collection')
 const {
   createAnnotation,
   getAnnotation,
   updateAnnotation,
   deleteAnnotation,
-} = require('./handlers/annotation')
-const { generateKey } = require('./util')
-const args = require('./args')
-
-const apiToken = generateKey()
+} = require('../handlers/annotation')
+const { generateKey } = require('../util')
+const args = require('../args')
 
 function addHandler (server, path, method, handler, options = {}) {
   server.route({
@@ -28,42 +24,20 @@ function addHandler (server, path, method, handler, options = {}) {
   })
 }
 
-async function createServer (opts = {}) {
-  const port = opts.port || 3000,
-    open = !!opts.open || false
-
-  const server = Hapi.server({
-    port,
-    router: {
-      stripTrailingSlash: true,
-    },
-    routes: {
-      cors: {
-        origin: ['*'],
-        exposedHeaders: ['link', 'allow', 'etag'],
-      },
-    },
-  })
-
-  await server.register(open ? createAuthDummy('basic') : AuthBasic)
-  server.auth.strategy('user', 'basic', {
-    validate: validateUser({ userParam: 'user' }),
-  })
-  server.auth.default('user')
-
-  await server.register(
-    open ? createAuthDummy('bearer-access-token') : AuthBearer
-  )
-  server.auth.strategy('api-token', 'bearer-access-token', {
-    allowQueryToken: true,
-    validate: validateToken(apiToken),
-  })
-
-  return server
-}
-
 async function main () {
-  const server = await createServer(args)
+  if (args.help) {
+    console.log(`Usage: $ simple-annotation-server
+  
+Options:
+ -p --port PORT  TCP port to serve on (defaults to 3000)
+ --host HOST     Full public host (e.g., www.example.com:5000)
+ -s --ssl        Runs behind an SSL proxy
+ -x              Don't require any authentication`)
+    process.exit(0)
+  }
+
+  const apiToken = generateKey()
+  const server = await createServer({ ...args, apiToken })
 
   addHandler(server, '/', 'POST', createUser, { auth: 'api-token' })
   addHandler(server, '/{user}', 'GET', getUser, {

package-lock.json

@@ -2,10 +2,13 @@
   "name": "simple-annotation-server",
   "version": "0.1.0",
   "description": "Simple HTTP server implementing the Web Annotation specification",
-  "main": "index.js",
   "scripts": {
+    "start": "./bin/server.js",
     "test": "tape test/*.js"
   },
+  "bin": {
+    "simple-annotation-server": "./bin/server.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/falafeljan/simple-annotation-server.git"
@@ -31,7 +34,7 @@
     "level": "^6.0.1",
     "minimist": "^1.2.5",
     "uuid": "^8.2.0",
-    "validate-web-annotation": "^0.2.0"
+    "validate-web-annotation": "^0.3.0"
   },
   "devDependencies": {
     "tape": "^5.0.1"

package.json

@@ -0,0 +1,42 @@
+const Hapi = require('@hapi/hapi')
+const AuthBasic = require('@hapi/basic')
+const AuthBearer = require('hapi-auth-bearer-token')
+const { createAuthDummy, validateToken, validateUser } = require('./auth')
+const { generateKey } = require('./util')
+
+async function createServer (opts = {}) {
+  const port = opts.port || 3000
+  const open = !!opts.open || false
+  const apiToken = opts.apiToken || generateKey()
+
+  const server = Hapi.server({
+    port,
+    router: {
+      stripTrailingSlash: true,
+    },
+    routes: {
+      cors: {
+        origin: ['*'],
+        exposedHeaders: ['link', 'allow', 'etag'],
+      },
+    },
+  })
+
+  await server.register(open ? createAuthDummy('basic') : AuthBasic)
+  server.auth.strategy('user', 'basic', {
+    validate: validateUser({ userParam: 'user' }),
+  })
+  server.auth.default('user')
+
+  await server.register(
+    open ? createAuthDummy('bearer-access-token') : AuthBearer
+  )
+  server.auth.strategy('api-token', 'bearer-access-token', {
+    allowQueryToken: true,
+    validate: validateToken(apiToken),
+  })
+
+  return server
+}
+
+module.exports = { createServer }