Add newest generated Tone Analyzer code and update tests

Author: lpatino10

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/ToneAnalyzer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -12,7 +12,6 @@
  */
 package com.ibm.watson.developer_cloud.tone_analyzer.v3;
 
-import com.ibm.watson.developer_cloud.util.RequestUtils;
 import com.google.gson.JsonObject;
 import com.ibm.watson.developer_cloud.http.RequestBuilder;
 import com.ibm.watson.developer_cloud.http.ServiceCall;
@@ -22,39 +21,16 @@
 import com.ibm.watson.developer_cloud.tone_analyzer.v3.model.ToneOptions;
 import com.ibm.watson.developer_cloud.tone_analyzer.v3.model.UtteranceAnalyses;
 import com.ibm.watson.developer_cloud.util.GsonSingleton;
+import com.ibm.watson.developer_cloud.util.RequestUtils;
 import com.ibm.watson.developer_cloud.util.ResponseConverterUtils;
 import com.ibm.watson.developer_cloud.util.Validator;
 
 /**
- * ### Service Overview
  * The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text.
  * The service can analyze tone at both the document and sentence levels. You can use the service to understand how your
  * written communications are perceived and then to improve the tone of your communications. Businesses can use the
  * service to learn the tone of their customers' communications and to respond to each customer appropriately, or to
  * understand and improve their customer conversations.
- * ### API Usage
- * The following information provides details about using the service to analyze tone:
- * * **The tone method:** The service offers `GET` and `POST /v3/tone` methods that use the general purpose endpoint to
- * analyze the tone of input content. The methods accept content in JSON, plain text, or HTML format.
- * * **The tone_chat method:** The service offers a `POST /v3/tone_chat` method that uses the customer engagement
- * endpoint to analyze the tone of customer service and customer support conversations. The method accepts content in
- * JSON format.
- * * **Authentication:** You authenticate to the service by using your service credentials. You can use your credentials
- * to authenticate via a proxy server that resides in IBM Cloud, or you can use your credentials to obtain a token and
- * contact the service directly. See [Service credentials for Watson
- * services](https://console.bluemix.net/docs/services/watson/getting-started-credentials.html) and [Tokens for
- * authentication](https://console.bluemix.net/docs/services/watson/getting-started-tokens.html).
- * * **Request Logging:** By default, all Watson services log requests and their results. Data is collected only to
- * improve the Watson services. If you do not want to share your data, set the header parameter
- * `X-Watson-Learning-Opt-Out` to `true` for each request. Data is collected for any request that omits this header. See
- * [Controlling request logging for Watson
- * services](https://console.bluemix.net/docs/services/watson/getting-started-logging.html).
- *
- * For more information about the service, see [About Tone
- * Analyzer](https://console.bluemix.net/docs/services/tone-analyzer/index.html).
- *
- * **Note:** Method descriptions apply to the latest version of the interface, `2017-09-21`. Where necessary, parameters
- * and models describe differences between versions `2017-09-21` and `2016-05-19`.
  *
  * @version v3
  * @see <a href="http://www.ibm.com/watson/developercloud/tone-analyzer.html">Tone Analyzer</a>
@@ -98,20 +74,18 @@ public ToneAnalyzer(String versionDate, String username, String password) {
   }
 
   /**
-   * Analyze general purpose tone.
+   * Analyze general tone.
    *
-   * Uses the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for
+   * Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for
    * emotional and language tones. The method always analyzes the tone of the full document; by default, it also
    * analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input
    * content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the
-   * first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. Use
-   * the `POST` request method to analyze larger amounts of content in any of the available formats. Use the `GET`
-   * request method to analyze smaller quantities of plain text content. Per the JSON specification, the default
-   * character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding
-   * for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of
-   * plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for
-   * example: `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes HTML tags and analyzes only
-   * the textual content.
+   * first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. Per
+   * the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP
+   * specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set).
+   * When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character
+   * encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service
+   * removes HTML tags and analyzes only the textual content.
    *
    * @param toneOptions the {@link ToneOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link ToneAnalysis}

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/DocumentAnalysis.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/SentenceAnalysis.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneAnalysis.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneCategory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneChatOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneChatScore.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneInput.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/ToneScore.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/Utterance.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/UtteranceAnalyses.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/model/UtteranceAnalysis.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -23,7 +23,7 @@
 public class UtteranceAnalysis extends GenericModel {
 
   @SerializedName("utterance_id")
-  private String utteranceId;
+  private Long utteranceId;
   @SerializedName("utterance_text")
   private String utteranceText;
   private List<ToneChatScore> tones;
@@ -37,7 +37,7 @@ public class UtteranceAnalysis extends GenericModel {
    *
    * @return the utteranceId
    */
