chore: Refactored Assistant V2 to use new WatsonResponse and WatsonError

Author: mediumTaj

Scripts/Services/Assistant.meta renamed to Assistant.meta

@@ -72,7 +72,7 @@ public class Response
             /// <summary>
             /// Error message if Success is false.
             /// </summary>
-            public Error Error { get; set; }
+            public WatsonError Error { get; set; }
             /// <summary>
             /// The data returned by the request.
             /// </summary>
@@ -91,41 +91,7 @@ public class Response
             public Dictionary<string, string> Headers { get; set; }
             #endregion
         };
-
-        /// <summary>
-        /// Class to encapsulate an error returned from a server request.
-        /// </summary>
-        public class Error
-        {
-            /// <summary>
-            /// The url that generated the error.
-            /// </summary>
-            public string URL { get; set; }
-            /// <summary>
-            /// The error code returned from the server.
-            /// </summary>
-            public long ErrorCode { get; set; }
-            /// <summary>
-            /// The error message returned from the server.
-            /// </summary>
-            public string ErrorMessage { get; set; }
-            /// <summary>
-            /// The contents of the response from the server.
-            /// </summary>
-            public string Response { get; set; }
-            /// <summary>
-            /// Dictionary of headers returned by the request.
-            /// </summary>
-            public Dictionary<string, string> ResponseHeaders { get; set; }
-
-            public override string ToString()
-            {
-                return string.Format("URL: {0}, ErrorCode: {1}, Error: {2}, Response: {3}", URL, ErrorCode,
-                                     string.IsNullOrEmpty(ErrorMessage) ? "" : ErrorMessage,
-                                     string.IsNullOrEmpty(Response) ? "" : Response);
-            }
-        }
-
+        
         /// <summary>
         /// Multi-part form data class.
         /// </summary>
@@ -297,9 +263,11 @@ public bool DisableSslVerification
 
         public static RESTConnector GetConnector(Credentials credentials, string function)
         {
-            RESTConnector connector = new RESTConnector();
-            connector.URL = credentials.Url + function;
-            connector.Authentication = credentials;
+            RESTConnector connector = new RESTConnector
+            {
+                URL = credentials.Url + function,
+                Authentication = credentials
+            };
             if (connector.Authentication.HasIamTokenData())
             {
                 connector.Authentication.GetToken();
@@ -507,17 +475,22 @@ private IEnumerator ProcessRequestQueue()
                     }
                     else if (req.Send != null)
                     {
-                        unityWebRequest = new UnityWebRequest(url, req.HttpMethod);
-                        unityWebRequest.uploadHandler = (UploadHandler)new UploadHandlerRaw(req.Send);
+                        unityWebRequest = new UnityWebRequest(url, req.HttpMethod)
+                        {
+                            uploadHandler = (UploadHandler)new UploadHandlerRaw(req.Send)
+                        };
+
                         unityWebRequest.SetRequestHeader("Content-Type", "application/json");
                     }
                 }
                 else
                 {
                     //  GET, DELETE and POST without data
-                    unityWebRequest = new UnityWebRequest();
-                    unityWebRequest.url = url;
-                    unityWebRequest.method = req.HttpMethod;
+                    unityWebRequest = new UnityWebRequest
+                    {
+                        url = url,
+                        method = req.HttpMethod
+                    };
                 }
 
                 foreach (KeyValuePair<string, string> kvp in req.Headers)
@@ -582,7 +555,7 @@ private IEnumerator ProcessRequestQueue()
                 }
 
                 bool bError = false;
-                Error error = null;
+                WatsonError error = null;
                 if (!string.IsNullOrEmpty(unityWebRequest.error))
                 {
                     switch (unityWebRequest.responseCode)
@@ -597,10 +570,10 @@ private IEnumerator ProcessRequestQueue()
                             break;
                     }
 
