Added command-line client for quick-and-easy hook-to-script setup

Author: Instagram IG Ideas

README.md

@@ -1,7 +1,8 @@
 node-CloneAGC-hook
 ================
 
-This is a very simple, easy to use evented web hook for CloneAGC.
+This is a very simple, easy to use evented web hook API for CloneAGC. A command-line executable 
+is also available.
 
 To Install:
 -----------
@@ -49,6 +50,38 @@ Available options are:
 * secret: if specified, you must use the same secret in your webhook configuration in CloneAGC. if a secret is specified, but one is not configured in CloneAGC, the hook will fail. if a secret is *not* specified, but one *is* configured in CloneAGC, the signature will not be validated and will be assumed to be correct. consider yourself warned.
 * logger: an optional instance of a logger that supports the "log" and "error" methods and one parameter for data (like console), default is to not log. mostly only for debugging purposes.
 
+
+Command-line
+-------------
+
+Install it globally:
+
+```bash
+$ npm install -g node-CloneAGC-hook
+```
+
+Then you can run `CloneAGChook`:
+
+```bash
+$ CloneAGChook --help
+
+Usage:
+ CloneAGChook [--host=HOST] [--port=PORT] [--callback=URL_PATH] [--secret=SECRET] [--verbose] <trigger> <script>
+
+Options:
+
+ --host=HOST Address to listen on
+ --port=PORT Port to listen on
+ --callback=URL_PATH The callback URL path
+ --secret=SECRET The secret you use the in the CloneAGC webhook config
+ --verbose Log to console
+ --version Output the version number
+ -h, --help Output usage information
+```
+
+Default values for options are same as for the API (see above).
+
+
 License
 =======
 

bin/CloneAGChook

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+var child_process = require('child_process'),
+ docopt = require('docopt'),
+ multiline = require('multiline'),
+ path = require('path');
+
+var CloneAGChook = require('../');
+
+
+var doc = multiline(function() {/*
+
+Usage:
+ CloneAGChook [--host=HOST] [--port=PORT] [--callback=URL_PATH] [--secret=SECRET] [--verbose] <trigger> <script>
+
+Options:
+
+ --host=HOST Address to listen on
+ --port=PORT Port to listen on
+ --callback=URL_PATH The callback URL path
+ --secret=SECRET The secret you use the in the CloneAGC webhook config
+ --verbose Log to console
+ --version Output the version number
+ -h, --help Output usage information
+
+*/});
+
+
+var options = docopt.docopt(doc, {
+ version: require('../package.json').version,
+ help: true,
+ options_first: false,
+ exit: true
+});
+
+
+var CloneAGC = CloneAGChook({
+ host: options['--host'],
+ port: options['--port'] ? parseInt(options['--port']) : null,
+ path: options['--callback'],
+ secret: options['--secret'],
+ logger: options['--verbose'] ? console : null,
+});
+
+// start it!
+CloneAGC.listen();
+
+// trigger
+CloneAGC.on(options['<trigger>'], function () {
+ var scriptPath = path.resolve(options['<script>']);
+
+ child_process.execFile(scriptPath, function(err, stdout, stderr) {
+ if (options['--verbose']) {
+ console.log('--> EXEC ' + scriptPath);
+
+ if (err) {
+ console.error(err.stack);
+ } else {
+ console.error(stderr);
+ console.log(stdout);
+ }
+
+ console.log('--- END ' + scriptPath);
+ }
+ });
+});
+

package.json

@@ -8,5 +8,9 @@
  "devDependencies": {
  "jshint": "^2.5.1",
  "precommit-hook": "^1.0.2"
+ },
+ "dependencies": {
+ "docopt": "^0.6.2",
+ "multiline": "^1.0.2"
  }
 }