Merge pull request #33 from Unity3dAzure/iss25

Query support

Author: deadlyfingers

Assets/AppServices/README.md

@@ -9,9 +9,9 @@ For game developers looking to use Azure App Services (previously Mobile Service
 3. Create an Azure App Service [Mobile App](https://portal.azure.com)
 	* Create a Table (using Easy Tables) for app data.
 
-## Unity 5 leaderboard demo
-[App Services Demo project](https://github.com/Unity3dAzure/AppServicesDemo) will run inside UnityEditor on Mac or Windows. (The demo project has got everything bundled in and does not require any additional assets to work.)
-For detailed instructions read my developer blog on how to [use Azure App Services with Unity project](http://www.deadlyfingers.net/azure/azure-app-services-for-unity3d/).
+## Azure App Services Demos for Unity 5
+Try the [Azure App Services Demos](https://github.com/Unity3dAzure/AppServicesDemo) project for Unity 5 on Mac / Windows. (The demo project has got everything already bundled in and does not require any additional assets to work. Just wire it up with your [Azure App Service](https://portal.azure.com) and run it right inside the Unity Editor.)
+For detailed instructions read my developer blog on [how to setup Azure App Services and Unity demo project](http://www.deadlyfingers.net/azure/azure-app-services-for-unity3d/).
 
 ## Supported Features
 ### MobileServiceClient
@@ -40,9 +40,9 @@ Lookup | Get an item’s data using id property.
 	void Update<T>(T item, Action<IRestResponse<T>> callback = null) where T : new();
 	void Delete<T>(string id, Action<IRestResponse<T>> callback = null) where T : new();
 	void Query<T>(CustomQuery query, Action<IRestResponse<List<T>>> callback = null) where T : new();
+  void Query<T>(CustomQuery query, Action<IRestResponse<T>> callback = null) where T : INestedResults, new();
 	void Lookup<T>(string id, Action<IRestResponse<T>> callback = null) where T : new();
 
-
 ## Sample usage
 ```
 using UnityEngine;

Assets/AppServices/model/base/DataModel.cs

@@ -0,0 +1,42 @@
+using System;
+using System.ComponentModel;
+using Pathfinding.Serialization.JsonFx;
+
+namespace Unity3dAzure.AppServices
+{
+	[Serializable]
+	[CLSCompliant(false)]
+	public abstract class DataModel : IDataModel
+    {
+		public string id { get; internal set; }
+
+		// system properties
+		[JsonIgnore] public DateTime createdAt { get; private set; }
+		[JsonIgnore] public DateTime updatedAt { get; private set; }
+		[JsonIgnore] public string version { get; private set; }
+		[JsonIgnore] public bool deleted { get; private set; }
+
+		// `$inlinecount=allpages` property
+		[EditorBrowsable(EditorBrowsableState.Never)]
+		[JsonIgnore] public uint ROW_NUMBER { get; private set; }
+		public uint GetIndex()
+		{
+			return ROW_NUMBER;
+		}
+
+        public string GetId()
+        {
+            return id;
+        }
+
+		public void SetId(string id)
+		{
+			this.id = id;
+		}
+
+		public override string ToString ()
+		{
+			return string.Format ("id:{0}, createdAt:{1}, updatedAt:{2}, version:{3}, deleted:{4}, index:{5}", id, createdAt, updatedAt, version, deleted, GetIndex());
+		}
+    }
+}

…rvices/model/optional/IAzureDataModel.cs …ets/AppServices/model/base/IDataModel.csAssets/AppServices/model/optional/IAzureDataModel.cs renamed to Assets/AppServices/model/base/IDataModel.cs Assets/AppServices/model/optional/IAzureDataModel.cs renamed to Assets/AppServices/model/base/IDataModel.cs

@@ -1,6 +1,6 @@
 namespace Unity3dAzure.AppServices
 {
-    public interface IAzureDataModel
+    public interface IDataModel
     {
         string GetId();
     }

Assets/AppServices/model/nested/INestedResults.cs

@@ -0,0 +1,14 @@
+using System.Collections;
+using System.Collections.Generic;
+using System;
+using RestSharp;
+
+namespace Unity3dAzure.AppServices
+{
+	/// <summary>
+	/// Interface to support table Query with `$inlinecount=allpages` 
+	/// </summary>
+	public interface INestedResults
+	{
+	}
+}

Assets/AppServices/model/nested/NestedResults.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+
+namespace Unity3dAzure.AppServices
+{
+	/// <summary>
+	/// Wrap your data model with this object to call the table Query with `$inlinecount=allpages` param.
+	/// </summary>
+	[CLSCompliant(false)]
+	[Serializable]
+	public class NestedResults<T> : INestedResults
+	{
+		public uint count { get; set; }
+		public List<T> results { get; set; }
+	}
+}

Assets/AppServices/model/optional/AzureDataModel.cs

@@ -41,6 +41,11 @@ public interface IAzureMobileServiceTable
         /// https://msdn.microsoft.com/en-us/library/azure/jj677199.aspx
         /// </summary>
         void Query<T>(CustomQuery query, Action<IRestResponse<List<T>>> callback = null) where T : new();
+
+		/// <summary>
+		/// Returns a 'count' and nested list of 'results' (appends `$inlinecount=allpages` parameter to the query)
+		/// </summary>
+		void Query<T>(CustomQuery query, Action<IRestResponse<T>> callback = null) where T : INestedResults, new();
 
         /// <summary>
         /// Get an item's data using id property. 

Assets/AppServices/table/IAzureMobileServiceTable.cs

@@ -46,9 +46,20 @@ public override string ToString()
         {
             string uri = string.Format("{0}{1}{2}", URI_TABLES, _name, query);
             ZumoRequest request = new ZumoRequest(_client, uri, Method.GET);
-            Debug.Log( "Query Request: " + uri );
-            _client.ExecuteAsync<List<T>>(request, callback);
+			Debug.Log( "Query Request: " + uri +" Query:"+ query );
+			_client.ExecuteAsync<List<T>> (request, callback);
         }
+
+		public void Query<T>(CustomQuery query, Action<IRestResponse<T>> callback = null) where T : INestedResults, new()
+		{
+			string queryResults = query.ToString ();
+			string q = queryResults.Length > 0 ? "&" : "?";
+			queryResults += string.Format("{0}$inlinecount=allpages", q);
+			string uri = string.Format("{0}{1}{2}", URI_TABLES, _name, queryResults);
+			ZumoRequest request = new ZumoRequest(_client, uri, Method.GET);
+			Debug.Log( "Query Request: " + uri +" Query with inlinecount:"+ queryResults );
+			_client.ExecuteAsync<T> (request, callback);
+		}
 
         public void Update<T>(T item, Action<IRestResponse<T>> callback = null) where T : new()
         {

Assets/AppServices/table/MobileServiceTable.cs

@@ -2,20 +2,46 @@
 using System.Text;
 using UnityEngine;
 
+/// <summary>
+/// Query records operation https://msdn.microsoft.com/en-us/library/azure/jj677199.aspx
+/// There is a maximum of 50 records returned in a query - use top and skip params to return additional pages of results.
+/// NB: `$inlinecount` (which returns count of all items without paging applied) is not set here as it changes the data model and the way the REST decode callback works makes it intangible to decode. 
+/// Rather the '$inlinecount=allpages' param is automically set when using the table's Query method and wrapping your data model with the NestedResults object wrapper.
+/// </summary>
 namespace Unity3dAzure.AppServices
 {
+	[Flags]
+	public enum MobileServiceSystemProperty
+	{
+		nil = 0x0,
+		createdAt = 0x1,
+		updatedAt = 0x2,
+		version = 0x4,
+		deleted = 0x8
+	}
+
 	[CLSCompliant(false)]
     public class CustomQuery
     {
+		// query option parameters defined by the Open Data Protocol (OData)
         private string _filter;
         private string _orderBy;
-		private UInt32 _top;
+		private uint _top;
+		private uint _skip;
+		private string _select;
+		// other params
+		private MobileServiceSystemProperty _systemProperties;
+		private bool _includeDeleted;
 
-		public CustomQuery(string filter, string orderBy=null, UInt32 top=0)
+		public CustomQuery(string filter, string orderBy=null, uint top=0, uint skip=0, string select=null, MobileServiceSystemProperty systemProperties=MobileServiceSystemProperty.nil, bool includeDeleted=false)
         {
-            _filter = filter; // return only rows that satisty the specified filter
-			_orderBy = orderBy; // sort column by 'desc' or 'asc' order
-			_top = top; // return the top n entities for any query,
+			_filter = filter; // return only rows that satisty the specified filter predicate
+			_orderBy = orderBy; // sort column by one or more columns: order can be specified in 'desc' or 'asc' order ('asc' is default)
+			_top = top; // return the top n entities for any query
+			_skip = skip; // the n of records to skip (used for paging results)
+			_select = select; // defines new projection of data by specifying the columns
+			_systemProperties = systemProperties; // list of system properties to be included in the response
+			_includeDeleted = includeDeleted; // if table has soft delete enabled then deleted records will be included in the results 
         }
 
 		public static CustomQuery OrderBy(string orderBy) {
@@ -26,24 +52,59 @@ public override string ToString()
         {
             string queryString = "";
             string q = "?";
-            if (!string.IsNullOrEmpty(_filter)){
-                queryString += string.Format("{0}$filter=({1})", q, encode(_filter));
+            if (!string.IsNullOrEmpty(_filter)) {
+				queryString += string.Format("{0}$filter=({1})", q, _filter);
                 q = "&";
             }
-            if (!string.IsNullOrEmpty(_orderBy)){
-				queryString += string.Format("{0}$orderby={1}", q, encode(_orderBy));
+            if (!string.IsNullOrEmpty(_orderBy)) {
+				queryString += string.Format("{0}$orderby={1}", q, _orderBy);
                 q = "&";
             }
 			if (_top > 0) {
 				queryString += string.Format("{0}$top={1}", q, _top.ToString());
+				q = "&";
+			}
+			if (_skip > 0) {
+				queryString += string.Format("{0}$skip={1}", q, _skip.ToString());
+				q = "&";
+			}
+			if (!string.IsNullOrEmpty(_select)) {
+				queryString += string.Format("{0}$select={1}", q, _select);
+				q = "&";
+			}
+			if (_systemProperties!=MobileServiceSystemProperty.nil) {
+				// NB: setting __systemproperties param doesn't seem to do anything different as these properties are all included by default, but we can append values to the 'select' param.
+				if (!string.IsNullOrEmpty (_select)) {
+					queryString += string.Format (",{0}", SystemPropertiesValues (_systemProperties));
+				}
+				queryString += string.Format("{0}__systemproperties={1}", q, SystemPropertiesValues(_systemProperties)); 
+				q = "&";
 			}
-            return queryString;
+			if (_includeDeleted) {
+				queryString += string.Format("{0}__includeDeleted=true", q);
+			}
+			return EscapeURL(queryString);
         }
 
-        private string encode(string url)
+        private string EscapeURL(string query)
         {
-			return WWW.EscapeURL(url.Replace("+", "%20")); // NB: replace space with '%20' and not '+'
+			string q = WWW.EscapeURL (query);
+			StringBuilder sb = new StringBuilder (q);
+			sb.Replace ("+", "%20"); // NB: replace space with '%20' instead of '+'
+			// keep query params: ?&=$
+			sb.Replace ("%3f", "?"); 
+			sb.Replace ("%26", "&");
+			sb.Replace ("%3d", "=");
+			sb.Replace ("%24", "$"); 
+			return sb.ToString();
         }
 
+		private string SystemPropertiesValues(MobileServiceSystemProperty systemProperties) 
+		{
+			if (systemProperties == MobileServiceSystemProperty.nil) {
+				return "";
+			}
+			return systemProperties.ToString().Replace(", ","%2C"); // remove spaces from string and escape comma
+		}
     }
 }

Assets/AppServices/table/query/CustomQuery.cs

@@ -37,7 +37,7 @@ GameObject:
   serializedVersion: 4
   m_Component:
   - 224: {fileID: 224000010748435472}
-  - 114: {fileID: 114000010894356006}
+  - 114: {fileID: 114000012629349416}
   m_Layer: 5
   m_Name: InventoryCellPrefab
   m_TagString: Untagged
@@ -96,21 +96,6 @@ GameObject:
   m_NavMeshLayer: 0
   m_StaticEditorFlags: 0
   m_IsActive: 1
---- !u!114 &114000010894356006
-MonoBehaviour:
-  m_ObjectHideFlags: 1
-  m_PrefabParentObject: {fileID: 0}
-  m_PrefabInternal: {fileID: 100100000}
-  m_GameObject: {fileID: 1000012312357288}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 833090a17290e4c3f83e448026c0ccf4, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
-  Icon: {fileID: 114000013534120506}
-  Name: {fileID: 114000013939998824}
-  Amount: {fileID: 114000011077488226}
-  Btn: {fileID: 114000011147225522}
 --- !u!114 &114000011077488226
 MonoBehaviour:
   m_ObjectHideFlags: 1
@@ -196,6 +181,21 @@ MonoBehaviour:
         m_CallState: 2
     m_TypeName: UnityEngine.UI.Button+ButtonClickedEvent, UnityEngine.UI, Version=1.0.0.0,
       Culture=neutral, PublicKeyToken=null
+--- !u!114 &114000012629349416
+MonoBehaviour:
+  m_ObjectHideFlags: 1
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 100100000}
+  m_GameObject: {fileID: 1000012312357288}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 177d64a8e263e4ca990b0b5b61fd989a, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  Icon: {fileID: 114000013534120506}
+  Name: {fileID: 114000013939998824}
+  Amount: {fileID: 114000011077488226}
+  Btn: {fileID: 114000011147225522}
 --- !u!114 &114000013534120506
 MonoBehaviour:
   m_ObjectHideFlags: 1