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

Add support for is_anycast

CHANGELOG.md

@@ -12,6 +12,11 @@ CHANGELOG
   the `JsonCreator` annotation so that it is used when deserializing.
   This will prevent new additions in the future from causing a
   deserialization error.
+* The `isAnycast()` method was added to `com.maxmind.geoip2.record.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.
 
 4.1.0 (2023-07-28)
 ------------------

src/main/java/com/maxmind/geoip2/record/Traits.java

@@ -24,6 +24,7 @@ public final class Traits extends AbstractRecord {
     private final boolean isAnonymous;
     private final boolean isAnonymousProxy;
     private final boolean isAnonymousVpn;
+    private final boolean isAnycast;
     private final boolean isHostingProvider;
     private final boolean isLegitimateProxy;
     private final boolean isPublicProxy;
@@ -41,14 +42,14 @@ public final class Traits extends AbstractRecord {
 
     public Traits() {
         this(null, null, null, null,
-            null, false, false, false, false,
+            null, false, false, false, false, false,
             false, false, false, false, false, null,
             null, null, null, null, null, null, null);
     }
 
     public Traits(String ipAddress, Network network) {
         this(null, null, null, null,
-            ipAddress, false, false, false, false,
+            ipAddress, false, false, false, false, false,
             false, false, false, false, false, null,
             null, null, network, null, null, null, null);
     }
@@ -62,6 +63,7 @@ public Traits(
         @JsonProperty("is_anonymous") boolean isAnonymous,
         @JsonProperty("is_anonymous_proxy") boolean isAnonymousProxy,
         @JsonProperty("is_anonymous_vpn") boolean isAnonymousVpn,
+        @JsonProperty("is_anycast") boolean isAnycast,
         @JsonProperty("is_hosting_provider") boolean isHostingProvider,
         @JsonProperty("is_legitimate_proxy") boolean isLegitimateProxy,
         @JsonProperty("is_public_proxy") boolean isPublicProxy,
@@ -86,6 +88,7 @@ public Traits(
         this.isAnonymous = isAnonymous;
         this.isAnonymousProxy = isAnonymousProxy;
         this.isAnonymousVpn = isAnonymousVpn;
+        this.isAnycast = isAnycast;
         this.isHostingProvider = isHostingProvider;
         this.isLegitimateProxy = isLegitimateProxy;
         this.isPublicProxy = isPublicProxy;
@@ -113,6 +116,7 @@ public Traits(
         @MaxMindDbParameter(name = "is_anonymous") Boolean isAnonymous,
         @MaxMindDbParameter(name = "is_anonymous_proxy") Boolean isAnonymousProxy,
         @MaxMindDbParameter(name = "is_anonymous_vpn") Boolean isAnonymousVpn,
+        @MaxMindDbParameter(name = "is_anycast") Boolean isAnycast,
         @MaxMindDbParameter(name = "is_hosting_provider") Boolean isHostingProvider,
         @MaxMindDbParameter(name = "is_legitimate_proxy") Boolean isLegitimateProxy,
         @MaxMindDbParameter(name = "is_public_proxy") Boolean isPublicProxy,
@@ -136,6 +140,7 @@ public Traits(
         this.isAnonymous = isAnonymous != null ? isAnonymous : false;
         this.isAnonymousProxy = isAnonymousProxy != null ? isAnonymousProxy : false;
         this.isAnonymousVpn = isAnonymousVpn != null ? isAnonymousVpn : false;
+        this.isAnycast = isAnycast != null ? isAnycast : false;
         this.isHostingProvider = isHostingProvider != null ? isHostingProvider : false;
         this.isLegitimateProxy = isLegitimateProxy != null ? isLegitimateProxy : false;
         this.isPublicProxy = isPublicProxy != null ? isPublicProxy : false;
@@ -152,6 +157,110 @@ public Traits(
         this.staticIpScore = staticIpScore;
     }
 
+    @Deprecated
+    public Traits(
+        Long autonomousSystemNumber,
+        String autonomousSystemOrganization,
+        ConnectionType connectionType,
+        String domain,
+        String ipAddress,
+        boolean isAnonymous,
+        boolean isAnonymousProxy,
+        boolean isAnonymousVpn,
+        boolean isHostingProvider,
+        boolean isLegitimateProxy,
+        boolean isPublicProxy,
+        boolean isResidentialProxy,
+        boolean isSatelliteProvider,
+        boolean isTorExitNode,
+        String isp,
+        String mobileCountryCode,
+        String mobileNetworkCode,
+        Network network,
+        String organization,
+        String userType,
+        Integer userCount,
+        Double staticIpScore
+    ) {
+        this(
+            autonomousSystemNumber,
+            autonomousSystemOrganization,
+            connectionType,
+            domain,
+            ipAddress,
+            isAnonymous,
+            isAnonymousProxy,
+            isAnonymousVpn,
+            false, // isAnycast
+            isHostingProvider,
+            isLegitimateProxy,
+            isPublicProxy,
+            isResidentialProxy,
+            isSatelliteProvider,
+            isTorExitNode,
+            isp,
+            mobileCountryCode,
+            mobileNetworkCode,
+            network,
+            organization,
+            userType,
+            userCount,
+            staticIpScore
+        );
+    }
+
+    @Deprecated
+    public Traits(
+        Long autonomousSystemNumber,
+        String autonomousSystemOrganization,
+        String connectionType,
+        String domain,
+        String ipAddress,
+        Boolean isAnonymous,
+        Boolean isAnonymousProxy,
+        Boolean isAnonymousVpn,
+        Boolean isHostingProvider,
+        Boolean isLegitimateProxy,
+        Boolean isPublicProxy,
+        Boolean isResidentialProxy,
+        Boolean isSatelliteProvider,
+        Boolean isTorExitNode,
+        String isp,
+        String mobileCountryCode,
+        String mobileNetworkCode,
+        Network network,
+        String organization,
+        String userType,
+        Integer userCount,
+        Double staticIpScore
+    ) {
+        this(
+            autonomousSystemNumber,
+            autonomousSystemOrganization,
+            connectionType,
+            domain,
+            ipAddress,
+            isAnonymous,
+            isAnonymousProxy,
+            isAnonymousVpn,
+            false, // isAnycast
+            isHostingProvider,
+            isLegitimateProxy,
+            isPublicProxy,
+            isResidentialProxy,
+            isSatelliteProvider,
+            isTorExitNode,
+            isp,
+            mobileCountryCode,
+            mobileNetworkCode,
+            network,
+            organization,
+            userType,
+            userCount,
+            staticIpScore
+        );
+    }
+
     public Traits(
         Traits traits,
         String ipAddress,
@@ -166,6 +275,7 @@ public Traits(
             traits.isAnonymous(),
             traits.isAnonymousProxy(),
             traits.isAnonymousVpn(),
+            traits.isAnycast(),
             traits.isHostingProvider(),
             traits.isLegitimateProxy(),
             traits.isPublicProxy(),
@@ -303,6 +413,16 @@ public boolean isAnonymousVpn() {
         return this.isAnonymousVpn;
     }
 
+    /**
+     * @return 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.
+     */
+    @JsonProperty("is_anycast")
+    public boolean isAnycast() {
+        return this.isAnycast;
+    }
+
     /**
      * @return This is true if the IP address belongs to a hosting or
      * VPN provider (see description of isAnonymousVpn). This is only

src/test/java/com/maxmind/geoip2/DatabaseReaderTest.java

@@ -273,6 +273,10 @@ public void testCity() throws Exception {
             CityResponse tryResponse = reader.tryCity(ipAddress).get();
             assertEquals(response.toJson(), tryResponse.toJson());
 
+            // This IP has is_anycast
+            response = reader.city(InetAddress.getByName("214.1.1.0"));
+            assertTrue(response.getTraits().isAnycast());
+
             // Test that the methods can be called on DB without
             // an exception
             reader.country(ipAddress);
@@ -313,6 +317,10 @@ public void testCountry() throws Exception {
 
             CountryResponse tryResponse = reader.tryCountry(ipAddress).get();
             assertEquals(response.toJson(), tryResponse.toJson());
+
+            // This IP has is_anycast
+            response = reader.country(InetAddress.getByName("214.1.1.0"));
+            assertTrue(response.getTraits().isAnycast());
         }
     }
 
@@ -357,6 +365,10 @@ public void testEnterprise() throws Exception {
             assertEquals("310", response.getTraits().getMobileCountryCode());
             assertEquals("004", response.getTraits().getMobileNetworkCode());
 
+            // This IP has is_anycast
+            response = reader.enterprise(InetAddress.getByName("214.1.1.0"));
+            assertTrue(response.getTraits().isAnycast());
+
             // Test that the city and country methods can be called without
             // an exception
             reader.city(ipAddress);

src/test/java/com/maxmind/geoip2/WebServiceClientTest.java

@@ -141,6 +141,7 @@ public void test200WithDefaultValues() throws Exception {
         assertNull(traits.getStaticIpScore());
         assertNull(traits.getUserCount());
         assertFalse(traits.isAnonymousProxy());
+        assertFalse(traits.isAnycast());
         assertFalse(traits.isSatelliteProvider());
 
         for (Country c : new Country[] {country, registeredCountry,

src/test/java/com/maxmind/geoip2/model/JsonTest.java

@@ -38,6 +38,7 @@ public void testInsightsSerialization() throws IOException {
             .put("is_anonymous", true)
             .put("is_anonymous_proxy", true)
             .put("is_anonymous_vpn", true)
+            .put("is_anycast", true)
             .put("is_hosting_provider", true)
             .put("is_legitimate_proxy", true)
             .put("is_public_proxy", true)
@@ -144,6 +145,7 @@ public void testCitySerialization() throws IOException {
             // difference
             .put("is_anonymous", false)
             .put("is_anonymous_vpn", false)
+            .put("is_anycast", true)
             .put("is_hosting_provider", false)
             .put("is_legitimate_proxy", false)
             .put("is_public_proxy", false)
@@ -232,6 +234,7 @@ public void testCountrySerialization() throws IOException {
             // difference
             .put("is_anonymous", false)
             .put("is_anonymous_vpn", false)
+            .put("is_anycast", true)
             .put("is_hosting_provider", false)
             .put("is_legitimate_proxy", false)
             .put("is_public_proxy", false)
@@ -349,5 +352,4 @@ public void testIspSerialization() throws Exception {
 
         assertEquals(expectedNode, actualNode);
     }
-
 }

src/test/resources/test-data/insights0.json

@@ -76,6 +76,7 @@
     "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,
@@ -86,4 +87,4 @@
     "user_count": 2,
     "user_type": "college"
   }
-}
+}

src/test/resources/test-data/insights1.json

@@ -92,6 +92,7 @@
     "is_anonymous": true,
     "is_anonymous_proxy": true,
     "is_anonymous_vpn": true,
+    "is_anycast": true,
     "is_hosting_provider": true,
     "is_public_proxy": true,
     "is_satellite_provider": true,
@@ -101,4 +102,4 @@
     "user_count": 2,
     "user_type": "college"
   }
-}
+}