Switched the color package to one with more reasonable deps, added some examples to README.md, and included which will soon be used to make promisses.

Author: Spencer Alger

Gruntfile.js

@@ -4,6 +4,7 @@
 module.exports = function (grunt) {
 
   var _ = require('lodash');
+  var child_process = require('child_process');
   var sharedBrowserfyExclusions = [
     'src/lib/connectors/http.js',
     'src/lib/loggers/file.js',
@@ -72,26 +73,25 @@ module.exports = function (grunt) {
         interupt: true
       }
     },
-    generate: {
+    run: {
       js_api: {
-        cmd: 'node',
         args: [
           'scripts/generate/js_api'
         ]
       },
       yaml_tests: {
-        cmd: 'node',
         args: [
           'scripts/generate/yaml_tests'
         ]
-      }
-    },
-    start: {
+      },
       integration_server: {
-        cmd: 'node',
         args: [
           'test/browser_integration/server.js'
-        ]
+        ],
+        options: {
+          wait: false,
+          ready: /server listening/
+        }
       }
     },
     browserify: {
@@ -168,10 +168,18 @@ module.exports = function (grunt) {
           '--web-security': false
         }
       }
+    },
+    open: {
+      yaml_suite: {
+        path: 'http://localhost:8888',
+        app: 'Google Chrome'
+      }
     }
   });
 
   // load plugins
+  grunt.loadNpmTasks('grunt-run');
+  grunt.loadNpmTasks('grunt-open');
   grunt.loadNpmTasks('grunt-mocha');
   grunt.loadNpmTasks('grunt-browserify');
   grunt.loadNpmTasks('grunt-mocha-test');
@@ -197,73 +205,14 @@ module.exports = function (grunt) {
     'browserify',
     'uglify:dist',
     'concat:dist_banners',
-    'generate:yaml_tests',
-    'generate:js_api'
+    'run:yaml_tests',
+    'run:js_api'
   ]);
 
-  grunt.task.registerMultiTask('generate', 'used to generate things', function () {
-    var done = this.async();
-    var proc = require('child_process').spawn(
-      this.data.cmd,
-      this.data.args,
-      {
-        stdio: ['ignore', 'pipe', 'pipe']
-      }
-    );
-
-    proc.stdout.on('data', grunt.log.write);
-    proc.stderr.on('data', grunt.log.error);
-
-    proc.on('close', function (exitCode) {
-      done(!exitCode);
-    });
-  });
-
-  var runningProcs = {};
-
-  process.on('exit', function () {
-    _.each(runningProcs, function (proc) {
-      proc.kill();
-    });
-  });
-
-  grunt.task.registerMultiTask('start', 'used to start external processes (like servers)', function () {
-    var self = this;
-
-
-    var proc = require('child_process').spawn(
-      self.data.cmd,
-      self.data.args,
-      {
-        stdio: ['ignore', 'pipe', 'pipe']
-      }
-    );
-
-    proc.stdout.on('data', grunt.log.write);
-    proc.stderr.on('data', function (chunk) {
-      grunt.log.error(chunk);
-      proc.kill();
-      self.ansyc()(new Error('Error output received'));
-      clearTimeout(timeoutId);
-    });
-
-    runningProcs[self.nameArgs] = proc;
-
-    proc.on('close', function (exitCode) {
-      delete runningProcs[self.nameArgs];
-    });
-
-    // operates asyncronously to give the processes a moment to start up, not sure if there is a signal for "I'm ready"
-    var timeoutId = setTimeout(self.async(), 1000);
-  });
-
-  grunt.task.registerMultiTask('stop', 'used to stop external processes (like servers)', function () {
-    var proc = runningProcs[this.nameArgs.replace(/^start:/, 'stop:')];
-    if (proc) {
-      proc.kill();
-    } else {
-      grunt.log.error(this.nameArgs + ' failed to find active process');
-    }
-  });
+  grunt.registerTask('browser', [
+    'run:integration_server',
+    'open:yaml_suite',
+    'wait:integration_server'
+  ]);
 
 };

