diff options
Diffstat (limited to 'dsa/FireBase/Query')
| -rw-r--r-- | dsa/FireBase/Query/AuthQuery.cs | 34 | ||||
| -rw-r--r-- | dsa/FireBase/Query/ChildQuery.cs | 50 | ||||
| -rw-r--r-- | dsa/FireBase/Query/FilterQuery.cs | 77 | ||||
| -rw-r--r-- | dsa/FireBase/Query/FirebaseQuery.cs | 314 | ||||
| -rw-r--r-- | dsa/FireBase/Query/IFirebaseQuery.cs | 40 | ||||
| -rw-r--r-- | dsa/FireBase/Query/OrderQuery.cs | 34 | ||||
| -rw-r--r-- | dsa/FireBase/Query/ParameterQuery.cs | 43 | ||||
| -rw-r--r-- | dsa/FireBase/Query/QueryExtensions.cs | 210 | ||||
| -rw-r--r-- | dsa/FireBase/Query/QueryFactoryExtensions.cs | 187 | ||||
| -rw-r--r-- | dsa/FireBase/Query/SilentQuery.cs | 18 |
10 files changed, 1007 insertions, 0 deletions
diff --git a/dsa/FireBase/Query/AuthQuery.cs b/dsa/FireBase/Query/AuthQuery.cs new file mode 100644 index 0000000..2cfda3c --- /dev/null +++ b/dsa/FireBase/Query/AuthQuery.cs @@ -0,0 +1,34 @@ +using System; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Represents an auth parameter in firebase query, e.g. "?auth=xyz". + /// </summary> + public class AuthQuery : ParameterQuery + { + private readonly Func<string> tokenFactory; + + /// <summary> + /// Initializes a new instance of the <see cref="AuthQuery" /> class. + /// </summary> + /// <param name="parent"> The parent. </param> + /// <param name="tokenFactory"> The authentication token factory. </param> + /// <param name="client"> The owner. </param> + public AuthQuery(FirebaseQuery parent, Func<string> tokenFactory, FirebaseClient client) : base(parent, + () => client.Options.AsAccessToken ? "access_token" : "auth", client) + { + this.tokenFactory = tokenFactory; + } + + /// <summary> + /// Build the url parameter value of this child. + /// </summary> + /// <param name="child"> The child of this child. </param> + /// <returns> The <see cref="string" />. </returns> + protected override string BuildUrlParameter(FirebaseQuery child) + { + return tokenFactory(); + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/ChildQuery.cs b/dsa/FireBase/Query/ChildQuery.cs new file mode 100644 index 0000000..014fe09 --- /dev/null +++ b/dsa/FireBase/Query/ChildQuery.cs @@ -0,0 +1,50 @@ +using System; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Firebase query which references the child of current node. + /// </summary> + public class ChildQuery : FirebaseQuery + { + private readonly Func<string> pathFactory; + + /// <summary> + /// Initializes a new instance of the <see cref="ChildQuery" /> class. + /// </summary> + /// <param name="parent"> The parent. </param> + /// <param name="pathFactory"> The path to the child node. </param> + /// <param name="client"> The owner. </param> + public ChildQuery(FirebaseQuery parent, Func<string> pathFactory, FirebaseClient client) + : base(parent, client) + { + this.pathFactory = pathFactory; + } + + /// <summary> + /// Initializes a new instance of the <see cref="ChildQuery" /> class. + /// </summary> + /// <param name="client"> The client. </param> + /// <param name="pathFactory"> The path to the child node. </param> + public ChildQuery(FirebaseClient client, Func<string> pathFactory) + : this(null, pathFactory, client) + { + } + + /// <summary> + /// Build the url segment of this child. + /// </summary> + /// <param name="child"> The child of this child. </param> + /// <returns> The <see cref="string" />. </returns> + protected override string BuildUrlSegment(FirebaseQuery child) + { + var s = pathFactory(); + + if (s != string.Empty && !s.EndsWith("/")) s += '/'; + + if (!(child is ChildQuery)) return s + ".json"; + + return s; + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/FilterQuery.cs b/dsa/FireBase/Query/FilterQuery.cs new file mode 100644 index 0000000..3434d1d --- /dev/null +++ b/dsa/FireBase/Query/FilterQuery.cs @@ -0,0 +1,77 @@ +using System; +using System.Globalization; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Represents a firebase filtering query, e.g. "?LimitToLast=10". + /// </summary> + public class FilterQuery : ParameterQuery + { + private readonly Func<bool> boolValueFactory; + private readonly Func<double> doubleValueFactory; + private readonly Func<string> valueFactory; + + /// <summary> + /// Initializes a new instance of the <see cref="FilterQuery" /> class. + /// </summary> + /// <param name="parent"> The parent. </param> + /// <param name="filterFactory"> The filter. </param> + /// <param name="valueFactory"> The value for filter. </param> + /// <param name="client"> The owning client. </param> + public FilterQuery(FirebaseQuery parent, Func<string> filterFactory, Func<string> valueFactory, + FirebaseClient client) + : base(parent, filterFactory, client) + { + this.valueFactory = valueFactory; + } + + /// <summary> + /// Initializes a new instance of the <see cref="FilterQuery" /> class. + /// </summary> + /// <param name="parent"> The parent. </param> + /// <param name="filterFactory"> The filter. </param> + /// <param name="valueFactory"> The value for filter. </param> + /// <param name="client"> The owning client. </param> + public FilterQuery(FirebaseQuery parent, Func<string> filterFactory, Func<double> valueFactory, + FirebaseClient client) + : base(parent, filterFactory, client) + { + doubleValueFactory = valueFactory; + } + + /// <summary> + /// Initializes a new instance of the <see cref="FilterQuery" /> class. + /// </summary> + /// <param name="parent"> The parent. </param> + /// <param name="filterFactory"> The filter. </param> + /// <param name="valueFactory"> The value for filter. </param> + /// <param name="client"> The owning client. </param> + public FilterQuery(FirebaseQuery parent, Func<string> filterFactory, Func<bool> valueFactory, + FirebaseClient client) + : base(parent, filterFactory, client) + { + boolValueFactory = valueFactory; + } + + /// <summary> + /// The build url parameter. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> Url parameter part of the resulting path. </returns> + protected override string BuildUrlParameter(FirebaseQuery child) + { + if (valueFactory != null) + { + if (valueFactory() == null) return "null"; + return $"\"{valueFactory()}\""; + } + + if (doubleValueFactory != null) + return doubleValueFactory().ToString(CultureInfo.InvariantCulture); + if (boolValueFactory != null) return $"{boolValueFactory().ToString().ToLower()}"; + + return string.Empty; + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/FirebaseQuery.cs b/dsa/FireBase/Query/FirebaseQuery.cs new file mode 100644 index 0000000..60d0289 --- /dev/null +++ b/dsa/FireBase/Query/FirebaseQuery.cs @@ -0,0 +1,314 @@ +using System; +using System.Collections.Generic; +using System.Net; +using System.Net.Http; +using System.Reactive.Linq; +using System.Threading.Tasks; +using Firebase.Database.Http; +using Firebase.Database.Streaming; +using Newtonsoft.Json; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Represents a firebase query. + /// </summary> + public abstract class FirebaseQuery : IFirebaseQuery, IDisposable + { + protected readonly FirebaseQuery Parent; + + private HttpClient client; + protected TimeSpan DEFAULT_HTTP_CLIENT_TIMEOUT = new TimeSpan(0, 0, 180); + + /// <summary> + /// Initializes a new instance of the <see cref="FirebaseQuery" /> class. + /// </summary> + /// <param name="parent"> The parent of this query. </param> + /// <param name="client"> The owning client. </param> + protected FirebaseQuery(FirebaseQuery parent, FirebaseClient client) + { + Client = client; + Parent = parent; + } + + /// <summary> + /// Disposes this instance. + /// </summary> + public void Dispose() + { + client?.Dispose(); + } + + /// <summary> + /// Gets the client. + /// </summary> + public FirebaseClient Client { get; } + + /// <summary> + /// Queries the firebase server once returning collection of items. + /// </summary> + /// <param name="timeout"> Optional timeout value. </param> + /// <typeparam name="T"> Type of elements. </typeparam> + /// <returns> Collection of <see cref="FirebaseObject{T}" /> holding the entities returned by server. </returns> + public async Task<IReadOnlyCollection<FirebaseObject<T>>> OnceAsync<T>(TimeSpan? timeout = null) + { + var url = string.Empty; + + try + { + url = await BuildUrlAsync().ConfigureAwait(false); + } + catch (Exception ex) + { + throw new FirebaseException("Couldn't build the url", string.Empty, string.Empty, HttpStatusCode.OK, + ex); + } + + return await GetClient(timeout).GetObjectCollectionAsync<T>(url, Client.Options.JsonSerializerSettings) + .ConfigureAwait(false); + } + + /// <summary> + /// Starts observing this query watching for changes real time sent by the server. + /// </summary> + /// <typeparam name="T"> Type of elements. </typeparam> + /// <param name="elementRoot"> Optional custom root element of received json items. </param> + /// <returns> Observable stream of <see cref="FirebaseEvent{T}" />. </returns> + public IObservable<FirebaseEvent<T>> AsObservable<T>( + EventHandler<ExceptionEventArgs<FirebaseException>> exceptionHandler = null, string elementRoot = "") + { + return Observable.Create<FirebaseEvent<T>>(observer => + { + var sub = new FirebaseSubscription<T>(observer, this, elementRoot, new FirebaseCache<T>()); + sub.ExceptionThrown += exceptionHandler; + return sub.Run(); + }); + } + + /// <summary> + /// Builds the actual URL of this query. + /// </summary> + /// <returns> The <see cref="string" />. </returns> + public async Task<string> BuildUrlAsync() + { + // if token factory is present on the parent then use it to generate auth token + if (Client.Options.AuthTokenAsyncFactory != null) + { + var token = await Client.Options.AuthTokenAsyncFactory().ConfigureAwait(false); + return this.WithAuth(token).BuildUrl(null); + } + + return BuildUrl(null); + } + + /*public async Task<IReadOnlyCollection<FirebaseObject<Object>>> OnceAsync(Type dataType, TimeSpan? timeout = null) + { + var url = string.Empty; + + try + { + url = await this.BuildUrlAsync().ConfigureAwait(false); + } + catch (Exception ex) + { + throw new FirebaseException("Couldn't build the url", string.Empty, string.Empty, HttpStatusCode.OK, ex); + } + + return await this.GetClient(timeout).GetObjectCollectionAsync(url, Client.Options.JsonSerializerSettings, dataType) + .ConfigureAwait(false); + }*/ + + /// <summary> + /// Assumes given query is pointing to a single object of type <typeparamref name="T" /> and retrieves it. + /// </summary> + /// <param name="timeout"> Optional timeout value. </param> + /// <typeparam name="T"> Type of elements. </typeparam> + /// <returns> Single object of type <typeparamref name="T" />. </returns> + public async Task<T> OnceSingleAsync<T>(TimeSpan? timeout = null) + { + var responseData = string.Empty; + var statusCode = HttpStatusCode.OK; + var url = string.Empty; + + try + { + url = await BuildUrlAsync().ConfigureAwait(false); + } + catch (Exception ex) + { + throw new FirebaseException("Couldn't build the url", string.Empty, responseData, statusCode, ex); + } + + try + { + var response = await GetClient(timeout).GetAsync(url).ConfigureAwait(false); + statusCode = response.StatusCode; + responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); + + response.EnsureSuccessStatusCode(); + response.Dispose(); + + return JsonConvert.DeserializeObject<T>(responseData, Client.Options.JsonSerializerSettings); + } + catch (Exception ex) + { + throw new FirebaseException(url, string.Empty, responseData, statusCode, ex); + } + } + + /// <summary> + /// Posts given object to repository. + /// </summary> + /// <param name="obj"> The object. </param> + /// <param name="generateKeyOffline"> Specifies whether the key should be generated offline instead of online. </param> + /// <param name="timeout"> Optional timeout value. </param> + /// <typeparam name="T"> Type of <see cref="obj" /> </typeparam> + /// <returns> Resulting firebase object with populated key. </returns> + public async Task<FirebaseObject<string>> PostAsync(string data, bool generateKeyOffline = true, + TimeSpan? timeout = null) + { + // post generates a new key server-side, while put can be used with an already generated local key + if (generateKeyOffline) + { + var key = FirebaseKeyGenerator.Next(); + await new ChildQuery(this, () => key, Client).PutAsync(data).ConfigureAwait(false); + + return new FirebaseObject<string>(key, data); + } + + var c = GetClient(timeout); + var sendData = await SendAsync(c, data, HttpMethod.Post).ConfigureAwait(false); + var result = JsonConvert.DeserializeObject<PostResult>(sendData, Client.Options.JsonSerializerSettings); + + return new FirebaseObject<string>(result.Name, data); + } + + /// <summary> + /// Patches data at given location instead of overwriting them. + /// </summary> + /// <param name="obj"> The object. </param> + /// <param name="timeout"> Optional timeout value. </param> + /// <typeparam name="T"> Type of <see cref="obj" /> </typeparam> + /// <returns> The <see cref="Task" />. </returns> + public async Task PatchAsync(string data, TimeSpan? timeout = null) + { + var c = GetClient(timeout); + + await this.Silent().SendAsync(c, data, new HttpMethod("PATCH")).ConfigureAwait(false); + } + + /// <summary> + /// Sets or overwrites data at given location. + /// </summary> + /// <param name="obj"> The object. </param> + /// <param name="timeout"> Optional timeout value. </param> + /// <typeparam name="T"> Type of <see cref="obj" /> </typeparam> + /// <returns> The <see cref="Task" />. </returns> + public async Task PutAsync(string data, TimeSpan? timeout = null) + { + var c = GetClient(timeout); + + await this.Silent().SendAsync(c, data, HttpMethod.Put).ConfigureAwait(false); + } + + /// <summary> + /// Deletes data from given location. + /// </summary> + /// <param name="timeout"> Optional timeout value. </param> + /// <returns> The <see cref="Task" />. </returns> + public async Task DeleteAsync(TimeSpan? timeout = null) + { + var c = GetClient(timeout); + var url = string.Empty; + var responseData = string.Empty; + var statusCode = HttpStatusCode.OK; + + try + { + url = await BuildUrlAsync().ConfigureAwait(false); + } + catch (Exception ex) + { + throw new FirebaseException("Couldn't build the url", string.Empty, responseData, statusCode, ex); + } + + try + { + var result = await c.DeleteAsync(url).ConfigureAwait(false); + statusCode = result.StatusCode; + responseData = await result.Content.ReadAsStringAsync().ConfigureAwait(false); + + result.EnsureSuccessStatusCode(); + } + catch (Exception ex) + { + throw new FirebaseException(url, string.Empty, responseData, statusCode, ex); + } + } + + /// <summary> + /// Build the url segment of this child. + /// </summary> + /// <param name="child"> The child of this query. </param> + /// <returns> The <see cref="string" />. </returns> + protected abstract string BuildUrlSegment(FirebaseQuery child); + + private string BuildUrl(FirebaseQuery child) + { + var url = BuildUrlSegment(child); + + if (Parent != null) url = Parent.BuildUrl(this) + url; + + return url; + } + + private HttpClient GetClient(TimeSpan? timeout = null) + { + if (client == null) client = new HttpClient(); + + if (!timeout.HasValue) + client.Timeout = DEFAULT_HTTP_CLIENT_TIMEOUT; + else + client.Timeout = timeout.Value; + + return client; + } + + private async Task<string> SendAsync(HttpClient client, string data, HttpMethod method) + { + var responseData = string.Empty; + var statusCode = HttpStatusCode.OK; + var requestData = data; + var url = string.Empty; + + try + { + url = await BuildUrlAsync().ConfigureAwait(false); + } + catch (Exception ex) + { + throw new FirebaseException("Couldn't build the url", requestData, responseData, statusCode, ex); + } + + var message = new HttpRequestMessage(method, url) + { + Content = new StringContent(requestData) + }; + + try + { + var result = await client.SendAsync(message).ConfigureAwait(false); + statusCode = result.StatusCode; + responseData = await result.Content.ReadAsStringAsync().ConfigureAwait(false); + + result.EnsureSuccessStatusCode(); + + return responseData; + } + catch (Exception ex) + { + throw new FirebaseException(url, requestData, responseData, statusCode, ex); + } + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/IFirebaseQuery.cs b/dsa/FireBase/Query/IFirebaseQuery.cs new file mode 100644 index 0000000..0da4b15 --- /dev/null +++ b/dsa/FireBase/Query/IFirebaseQuery.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using Firebase.Database.Streaming; + +namespace Firebase.Database.Query +{ + /// <summary> + /// The FirebaseQuery interface. + /// </summary> + public interface IFirebaseQuery + { + /// <summary> + /// Gets the owning client of this query. + /// </summary> + FirebaseClient Client { get; } + + /// <summary> + /// Retrieves items which exist on the location specified by this query instance. + /// </summary> + /// <param name="timeout"> Optional timeout value. </param> + /// <typeparam name="T"> Type of the items. </typeparam> + /// <returns> Collection of <see cref="FirebaseObject{T}" />. </returns> + Task<IReadOnlyCollection<FirebaseObject<T>>> OnceAsync<T>(TimeSpan? timeout = null); + + /// <summary> + /// Returns current location as an observable which allows to real-time listening to events from the firebase server. + /// </summary> + /// <typeparam name="T"> Type of the items. </typeparam> + /// <returns> Cold observable of <see cref="FirebaseEvent{T}" />. </returns> + IObservable<FirebaseEvent<T>> AsObservable<T>( + EventHandler<ExceptionEventArgs<FirebaseException>> exceptionHandler, string elementRoot = ""); + + /// <summary> + /// Builds the actual url of this query. + /// </summary> + /// <returns> The <see cref="string" />. </returns> + Task<string> BuildUrlAsync(); + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/OrderQuery.cs b/dsa/FireBase/Query/OrderQuery.cs new file mode 100644 index 0000000..302d1a3 --- /dev/null +++ b/dsa/FireBase/Query/OrderQuery.cs @@ -0,0 +1,34 @@ +using System; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Represents a firebase ordering query, e.g. "?OrderBy=Foo". + /// </summary> + public class OrderQuery : ParameterQuery + { + private readonly Func<string> propertyNameFactory; + + /// <summary> + /// Initializes a new instance of the <see cref="OrderQuery" /> class. + /// </summary> + /// <param name="parent"> The query parent. </param> + /// <param name="propertyNameFactory"> The property name. </param> + /// <param name="client"> The owning client. </param> + public OrderQuery(ChildQuery parent, Func<string> propertyNameFactory, FirebaseClient client) + : base(parent, () => "orderBy", client) + { + this.propertyNameFactory = propertyNameFactory; + } + + /// <summary> + /// The build url parameter. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> The <see cref="string" />. </returns> + protected override string BuildUrlParameter(FirebaseQuery child) + { + return $"\"{propertyNameFactory()}\""; + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/ParameterQuery.cs b/dsa/FireBase/Query/ParameterQuery.cs new file mode 100644 index 0000000..572224c --- /dev/null +++ b/dsa/FireBase/Query/ParameterQuery.cs @@ -0,0 +1,43 @@ +using System; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Represents a parameter in firebase query, e.g. "?data=foo". + /// </summary> + public abstract class ParameterQuery : FirebaseQuery + { + private readonly Func<string> parameterFactory; + private readonly string separator; + + /// <summary> + /// Initializes a new instance of the <see cref="ParameterQuery" /> class. + /// </summary> + /// <param name="parent"> The parent of this query. </param> + /// <param name="parameterFactory"> The parameter. </param> + /// <param name="client"> The owning client. </param> + protected ParameterQuery(FirebaseQuery parent, Func<string> parameterFactory, FirebaseClient client) + : base(parent, client) + { + this.parameterFactory = parameterFactory; + separator = Parent is ChildQuery ? "?" : "&"; + } + + /// <summary> + /// Build the url segment represented by this query. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> The <see cref="string" />. </returns> + protected override string BuildUrlSegment(FirebaseQuery child) + { + return $"{separator}{parameterFactory()}={BuildUrlParameter(child)}"; + } + + /// <summary> + /// The build url parameter. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> The <see cref="string" />. </returns> + protected abstract string BuildUrlParameter(FirebaseQuery child); + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/QueryExtensions.cs b/dsa/FireBase/Query/QueryExtensions.cs new file mode 100644 index 0000000..df2edfc --- /dev/null +++ b/dsa/FireBase/Query/QueryExtensions.cs @@ -0,0 +1,210 @@ +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using Newtonsoft.Json; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Query extensions providing linq like syntax for firebase server methods. + /// </summary> + public static class QueryExtensions + { + /// <summary> + /// Adds an auth parameter to the query. + /// </summary> + /// <param name="node"> The child. </param> + /// <param name="token"> The auth token. </param> + /// <returns> The <see cref="AuthQuery" />. </returns> + internal static AuthQuery WithAuth(this FirebaseQuery node, string token) + { + return node.WithAuth(() => token); + } + + /// <summary> + /// Appends print=silent to save bandwidth. + /// </summary> + /// <param name="node"> The child. </param> + /// <returns> The <see cref="SilentQuery" />. </returns> + internal static SilentQuery Silent(this FirebaseQuery node) + { + return new SilentQuery(node, node.Client); + } + + /// <summary> + /// References a sub child of the existing node. + /// </summary> + /// <param name="node"> The child. </param> + /// <param name="path"> The path of sub child. </param> + /// <returns> The <see cref="ChildQuery" />. </returns> + public static ChildQuery Child(this ChildQuery node, string path) + { + return node.Child(() => path); + } + + /// <summary> + /// Order data by given <see cref="propertyName" />. Note that this is used mainly for following filtering queries and + /// due to firebase implementation + /// the data may actually not be ordered. + /// </summary> + /// <param name="child"> The child. </param> + /// <param name="propertyName"> The property name. </param> + /// <returns> The <see cref="OrderQuery" />. </returns> + public static OrderQuery OrderBy(this ChildQuery child, string propertyName) + { + return child.OrderBy(() => propertyName); + } + + /// <summary> + /// Instructs firebase to send data greater or equal to the <see cref="value" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery StartAt(this ParameterQuery child, string value) + { + return child.StartAt(() => value); + } + + /// <summary> + /// Instructs firebase to send data lower or equal to the <see cref="value" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EndAt(this ParameterQuery child, string value) + { + return child.EndAt(() => value); + } + + /// <summary> + /// Instructs firebase to send data equal to the <see cref="value" />. This must be preceded by an OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child, string value) + { + return child.EqualTo(() => value); + } + + /// <summary> + /// Instructs firebase to send data greater or equal to the <see cref="value" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery StartAt(this ParameterQuery child, double value) + { + return child.StartAt(() => value); + } + + /// <summary> + /// Instructs firebase to send data lower or equal to the <see cref="value" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EndAt(this ParameterQuery child, double value) + { + return child.EndAt(() => value); + } + + /// <summary> + /// Instructs firebase to send data equal to the <see cref="value" />. This must be preceded by an OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child, double value) + { + return child.EqualTo(() => value); + } + + /// <summary> + /// Instructs firebase to send data equal to the <see cref="value" />. This must be preceded by an OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="value"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child, bool value) + { + return child.EqualTo(() => value); + } + + /// <summary> + /// Instructs firebase to send data equal to null. This must be preceded by an OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child) + { + return child.EqualTo(() => null); + } + + /// <summary> + /// Limits the result to first <see cref="count" /> items. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="count"> Number of elements. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery LimitToFirst(this ParameterQuery child, int count) + { + return child.LimitToFirst(() => count); + } + + /// <summary> + /// Limits the result to last <see cref="count" /> items. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="count"> Number of elements. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery LimitToLast(this ParameterQuery child, int count) + { + return child.LimitToLast(() => count); + } + + public static Task PutAsync<T>(this FirebaseQuery query, T obj) + { + return query.PutAsync(JsonConvert.SerializeObject(obj, query.Client.Options.JsonSerializerSettings)); + } + + public static Task PatchAsync<T>(this FirebaseQuery query, T obj) + { + return query.PatchAsync(JsonConvert.SerializeObject(obj, query.Client.Options.JsonSerializerSettings)); + } + + public static async Task<FirebaseObject<T>> PostAsync<T>(this FirebaseQuery query, T obj, + bool generateKeyOffline = true) + { + var result = + await query.PostAsync(JsonConvert.SerializeObject(obj, query.Client.Options.JsonSerializerSettings), + generateKeyOffline); + + return new FirebaseObject<T>(result.Key, obj); + } + + /// <summary> + /// Fan out given item to multiple locations at once. See + /// https://firebase.googleblog.com/2015/10/client-side-fan-out-for-data-consistency_73.html for details. + /// </summary> + /// <typeparam name="T"> Type of object to fan out. </typeparam> + /// <param name="query"> Current node. </param> + /// <param name="item"> Object to fan out. </param> + /// <param name="relativePaths"> Locations where to store the item. </param> + public static async Task FanOut<T>(this ChildQuery child, T item, params string[] relativePaths) + { + if (relativePaths == null) throw new ArgumentNullException(nameof(relativePaths)); + + var fanoutObject = new Dictionary<string, T>(relativePaths.Length); + + foreach (var path in relativePaths) fanoutObject.Add(path, item); + + await child.PatchAsync(fanoutObject); + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/QueryFactoryExtensions.cs b/dsa/FireBase/Query/QueryFactoryExtensions.cs new file mode 100644 index 0000000..71dae5c --- /dev/null +++ b/dsa/FireBase/Query/QueryFactoryExtensions.cs @@ -0,0 +1,187 @@ +using System; + +namespace Firebase.Database.Query +{ + /// <summary> + /// Query extensions providing linq like syntax for firebase server methods. + /// </summary> + public static class QueryFactoryExtensions + { + /// <summary> + /// Adds an auth parameter to the query. + /// </summary> + /// <param name="node"> The child. </param> + /// <param name="tokenFactory"> The auth token. </param> + /// <returns> The <see cref="AuthQuery" />. </returns> + internal static AuthQuery WithAuth(this FirebaseQuery node, Func<string> tokenFactory) + { + return new AuthQuery(node, tokenFactory, node.Client); + } + + /// <summary> + /// References a sub child of the existing node. + /// </summary> + /// <param name="node"> The child. </param> + /// <param name="pathFactory"> The path of sub child. </param> + /// <returns> The <see cref="ChildQuery" />. </returns> + public static ChildQuery Child(this ChildQuery node, Func<string> pathFactory) + { + return new ChildQuery(node, pathFactory, node.Client); + } + + /// <summary> + /// Order data by given <see cref="propertyNameFactory" />. Note that this is used mainly for following filtering + /// queries and due to firebase implementation + /// the data may actually not be ordered. + /// </summary> + /// <param name="child"> The child. </param> + /// <param name="propertyNameFactory"> The property name. </param> + /// <returns> The <see cref="OrderQuery" />. </returns> + public static OrderQuery OrderBy(this ChildQuery child, Func<string> propertyNameFactory) + { + return new OrderQuery(child, propertyNameFactory, child.Client); + } + + /// <summary> + /// Order data by $key. Note that this is used mainly for following filtering queries and due to firebase + /// implementation + /// the data may actually not be ordered. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> The <see cref="OrderQuery" />. </returns> + public static OrderQuery OrderByKey(this ChildQuery child) + { + return child.OrderBy("$key"); + } + + /// <summary> + /// Order data by $value. Note that this is used mainly for following filtering queries and due to firebase + /// implementation + /// the data may actually not be ordered. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> The <see cref="OrderQuery" />. </returns> + public static OrderQuery OrderByValue(this ChildQuery child) + { + return child.OrderBy("$value"); + } + + /// <summary> + /// Order data by $priority. Note that this is used mainly for following filtering queries and due to firebase + /// implementation + /// the data may actually not be ordered. + /// </summary> + /// <param name="child"> The child. </param> + /// <returns> The <see cref="OrderQuery" />. </returns> + public static OrderQuery OrderByPriority(this ChildQuery child) + { + return child.OrderBy("$priority"); + } + + /// <summary> + /// Instructs firebase to send data greater or equal to the <see cref="valueFactory" />. This must be preceded by an + /// OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery StartAt(this ParameterQuery child, Func<string> valueFactory) + { + return new FilterQuery(child, () => "startAt", valueFactory, child.Client); + } + + /// <summary> + /// Instructs firebase to send data lower or equal to the <see cref="valueFactory" />. This must be preceded by an + /// OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EndAt(this ParameterQuery child, Func<string> valueFactory) + { + return new FilterQuery(child, () => "endAt", valueFactory, child.Client); + } + + /// <summary> + /// Instructs firebase to send data equal to the <see cref="valueFactory" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child, Func<string> valueFactory) + { + return new FilterQuery(child, () => "equalTo", valueFactory, child.Client); + } + + /// <summary> + /// Instructs firebase to send data greater or equal to the <see cref="valueFactory" />. This must be preceded by an + /// OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery StartAt(this ParameterQuery child, Func<double> valueFactory) + { + return new FilterQuery(child, () => "startAt", valueFactory, child.Client); + } + + /// <summary> + /// Instructs firebase to send data lower or equal to the <see cref="valueFactory" />. This must be preceded by an + /// OrderBy query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EndAt(this ParameterQuery child, Func<double> valueFactory) + { + return new FilterQuery(child, () => "endAt", valueFactory, child.Client); + } + + /// <summary> + /// Instructs firebase to send data equal to the <see cref="valueFactory" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child, Func<double> valueFactory) + { + return new FilterQuery(child, () => "equalTo", valueFactory, child.Client); + } + + /// <summary> + /// Instructs firebase to send data equal to the <see cref="valueFactory" />. This must be preceded by an OrderBy + /// query. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="valueFactory"> Value to start at. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery EqualTo(this ParameterQuery child, Func<bool> valueFactory) + { + return new FilterQuery(child, () => "equalTo", valueFactory, child.Client); + } + + /// <summary> + /// Limits the result to first <see cref="countFactory" /> items. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="countFactory"> Number of elements. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery LimitToFirst(this ParameterQuery child, Func<int> countFactory) + { + return new FilterQuery(child, () => "limitToFirst", () => countFactory(), child.Client); + } + + /// <summary> + /// Limits the result to last <see cref="countFactory" /> items. + /// </summary> + /// <param name="child"> Current node. </param> + /// <param name="countFactory"> Number of elements. </param> + /// <returns> The <see cref="FilterQuery" />. </returns> + public static FilterQuery LimitToLast(this ParameterQuery child, Func<int> countFactory) + { + return new FilterQuery(child, () => "limitToLast", () => countFactory(), child.Client); + } + } +}
\ No newline at end of file diff --git a/dsa/FireBase/Query/SilentQuery.cs b/dsa/FireBase/Query/SilentQuery.cs new file mode 100644 index 0000000..d09d38b --- /dev/null +++ b/dsa/FireBase/Query/SilentQuery.cs @@ -0,0 +1,18 @@ +namespace Firebase.Database.Query +{ + /// <summary> + /// Appends print=silent to the url. + /// </summary> + public class SilentQuery : ParameterQuery + { + public SilentQuery(FirebaseQuery parent, FirebaseClient client) + : base(parent, () => "print", client) + { + } + + protected override string BuildUrlParameter(FirebaseQuery child) + { + return "silent"; + } + } +}
\ No newline at end of file |