-                    error = new Error()
+                    error = new WatsonError()
                     {
-                        URL = url,
-                        ErrorCode = unityWebRequest.responseCode,
+                        Url = url,
+                        StatusCode = unityWebRequest.responseCode,
                         ErrorMessage = unityWebRequest.error,
                         Response = unityWebRequest.downloadHandler.text,
                         ResponseHeaders = unityWebRequest.GetResponseHeaders()

Scripts/Services/Assistant/v2.meta renamed to Assistant/v2.meta

@@ -146,16 +146,9 @@ public bool DisableSslVerification
         /// Success callback delegate.
         /// </summary>
         /// <typeparam name="T">Type of the returned object.</typeparam>
-        /// <param name="response">The returned object.</param>
+        /// <param name="response">The returned WatsonResponse.</param>
         /// <param name="customData">user defined custom data including raw json.</param>
-        public delegate void SuccessCallback<T>(T response, Dictionary<string, object> customData);
-
-        /// <summary>
-        /// Fail callback delegate.
-        /// </summary>
-        /// <param name="error">The error object.</param>
-        /// <param name="customData">User defined custom data</param>
-        public delegate void FailCallback(RESTConnector.Error error, Dictionary<string, object> customData);
+        public delegate void Callback<T>(WatsonResponse<T> response, WatsonError error, Dictionary<string, object> customData);
         #endregion
 
         #region Constructors
@@ -260,59 +253,53 @@ public void GetToken()
             if (!string.IsNullOrEmpty(_userAcessToken))
             {
                 // 1. use user-managed token
-                OnGetToken(new IamTokenData() { AccessToken = _userAcessToken }, new Dictionary<string, object>());
+                OnGetToken(new WatsonResponse<IamTokenData>() { Result = new IamTokenData() { AccessToken = _userAcessToken } }, new WatsonError(), new Dictionary<string, object>());
             }
             else if (!string.IsNullOrEmpty(_iamTokenData.AccessToken) || IsRefreshTokenExpired())
             {
                 // 2. request an initial token
-                RequestIamToken(OnGetToken, OnGetTokenFail);
+                RequestIamToken(OnGetToken);
             }
             else if (IsTokenExpired())
             {
                 // 3. refresh a token
-                RefreshIamToken(OnGetToken, OnGetTokenFail);
+                RefreshIamToken(OnGetToken);
             }
             else
             {
                 //  4. use valid managed token
-                OnGetToken(new IamTokenData() { AccessToken = _iamTokenData.AccessToken }, new Dictionary<string, object>());
+
+                OnGetToken(new WatsonResponse<IamTokenData>() { Result = new IamTokenData() { AccessToken = _iamTokenData.AccessToken } }, new WatsonError(), new Dictionary<string, object>());
             }
         }
 
-        private void OnGetToken(IamTokenData iamTokenData, Dictionary<string, object> customData)
+        private void OnGetToken(WatsonResponse<IamTokenData> response, WatsonError error, Dictionary<string, object> customData)
         {
-            SaveTokenInfo(iamTokenData);
+            SaveTokenInfo(response.Result);
         }
 
-        private void OnGetTokenFail(RESTConnector.Error error, Dictionary<string, object> customData)
-        {
-            Log.Debug("Credentials.OnGetTokenFail();", "Failed to get IAM Token: {0}", error.ToString());
-        }
         #endregion
 
         #region Request Token
         /// <summary>
         /// Request an IAM token using an API key.
         /// </summary>
-        /// <param name="successCallback">The request callback.</param>
-        /// <param name="failCallback">The fail callback.</param>
+        /// <param name="callback">The request callback.</param>
+        /// <param name="error"> The request error.</param>
         /// <param name="customData">Dictionary of custom data.</param>
         /// <returns></returns>
