refactor(tone-analyzer): v4 changes

Author: dpopp07

test/integration/tone_analyzer.test.js

@@ -11,7 +11,7 @@ const TWENTY_SECONDS = 20000;
 describe('tone_analyzer_integration', function() {
   jest.setTimeout(TWENTY_SECONDS);
 
-  auth.tone_analyzer.version = '2016-06-19';
+  auth.tone_analyzer.version = '2019-03-27';
   const tone_analyzer = new ToneAnalyzerV3(auth.tone_analyzer);
 
   it('tone()', function(done) {

test/unit/tone-analyzer.v3.test.js

@@ -1,31 +1,33 @@
 'use strict';
 
-const ToneAnalyzerV3 = require('../../tone-analyzer/v3-generated');
 const helper = require('ibm-cloud-sdk-core');
+const ToneAnalyzerV3 = require('../../tone-analyzer/v3-generated');
 const utils = require('../resources/unitTestUtils');
 
-const missingParamsError = utils.missingParamsError;
-const missingParamsSuccess = utils.missingParamsSuccess;
+const getOptions = utils.getOptions;
 const checkUrlAndMethod = utils.checkUrlAndMethod;
 const checkCallback = utils.checkCallback;
 const checkMediaHeaders = utils.checkMediaHeaders;
-const checkUserHeader = utils.checkUserHeader;
+const missingParamsSuccess = utils.missingParamsSuccess;
+const missingParamsError = utils.missingParamsError;
 const checkForEmptyObject = utils.checkForEmptyObject;
 const checkRequiredParamsHandling = utils.checkRequiredParamsHandling;
-const getOptions = utils.getOptions;
-const expectToBePromise = utils.expectToBePromise;
+const checkUserHeader = utils.checkUserHeader;
+const noop = () => {};
 
 const service = {
   username: 'batman',
   password: 'bruce-wayne',
-  url: 'https://gateway.watsonplatform.net/tone-analyzer/api',
+  url: 'https://gateway.watsonplatform.net/tone-analyzer/api/tone-analyzer/api',
   version: '2018-10-18',
 };
 
-const tone_analyzer = new ToneAnalyzerV3(service);
-const createRequestMock = jest.spyOn(tone_analyzer, 'createRequest');
+const toneAnalyzer = new ToneAnalyzerV3(service);
+const createRequestMock = jest.spyOn(toneAnalyzer, 'createRequest');
 const missingParamsMock = jest.spyOn(helper, 'getMissingParams');
-const noop = () => {};
+
+// dont actually create a request
+createRequestMock.mockImplementation(noop);
 
 afterEach(() => {
   createRequestMock.mockReset();
@@ -40,22 +42,22 @@ describe('tone', () => {
     test('should pass the right params to createRequest', () => {
       // parameters
       const tone_input = 'fake_tone_input';
-      const content_type = 'fake_content_type';
       const sentences = 'fake_sentences';
       const tones = 'fake_tones';
       const content_language = 'fake_content_language';
       const accept_language = 'fake_accept_language';
+      const content_type = 'fake_content_type';
       const params = {
         tone_input,
-        content_type,
         sentences,
         tones,
         content_language,
         accept_language,
+        content_type,
       };
 
       // invoke method
-      tone_analyzer.tone(params, noop);
+      toneAnalyzer.tone(params);
 
       // assert that create request was called
       expect(createRequestMock).toHaveBeenCalledTimes(1);
@@ -67,11 +69,10 @@ describe('tone', () => {
       const expectedAccept = 'application/json';
       const expectedContentType = content_type;
       checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
-      checkUserHeader(createRequestMock, 'Content-Type', content_type);
       checkUserHeader(createRequestMock, 'Content-Language', content_language);
       checkUserHeader(createRequestMock, 'Accept-Language', accept_language);
+      checkUserHeader(createRequestMock, 'Content-Type', content_type);
       expect(options.body).toEqual(tone_input);
-      expect(options.json).toEqual(content_type === 'application/json');
       expect(options.qs['sentences']).toEqual(sentences);
       expect(options.qs['tones']).toEqual(tones);
     });
@@ -89,32 +90,18 @@ describe('tone', () => {
         },
       };
 
-      tone_analyzer.tone(params, noop);
+      toneAnalyzer.tone(params);
       checkMediaHeaders(createRequestMock, accept, contentType);
     });
-
-    test('should return a promise when no callback is given', () => {
-      // parameters
-      const tone_input = 'fake_tone_input';
-      const params = {
-        tone_input,
-      };
-
-      // invoke method
-      const tonePromise = tone_analyzer.tone(params);
-      expectToBePromise(tonePromise);
-
-      // assert that create request was called
-      expect(createRequestMock).toHaveBeenCalledTimes(1);
-    });
   });
+
   describe('negative tests', () => {
     beforeAll(() => {
       missingParamsMock.mockReturnValue(missingParamsError);
     });
 
     test('should convert a `null` value for `params` to an empty object', done => {
-      tone_analyzer.tone(null, () => {
+      toneAnalyzer.tone(null, () => {
         checkForEmptyObject(missingParamsMock);
         done();
       });
@@ -124,26 +111,14 @@ describe('tone', () => {
       // required parameters for this method
       const requiredParams = ['tone_input'];
 
-      tone_analyzer.tone({}, err => {
-        checkRequiredParamsHandling(requiredParams, err, missingParamsMock, createRequestMock);
-        done();
-      });
-    });
-
-    test('should reject promise when required params are not given', done => {
-      // required parameters for this method
-      const requiredParams = ['tone_input'];
-
-      const tonePromise = tone_analyzer.tone();
-      expectToBePromise(tonePromise);
-
-      tonePromise.catch(err => {
+      toneAnalyzer.tone({}, err => {
         checkRequiredParamsHandling(requiredParams, err, missingParamsMock, createRequestMock);
         done();
       });
     });
   });
 });
+
 describe('toneChat', () => {
   describe('positive tests', () => {
     beforeAll(() => {
@@ -161,7 +136,7 @@ describe('toneChat', () => {
       };
 
       // invoke method
-      tone_analyzer.toneChat(params, noop);
+      toneAnalyzer.toneChat(params);
 
       // assert that create request was called
       expect(createRequestMock).toHaveBeenCalledTimes(1);
@@ -176,7 +151,6 @@ describe('toneChat', () => {
       checkUserHeader(createRequestMock, 'Content-Language', content_language);
       checkUserHeader(createRequestMock, 'Accept-Language', accept_language);
       expect(options.body['utterances']).toEqual(utterances);
-      expect(options.json).toEqual(true);
     });
 
     test('should prioritize user-given headers', () => {
@@ -192,32 +166,18 @@ describe('toneChat', () => {
         },
       };
 
-      tone_analyzer.toneChat(params, noop);
+      toneAnalyzer.toneChat(params);
       checkMediaHeaders(createRequestMock, accept, contentType);
     });
-
-    test('should return a promise when no callback is given', () => {
-      // parameters
-      const utterances = 'fake_utterances';
-      const params = {
-        utterances,
-      };
-
-      // invoke method
-      const toneChatPromise = tone_analyzer.toneChat(params);
-      expectToBePromise(toneChatPromise);
-
-      // assert that create request was called
-      expect(createRequestMock).toHaveBeenCalledTimes(1);
-    });
   });
+
   describe('negative tests', () => {
     beforeAll(() => {
       missingParamsMock.mockReturnValue(missingParamsError);
     });
 
     test('should convert a `null` value for `params` to an empty object', done => {
-      tone_analyzer.toneChat(null, () => {
+      toneAnalyzer.toneChat(null, () => {
         checkForEmptyObject(missingParamsMock);
         done();
       });
@@ -227,20 +187,7 @@ describe('toneChat', () => {
       // required parameters for this method
       const requiredParams = ['utterances'];
 
-      tone_analyzer.toneChat({}, err => {
-        checkRequiredParamsHandling(requiredParams, err, missingParamsMock, createRequestMock);
-        done();
-      });
-    });
-
-    test('should reject promise when required params are not given', done => {
-      // required parameters for this method
-      const requiredParams = ['utterances'];
-
-      const toneChatPromise = tone_analyzer.toneChat();
-      expectToBePromise(toneChatPromise);
-
-      toneChatPromise.catch(err => {
+      toneAnalyzer.toneChat({}, err => {
         checkRequiredParamsHandling(requiredParams, err, missingParamsMock, createRequestMock);
         done();
       });

tone-analyzer/v3-generated.ts

@@ -16,7 +16,7 @@
 
 import { AxiosResponse } from 'axios';
 import * as extend from 'extend';
-import { BaseService, getMissingParams} from 'ibm-cloud-sdk-core';
+import { BaseService, getMissingParams } from 'ibm-cloud-sdk-core';
 import { getSdkHeaders } from '../lib/common';
 
 /**
@@ -83,8 +83,6 @@ class ToneAnalyzerV3 extends BaseService {
    * @param {Object} params - The parameters to send to the service.
    * @param {ToneInput|string} params.tone_input - JSON, plain text, or HTML input that contains the content to be
    * analyzed. For JSON input, provide an object of type `ToneInput`.
-   * @param {string} [params.content_type] - The type of the input. A character encoding can be specified by including a
-   * `charset` parameter. For example, 'text/plain;charset=utf-8'.
    * @param {boolean} [params.sentences] - Indicates whether the service is to return an analysis of each individual
    * sentence in addition to its analysis of the full document. If `true` (the default), the service returns results for
    * each sentence.
@@ -103,9 +101,11 @@ class ToneAnalyzerV3 extends BaseService {
    * @param {string} [params.accept_language] - The desired language of the response. For two-character arguments,
    * regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can use
    * different languages for **Content-Language** and **Accept-Language**.
+   * @param {string} [params.content_type] - The type of the input. A character encoding can be specified by including a
+   * `charset` parameter. For example, 'text/plain;charset=utf-8'.
    * @param {Object} [params.headers] - Custom request headers
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {NodeJS.ReadableStream|void}
+   * @returns {Promise<any>|void}
    */
   public tone(params: ToneAnalyzerV3.ToneParams, callback?: ToneAnalyzerV3.Callback<ToneAnalyzerV3.ToneAnalysis>): Promise<any> | void {
     const _params = extend({}, params);
@@ -132,21 +132,20 @@ class ToneAnalyzerV3 extends BaseService {
     };
 
     const sdkHeaders = getSdkHeaders('tone_analyzer', 'v3', 'tone');
- 
+
     const parameters = {
       options: {
         url: '/v3/tone',
         method: 'POST',
-        json: (_params.content_type === 'application/json'),
         body,
         qs: query,
       },
       defaultOptions: extend(true, {}, this._options, {
         headers: extend(true, sdkHeaders, {
           'Accept': 'application/json',
-          'Content-Type': _params.content_type,
           'Content-Language': _params.content_language,
-          'Accept-Language': _params.accept_language
+          'Accept-Language': _params.accept_language,
+          'Content-Type': _params.content_type
         }, _params.headers),
       }),
     };
@@ -184,7 +183,7 @@ class ToneAnalyzerV3 extends BaseService {
    * different languages for **Content-Language** and **Accept-Language**.
    * @param {Object} [params.headers] - Custom request headers
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {NodeJS.ReadableStream|void}
+   * @returns {Promise<any>|void}
    */
   public toneChat(params: ToneAnalyzerV3.ToneChatParams, callback?: ToneAnalyzerV3.Callback<ToneAnalyzerV3.UtteranceAnalyses>): Promise<any> | void {
     const _params = extend({}, params);
@@ -209,12 +208,11 @@ class ToneAnalyzerV3 extends BaseService {
     };
 
     const sdkHeaders = getSdkHeaders('tone_analyzer', 'v3', 'toneChat');
- 
+
     const parameters = {
       options: {
         url: '/v3/tone_chat',
         method: 'POST',
-        json: true,
         body,
       },
       defaultOptions: extend(true, {}, this._options, {
@@ -268,29 +266,23 @@ namespace ToneAnalyzerV3 {
   export interface ToneParams {
     /** JSON, plain text, or HTML input that contains the content to be analyzed. For JSON input, provide an object of type `ToneInput`. */
     tone_input: ToneInput|string;
-    /** The type of the input. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'. */
-    content_type?: ToneConstants.ContentType | string;
     /** Indicates whether the service is to return an analysis of each individual sentence in addition to its analysis of the full document. If `true` (the default), the service returns results for each sentence. */
     sentences?: boolean;
     /** **`2017-09-21`:** Deprecated. The service continues to accept the parameter for backward-compatibility, but the parameter no longer affects the response. **`2016-05-19`:** A comma-separated list of tones for which the service is to return its analysis of the input; the indicated tones apply both to the full document and to individual sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results for all three tones. */
-    tones?: string[];
+    tones?: ToneConstants.Tones[] | string[];
     /** The language of the input text for the request: English or French. Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do not submit content that contains both languages. You can use different languages for **Content-Language** and **Accept-Language**. * **`2017-09-21`:** Accepts `en` or `fr`. * **`2016-05-19`:** Accepts only `en`. */
     content_language?: ToneConstants.ContentLanguage | string;
     /** The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** and **Accept-Language**. */
     accept_language?: ToneConstants.AcceptLanguage | string;
+    /** The type of the input. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'. */
+    content_type?: ToneConstants.ContentType | string;
     headers?: Object;
     return_response?: boolean;
   }
 
   /** Constants for the `tone` operation. */
   export namespace ToneConstants {
-    /** The type of the input. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'. */
-    export enum ContentType {
-      APPLICATION_JSON = 'application/json',
-      TEXT_PLAIN = 'text/plain',
-      TEXT_HTML = 'text/html',
-    }
-    /** Tones */
+    /** **`2017-09-21`:** Deprecated. The service continues to accept the parameter for backward-compatibility, but the parameter no longer affects the response. **`2016-05-19`:** A comma-separated list of tones for which the service is to return its analysis of the input; the indicated tones apply both to the full document and to individual sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results for all three tones. */
     export enum Tones {
       EMOTION = 'emotion',
       LANGUAGE = 'language',
@@ -315,6 +307,12 @@ namespace ToneAnalyzerV3 {
       ZH_CN = 'zh-cn',
       ZH_TW = 'zh-tw',
     }
+    /** The type of the input. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'. */
+    export enum ContentType {
+      APPLICATION_JSON = 'application/json',
+      TEXT_PLAIN = 'text/plain',
+      TEXT_HTML = 'text/html',
+    }
   }
 
   /** Parameters for the `toneChat` operation. */