Merge pull request #294 from maxmind/greg/is-anycast

Add support for is_anycast

MaxMind.GeoIP2.UnitTests/DatabaseReaderTests.cs

@@ -137,7 +137,7 @@ public void ConnectionType_ValidResponse()
             using var reader = new DatabaseReader(_connectionTypeDatabaseFile);
             var ipAddress = "1.0.1.0";
             var response = reader.ConnectionType(ipAddress);
-            Assert.Equal("Cable/DSL", response.ConnectionType);
+            Assert.Equal("Cellular", response.ConnectionType);
             Assert.Equal(ipAddress, response.IPAddress);
             Assert.Equal("1.0.1.0/24", response.Network?.ToString());
         }
@@ -174,6 +174,9 @@ public void Enterprise_ValidResponse()
             response = reader.Enterprise("149.101.100.0");
             Assert.Equal("310", response.Traits.MobileCountryCode);
             Assert.Equal("004", response.Traits.MobileNetworkCode);
+
+            response = reader.Enterprise("214.1.1.0");
+            Assert.True(response.Traits.IsAnycast);
         }
 
         [Fact]
@@ -204,6 +207,9 @@ public void Country_ValidResponse()
             Assert.False(response.RegisteredCountry.IsInEuropeanUnion);
             Assert.False(response.RepresentedCountry.IsInEuropeanUnion);
             Assert.Equal("81.2.69.160/27", response.Traits.Network?.ToString());
+
+            response = reader.Country("214.1.1.0");
+            Assert.True(response.Traits.IsAnycast);
         }
 
         [Fact]
@@ -230,6 +236,9 @@ public void City_ValidResponse()
             Assert.False(response.RegisteredCountry.IsInEuropeanUnion);
             Assert.False(response.RepresentedCountry.IsInEuropeanUnion);
             Assert.Equal("81.2.69.160/27", response.Traits.Network?.ToString());
+
+            response = reader.City("214.1.1.0");
+            Assert.True(response.Traits.IsAnycast);
         }
 
         [Fact]

MaxMind.GeoIP2.UnitTests/DeserializationTests.cs

@@ -35,6 +35,7 @@ private static void CanDeserializeCountryResponse(CountryResponse resp)
             Assert.Equal("United Kingdom", resp.RepresentedCountry.Name);
             Assert.Equal("military", resp.RepresentedCountry.Type);
 
+            Assert.True(resp.Traits.IsAnycast);
             Assert.Equal("1.2.3.4", resp.Traits.IPAddress);
         }
 
@@ -100,6 +101,7 @@ private static void CanDeserializeInsightsResponse(InsightsResponse insights)
             Assert.True(insights.Traits.IsAnonymousProxy);
             Assert.True(insights.Traits.IsSatelliteProvider);
 #pragma warning restore 0618
+            Assert.True(insights.Traits.IsAnycast);
             Assert.Equal("Comcast", insights.Traits.Isp);
             Assert.Equal("310", insights.Traits.MobileCountryCode);
             Assert.Equal("004", insights.Traits.MobileNetworkCode);

MaxMind.GeoIP2.UnitTests/ResponseHelper.cs

@@ -64,6 +64,7 @@ internal static class ResponseHelper
                     ""is_anonymous"": true,
                     ""is_anonymous_proxy"": true,
                     ""is_anonymous_vpn"": true,
+                    ""is_anycast"": true,
                     ""is_hosting_provider"": true,
                     ""is_public_proxy"": true,
                     ""is_residential_proxy"": true,
@@ -109,6 +110,7 @@ internal static class ResponseHelper
                 },
                 ""traits"": {
                     ""ip_address"": ""1.2.3.4"",
+                    ""is_anycast"": true,
                     ""network"": ""1.2.3.0/24""
                 }
             }";

MaxMind.GeoIP2.UnitTests/WebServiceClientTests.cs

@@ -413,6 +413,7 @@ public void MissingKeys()
             Assert.False(traits.IsAnonymousProxy);
             Assert.False(traits.IsSatelliteProvider);
 #pragma warning restore 0618
