it all works! - prep'ing for release

Author: nfriedly

README.md

@@ -46,7 +46,7 @@ Options:
 
 Requires that the browser support MediaElement and whatever audio codec is used in your media file.
 
-Will automatically call `.play()` the `element`, set `options.autoplay=false` to  disable. Calling `.stop()` on the returned stream will automatically call `.stop()` on the `element`.
+Will automatically call `.play()` the `element`, set `options.autoPlay=false` to  disable. Calling `.stop()` on the returned stream will automatically call `.stop()` on the `element`.
 
 Pipes results through a `{FormatStream}` by default, set `options.format=false` to disable.
 
@@ -85,13 +85,12 @@ See speech-to-text/recognize-stream.js for other options.
   Standard `close` event will fire once the underlying websocket is closed and `end` once all of the data is consumed.
 
 #### Events
-In addition to the standard [Node.js stream events](https://nodejs.org/api/stream.html), the following events are fired:
+Follows standard [Node.js stream events](https://nodejs.org/api/stream.html), in particular: 
 
-* `result`: an individual result object from the results array. 
-  May include final or interim transcription, alternatives, word timing, confidence scores, etc. depending on passed in options.
-  Note: Listening for `result` will automatically put the stream into flowing mode.
+* `data`: emits either final Strings or final/interim result objects depending on if the stream is in objectMode
+* `end`: emitted once all data has been consumed.
 
-(Note: there are several other events, but they are intended for internal usage)
+(Note: there are several custom events, but they are deprecated or intended for internal usage)
 
 ### Class `FormatStream()`
 
@@ -101,18 +100,20 @@ Pipe a `RecognizeStream` to a format stream, and the resulting text and `results
  *  Fix any "cruft" in the transcription
  *  A few other tweaks for asian languages and such.
 
-Inherits `.promise()` and `.stop()` methods and `result` event from the `RecognizeStream`.
+Inherits `.promise()` from the `RecognizeStream`.
 
 
 ### Class `TimingStream()`
 
 For use with `.recognizeBlob({play: true})` - slows the results down to match the audio. Pipe in the `RecognizeStream` (or `FormatStream`) and listen for results as usual.
 
-Inherits `.stop()` method and `result` event from the `RecognizeStream`.
-
 
 ## Changelog
 
+### v0.8
+* deprecated `result` events in favor of `objectMode`.
+* renamed the `autoplay` option to `autoPlay` on `recognizeElement()` (capital P)
+
 ### v0.7
 * Changed `playFile` option of `recognizeBlob()` to just `play`, corrected default
 * Added `options.format=true` to `recognize*()` to pipe text through a FormatStream
@@ -125,21 +126,16 @@ Inherits `.stop()` method and `result` event from the `RecognizeStream`.
 ## todo
 
 * Solidify API
-* support objectMode instead of having random events
-* add text-to-speech support
+* add text-to-speech support - may require service improvements
 * add an example that includes alternatives and word confidence scores
-* enable eslint
+* enable eslint - https://github.ibm.com/fed/javascript-style-guides
 * break components into standalone npm modules where it makes sense
-* record which shim/pollyfills would be useful to extend partial support to older browsers (Promise, etc.)
+* record which shim/pollyfills would be useful to extend partial support to older browsers (Promise, Object.assign, etc.)
 * run integration tests on travis (fall back to offline server for pull requests)
 * more tests in general
 * update node-sdk to use current version of this lib's RecognizeStream (and also provide the FormatStream + anything else that might be handy)
+* move `result` and `results` events to node wrapper (along with the deprecation notice)
 * improve docs
 * consider a wrapper to match https://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html
-
-
-recognizeBlob -> recognizeFile (?)
-objectMode
-move timing/format stream.stop to wrapper methods
-test promise with objectmode
-consider interim event for recognize/format/timing streams
+* consider renaming recognizeBlob to recognizeFile to make the usage more obvious
+* consider an `interim` event for recognize/format/timing streams to avoid objectMode (in most cases)

dist/watson-speech.js

@@ -116,8 +116,6 @@ FormatStream.prototype.formatResult = function formatResult(result, encoding, ne
   next();
 };
 
-FormatStream.prototype.promise = require('./promise');
-
-FormatStream.prototype.stop = function(){}; // usually overwritten during the `pipe` event
+FormatStream.prototype.promise = require('./to-promise');
 
 module.exports = FormatStream;

speech-to-text/format-stream.js

@@ -59,6 +59,7 @@ module.exports = function recognizeBlob(options) {
   if (realtime) {
     stream = stream.pipe(new TimingStream(options));
   }
+  stream.stop = recognizeStream.stop.bind(recognizeStream);
 
   if (options.play) {
     FilePlayer.playFile(options.data).then(function (player) {

speech-to-text/recognize-blob.js

@@ -56,6 +56,7 @@ module.exports = function recognizeElement(options) {
 
   if (options.format !== false) {
     stream = stream.pipe(new FormatStream(options));
+    stream.stop = recognizeStream.stop.bind(recognizeStream);
   }
 
   recognizeStream.on('stop', sourceStream.stop.bind(sourceStream));

speech-to-text/recognize-element.js

@@ -63,6 +63,7 @@ module.exports = function recognizeMicrophone(options) {
   var stream = recognizeStream;
   if (options.format !== false) {
     stream = stream.pipe(new FormatStream(options));
+    stream.stop = recognizeStream.stop.bind(recognizeStream);
   }
 
   return stream;

speech-to-text/recognize-microphone.js

@@ -324,7 +324,7 @@ RecognizeStream.prototype.finish = function finish() {
   }
 };
 
-RecognizeStream.prototype.promise = require('./promise');
+RecognizeStream.prototype.promise = require('./to-promise');
 
 
 RecognizeStream.getContentType = function (buffer) {

speech-to-text/recognize-stream.js

@@ -33,9 +33,6 @@ function TimingStream(opts) {
 
   var self = this;
   this.on('pipe', function(source) {
-    if(source.stop) {
-      self.stop = source.stop.bind(source);
-    }
     source.on('end', function() {
       self.sourceEnded = true; // todo: see if there's anything built-in that does this for us
     });
@@ -223,7 +220,4 @@ TimingStream.prototype.handleResult = function handleResult(result) {
   this.tick();
 };
 
-TimingStream.prototype.stop = function(){}; // usually overwritten during the `pipe` event
-
-
 module.exports = TimingStream;

speech-to-text/timing-stream.js

@@ -1,7 +1,7 @@
 var fs = require('fs');
 var watson = require('watson-developer-cloud');
 
-var AUTH_FILE = __dirname + '/auth.json';
+var AUTH_FILE = __dirname + '/stt-auth.json';
 
 if (!fs.existsSync(AUTH_FILE)) {
   console.error('Missing required test/resources/auth.json for integration test - see https://github.com/watson-developer-cloud/node-sdk#getting-the-service-credentials');