Merge pull request #2 from apibyexample/nick/abe-json-builder-creation

ABE JSON builder creation

Author: jonman

README.md

@@ -1,3 +1,9 @@
+[![Build Status](http://img.shields.io/travis/apibyexample/abe-json-builder/master.svg)](https://travis-ci.org/apibyexample/abe-json-builder)
+[![Dependency Status](https://david-dm.org/apibyexample/abe-json-builder/dev-status.svg)](https://david-dm.org/apibyexample/abe-json-builder#info=devDependencies)
+[![devDependency Status](https://david-dm.org/apibyexample/abe-json-builder/status.svg)](https://david-dm.org/apibyexample/abe-json-builder#info=dependencies)
+[![Monthly downloads](http://img.shields.io/npm/dm/abe-json-builder.svg)](https://www.npmjs.org/package/abe-json-builder)
+[![License](http://img.shields.io/npm/l/abe-json-builder.svg)](https://www.npmjs.org/package/abe-json-builder)
+
 abe-json-builder
 ================
 
@@ -63,3 +69,32 @@ Would be converted into two different files (using the file name and the example
     "payload": "Another Sample"
 }
 ```
+
+## Usage
+
+It is expected that you are using ABE Spec's for this node module to be used, to
+take a look at the Spec's take a look at the repo [here](https://github.com/apibyexample/abe-spec).
+
+``npm install --save-dev abe-json-builder``
+
+You will need to run the JSON Builder prior to running your tests and/or server.
+
+Example usage (file name createFeeds.js):
+
+```js
+var createFeeds = require('abe-json-builder'),
+    options = {
+        'verbose': false,
+        'location': 'myApp/mocks/**/*',
+        'build': 'www/dist/json/'
+    };
+
+createFeeds.jsonBuilder(options);
+
+```
+
+To execute you would then need to run
+
+``node createFeeds.js``
+
+A suggestion would be to add this to your ``package.json`` as a script command.

package.json

@@ -2,20 +2,33 @@
   "name": "abe-json-builder",
   "version": "0.1.0",
   "description": "Strips ABE spec files to JSON files containing response body only.",
-  "main": "src/index.js",
+  "main": "src/abe-json-builder.js",
   "scripts": {
     "test": "grunt test"
   },
+  "keywords": [
+      "abe",
+      "mocks",
+      "json"
+  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/apibyexample/abe-json-builder.git"
   },
-  "author": "Rockabox <tech@rockabox.com> (http://rockabox.com)",
+  "author": [
+    "API By Example <apibyexample@gmail.com>",
+    "Nick White <nickswhite89@gmail.com>"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/apibyexample/abe-json-builder/issues"
   },
   "homepage": "https://github.com/apibyexample/abe-json-builder",
+  "dependencies": {
+    "colours": "~0.6.0-2",
+    "glob": "~4.0.6",
+    "lodash-node": "~2.4.1"
+  },
   "devDependencies": {
     "grunt": "~0.4.5",
     "grunt-cli": "~0.1.13",

src/abe-json-builder.js

@@ -0,0 +1,64 @@
+var colors = require('colours'),
+    glob = require('glob'),
+    path = require('path'),
+    util = require('util'),
+    lodash = require('lodash-node'),
+    fs = require('fs'),
+    errors = {
+        'NOT_ABE': 'This file isn\'t valid ABE JSON format'
+    },
+    opt = {
+        'verbose': false,
+        'location': './',
+        'build': 'tmp/'
+    };
+
+exports.jsonBuilder = function (options) {
+    lodash.merge(opt, options);
+
+    glob
+        .sync(opt.location + '.json', {
+            mark: true
+        })
+        .forEach(function (match) {
+            var json = require(process.cwd() + '/' + match);
+
+            // Check that the JSON passed to the function has examples / matches
+            // ABE Spec
+            if (!lodash.has(json, 'examples')) {
+                return errors.NOT_ABE;
+            }
+
+            var folderArr = path.dirname(match).split('/'),
+                filePath = process.cwd() + '/' + opt.build,
+                buildName = folderArr[folderArr.length - 1] + '-',
+                baseName = path.basename(match, '.json');
+
+            if (!fs.existsSync(filePath)) {
+                fs.mkdir(filePath, function (err) {
+                    if (err) {
+                        console.log(err.red);
+                    } else if (opt.verbose) {
+                        console.log(opt.build.yellow, ' created.');
+                    }
+                });
+            }
+
+            // Loop through each example within the JSON to create it's own
+            // JSON file
+            lodash.forEach(json.examples, function (obj, key) {
+                var bodyData = json.examples[key].response.body,
+                    fileData = JSON.stringify(bodyData, null, 4),
+                    file = buildName + baseName + '-' + key + '.json';
+
+                fs.writeFile(filePath + file, fileData, function (err) {
+                    if (err) {
+                        console.log(err.red);
+                    } else if (opt.verbose) {
+                        console.log(file.green, ' file was saved.');
+                    }
+                });
+            });
+
+        });
+};