chore: remove buffer-based client

Author: palmerabollo

README.md

@@ -17,7 +17,6 @@ npm install --save bingspeech-api-client
 
 See example below on how to require and use for Speech to text (STT) and text to speech (TTS).
 
-
 ## Examples
 
 Following example code is assuming you are using [typescript](https://www.typescriptlang.org/). If you are, skip this section and go straight to the examples. But if you are using node ES6 and want to use the example code read on.
@@ -26,17 +25,13 @@ At present node does not support `import`. As mentioned on [MDN](https://develop
 
 >Note: This feature[`import`] is only beginning to be implemented in browsers natively at this time. It is implemented in many transpilers, such as the Traceur Compiler, Babel, Rollup or Webpack.
 
-
 To get the example code working change the first line to:
 
 ```js
 const { BingSpeechClient, VoiceRecognitionResponse } = require('bingspeech-api-client');
 ```
 
-
-### Usage with streams
-
-#### STT usage example (recognize)
+### STT usage example (recognize)
 
 ```javascript
 import { BingSpeechClient, VoiceRecognitionResponse } from 'bingspeech-api-client';
@@ -50,7 +45,7 @@ let client = new BingSpeechClient(subscriptionKey);
 client.recognizeStream(audioStream).then(response => console.log(response.results[0].name));
 ```
 
-#### TTS usage example (synthesize)
+### TTS usage example (synthesize)
 
 ```javascript
 import { BingSpeechClient, VoiceVoiceSynthesisResponse } from 'bingspeech-api-client';
@@ -61,33 +56,3 @@ let subscriptionKey = 'your_private_subscription_key';
 let client = new BingSpeechClient(subscriptionKey);
 client.synthesizeStream('I have a dream').then(audioStream => /* ... */);
 ```
-
-### Usage with buffers (deprecated, will be removed in 2.x)
-
-#### STT usage example (recognize)
-
-```javascript
-import { BingSpeechClient, VoiceRecognitionResponse } from 'bingspeech-api-client';
-
-// audio input in a Buffer
-let wav = fs.readFileSync('myaudiofile.wav');
-
-// Bing Speech Key (https://www.microsoft.com/cognitive-services/en-us/subscriptions)
-let subscriptionKey = 'your_private_subscription_key';
-
-let client = new BingSpeechClient(subscriptionKey);
-client.recognize(wav).then(response => console.log(response.results[0].name));
-```
-
-#### TTS usage example (synthesize)
-
-```javascript
-import { BingSpeechClient, VoiceVoiceSynthesisResponse } from 'bingspeech-api-client';
-
-// Bing Speech Key (https://www.microsoft.com/cognitive-services/en-us/subscriptions)
-let subscriptionKey = 'your_private_subscription_key';
-
-let client = new BingSpeechClient(subscriptionKey);
-client.synthesize('I have a dream').then(response => { /* audio is a Buffer in response.wave */ });
-```
-

package-lock.json

@@ -1,10 +1,16 @@
 import { expect } from 'chai';
 
-import { BingSpeechClient, VoiceRecognitionResponse, VoiceSynthesisResponse } from './';
+import { BingSpeechClient, VoiceRecognitionResponse } from './';
 
 import * as nock from 'nock';
 
 describe('Bing Speech API client', () => {
+    beforeEach(() => {
+        nock('https://api.cognitive.microsoft.com')
+            .post('/sts/v1.0/issueToken')
+            .reply(200, 'FAKETOKEN');
+    });
+
     it('should recognize a voice', () => {
         const mockResponse: VoiceRecognitionResponse = {
               version: '3.0',
@@ -31,40 +37,32 @@ describe('Bing Speech API client', () => {
               ]
         };
 
-        nock('https://api.cognitive.microsoft.com')
-            .post('/sts/v1.0/issueToken')
-            .reply(200, 'FAKETOKEN');
-
         nock('https://speech.platform.bing.com')
             .post('/recognize')
             .query(true)
             .reply(200, mockResponse);
 
-        let client = new BingSpeechClient('fakeSubscriptionId');
+        const client = new BingSpeechClient('fakeSubscriptionId');
 
-        let wave = new Buffer('');
-        return client.recognize(wave)
+        const stream: NodeJS.ReadWriteStream = null;
+        return client.recognizeStream(stream)
             .then((response: VoiceRecognitionResponse) => {
                 expect(response).to.eql(mockResponse);
             });
     });
 
     it('should synthesize a voice', () => {
-         const mockResponse = 'this is a wav';
-
-        nock('https://api.cognitive.microsoft.com')
-            .post('/sts/v1.0/issueToken')
-            .reply(200, 'FAKETOKEN');
+        const client = new BingSpeechClient('fakeSubscriptionId');
 
         nock('https://speech.platform.bing.com')
             .post('/synthesize')
-            .reply(200, mockResponse);
-
-        let client = new BingSpeechClient('fakeSubscriptionId');
+            .reply(200, '');
 
-        return client.synthesize('This is a fake test')
-            .then((response: VoiceSynthesisResponse) => {
-                expect(response.wave.toString()).to.eq(mockResponse);
+        // TODO fix & improve this test.
+        // It passes but it is weak and, what is worse, it shows an ECONNRESET as if some connection wasn't properly intercepted by nock
+        return client.synthesizeStream('This is a fake test')
+            .then((stream: NodeJS.ReadableStream) => {
+                expect(stream).to.be.an('object');
             });
     });
 });

src/client.spec.ts

@@ -1,11 +1,8 @@
-import * as fs from 'fs';
-import * as util from 'util';
 import * as uuid from 'uuid';
 import * as needle from 'needle';
-import * as stream from 'stream';
 import * as querystring from 'querystring';
 
-import { VoiceRecognitionResponse, VoiceSynthesisResponse } from './models';
+import { VoiceRecognitionResponse } from './models';
 
 const debug = require('debug')('bingspeechclient');
 
@@ -74,19 +71,9 @@ export class BingSpeechClient {
         this.subscriptionKey = subscriptionKey;
     }
 
-    /**
-     * @deprecated Use the recognizeStream function instead. Will be removed in 2.x
-     */
-    recognize(wave: Buffer, locale: string = 'en-us'): Promise<VoiceRecognitionResponse> {
-        var bufferStream = new stream.PassThrough();
-        bufferStream.end(wave);
-
-        return this.recognizeStream(bufferStream, locale);
-    }
-
     recognizeStream(input: NodeJS.ReadWriteStream, locale: string = 'en-us'): Promise<VoiceRecognitionResponse> {
         // see also https://nowayshecodes.com/2016/02/12/speech-to-text-with-project-oxford-using-node-js/
-        // TODO make locale and content-type configurable
+        // TODO make content-type configurable
         return this.issueToken()
             .then((token) => {
                 // Access token expires every 10 minutes. Renew it every 9 minutes only.
@@ -133,30 +120,6 @@ export class BingSpeechClient {
             });
     }
 
-    /**
-     * * @deprecated Use the synthesizeStream function instead. Will be removed in 2.x
-     */
-    synthesize(text: string, locale: string = 'en-us', gender: string = 'female'): Promise<VoiceSynthesisResponse> {
-        return this.synthesizeStream(text, locale, gender)
-            .then(waveStream => {
-                return new Promise<VoiceSynthesisResponse>((resolve, reject) => {
-                    let buffers: any[] = [];
-                    waveStream.on('data', (buffer: any) => buffers.push(buffer));
-                    waveStream.on('end', () => {
-                        let wave = Buffer.concat(buffers);
-                        let response: VoiceSynthesisResponse = {
-                            wave: wave
-                        };
-                        resolve(response);
-                    });
-                    waveStream.on('error', (err: Error) => reject(err));
-                });
-            })
-            .catch((err: Error) => {
-                throw new Error(`Voice synthesis failed miserably: ${err.message}`);
-            });
-    }
-
     synthesizeStream(text: string, locale: string = 'en-us', gender: string = 'female', outputFormat:string = this.DEFAULT_AUDIO_OUTPUT_FORMAT): Promise<NodeJS.ReadableStream> {
         // see also https://github.com/Microsoft/Cognitive-Speech-TTS/blob/master/Samples-Http/NodeJS/TTSService.js
         return this.issueToken()

src/client.ts

@@ -1,3 +1,3 @@
 export { BingSpeechClient } from './client';
-export { VoiceRecognitionResponse, VoiceSynthesisResponse } from './models';
+export { VoiceRecognitionResponse } from './models';
 

src/index.ts

@@ -27,11 +27,4 @@ export interface VoiceRecognitionResponse {
             LOWCONF?: string;
         }
     }[];
-};
-
-/**
- * @deprecated Use streaming mode instead. Will be removed in 2.x
- */
-export interface VoiceSynthesisResponse {
-    wave: Buffer;
 }