add installer

README.md

@@ -16,14 +16,16 @@ Imagine you have an app that creates invoices. You want to save those invoices a
 
 ```bash
 $ npm install -g pdf-bot
-$ pdf-bot --help
+$ pdf-bot install
 ```
 
 > Make sure the node path is in your $PATH
 
+`pdf-bot install` will prompt for some basic configurations and then create a storage folder where your database and pdf files will be saved.
+
 ### Configuration
 
-`pdf-bot` comes packaged with sensible defaults. However, if you want to customize your config, simply create a config file that exports a configuration and pass it as a parameter to `pdf-bot`
+`pdf-bot` comes packaged with sensible defaults. At the very minimum you must have a config file in the same folder from which you are executing `pdf-bot` with a `storagePath` given.
 
 `pdf-bot.config.js`
 ```js
@@ -35,7 +37,8 @@ module.exports = {
   },
   generator: {
     completionTrigger: new htmlPdf.CompletionTrigger.Timer(1000) // 1 sec timeout
-  }
+  },
+  storagePath: 'storage'
 }
 ```
 

bin/pdf-bot.js

@@ -12,7 +12,8 @@ var error = require('../src/error')
 var createQueue = require('../src/queue')
 var webhook = require('../src/webhook')
 var pjson = require('../package.json')
-var appRoot = require('app-root-path')
+var execSync = require('child_process').execSync
+var prompt = require('prompt')
 
 program
   .version(pjson.version)
@@ -59,7 +60,7 @@ var defaultConfig = {
     })
     */
   },
