feat: adding an AdditionalParameters property to specify anything the user may want outside of what is in the current parameters (#125)

Author: JustinCanton

clean-bin-and-obj.bat

@@ -0,0 +1,15 @@
+@Echo Off
+FOR /d /r .\ %%d IN (*) DO (
+	@IF EXIST "%%d" (
+		pushd %%d
+		FOR /d /r %%t IN (bin\, obj\) DO (
+			@IF EXIST "%%t" (
+				ECHO "Removing %%t"
+				rd /s /q "%%t"
+			)
+		)
+		popd
+	)
+)
+
+pause

src/Geo.ArcGIS/Models/Parameters/GeocodingParameters.cs

@@ -12,7 +12,7 @@ namespace Geo.ArcGIS.Models.Parameters
     /// <summary>
     /// A parameters object for the geocoding ArcGIS request.
     /// </summary>
-    public class GeocodingParameters : IClientCredentialsParameters
+    public class GeocodingParameters : IClientCredentialsParameters, IAdditionalParameters
     {
         /// <summary>
         /// Gets a list of address attributes.
@@ -85,5 +85,8 @@ public class GeocodingParameters : IClientCredentialsParameters
 
         /// <inheritdoc/>
         public string ClientSecret { get; set; }
+
+        /// <inheritdoc/>
+        public IDictionary<string, string> AdditionalParameters { get; } = new Dictionary<string, string>();
     }
 }

src/Geo.ArcGIS/Models/Parameters/StorageParameters.cs

@@ -5,10 +5,12 @@
 
 namespace Geo.ArcGIS.Models.Parameters
 {
+    using System.Collections.Generic;
+
     /// <summary>
     /// A parameters object for the storage flag information in ArcGIS request.
     /// </summary>
-    public class StorageParameters
+    public class StorageParameters : IAdditionalParameters
     {
         /// <summary>
         /// Gets or sets a value indicating whether the results of the operation will be persisted.
@@ -31,5 +33,8 @@ public class StorageParameters
         /// (https://developers.arcgis.com/rest/geocode/api-reference/geocoding-free-vs-paid.htm).
         /// </summary>
         public bool ForStorage { get; set; } = false;
+
+        /// <inheritdoc/>
+        public IDictionary<string, string> AdditionalParameters { get; } = new Dictionary<string, string>();
     }
 }

src/Geo.ArcGIS/Models/Parameters/SuggestParameters.cs

@@ -13,7 +13,7 @@ namespace Geo.ArcGIS.Models.Parameters
     /// <summary>
     /// A parameters object for the suggest ArcGIS request.
     /// </summary>
-    public class SuggestParameters
+    public class SuggestParameters : IAdditionalParameters
     {
         /// <summary>
         /// Gets or sets the input text entered by a user, which is used by the suggest operation to generate a list of possible matches.
@@ -65,5 +65,8 @@ public class SuggestParameters
         /// The default value is postal city.
         /// </summary>
         public PreferredLabelValue PreferredLabelValue { get; set; } = PreferredLabelValue.PostalCity;
+
+        /// <inheritdoc/>
+        public IDictionary<string, string> AdditionalParameters { get; } = new Dictionary<string, string>();
     }
 }

src/Geo.ArcGIS/Services/ArcGISGeocoding.cs

