Merge branch 'master' into v4.0.0-branch

Author: dpopp07

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.15.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.0...v3.15.1) (2019-01-07)
+
+
+### Bug Fixes
+
+* add `disabled` property to CreateDialogNode ([41cd8dc](https://github.com/watson-developer-cloud/node-sdk/commit/41cd8dc))
+* add `user_defined` property to MessageOutput model ([ea28bf3](https://github.com/watson-developer-cloud/node-sdk/commit/ea28bf3))
+
 # [3.15.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.14.0...v3.15.0) (2018-12-07)
 
 

README.md

@@ -281,9 +281,8 @@ function (err, token) {
 ```
 
 ### Assistant v2
-> Watson Assistant v2 API is released in beta. For details, see the ["Introducing Watson Assistant"](https://www.ibm.com/blogs/watson/2018/03/the-future-of-watson-conversation-watson-assistant/) blog post.
 
-Use the [Assistant][assistant] service to determine the intent of a message.
+Use the [Assistant][conversation] service to determine the intent of a message.
 
 Note: You must first create a workspace via IBM Cloud. See [the documentation](https://console.bluemix.net/docs/services/conversation/index.html#about) for details.
 

lib/base_service.ts

@@ -86,6 +86,30 @@ function usesBasicForIam(obj: any): boolean {
   return obj.username === 'apikey' && !obj.password.startsWith('icp-');
 }
 
+// returns true if the string has a curly bracket or quote as the first or last character
+// these are common user-issues that we should handle before they get a network error
+function badCharAtAnEnd(value: string): boolean {
+  return value.startsWith('{') || value.startsWith('"') || value.endsWith('}') || value.endsWith('"');
+}
+
+// checks credentials for common user mistakes of copying {, }, or " characters from the documentation
+function checkCredentials(obj: any) {
+  let errorMessage = '';
+  const credsToCheck = ['url', 'username', 'password', 'iam_apikey'];
+  credsToCheck.forEach(cred => {
+    if (obj[cred] && badCharAtAnEnd(obj[cred])) {
+      errorMessage += `The ${cred} shouldn't start or end with curly brackets or quotes. Be sure to remove any {, }, or "`;
+    }
+  });
+
+  if (errorMessage.length) {
+    errorMessage += 'Revise these credentials - they should not start or end with curly brackets or quotes.';
+    return errorMessage;
+  } else {
+    return null;
+  }
+}
+
 export class BaseService {
   static URL: string;
   name: string;
@@ -293,6 +317,11 @@ export class BaseService {
         }
       }
     }
+    // check credentials for common user errors
+    const credentialProblems = checkCredentials(_options);
+    if (credentialProblems) {
+      throw new Error(credentialProblems);
+    }
     return _options;
   }
   /**

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "watson-developer-cloud",
-  "version": "3.15.0",
+  "version": "3.15.1",
   "description": "Client library to use the IBM Watson Services and AlchemyAPI",
   "main": "./index",
   "repository": {

package.json

@@ -335,4 +335,86 @@ describe('BaseService', function() {
     });
     expect(instance._options.rejectUnauthorized).toBe(true);
   });
+
+  describe('check credentials for common problems', function() {
+    function assertConstructorThrows(params) {
+      expect(() => {
+        new TestService(params);
+      }).toThrowError(
+        'Revise these credentials - they should not start or end with curly brackets or quotes.'
+      );
+    }
+
+    it('should throw when username starts with {', function() {
+      assertConstructorThrows({
+        username: '{batman}',
+        password: 'goodpass',
+      });
+    });
+
+    it('should throw when username starts with "', function() {
+      assertConstructorThrows({
+        username: '"<batman">',
+        password: 'goodpass',
+      });
+    });
+
+    it('should throw when password starts with {', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: '{badpass}',
+      });
+    });
+
+    it('should throw when password starts with "', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: '"badpass"',
+      });
+    });
+
+    it('should throw when iam_apikey starts with {', function() {
+      assertConstructorThrows({
+        iam_apikey: '{abc123}',
+      });
+    });
+
+    it('should throw when iam_apikey starts with "', function() {
+      assertConstructorThrows({
+        iam_apikey: '"<abc123',
+      });
+    });
+
+    it('should throw when url starts with {', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: 'goodpass',
+        url: '{watson-url}/some-api/v1/endpoint',
+      });
+    });
+
+    it('should throw when url ends with }', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: 'goodpass',
+        url: 'watson-url.com/some-api/v1/endpoint}',
+      });
+    });
+
+    it('should throw when url starts with "', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: 'goodpass',
+        url: '"watson-url.com/some-api/v1/endpoint',
+      });
+    });
+
+    it('should throw when mutiple creds are bad', function() {
+      assertConstructorThrows({
+        username: '{batman}',
+        password: '"<badpass>"',
+        url: '{watson-url}/some-api/v1/endpoint',
+      });
+    });
+  });
 });