📦 RESTClient for Unity

Author: David Douglas

.gitignore

@@ -0,0 +1,40 @@
+/[Ll]ibrary/
+/[Tt]emp/
+/[Oo]bj/
+/[Bb]uild/
+/[Bb]uilds/
+/Assets/AssetStoreTools*
+
+# Visual Studio 2015 cache directory
+/.vs/
+
+# Autogenerated VS/MD/Consulo solution and project files
+ExportedObj/
+.consulo/
+*.csproj
+*.unityproj
+*.sln
+*.suo
+*.tmp
+*.user
+*.userprefs
+*.pidb
+*.booproj
+*.svd
+*.pdb
+
+# Unity3D generated meta files
+*.pidb.meta
+*.meta
+
+# Unity3D Generated File On Crash Reports
+sysinfo.txt
+
+# Builds
+*.apk
+*.unitypackage
+
+# IDEs
+/.vscode
+omnisharp.json
+.editorconfig

README.md

@@ -0,0 +1,33 @@
+# REST Client for Unity
+For Unity developers looking to use REST Services in their Unity game / app.
+
+**RESTClient** for Unity is built on top of [UnityWebRequest](https://docs.unity3d.com/Manual/UnityWebRequest.html) and Unity's [JsonUtility](https://docs.unity3d.com/ScriptReference/JsonUtility.html) to make it easier to compose REST requests and return the results serialized as native C# data model objects.
+
+## Features
+ - Methods to add request body, headers and query strings to REST requests.
+ - Ability to return result as native object or as plain text.
+ - Work around for nested arrays.
+ - Work around for parsing abstract types on UWP.
+
+## How do I use this with cloud services?
+Checkout the following projects for Unity which were built using this REST Client library as  examples.
+ - [Azure App Services](https://github.com/Unity3dAzure/AppServicesDemo)
+ - [Azure Blob Storage](https://github.com/Unity3dAzure/StorageServicesDemo)
+ - [Azure Functions](https://github.com/Unity3dAzure/AzureFunctions)
+ - [Nether (serverless)](https://github.com/MicrosoftDX/nether/tree/serverless/src/Client/Unity)
+
+## Requirements
+Requires Unity v5.3 or greater as [UnityWebRequest](https://docs.unity3d.com/Manual/UnityWebRequest.html) and [JsonUtility](https://docs.unity3d.com/ScriptReference/JsonUtility.html) features are used. Unity will be extending platform support for UnityWebRequest so keep Unity up to date if you need to support these additional platforms.
+
+## Supported platforms
+Intended to work on all the platforms [UnityWebRequest](https://docs.unity3d.com/Manual/UnityWebRequest.html) supports including:
+* Unity Editor (Mac/PC) and Standalone players
+* iOS
+* Android
+* Windows 10 (UWP)
+
+## Troubleshooting
+- Remember to wrap async calls with [`StartCoroutine()`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.StartCoroutine.html)
+- Before building for a target platform remember to check the **Internet Client capability** is enabled in the Unity player settings, otherwise all REST calls will fail with a '-1' status error.
+
+Questions or tweet [@deadlyfingers](https://twitter.com/deadlyfingers)

RestClient.cs

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using UnityEngine;
+using System.Collections;
+using System.Collections.Generic;
+using System;
+using System.Text.RegularExpressions;
+
+
+#if !NETFX_CORE || UNITY_ANDROID
+using System.Net;
+using System.Security.Cryptography.X509Certificates;
+using System.Net.Security;
+#endif
+
+namespace RESTClient {
+  public class RestClient {
+    public string Url { get; private set; }
+
+    /// <summary>
+    /// Creates a new REST Client
+    /// </summary>
+    public RestClient(string url, bool forceHttps = true) {
+      if (forceHttps) {
+        Url = HttpsUri(url);
+      }
+      // required for running in Windows and Android
+#if !NETFX_CORE || UNITY_ANDROID
+      ServicePointManager.ServerCertificateValidationCallback = RemoteCertificateValidationCallback;
+#endif
+    }
+
+    public override string ToString() {
+      return this.Url;
+    }
+
+    /// <summary>
+    /// Changes 'http' to be 'https' instead
+    /// </summary>
+    private static string HttpsUri(string appUrl) {
+      return Regex.Replace(appUrl, "(?si)^http://", "https://").TrimEnd('/');
+    }
+
+    private static string DomainName(string url) {
+      var match = Regex.Match(url, @"^(https:\/\/|http:\/\/)(www\.)?([a-z0-9-_]+\.[a-z]+)", RegexOptions.IgnoreCase);
+      if (match.Groups.Count == 4 && match.Groups[3].Value.Length > 0) {
+        return match.Groups[3].Value;
+      }
+      return url;
+    }
+
+#if !NETFX_CORE || UNITY_ANDROID
+    private bool RemoteCertificateValidationCallback(System.Object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors) {
+      // Check the certificate to see if it was issued from Azure
+      if (certificate.Subject.Contains(DomainName(Url))) {
+        return true;
+      } else {
+        return false;
+      }
+    }
+#endif
+
+  }
+}

helpers/JsonHelper.cs

@@ -0,0 +1,96 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using UnityEngine;
+using System;
+using System.Text.RegularExpressions;
+#if NETFX_CORE
+using Windows.Data.Json;
+using System.Collections.Generic;
+using System.Linq;
+#endif
+
+namespace RESTClient {
+  /// <summary>
+  /// Wrapper work-around for json array described on https://forum.unity3d.com/threads/how-to-load-an-array-with-jsonutility.375735/
+  /// </summary>
+#pragma warning disable 0649 // suppresses warning: array "is never assigned to, and will always have its default value 'null'"
+  [Serializable]
+  internal class Wrapper<T> {
+
+    public T[] array;
+  }
+
+  public static class JsonHelper {
+    /// <summary>
+    /// Work-around to parse json array
+    /// </summary>
+    public static T[] FromJsonArray<T>(string json) {
+      // Work-around for JsonUtility array serialization issues in Windows Store Apps.
+#if NETFX_CORE
+      JsonArray jsonArray = new JsonArray();
+      if (JsonArray.TryParse(json, out jsonArray)) {
+        return GetArray<T>(jsonArray);
+      }
+      Debug.LogWarning("Failed to parse json array of type:" + typeof(T).ToString() );
+      return default(T[]);
+#endif
+      string newJson = "{\"array\":" + json + "}";
+      Wrapper<T> wrapper = new Wrapper<T>();
+      try {
+        wrapper = JsonUtility.FromJson<Wrapper<T>>(newJson);
+      } catch (Exception e) {
+        Debug.LogWarning("Failed to parse json array of type:" + typeof(T).ToString() + " Exception message: " + e.Message);
+        return default(T[]);
+      }
+      return wrapper.array;
+    }
+
+    public static N FromJsonNestedArray<T, N>(string json, string namedArray) where N : INestedResults<T>, new() {
+#if NETFX_CORE
+      JsonObject jsonObject = new JsonObject();
+      if (JsonObject.TryParse(json, out jsonObject)) {
+        JsonArray jsonArray = jsonObject.GetNamedArray(namedArray);
+        T[] array = GetArray<T>(jsonArray);
+        N nestedResults = new N(); //NestedResults<T> nestedResults = new NestedResults<T>(array);
+        nestedResults.SetArray(array);
+
+        string namedCount = nestedResults.GetCountField();
+        uint count = Convert.ToUInt32( jsonObject.GetNamedNumber(namedCount) );
+        nestedResults.SetCount(count);
+
+        return nestedResults;
+      } else {
+        Debug.LogWarning("Failed to parse json nested array of type:" + typeof(T).ToString());
+        return default(N);
+      }
+#endif
+      N results = JsonUtility.FromJson<N>(json); // NestedResults<T> nestedResults = JsonUtility.FromJson<NestedResults<T>(json);
+      return results;
+    }
+
+#if NETFX_CORE
+    private static T[] GetArray<T>(JsonArray array)
+    {
+      List<T> list = new List<T>();
+      foreach (var x in array) {
+        try {
+          T item = JsonUtility.FromJson<T>(x.ToString());
+          list.Add(item);
+        } catch (Exception e) {
+          Debug.LogWarning("Failed to parse json of type:" + typeof(T).ToString() + " Exception message: " + e.Message + " json:'" + x.ToString() + "'");
+        }
+      }
+      return list.ToArray();
+    }
+#endif
+
+    /// <summary>
+    /// Workaround to only exclude Data Model's read only system properties being returned as json object. Unfortunately there is no JsonUtil attribute to do this as [NonSerialized] will just ignore the properties completely (both in and out).
+    /// </summary>
+    public static string ToJsonExcludingSystemProperties(object obj) {
+      string jsonString = JsonUtility.ToJson(obj);
+      return Regex.Replace(jsonString, "(?i)(\\\"id\\\":\\\"\\\",)?(\\\"createdAt\\\":\\\"[0-9TZ:.-]*\\\",)?(\\\"updatedAt\\\":\\\"[0-9TZ:.-]*\\\",)?(\\\"version\\\":\\\"[A-Z0-9=]*\\\",)?(\\\"deleted\\\":(true|false),)?(\\\"ROW_NUMBER\\\":\\\"[0-9]*\\\",)?", "");
+    }
+  }
+}

helpers/ReflectionHelper.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Reflection;
+
+namespace RESTClient {
+  /// <summary>
+  /// Helper methods to check and get object properties
+  /// </summary>
+  public static class ReflectionHelper {
+    public static bool HasProperty(object obj, string propertyName) {
+      return GetProperty(obj, propertyName) != null;
+    }
+
+    public static PropertyInfo GetProperty(object obj, string propertyName) {
+#if NETFX_CORE
+      return obj.GetType().GetTypeInfo().GetDeclaredProperty(propertyName); // GetProperty for UWP
+#else
+      return obj.GetType().GetProperty(propertyName);
+#endif
+    }
+
+    public static bool HasField(object obj, string fieldName) {
+      return GetField(obj, fieldName) != null;
+    }
+
+    public static FieldInfo GetField(object obj, string fieldName) {
+#if NETFX_CORE
+      return obj.GetType().GetTypeInfo().GetDeclaredField(fieldName); // GetField for UWP
+#else
+      return obj.GetType().GetField(fieldName);
+#endif
+    }
+  }
+}

http/IRestResponse.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Net;
+
+namespace RESTClient {
+  public interface IRestResponse<T> {
+    bool IsError { get; }
+
+    string ErrorMessage { get; }
+
+    string Url { get; }
+
+    HttpStatusCode StatusCode { get; }
+
+    string Content { get; }
+
+    T Data { get; }
+  }
+}
+

http/Method.cs

@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using UnityEngine;
+using System.Collections;
+
+namespace RESTClient {
+  public enum Method {
+    GET,
+    POST,
+    PATCH,
+    DELETE
+  }
+}

http/QueryParams.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using UnityEngine;
+
+namespace RESTClient {
+  public class QueryParams {
+    private Dictionary<string, string> parameters;
+
+    public QueryParams() {
+      parameters = new Dictionary<string, string>();
+    }
+
+    public void AddParam(string key, string value) {
+      parameters.Add(key, value);
+    }
+
+    public override string ToString() {
+      if (parameters.Count == 0) {
+        return "";
+      }
+      StringBuilder sb = new StringBuilder("?");
+      foreach (KeyValuePair<string, string> param in parameters) {
+        string key = WWW.EscapeURL(param.Key);
+        string value = WWW.EscapeURL(param.Value);
+        sb.Append(key + "=" + value + "&");
+      }
+      sb.Remove(sb.Length - 1, 1);
+      return sb.ToString();
+    }
+  }
+}