swagger-routes/src/options.js

Generate Express or Restify route handlers from a Swagger specification

'use strict'

const path = require('path')
const fileUtil = require('./fileUtil')
const fileHandlers = require('./fileHandlers')
const fileAuthorizers = require('./fileAuthorizers')
const fileSpecs = require('./fileSpecs')

const DEFAULT_EXPRESS_OPTIONS = {
  'case sensitive routing': false,
  'jsonp callback name': null,
  'trust proxy': false,
  'views': null,
  'view cache': false,
  'x-powered-by': false
}

const DEFAULT_OPTIONS = {
  docsPath: '/api-docs',
  handlers: {
    path: './handlers',
    template: path.join(__dirname, '..', 'template', 'handler.mustache'),
    generate: true
  },
  authorizers: {
    path: './security',
    template: path.join(__dirname, '..', 'template', 'authorizer.mustache'),
    generate: true
  },
  unusedFilePrefix: '_'
}

const DEFAULT_SPEC_OPTIONS = {
  specs: {
    path: './tests/api',
    template: path.join(__dirname, '..', 'template', 'spec.mustache'),
    generate: true,
    startServer: done => done(),
    stopServer: done => done()
  },
  fileType: '.spec.yml',
  unusedFilePrefix: '_'
}

exports.DEFAULT_OPTIONS = DEFAULT_OPTIONS
exports.DEFAULT_EXPRESS_OPTIONS = DEFAULT_EXPRESS_OPTIONS
exports.applyDefaultOptions = applyDefaultOptions
exports.applyDefaultSpecOptions = applyDefaultSpecOptions
exports.applyDefaultAppOptions = applyDefaultAppOptions

function applyDefaultOptions(options, extra) {
  const handlers = expandFlattenedOption('handlers', options)
  const authorizers = expandFlattenedOption('authorizers', options)

  options = Object.assign({}, DEFAULT_OPTIONS, options, extra)
  options.handlers = Object.assign({}, DEFAULT_OPTIONS.handlers, handlers)
  options.authorizers = Object.assign({}, DEFAULT_OPTIONS.authorizers, authorizers)
  options = applyTemplateOptions('handlers', fileHandlers, options)
  options = applyTemplateOptions('authorizers', fileAuthorizers, options)

  return options
}

function expandFlattenedOption(type, options) {
  const flattened = options[type]
  if (typeof flattened === 'string') return { path: flattened }
  else if (typeof flattened === 'function') return { create: flattened }
  else return flattened
}

function applyTemplateOptions(type, fileModule, options) {
  if (options[type].generate) {
    options[type].template = fileUtil.getTemplate(type, options)
    if (!options[type].getTemplateView) {
      options[type].getTemplateView = fileModule.getTemplateView
    }
  }
  return options
}

function applyDefaultSpecOptions(options) {
  const specs = expandFlattenedOption('specs', options)
  options = Object.assign({}, DEFAULT_SPEC_OPTIONS, options)
  options.specs = Object.assign({}, DEFAULT_SPEC_OPTIONS.specs, specs)
  options = applyTemplateOptions('specs', fileSpecs, options)
  if (options.sortByStatus === undefined) options.sortByStatus = true
  return options
}

function applyDefaultAppOptions(app) {
  if (isExpress(app)) {
    applyDefaultExpressOptions(app)
  }
  return app
}

function isExpress(app) {
  return (!!app && !!app.set && !!app.render)
}

function applyDefaultExpressOptions(app) {
  Object.keys(DEFAULT_EXPRESS_OPTIONS)
    .forEach(name =>
      app.set(name, DEFAULT_EXPRESS_OPTIONS[name]))
}