+            Assert.False(traits.IsAnycast);
 
             foreach (var c in new[]
             {

MaxMind.GeoIP2/Model/Traits.cs

@@ -33,6 +33,7 @@ public Traits(
             [Parameter("is_anonymous")] bool isAnonymous = false,
             [Parameter("is_anonymous_proxy")] bool isAnonymousProxy = false,
             [Parameter("is_anonymous_vpn")] bool isAnonymousVpn = false,
+            [Parameter("is_anycast")] bool isAnycast = false,
             [Parameter("is_hosting_provider")] bool isHostingProvider = false,
             [Parameter("is_legitimate_proxy")] bool isLegitimateProxy = false,
             [Parameter("is_public_proxy")] bool isPublicProxy = false,
@@ -59,6 +60,7 @@ public Traits(
             IsAnonymousProxy = isAnonymousProxy;
 #pragma warning restore 618
             IsAnonymousVpn = isAnonymousVpn;
+            IsAnycast = isAnycast;
             IsHostingProvider = isHostingProvider;
             IsLegitimateProxy = isLegitimateProxy;
             IsPublicProxy = isPublicProxy;
@@ -77,6 +79,61 @@ public Traits(
             UserType = userType;
         }
 
+        /// <summary>
+        ///     Constructor for binary compatibility.
+        /// </summary>
+        [Obsolete]
+        public Traits(
+            long? autonomousSystemNumber,
+            string? autonomousSystemOrganization,
+            string? connectionType,
+            string? domain,
+            string? ipAddress,
+            bool isAnonymous,
+            bool isAnonymousProxy,
+            bool isAnonymousVpn,
+            bool isHostingProvider,
+            bool isLegitimateProxy,
+            bool isPublicProxy,
+            bool isResidentialProxy,
+            bool isSatelliteProvider,
+            bool isTorExitNode,
+            string? isp,
+            string? mobileCountryCode,
+            string? mobileNetworkCode,
+            string? organization,
+            string? userType,
+            Network? network,
+            double? staticIPScore,
+            int? userCount
+        ) : this(
+            autonomousSystemNumber,
+            autonomousSystemOrganization,
+            connectionType,
+            domain,
+            ipAddress,
+            isAnonymous,
+            isAnonymousProxy,
+            isAnonymousVpn,
+            false, // isAnycast
+            isHostingProvider,
+            isLegitimateProxy,
+            isPublicProxy,
+            isResidentialProxy,
+            isSatelliteProvider,
+            isTorExitNode,
+            isp,
+            mobileCountryCode,
+            mobileNetworkCode,
+            organization,
+            userType,
+            network,
+            staticIPScore,
+            userCount
+        )
+        {
+        }
+
         /// <summary>
         ///     The
         ///     <a
@@ -153,6 +210,15 @@ public Traits(
         [Obsolete("Use our GeoIP2 Anonymous IP database instead.")]
         public bool IsAnonymousProxy { get; internal set; }
 
+        /// <summary>
+        ///     This is true if the IP address belongs to an <a
+        ///     href="https://en.wikipedia.org/wiki/Anycast">anycast network</a>.
+        ///     This is not available from GeoLite databases or web services.
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyName("is_anycast")]
+        public bool IsAnycast { get; internal set; }
+
         /// <summary>
         ///     This is true if the IP address is registered to an anonymous
         ///     VPN provider.
@@ -372,6 +438,7 @@ public override string ToString()
                 $"{nameof(IsAnonymousProxy)}: {IsAnonymousProxy}, " +
 #pragma warning restore 618
                 $"{nameof(IsAnonymousVpn)}: {IsAnonymousVpn}, " +
+                $"{nameof(IsAnycast)}: {IsAnycast}, " +
                 $"{nameof(IsHostingProvider)}: {IsHostingProvider}, " +
                 $"{nameof(IsLegitimateProxy)}: {IsLegitimateProxy}, " +
                 $"{nameof(IsPublicProxy)}: {IsPublicProxy}, " +

releasenotes.md

@@ -8,6 +8,11 @@ GeoIP2 .NET API Release Notes
   However, if you are using .NET 5.0, the .NET Standard 2.1 target should
   continue working for you.
 * .NET 7.0 and .NET 8.0 have been added as a target.
+* The `IsAnycast` property was added to `MaxMind.GeoIP2.Model.Traits`. This
+  returns `true` if the IP address belongs to an [anycast
+  network](https://en.wikipedia.org/wiki/Anycast). This is available for the
+  GeoIP2 Country, City Plus, and Insights web services and the GeoIP2 Country,
+  City, and Enterprise databases.
 
 5.1.0 (2022-02-04)
 ------------------