-  public String getUtteranceId() {
+  public Long getUtteranceId() {
     return utteranceId;
   }
 
@@ -82,7 +82,7 @@ public String getError() {
    *
    * @param utteranceId the new utteranceId
    */
-  public void setUtteranceId(final String utteranceId) {
+  public void setUtteranceId(final long utteranceId) {
     this.utteranceId = utteranceId;
   }
 

tone-analyzer/src/main/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corp. All Rights Reserved.
+ * Copyright 2018 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at

tone-analyzer/src/test/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/ToneAnalyzerIT.java

@@ -37,23 +37,22 @@ public class ToneAnalyzerIT extends WatsonServiceTest {
 
   /** The service. */
   private ToneAnalyzer service;
-  private static final String VERSION_DATE_2016_05_19 = "2016-05-19";
+  private static final String VERSION_DATE_VALUE = "2017-09-21";
   private String text = "I know the times are difficult! Our sales have been "
       + "disappointing for the past three quarters for our data analytics "
       + "product suite. We have a competitive data analytics product "
       + "suite in the industry. But we need to do our job selling it! ";
 
   private String[] users = { "customer", "agent", "customer", "agent" };
-  private String[] texts =
-      { "My charger isn't working.", "Thanks for reaching out. Can you give me some more detail about the issue?",
-          "I put my charger in my tablet to charge it up last night and it keeps saying it isn't"
-              + " charging. The charging icon comes on, but it stays on even when I take the charger out. "
-              + "Which is ridiculous, it's brand new.",
-          "I'm sorry you're having issues with charging. What kind of charger are you using?" };
+  private String[] texts = { "My charger isn't working.",
+      "Thanks for reaching out. Can you give me some more detail about the issue?",
+      "I put my charger in my tablet to charge it up last night and it keeps saying it isn't"
+          + " charging. The charging icon comes on, but it stays on even when I take the charger out. "
+          + "Which is ridiculous, it's brand new.",
+      "I'm sorry you're having issues with charging. What kind of charger are you using?" };
 
   /*
    * (non-Javadoc)
-   *
    * @see com.ibm.watson.developer_cloud.WatsonServiceTest#setUp()
    */
   @Override
@@ -66,7 +65,7 @@ public void setUp() throws Exception {
     Assume.assumeFalse("config.properties doesn't have valid credentials.",
         (username == null) || username.equals(PLACEHOLDER));
 
-    service = new ToneAnalyzer(VERSION_DATE_2016_05_19);
+    service = new ToneAnalyzer(VERSION_DATE_VALUE);
     service.setUsernameAndPassword(username, getProperty("tone_analyzer.v3.password"));
     service.setEndPoint(getProperty("tone_analyzer.v3.url"));
     service.setDefaultHeaders(getDefaultHeaders());
@@ -155,7 +154,7 @@ public void testtoneFromHtml() {
   private void assertToneAnalysis(ToneAnalysis tone) {
     Assert.assertNotNull(tone);
     Assert.assertNotNull(tone.getDocumentTone());
-    Assert.assertEquals(3, tone.getDocumentTone().getToneCategories().size());
+    Assert.assertEquals(2, tone.getDocumentTone().getTones().size());
     Assert.assertNotNull(tone.getSentencesTone());
     Assert.assertEquals(4, tone.getSentencesTone().size());
     Assert.assertEquals("I know the times are difficult!", tone.getSentencesTone().get(0).getText());
@@ -178,7 +177,6 @@ public void testGetChatTone() {
         .utterances(utterances)
         .build();
 
-
     UtteranceAnalyses utterancesTone = service.toneChat(toneChatOptions).execute();
 
     Assert.assertNotNull(utterancesTone);

tone-analyzer/src/test/java/com/ibm/watson/developer_cloud/tone_analyzer/v3/ToneAnalyzerTest.java

@@ -48,18 +48,17 @@ public class ToneAnalyzerTest extends WatsonServiceUnitTest {
 
   /** The service. */
   private ToneAnalyzer service;
-  private static final String VERSION_DATE_2016_05_19 = "2016-05-19";
+  private static final String VERSION_DATE_VALUE = "2017-09-21";
 
   /*
    * (non-Javadoc)
-   *
    * @see com.ibm.watson.developer_cloud.WatsonServiceTest#setUp()
    */
   @Override
   @Before
   public void setUp() throws Exception {
     super.setUp();
-    service = new ToneAnalyzer(VERSION_DATE_2016_05_19);
+    service = new ToneAnalyzer(VERSION_DATE_VALUE);
     service.setApiKey("");
     service.setEndPoint(getMockWebServerUrl());
 
@@ -71,25 +70,23 @@ public void setUp() throws Exception {
   @Test
   public void testReadme() throws InterruptedException, IOException {
 
-//    final String VERSION_DATE = "2016-05-19";
     ToneAnalyzer service = new ToneAnalyzer(VERSION_DATE);
     service.setUsernameAndPassword("<username>", "<password>");
 
     service.setEndPoint(getMockWebServerUrl()); // exclude
     ToneAnalysis mockResponse = loadFixture(FIXTURE, ToneAnalysis.class); // exclude
     server.enqueue(jsonResponse(mockResponse)); // exclude
 
-    String text =
-        "I know the times are difficult! Our sales have been "
-            + "disappointing for the past three quarters for our data analytics "
-            + "product suite. We have a competitive data analytics product "
-            + "suite in the industry. But we need to do our job selling it! "
-            + "We need to acknowledge and fix our sales challenges. "
-            + "We can’t blame the economy for our lack of execution! "
-            + "We are missing critical sales opportunities. "
-            + "Our product is in no way inferior to the competitor products. "
-            + "Our clients are hungry for analytical tools to improve their "
-            + "business outcomes. Economy has nothing to do with it.";
+    String text = "I know the times are difficult! Our sales have been "
+        + "disappointing for the past three quarters for our data analytics "
+        + "product suite. We have a competitive data analytics product "
+        + "suite in the industry. But we need to do our job selling it! "
+        + "We need to acknowledge and fix our sales challenges. "
+        + "We can’t blame the economy for our lack of execution! "
+        + "We are missing critical sales opportunities. "
+        + "Our product is in no way inferior to the competitor products. "
+        + "Our clients are hungry for analytical tools to improve their "
+        + "business outcomes. Economy has nothing to do with it.";
 
     // Call the service and get the tone
     ToneOptions toneOptions = new ToneOptions.Builder().html(text).build();
@@ -105,7 +102,6 @@ public void testtoneWithNull() {
     service.tone(null);
   }
 
-
   /**
    * Test get tones.
    *
@@ -131,7 +127,7 @@ public void testtones() throws InterruptedException, IOException {
     // first request
     RecordedRequest request = server.takeRequest();
 
-    String path = StringUtils.join(TONE_PATH, "?", VERSION_DATE, "=", VERSION_DATE_2016_05_19);
+    String path = StringUtils.join(TONE_PATH, "?", VERSION_DATE, "=", VERSION_DATE_VALUE);
     assertEquals(path, request.getPath());
     assertNotNull(request.getHeader(HttpHeaders.AUTHORIZATION));
     assertEquals(serviceResponse, mockResponse);
@@ -168,13 +164,13 @@ public void testGetChatTones() throws IOException, InterruptedException {
     String[] users = { "customer", "agent", "customer", "agent" };
 
     String[] texts = {
-            "My charger isn't working.",
-            "Thanks for reaching out. Can you give me some more detail about the issue?",
-            "I put my charger in my tablet to charge it up last night and it keeps saying it isn't"
+        "My charger isn't working.",
+        "Thanks for reaching out. Can you give me some more detail about the issue?",
+        "I put my charger in my tablet to charge it up last night and it keeps saying it isn't"
             + " charging. The charging icon comes on, but it stays on even when I take the charger out. "
             + "Which is ridiculous, it's brand new.",
-            "I'm sorry you're having issues with charging. What kind of charger are you using?"
-            };
+        "I'm sorry you're having issues with charging. What kind of charger are you using?"
+    };
 
     List<Utterance> utterances = new ArrayList<>();
     for (int i = 0; i < texts.length; i++) {
@@ -200,7 +196,7 @@ public void testGetChatTones() throws IOException, InterruptedException {
     // first request
     RecordedRequest request = server.takeRequest();
 
-    String path = StringUtils.join(CHAT_TONE_PATH, "?", VERSION_DATE, "=", VERSION_DATE_2016_05_19);
+    String path = StringUtils.join(CHAT_TONE_PATH, "?", VERSION_DATE, "=", VERSION_DATE_VALUE);
     assertEquals(path, request.getPath());
     assertNotNull(request.getHeader(HttpHeaders.AUTHORIZATION));
     assertEquals(serviceResponse, mockResponse);