Merge pull request #388 from watson-developer-cloud/rc-2.2.3

Watson Unity SDK v2.2.3

Author: mediumTaj

.travis.yml

@@ -17,5 +17,5 @@ before_script:
 script:
 - ./Travis/createProject.sh
 - ./Travis/installSDK.sh
-- travis_wait 15 ./Travis/runTests.sh
+- ./Travis/runTests.sh
 - ./Travis/build.sh

CHANGELOG.md

@@ -1,5 +1,14 @@
 Change Log
 ==========
+## Version 2.2.3
+_2018-05-21_
+* New: Abstract `DeleteUserData()` for Assistant, Conversation and Discovery ([#387](https://github.com/watson-developer-cloud/unity-sdk/pull/387)).
+* Fixed: Replaced `ToUnixTimeInSeconds()` with dotnet 3.5 equivalent ([#382](https://github.com/watson-developer-cloud/unity-sdk/issues/382), [#386](https://github.com/watson-developer-cloud/unity-sdk/pull/386)).
+* New: Get credentials for testing from internal github repo ([#4333](https://github.ibm.com/Watson/developer-experience/issues/4333), [#364](https://github.com/watson-developer-cloud/unity-sdk/pull/364)).
+* New: Warn user to `InstallDefaultReactors()` ([#328](https://github.com/watson-developer-cloud/unity-sdk/issues/328), [#380](https://github.com/watson-developer-cloud/unity-sdk/pull/380)).
+* New: Revised WSConnector for TLS 1.2 support in upcoming Unity release ([#4230](https://github.ibm.com/Watson/developer-experience/issues/4230), [#379](https://github.com/watson-developer-cloud/unity-sdk/pull/379)).
+* New: Added support for IAM authentication ([#4291](https://github.ibm.com/Watson/developer-experience/issues/4291), [#377](https://github.com/watson-developer-cloud/unity-sdk/pull/377)).
+
 ## Version 2.2.2
 * New: Send custom request headers and access response headers via `customData` object ([#4310](https://github.ibm.com/Watson/developer-experience/issues/4310), [#362](https://github.com/watson-developer-cloud/unity-sdk/pull/362)).
 * Fixed: Unresolved errors hidden by `#ifdef` ([#368](https://github.com/watson-developer-cloud/unity-sdk/issues/368), [#369](https://github.com/watson-developer-cloud/unity-sdk/pull/369))

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Watson Developer Cloud Unity SDK"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.2.2
+PROJECT_NUMBER         = 2.2.3
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Examples/ServiceExamples/Scripts/ExampleAssistant.cs

@@ -690,7 +690,7 @@ private void OnMessage(object response, Dictionary<string, object> customData)
         if (_tempContext != null)
             _context = _tempContext as Dictionary<string, object>;
         else
-            Log.Debug("ExampleConversation.OnMessage()", "Failed to get context");
+            Log.Debug("ExampleAssistant.OnMessage()", "Failed to get context");
 
         //  Get intent
         object tempIntentsObj = null;
@@ -700,6 +700,8 @@ private void OnMessage(object response, Dictionary<string, object> customData)
         (tempIntentObj as Dictionary<string, object>).TryGetValue("intent", out tempIntent);
         string intent = tempIntent.ToString();
 
+        Log.Debug("ExampleAssistant.OnMessage()", "intent: {0}", intent);
+
         _messageTested = true;
     }
 

Examples/ServiceExamples/Scripts/ExampleDiscovery.cs

@@ -50,7 +50,7 @@ void Start ()
     private IEnumerator Example()
     {
         //  Get token
-        if (!Utility.GetToken(OnGetToken, _conversationUrl, _conversationUsername, _conversationPassword))
+        if (!Utility.GetWatsonToken(OnGetWatsonToken, _conversationUrl, _conversationUsername, _conversationPassword))
             Log.Debug("ExampleGetToken.GetToken()", "Failed to get token.");
 
         while (!_receivedAuthToken)
@@ -60,14 +60,14 @@ private IEnumerator Example()
         Message();
     }
 
-    private void OnGetToken(AuthenticationToken authenticationToken, string customData)
+    private void OnGetWatsonToken(AuthenticationToken authenticationToken, string customData)
     {
         _authenticationToken = authenticationToken;
         Log.Debug("ExampleGetToken.OnGetToken()", "created: {0} | time to expiration: {1} minutes | token: {2}", _authenticationToken.Created, _authenticationToken.TimeUntilExpiration, _authenticationToken.Token);
         _receivedAuthToken = true;
     }
 
-    private IEnumerator GetTokenTimeRemaining(float time)
+    private IEnumerator GetWatsonTokenTimeRemaining(float time)
     {
         yield return new WaitForSeconds(time);
         Log.Debug("ExampleGetToken.GetTokenTimeRemaining()", "created: {0} | time to expiration: {1} minutes | token: {2}", _authenticationToken.Created, _authenticationToken.TimeUntilExpiration, _authenticationToken.Token);
@@ -77,7 +77,7 @@ private void Message()
     {
         Credentials credentials = new Credentials()
         {
-            AuthenticationToken = _authenticationToken.Token,
+            WatsonAuthenticationToken = _authenticationToken.Token,
             Url = _conversationUrl
         };
 
@@ -92,7 +92,7 @@ private void OnMessage(object resp, Dictionary<string, object> customData)
         Log.Debug("ExampleGetToken.OnMessage()", "message response: {0}", customData);
 
         //  Check token time remaining
-        Runnable.Run(GetTokenTimeRemaining(0f));
+        Runnable.Run(GetWatsonTokenTimeRemaining(0f));
     }
     private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
     {

Examples/ServiceExamples/Scripts/ExampleGetToken.cs

@@ -1,5 +1,6 @@
 # Watson APIs Unity SDK
 [![Build Status](https://travis-ci.org/watson-developer-cloud/unity-sdk.svg?branch=develop)](https://travis-ci.org/watson-developer-cloud/unity-sdk)
+[![wdc-community.slack.com](https://wdc-slack-inviter.mybluemix.net/badge.svg)](http://wdc-slack-inviter.mybluemix.net/)
 
 Use this SDK to build Watson-powered applications in Unity.
 
@@ -99,6 +100,39 @@ void Start()
 }
 ```
 
+You can also authenticate a service using IAM authentication. You can either supply a valid access token in the `iamTokenOptions` or get an access token using an `apikey`.
+
+```cs
+void IEnumerator TokenExample()
+{
+    //  Create IAM token options and supply the apikey. 
+    //  Alternatively you can supply an access token.
+    TokenOptions iamTokenOptions = new TokenOptions()
+    {
+        IamApiKey = "<iam-api-key>"
+    };
+
+    //  Create credentials using the IAM token options
+     _credentials = new Credentials(iamTokenOptions, "<service-url");
+    while (!_credentials.HasIamTokenData())
+        yield return null;
+
+    _assistant = new Assistant(_credentials);
+    _assistant.VersionDate = "2018-02-16";
+    _assistant.ListWorkspaces(OnListWorkspaces, OnFail);
+}
+
+private void OnListWorkspaces(WorkspaceCollection response, Dictionary<string, object> customData)
+{
+    Log.Debug("OnListWorkspaces()", "Response: {0}", customData["json"].ToString());
+}
+
+private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
+{
+    Log.Debug("OnFail()", "Failed: {0}", error.ToString());
+}
+```
+
 ## Callbacks
 Success and failure callbacks are required. You can specify the return type in the callback.  
 ```cs
@@ -282,6 +316,6 @@ See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
 [wdc]: https://www.ibm.com/watson/developer/
 [wdc_unity_sdk]: https://github.com/watson-developer-cloud/unity-sdk
 [latest_release]: https://github.com/watson-developer-cloud/unity-sdk/releases/latest
-[ibm_cloud_registration]: http://console.bluemix.net/registration
+[ibm_cloud_registration]: http://console.bluemix.net/registration?cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Unity
 [get_unity]: https://unity3d.com/get-unity
 [documentation]: https://watson-developer-cloud.github.io/unity-sdk/

Examples/ServiceExamples/TestData/Discovery/constitution.pdf

@@ -43,6 +43,7 @@ public class RESTConnector
         public const string AUTHENTICATION_AUTHORIZATION_HEADER = "Authorization";
         public const long HTTP_STATUS_OK = 200;
         public const long HTTP_STATUS_CREATED = 201;
+        public const long HTTP_STATUS_ACCEPTED = 202;
         public const long HTTP_STATUS_NO_CONTENT = 204;
         #region Public Types
         /// <summary>
@@ -282,6 +283,8 @@ public static RESTConnector GetConnector(Credentials credentials, string functio
             RESTConnector connector = new RESTConnector();
             connector.URL = credentials.Url + function;
             connector.Authentication = credentials;
+            if (connector.Authentication.HasIamTokenData())
+                connector.Authentication.GetToken();
 
             return connector;
         }
@@ -327,14 +330,18 @@ private void AddHeaders(Dictionary<string, string> headers)
                 if (headers == null)
                     throw new ArgumentNullException("headers");
 
-                if (Authentication.HasAuthorizationToken())
+                if (Authentication.HasWatsonAuthenticationToken())
                 {
-                    headers.Add(AUTHENTICATION_TOKEN_AUTHORIZATION_HEADER, Authentication.AuthenticationToken);
+                    headers.Add(AUTHENTICATION_TOKEN_AUTHORIZATION_HEADER, Authentication.WatsonAuthenticationToken);
                 }
                 else if (Authentication.HasCredentials())
                 {
                     headers.Add(AUTHENTICATION_AUTHORIZATION_HEADER, Authentication.CreateAuthorization());
                 }
+                else if(Authentication.HasIamTokenData())
+                {
+                    headers.Add(AUTHENTICATION_AUTHORIZATION_HEADER, string.Format("Bearer {0}", Authentication.IamAccessToken));
+                }
             }
 
             if (Headers != null)
@@ -475,6 +482,7 @@ private IEnumerator ProcessRequestQueue()
                             {
                                 case HTTP_STATUS_OK:
                                 case HTTP_STATUS_CREATED:
+                                case HTTP_STATUS_ACCEPTED:
                                     bError = false;
                                     break;
                                 default:
@@ -679,7 +687,7 @@ public IEnumerator Send(string url, Dictionary<string, string> headers)
                     };
                 }
 
-                Success = deleteReq.responseCode == HTTP_STATUS_OK || deleteReq.responseCode == HTTP_STATUS_OK || deleteReq.responseCode == HTTP_STATUS_NO_CONTENT;
+                Success = deleteReq.responseCode == HTTP_STATUS_OK || deleteReq.responseCode == HTTP_STATUS_OK || deleteReq.responseCode == HTTP_STATUS_NO_CONTENT || deleteReq.responseCode == HTTP_STATUS_ACCEPTED;
                 HttpResponseCode = deleteReq.responseCode;
                 ResponseHeaders = deleteReq.GetResponseHeaders();
                 Data = deleteReq.downloadHandler.data;