@@ -420,6 +420,7 @@ internal async Task<Uri> BuildAddressCandidateRequest(AddressCandidateParameters
             AddStorageParameter(parameters, ref query);
 
             query = await AddArcGISToken(parameters, query, cancellationToken).ConfigureAwait(false);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 
@@ -597,6 +598,7 @@ internal async Task<Uri> BuildPlaceCandidateRequest(PlaceCandidateParameters par
             AddStorageParameter(parameters, ref query);
 
             query = await AddArcGISToken(parameters, query, cancellationToken).ConfigureAwait(false);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 
@@ -686,6 +688,8 @@ internal Task<Uri> BuildSuggestRequest(SuggestParameters parameters, Cancellatio
                 _logger.ArcGISWarning(Resources.Services.ArcGISGeocoding.Invalid_Preferred_Label_Value);
             }
 
+            query = query.AddAdditionalParameters(parameters);
+
             uriBuilder.AddQuery(query);
 
             return Task.FromResult<Uri>(uriBuilder.Uri);
@@ -765,6 +769,7 @@ internal async Task<Uri> BuildReverseGeocodingRequest(ReverseGeocodingParameters
             AddStorageParameter(parameters, ref query);
 
             query = await AddArcGISToken(parameters, query, cancellationToken).ConfigureAwait(false);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 
@@ -884,6 +889,7 @@ internal async Task<Uri> BuildGeocodingRequest(GeocodingParameters parameters, C
             }
 
             query = await AddArcGISToken(parameters, query, cancellationToken).ConfigureAwait(false);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 

src/Geo.Bing/Models/Parameters/BaseParameters.cs

@@ -5,12 +5,13 @@
 
 namespace Geo.Bing.Models.Parameters
 {
+    using System.Collections.Generic;
     using System.Globalization;
 
     /// <summary>
     /// Base parameters across all Bing geocoding APIs.
     /// </summary>
-    public class BaseParameters
+    public class BaseParameters : IAdditionalParameters
     {
         /// <summary>
         /// Gets or sets a value indicating whether or not to include the neighbourhood information.
@@ -34,5 +35,8 @@ public class BaseParameters
         /// Gets or sets the culture to use for the request.
         /// </summary>
         public CultureInfo Culture { get; set; }
+
+        /// <inheritdoc/>
+        public IDictionary<string, string> AdditionalParameters { get; } = new Dictionary<string, string>();
     }
 }

src/Geo.Bing/Services/BingGeocoding.cs

@@ -126,6 +126,7 @@ internal Uri BuildGeocodingRequest(GeocodingParameters parameters)
             BuildLimitedResultQuery(parameters, ref query);
 
             AddBingKey(parameters, ref query);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 
@@ -197,6 +198,7 @@ internal Uri BuildReverseGeocodingRequest(ReverseGeocodingParameters parameters)
             BuildBaseQuery(parameters, ref query);
 
             AddBingKey(parameters, ref query);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 
@@ -272,6 +274,7 @@ internal Uri BuildAddressGeocodingRequest(AddressGeocodingParameters parameters)
             BuildLimitedResultQuery(parameters, ref query);
 
             AddBingKey(parameters, ref query);
+            query = query.AddAdditionalParameters(parameters);
 
             uriBuilder.AddQuery(query);
 

src/Geo.Core/Abstractions/IAdditionalParameters.cs

@@ -0,0 +1,20 @@
+// <copyright file="IAdditionalParameters.cs" company="Geo.NET">
+// Copyright (c) Geo.NET.
+// Licensed under the MIT license. See the LICENSE file in the solution root for full license information.
+// </copyright>
+
+namespace Geo
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Parameters that allow additional key/value pairs to be appended to the request query string.
+    /// </summary>
+    public interface IAdditionalParameters
+    {
+        /// <summary>
+        /// Gets the additional key/value pairs to be appended to the request query string.
+        /// </summary>
+        IDictionary<string, string> AdditionalParameters { get; }
+    }
+}

src/Geo.Core/Extensions/QueryStringExtensions.cs

@@ -0,0 +1,42 @@
+// <copyright file="QueryStringExtensions.cs" company="Geo.NET">
+// Copyright (c) Geo.NET.
+// Licensed under the MIT license. See the LICENSE file in the solution root for full license information.
+// </copyright>
+
+namespace Geo.Core.Extensions
+{
+    using Geo;
+
+    /// <summary>
+    /// Extension methods on the <see cref="QueryString"/> struct.
+    /// </summary>
+    public static class QueryStringExtensions
+    {
+        /// <summary>
+        /// Adds any additional parameters from an <see cref="IAdditionalParameters"/> instance to the <see cref="QueryString"/>.
+        /// Entries with a null value are skipped.
+        /// </summary>
+        /// <param name="query">The <see cref="QueryString"/> to add to.</param>
+        /// <param name="parameters">The <see cref="IAdditionalParameters"/> to read additional key/value pairs from.</param>
+        /// <returns>The <see cref="QueryString"/> with the additional parameters appended.</returns>
+        public static QueryString AddAdditionalParameters(this QueryString query, IAdditionalParameters parameters)
+        {
+            if (parameters?.AdditionalParameters == null)
+            {
+                return query;
+            }
+
+            foreach (var kvp in parameters.AdditionalParameters)
+            {
+                if (kvp.Value == null)
+                {
+                    continue;
+                }
+
+                query = query.Add(kvp.Key, kvp.Value);
+            }
+
+            return query;
+        }
+    }
+}

src/Geo.Google/Models/Parameters/BaseParameters.cs

@@ -5,16 +5,20 @@
 
 namespace Geo.Google.Models.Parameters
 {
+    using System.Collections.Generic;
     using System.Globalization;
 
     /// <summary>
     /// The base parameters shared across all requests.
     /// </summary>
-    public class BaseParameters
+    public class BaseParameters : IAdditionalParameters
     {
         /// <summary>
         /// Gets or sets the language in which to return results.
         /// </summary>
         public CultureInfo Language { get; set; }
+
+        /// <inheritdoc/>
+        public IDictionary<string, string> AdditionalParameters { get; } = new Dictionary<string, string>();
     }
 }