-  storagePath: path.join(appRoot.toString(), 'storage'),
+  storagePath: 'storage',
   /*webhook: {
     headerNamespace: 'X-PDF-',
     requestOptions: {
@@ -74,7 +75,7 @@ program
   .command('api')
   .description('Start the API')
   .action(function (options) {
-    createConfig()
+    openConfig()
 
     var apiOptions = configuration.api
     var port = apiOptions.port
@@ -87,14 +88,84 @@ program
     })
   })
 
+program
+  .command('install')
+  .action(function (options) {
+    var configPath = program.config || path.join(process.cwd(), 'pdf-bot.config.js')
+
+    function startPrompt() {
+      prompt.start({noHandleSIGINT: true})
+      prompt.get([
+      {
+        name: 'storagePath',
+        description: 'Enter a path for storage',
+        default: path.join(process.cwd(), 'pdf-storage'),
+        required: true
+      },
+      {
+        name: 'token',
+        description: 'An access token for your API',
+        required: false
+      }], function (err, result) {
+        if (err) {
+          process.exit(0)
+        }
+        var options = {}
+
+        if (result.token) {
+          options.api = {token: result.token}
+        }
+
+        options.storagePath = result.storagePath
+
+        var configContents = "module.exports = " + JSON.stringify(options, null, 2)
+
+        fs.writeFileSync(configPath, configContents)
+
+        if (!fs.existsSync(options.storagePath)) {
+          fs.mkdirSync(options.storagePath, '0775')
+          fs.mkdirSync(path.join(options.storagePath, 'db'), '0775')
+          fs.mkdirSync(path.join(options.storagePath, 'pdf'), '0775')
+        }
+
+        console.log('pdf-bot was installed successfully.')
+        console.log('Config file is placed at ' + configPath + ' and contains')
+        console.log(configContents)
+        console.log('You should add ALIAS pdf-bot="pdf-bot -c ' + configPath + '" to your ~/.profile')
+      });
+    }
+
+    var existingConfigFileFound = fs.existsSync(configPath)
+    if (existingConfigFileFound) {
+      prompt.start({noHandleSIGINT: true})
+      prompt.get([
+        {
+          name: 'replaceConfig',
+          description: 'A config file already exists, are you sure you want to override (yes/no)'
+        }
+      ], function (err, result) {
+        if (err) {
+          process.exit(0)
+        }
+        if (result.replaceConfig !== 'yes') {
+          process.exit(0)
+        } else {
+          startPrompt()
+        }
+      })
+    } else {
+      startPrompt()
+    }
+  })
+
 program
   .command('jobs')
   .description('List all completed jobs')
   .option('--completed', 'Show completed jobs')
   .option('--failed', 'Show failed jobs')
   .option('-l, --limit [limit]', 'Limit how many jobs to show')
   .action(function (options) {
-    createConfig()
+    openConfig()
 
     listJobs(queue, options.failed, options.completed, options.limit)
   })
@@ -103,7 +174,7 @@ program
   .command('ping [jobID]')
   .description('Attempt to ping webhook for job')
   .action(function (jobId, options) {
-    createConfig()
+    openConfig()
 
     var job = queue.getById(jobId)
 
@@ -118,7 +189,7 @@ program
 program
   .command('ping:retry-failed')
   .action(function() {
-    createConfig()
+    openConfig()
 
     var maxTries = configuration.queue.webhookMaxTries
     var retryStrategy = configuration.queue.webhookRetryStrategy
@@ -134,7 +205,7 @@ program
   .command('pings [jobId]')
   .description('List pings for a job')
   .action(function (jobId, options) {
-    createConfig()
+    openConfig()
 
     var job = queue.getById(jobId)
 
@@ -170,7 +241,7 @@ program
   .description('Push new job to the queue')
   .option('-m, --meta [meta]', 'JSON string with meta data. Default: \'{}\'')
   .action(function (url, options) {
-    createConfig()
+    openConfig()
 
     var response = queue.addToQueue({
       url: url,
@@ -187,7 +258,7 @@ program
   .command('shift')
   .description('Run the next job in the queue')
   .action(function (url) {
-    createConfig()
+    openConfig()
 
     var maxTries = configuration.queue.generationMaxTries
     var retryStrategy = configuration.queue.generationRetryStrategy
@@ -218,18 +289,36 @@ if (!process.argv.slice(2).length) {
   program.outputHelp();
 }
 
-function createConfig() {
+function openConfig() {
   configuration = defaultConfig
 
-  if (program.config) {
-    var configPath = path.join(process.cwd(), program.config)
-
-    if (!fs.existsSync(configPath)) {
-      throw new Error('No config file was found at ' + configPath)
+  if (!program.config) {
+    if (fs.existsSync(path.join(process.cwd(), 'pdf-bot.config.js'))) {
+      program.config = 'pdf-bot.config.js'
+    } else {
+      throw new Error('You need to supply a config file')
     }
+  }
+
+  var configPath = path.join(process.cwd(), program.config)
+
+  if (!fs.existsSync(configPath)) {
+    throw new Error('No config file was found at ' + configPath)
+  }
+
+  debug('Creating CLI using config file %s', configPath)
+  merge(configuration, require(configPath))
+
+  if (!fs.existsSync(configuration.storagePath)) {
+    throw new Error('Whoops! Looks like your storage folder does not exist. You should run pdf-bot install.')
+  }
+
+  if (!fs.existsSync(path.join(configuration.storagePath, 'db'))) {
+    throw new Error('There is no database folder in the storage folder. Create it: storage/db')
+  }
 
-    debug('Creating CLI using config file %s', configPath)
-    merge(configuration, require(configPath))
+  if (!fs.existsSync(path.join(configuration.storagePath, 'pdf'))) {
+    throw new Error('There is no pdf folder in the storage folder. Create it: storage/pdf')
   }
 
   var queueOptions = configuration.queue

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-bot",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "author": "Esben Petersen <[email protected]>",
   "homepage": "https://github.com/esbenp/pdf-bot",
   "license": "MIT",
@@ -23,7 +23,6 @@
     "test:watch": "mocha -w test/*.test.js --recursive"
   },
   "dependencies": {
-    "app-root-path": "^2.0.1",
     "body-parser": "^1.17.2",
     "cli-table": "^0.3.1",
     "commander": "^2.11.0",
@@ -34,6 +33,7 @@
     "lodash.merge": "^4.6.0",
     "lowdb": "^0.16.2",
     "node-fetch": "^1.7.1",
+    "prompt": "^1.0.0",
     "s3": "^4.4.0",
     "uuid": "^3.1.0"
   },