Add Priority field to providers to allow more clear ordering.

Author: jakebraun

Kapok.IpToGeolocation.Tests/Kapok.IpToGeolocation.Tests.csproj

@@ -9,7 +9,7 @@
 
     <PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
 
-    <Version>0.0.4-alpha</Version>
+    <Version>0.0.5-alpha</Version>
 
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
 

Kapok.IpToGeolocation.Tests/appsettings.json

@@ -1,35 +1,40 @@
 {
   "IpToGeolocation": {
     "Providers": {
-      "IpRegistry": {
-        "Name": "IpRegistry",
-        "UrlPattern": "https://api.ipregistry.co/{IpAddress}?key={Key}",
-        "PrivateKey": "",
-        "Disabled": true
-      },
       "AbstractApi": {
         "Name": "AbstractApi",
         "UrlPattern": "https://ipgeolocation.abstractapi.com/v1/?api_key={Key}&ip_address={IpAddress}",
         "PrivateKey": "",
-        "Disabled": false
+        "Disabled": false,
+        "Priority": 10
+      },
+      "IpRegistry": {
+        "Name": "IpRegistry",
+        "UrlPattern": "https://api.ipregistry.co/{IpAddress}?key={Key}",
+        "PrivateKey": "",
+        "Disabled": true,
+        "Priority": 20
       },
       "IpStack": {
         "Name": "IpStack",
         "UrlPattern": "http://api.ipstack.com/{IpAddress}?access_key={Key}",
         "PrivateKey": "",
-        "Disabled": true
+        "Disabled": true,
+        "Priority": 30
       },
       "IpGeolocationIo": {
         "Name": "IpGeolocationIo",
         "UrlPattern": "https://api.ipgeolocation.io/ipgeo?apiKey={Key}&ip={IpAddress}",
         "PrivateKey": "",
-        "Disabled": true
+        "Disabled": true,
+        "Priority": 40
       },
       "IpGeolocationApi": {
         "Name": "IpGeolocationApi",
         "UrlPattern": "https://api.ipgeolocationapi.com/geolocate/{IpAddress}",
         "PrivateKey": null,
-        "Disabled": false
+        "Disabled": false,
+        "Priority": 50
       }
     }
   }

Kapok.IpToGeolocation/GeolocationProviderConfiguration.cs

@@ -10,6 +10,7 @@ public class GeolocationProviderConfiguration
 
         public Provider Name { get; set; }
         public bool Disabled { get; set; }
+        public int Priority { get; set; }
         public string? UrlPattern { get; set; }
         public string? PrivateKey { get; set; }
         public string? UrlPatternWithPrivateKey

Kapok.IpToGeolocation/GeolocationService.cs

@@ -42,10 +42,10 @@ public GeolocationService(IConfiguration configuration, HttpClient httpClient, I
         }
 
         private GeolocationProviderConfiguration[] GetProviders()
-            => _configuration.Providers.Values.Where(p => !p.Disabled).ToArray();
+            => _configuration.Providers.Values.Where(p => !p.Disabled).OrderBy(p => p.Priority).ToArray();
 
         private GeolocationProviderConfiguration[] GetProviders(IEnumerable<Provider> providers)
-            => _configuration.Providers.Values.Where(p => !p.Disabled && providers.Contains(p.Name)).ToArray();
+            => _configuration.Providers.Values.Where(p => !p.Disabled && providers.Contains(p.Name)).OrderBy(p => p.Priority).ToArray();
 
         /// <summary>
         /// Create the <see cref="HttpRequestMessage"/> for the first valid and available provider.

Kapok.IpToGeolocation/Kapok.IpToGeolocation.csproj

@@ -7,7 +7,7 @@
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Copyright>Ⓒ Kapok Marketing, Inc. All Rights Reserved.</Copyright>
     <PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
-    <Version>0.0.4-alpha</Version>
+    <Version>0.0.5-alpha</Version>
     <PackageProjectUrl>https://github.com/kapokmarketing/IpToGeolocation</PackageProjectUrl>
     <RepositoryUrl>https://github.com/kapokmarketing/IpToGeolocation</RepositoryUrl>
     <Authors>Kapok Marketing, Inc., Jake Braun</Authors>