-        public bool RequestIamToken(SuccessCallback<IamTokenData> successCallback, FailCallback failCallback, Dictionary<string, object> customData = null)
+        public bool RequestIamToken(Callback<IamTokenData> callback, Dictionary<string, object> customData = null)
         {
-            if (successCallback == null)
+            if (callback == null)
                 throw new ArgumentNullException("successCallback");
-            if (failCallback == null)
-                throw new ArgumentNullException("failCallback");
 
             RESTConnector connector = new RESTConnector();
             connector.URL = _iamUrl;
             if (connector == null)
                 return false;
 
             RequestIamTokenRequest req = new RequestIamTokenRequest();
-            req.SuccessCallback = successCallback;
-            req.FailCallback = failCallback;
+            req.Callback = callback;
             req.HttpMethod = UnityWebRequest.kHttpVerbGET;
             req.Headers.Add("Content-type", "application/x-www-form-urlencoded");
             req.Headers.Add("Authorization", "Basic Yng6Yng=");
@@ -337,13 +324,13 @@ public bool RequestIamToken(SuccessCallback<IamTokenData> successCallback, FailC
         private class RequestIamTokenRequest : RESTConnector.Request
         {
             public Dictionary<string, object> CustomData { get; set; }
-            public SuccessCallback<IamTokenData> SuccessCallback { get; set; }
-            public FailCallback FailCallback { get; set; }
+            public Callback<IamTokenData> Callback { get; set; }
         }
 
         private void OnRequestIamTokenResponse(RESTConnector.Request req, RESTConnector.Response resp)
         {
-            IamTokenData result = new IamTokenData();
+            WatsonResponse<IamTokenData> response = new WatsonResponse<IamTokenData>();
+            response.Result = new IamTokenData();
             fsData data = null;
             Dictionary<string, object> customData = ((RequestIamTokenRequest)req).CustomData;
             customData.Add(Constants.String.RESPONSE_HEADERS, resp.Headers);
@@ -356,7 +343,7 @@ private void OnRequestIamTokenResponse(RESTConnector.Request req, RESTConnector.
                     if (!r.Succeeded)
                         throw new WatsonException(r.FormattedMessages);
 
-                    object obj = result;
+                    object obj = response.Result;
                     r = _serializer.TryDeserialize(data, obj.GetType(), ref obj);
                     if (!r.Succeeded)
                         throw new WatsonException(r.FormattedMessages);
@@ -370,42 +357,31 @@ private void OnRequestIamTokenResponse(RESTConnector.Request req, RESTConnector.
                 }
             }
 
-            if (resp.Success)
-            {
-                if (((RequestIamTokenRequest)req).SuccessCallback != null)
-                    ((RequestIamTokenRequest)req).SuccessCallback(result, customData);
-            }
-            else
-            {
-                if (((RequestIamTokenRequest)req).FailCallback != null)
-                    ((RequestIamTokenRequest)req).FailCallback(resp.Error, customData);
-            }
+            if (((RequestIamTokenRequest)req).Callback != null)
+                ((RequestIamTokenRequest)req).Callback(response, resp.Error, customData);
         }
         #endregion
 
         #region Refresh Token
         /// <summary>
         /// Refresh an IAM token using a refresh token.
         /// </summary>
-        /// <param name="successCallback">The success callback.</param>
+        /// <param name="callback">The success callback.</param>
         /// <param name="failCallback">The fail callback.</param>
         /// <param name="customData">Dictionary of custom data.</param>
         /// <returns></returns>
-        public bool RefreshIamToken(SuccessCallback<IamTokenData> successCallback, FailCallback failCallback, Dictionary<string, object> customData = null)
+        public bool RefreshIamToken(Callback<IamTokenData> callback, Dictionary<string, object> customData = null)
         {
-            if (successCallback == null)
-                throw new ArgumentNullException("successCallback");
-            if (failCallback == null)
-                throw new ArgumentNullException("failCallback");
+            if (callback == null)
+                throw new ArgumentNullException("callback");
 
             RESTConnector connector = new RESTConnector();
             connector.URL = _iamUrl;
             if (connector == null)
                 return false;
 
             RefreshIamTokenRequest req = new RefreshIamTokenRequest();
-            req.SuccessCallback = successCallback;
-            req.FailCallback = failCallback;
+            req.Callback = callback;
             req.HttpMethod = UnityWebRequest.kHttpVerbGET;
             req.Headers.Add("Content-type", "application/x-www-form-urlencoded");
             req.Headers.Add("Authorization", "Basic Yng6Yng=");
@@ -428,14 +404,14 @@ public bool RefreshIamToken(SuccessCallback<IamTokenData> successCallback, FailC
 
         private class RefreshIamTokenRequest : RESTConnector.Request
         {
+            public Callback<IamTokenData> Callback { get; set; }
             public Dictionary<string, object> CustomData { get; set; }
-            public SuccessCallback<IamTokenData> SuccessCallback { get; set; }
-            public FailCallback FailCallback { get; set; }
         }
 
         private void OnRefreshIamTokenResponse(RESTConnector.Request req, RESTConnector.Response resp)
         {
-            IamTokenData result = new IamTokenData();
+            WatsonResponse<IamTokenData> response = new WatsonResponse<IamTokenData>();
+            response.Result = new IamTokenData();
             fsData data = null;
             Dictionary<string, object> customData = ((RefreshIamTokenRequest)req).CustomData;
             customData.Add(Constants.String.RESPONSE_HEADERS, resp.Headers);
@@ -448,7 +424,7 @@ private void OnRefreshIamTokenResponse(RESTConnector.Request req, RESTConnector.
                     if (!r.Succeeded)
                         throw new WatsonException(r.FormattedMessages);
 
-                    object obj = result;
+                    object obj = response.Result;
                     r = _serializer.TryDeserialize(data, obj.GetType(), ref obj);
                     if (!r.Succeeded)
                         throw new WatsonException(r.FormattedMessages);
@@ -462,16 +438,8 @@ private void OnRefreshIamTokenResponse(RESTConnector.Request req, RESTConnector.
                 }
             }
 
-            if (resp.Success)
-            {
-                if (((RefreshIamTokenRequest)req).SuccessCallback != null)
-                    ((RefreshIamTokenRequest)req).SuccessCallback(result, customData);
-            }
-            else
-            {
-                if (((RefreshIamTokenRequest)req).FailCallback != null)
-                    ((RefreshIamTokenRequest)req).FailCallback(resp.Error, customData);
-            }
+            if (((RefreshIamTokenRequest)req).Callback != null)
+                ((RefreshIamTokenRequest)req).Callback(response, resp.Error, customData);
         }
         #endregion
 

Scripts/Services/Assistant/v2/Assistant.cs renamed to Assistant/v2/Assistant.cs

@@ -1,4 +1,7 @@
-/**
+
+
+using System.Collections.Generic;
+/**
 * Copyright 2019 IBM Corp. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,10 +17,9 @@
 * limitations under the License.
 *
 */
-
 namespace IBM.Watson
 {
-    class WatsonError
+    public class WatsonError
     {
         /// <summary>
         /// The url that generated the error.
@@ -35,5 +37,9 @@ class WatsonError
         /// The contents of the response from the server.
         /// </summary>
         public string Response { get; set; }
+        /// <summary>
+        /// Dictionary of headers returned by the request.
+        /// </summary>
+        public Dictionary<string, string> ResponseHeaders { get; set; }
     }
 }