README.md

@@ -1,20 +1,101 @@
-elasticsearch-js
-=================
-
-[![Build Status](https://magnum.travis-ci.com/spenceralger/elasticsearch-js.png?token=tsFxSKHtVKG8EZavSjXY)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
+# elasticsearch.js
 
 Official *low-level* client for Elasticsearch.
 
-This project's goal it to give the JavaScript community a solif foundation for all Elasticsearch-related code. It features a complete API, provides a module for use in Node.js as well as several different build for use in the browser. We have tried to be opinion-free and very plugable.
-
-To maintain consistency across all the low-level clients (Ruby, Python, etc), clients accept all of their parameters via a single object, along with a single callback.
+This project's goal it to give the JavaScript community a solif foundation for all Elasticsearch-related code. It features a complete API, provides a module for use in Node.js as well as several different builds for use in the browser. We have tried to be opinion-free and very plugable.
 
-Features
---------
+## Features
 
  - One-to-one mapping with REST API and other language clients
+ - Generalized, pluggable architecture. See [replacing core components](docs/replacing-core-components.md)
  - Configurable, automatic discovery of cluster nodes
  - Persistent, Keep-Alive connections
  - Load balancing (with pluggable selection strategy) across all availible nodes. Defaults to round-robin
  - Pluggable connection pools to offer different connection strategies
- - Generalized, pluggable architecture - most components can be replaced with your own custom class if specialized behavior is required
+
+
+
+## Node and the browser
+
+elasticsearch.js works great in node, as well as the browser (many thanks to [browserify](https://github.com/substack/browserify)).
+
+ - Node: [![Build Status](https://magnum.travis-ci.com/spenceralger/elasticsearch-js.png?token=tsFxSKHtVKG8EZavSjXY)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
+ - Browsers:
+  + ![testling results for browser clients](https://ci.testling.com/spenceralger/xhr-method-test.png)
+
+## Install in Node
+
+```
+npm install --save elasticsearch
+```
+
+## Browser Builds
+Download one of these builds:
+
+ - [elasticsearch.js](dist/elasticsearch.js) - [minified](dist/elasticsearch.min.js)
+   - uses the browser's native XHR object
+   - Node style callbacks with a bare-bones `.then()` method
+ - [elasticsearch.angular.js](dist/elasticsearch.angular.js) - [minified](dist/elasticsearch.angular.min.js)
+   - Uses angular's $http servive
+   - returns promisses using angular's $q servive
+
+## API
+
+To maintain consistency across all the low-level clients (Ruby, Python, etc), clients accept all of their parameters via a single object, along with a single callback.
+
+#### create the client
+```
+var es = new elasticsearch.Client({
+  hosts: [
+    'localhost:9200'
+  ],
+  log: 'trace',
+  sniffOnStart: true
+});
+```
+
+#### call an endpoint
+```
+es.cluster.nodeInfo({
+  clear: true,
+  jvm: true,
+  os: ture
+}, function (err, resp, status) {
+    // do your thing
+})
+```
+
+#### skip the callback to get a promise back
+```
+es.search({
+  q: 'pants'
+}).then(function (resp) {
+  // use resp.body and resp.status
+}, function (err) {
+  // freak out!
+})
+```
+
+#### abort a request
+```
+var req = es.search({
+  q: 'robots'
+}, function (err, body, status) {
+  clearTimeout(timeout);
+  // do something
+});
+
+var timeout = setTimeout(function () {
+  req.abort();
+}, 200);
+```
+
+#### or just use the timeout param
+```
+es.search({
+  q: '*',
+  timeout: 200
+}).then(function (resp) {
+  // Iterate all the hits
+})
+```

docs/replacing-core-components.md

@@ -0,0 +1 @@
+==

package.json

@@ -7,33 +7,36 @@
   "homepage": "https://github.com/elasticsearch/elasticsearch-js",
   "version": "0.0.1",
   "devDependencies": {
-    "grunt": "*",
-    "grunt-contrib-jshint": "*",
-    "grunt-contrib-nodeunit": "*",
-    "js-yaml": "*",
+    "tar": "*",
+    "mocha": "*",
+    "async": "*",
     "mkdirp": "*",
     "moment": "*",
     "should": "*",
-    "grunt-mocha-test": "*",
-    "grunt-contrib-watch": "*",
-    "expect.js": "*",
-    "async": "*",
+    "js-yaml": "*",
     "optimist": "*",
+    "expect.js": "*",
     "minimatch": "*",
     "browserify": "*",
+    "grunt": "*",
+    "grunt-contrib-jshint": "*",
+    "grunt-contrib-nodeunit": "*",
+    "grunt-mocha-test": "*",
+    "grunt-contrib-watch": "*",
     "grunt-browserify": "*",
     "grunt-contrib-clean": "*",
     "grunt-contrib-uglify": "*",
-    "mocha": "*",
     "grunt-mocha": "*",
-    "grunt-contrib-concat": "~0.3.0"
+    "grunt-contrib-concat": "~0.3.0",
+    "grunt-open": "~0.2.2",
+    "grunt-run": "~0.1.0"
   },
   "license": "Apache License",
   "dependencies": {
-    "cli-color": "*",
+    "when": "~2.6.0",
     "lodash": "*",
-    "tar": "*",
-    "agentkeepalive": "*"
+    "agentkeepalive": "*",
+    "chalk": "~0.3.0"
   },
   "scripts": {
     "test": "grunt"

scripts/grunt-run-wait-stop.js

@@ -0,0 +1,76 @@
+var runningProcs = [];
+
+process.on('exit', function () {
+  _.each(runningProcs, function (proc) {
+    proc.kill();
+  });
+});
+
+grunt.task.registerMultiTask('run', 'used to start external processes (like servers)', function () {
+  var self = this;
+  var name = this.target;
+  var opts = this.options({
+    wait: true,
+    killOnError: true
+  });
+
+  console.log(opts);
+
+  var proc = child_process.spawn(
+    self.data.cmd,
+    self.data.args,
+    {
+      stdio: ['ignore', 'pipe', 'pipe']
+    }
+  );
+
+  proc.stdout.on('data', grunt.log.write);
+
+  var done = this.async();
+
+  if (opts.killOnError) {
+    proc.stderr.on('data', function (chunk) {
+      grunt.log.error(chunk);
+      proc.kill();
+      self.ansyc()(new Error('Error output received'));
+      clearTimeout(timeoutId);
+    });
+  }
+
+  if (opts.wait) {
+    proc.on('close', function (exitCode) {
+      done(!exitCode);
+    });
+  } else {
+    grunt.config.set('stop.' + name + '._pid', proc.pid);
+    grunt.config.set('wait.' + name + '._pid', proc.pid);
+    runningProcs.push(proc);
+    var timeoutId = setTimeout(done, 1000);
+  }
+
+  proc.on('close', function (exitCode) {
+    var i;
+    if ((i = runningProcs.indexOf(proc)) !== -1) {
+      runningProcs.splice(i, 1);
+    }
+    grunt.log.debug('Process ' + name + ' closed.');
+  });
+});
+
+grunt.task.registerMultiTask('stop', 'stop a process started with "start" ' +
+  '(only works for tasks that use wait:false)', function () {
+  var pid = this.data._pid;
+  child_process.kill(pid);
+});
+
+grunt.task.registerMultiTask('wait', 'wait for a process to close ' +
+  '(only works for tasks that use wait:false)', function () {
+
+  var pid = this.data._pid;
+  var proc = _.find(runningProcs, { pid: pid });
+  if (proc) {
+    proc.on('close', this.async());
+  } else {
+    grunt.log.writeLn('process already closed');
+  }
+});