Merge pull request #278 from maxmind/greg/mcc-mnc

Add MCC/MNC support

Author: ugexe

.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        version: [ 8, 9, 10, 11, 12, 13, 14, 15 ]
+        version: [ 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ]
     steps:
       - uses: actions/checkout@v2
         with:

CHANGELOG.md

@@ -1,6 +1,20 @@
 CHANGELOG
 =========
 
+2.16.0
+-------------------
+
+* Support for mobile country code (MCC) and mobile network codes (MNC) was
+ added for the GeoIP2 ISP and Enterprise databases as well as the GeoIP2
+ City and Insights web services. `getMobileCountryCode()` and
+ `getMobileNetworkCode()` were added to `com.maxmind.geoip2.model.IspResponse`
+ for the GeoIP2 ISP database and `com.maxmind.geoip2.record.Traits` for the
+  Enterprise database and the GeoIP2 City and Insights web services. We expect
+  this data to be available by late January, 2022.
+* Deprecated model constructors that exist for backwards compatibility.
+  These constructors are not generally used by users of this library
+  directly except perhaps when mocking the reader in tests.
+
 2.15.0 (2020-10-14)
 -------------------
 

README.md

@@ -532,6 +532,6 @@ The GeoIP2 Java API uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License ##
 
-This software is Copyright (c) 2013-2020 by MaxMind, Inc.
+This software is Copyright (c) 2013-2021 by MaxMind, Inc.
 
 This is free software, licensed under the Apache License, Version 2.0.

src/main/java/com/maxmind/geoip2/WebServiceClient.java

@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.databind.InjectableValues;
 import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.json.JsonMapper;
 import com.maxmind.geoip2.exception.*;
 import com.maxmind.geoip2.model.CityResponse;
 import com.maxmind.geoip2.model.CountryResponse;
@@ -119,9 +120,10 @@ private WebServiceClient(Builder builder) {
         this.licenseKey = builder.licenseKey;
         this.accountId = builder.accountId;
 
-        mapper = new ObjectMapper();
-        mapper.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS);
-        mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
+        mapper = JsonMapper.builder()
+                .disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
+                .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+                .build();
 
         RequestConfig.Builder configBuilder = RequestConfig.custom()
                 .setConnectTimeout(builder.connectTimeout)

src/main/java/com/maxmind/geoip2/model/AbstractResponse.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.json.JsonMapper;
 
 import java.io.IOException;
 
@@ -14,10 +15,12 @@ public abstract class AbstractResponse {
      * @throws IOException if there is an error serializing the object to JSON.
      */
     public String toJson() throws IOException {
-        ObjectMapper mapper = new ObjectMapper();
-        mapper.setSerializationInclusion(Include.NON_NULL);
-        mapper.setSerializationInclusion(Include.NON_EMPTY);
-        mapper.configure(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS, false);
+        JsonMapper mapper = JsonMapper.builder()
+                .disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
+                .serializationInclusion(Include.NON_NULL)
+                .serializationInclusion(Include.NON_EMPTY)
+                .build();
+
         return mapper.writeValueAsString(this);
     }
 

src/main/java/com/maxmind/geoip2/model/AnonymousIpResponse.java

@@ -28,7 +28,11 @@ public class AnonymousIpResponse extends AbstractResponse {
         this(null, false, false, false, false, false);
     }
 
-    // This is for compatibility and should be removed if we do a major release.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
     public AnonymousIpResponse(
             String ipAddress,
             boolean isAnonymous,
@@ -40,7 +44,11 @@ public AnonymousIpResponse(
         this(ipAddress, isAnonymous, isAnonymousVpn, isHostingProvider, isPublicProxy, isTorExitNode, null);
     }
 
-    // This is for compatibility and should be removed if we do a major release.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
     public AnonymousIpResponse(
             String ipAddress,
             boolean isAnonymous,

src/main/java/com/maxmind/geoip2/model/AsnResponse.java

@@ -24,6 +24,11 @@ public class AsnResponse extends AbstractResponse {
         this((Integer) null, null, null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
     public AsnResponse(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,

src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java

@@ -68,6 +68,11 @@ public static ConnectionType fromString(String s) {
         this(null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
     public ConnectionTypeResponse(
             ConnectionType connectionType,
             String ipAddress

src/main/java/com/maxmind/geoip2/model/DomainResponse.java

@@ -23,6 +23,11 @@ public class DomainResponse extends AbstractResponse {
         this(null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
     public DomainResponse(
             String domain,
             String ipAddress

src/main/java/com/maxmind/geoip2/model/IspResponse.java

@@ -15,11 +15,18 @@ public class IspResponse extends AsnResponse {
 
     private final String isp;
     private final String organization;
+    private final String mobileCountryCode;
+    private final String mobileNetworkCode;
 
     IspResponse() {
         this(null, null, null, null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
     public IspResponse(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,
@@ -30,16 +37,52 @@ public IspResponse(
         this(autonomousSystemNumber, autonomousSystemOrganization, ipAddress, isp, organization, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
+    public IspResponse(
+            Integer autonomousSystemNumber,
+            String autonomousSystemOrganization,
+            String ipAddress,
+            String isp,
+            String organization,
+            Network network
+    ) {
+        this(autonomousSystemNumber, autonomousSystemOrganization, ipAddress, isp, null, null, organization, network);
+    }
+
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
+    @Deprecated
+    public IspResponse(
+            Long autonomousSystemNumber,
+            String autonomousSystemOrganization,
+            String ipAddress,
+            String isp,
+            String organization,
+            Network network
+    ) {
+        this(autonomousSystemNumber, autonomousSystemOrganization, ipAddress, isp, null, null, organization, network);
+    }
+
     public IspResponse(
             @JsonProperty("autonomous_system_number") Integer autonomousSystemNumber,
             @JsonProperty("autonomous_system_organization") String autonomousSystemOrganization,
             @JacksonInject("ip_address") @JsonProperty("ip_address") String ipAddress,
             @JsonProperty("isp") String isp,
+            @JsonProperty("mobile_country_code") String mobileCountryCode,
+            @JsonProperty("mobile_network_code") String mobileNetworkCode,
             @JsonProperty("organization") String organization,
             @JacksonInject("network") @JsonProperty("network") @JsonDeserialize(using = NetworkDeserializer.class) Network network
     ) {
         super(autonomousSystemNumber, autonomousSystemOrganization, ipAddress, network);
         this.isp = isp;
+        this.mobileCountryCode = mobileCountryCode;
+        this.mobileNetworkCode = mobileNetworkCode;
         this.organization = organization;
     }
 
@@ -49,6 +92,8 @@ public IspResponse(
             @MaxMindDbParameter(name="autonomous_system_organization") String autonomousSystemOrganization,
             @MaxMindDbParameter(name="ip_address") String ipAddress,
             @MaxMindDbParameter(name="isp") String isp,
+            @MaxMindDbParameter(name="mobile_country_code") String mobileCountryCode,
+            @MaxMindDbParameter(name="mobile_network_code") String mobileNetworkCode,
             @MaxMindDbParameter(name="organization") String organization,
             @MaxMindDbParameter(name="network") Network network
     ) {
@@ -57,6 +102,8 @@ public IspResponse(
             autonomousSystemOrganization,
             ipAddress,
             isp,
+            mobileCountryCode,
+            mobileNetworkCode,
             organization,
             network
         );
@@ -72,6 +119,8 @@ public IspResponse(
             response.getAutonomousSystemOrganization(),
             ipAddress,
             response.getIsp(),
+            response.getMobileCountryCode(),
+            response.getMobileNetworkCode(),
             response.getOrganization(),
             network
         );
@@ -84,6 +133,26 @@ public String getIsp() {
         return this.isp;
     }
 
+    /**
+     * @return The <a href="https://en.wikipedia.org/wiki/Mobile_country_code">
+     * mobile country code (MCC)</a> associated with the IP address and ISP.
+     * This property is available from the City and Insights web services and
+     * the GeoIP2 Enterprise database.
+     */
+    public String getMobileCountryCode() {
+        return this.mobileCountryCode;
+    }
+
+    /**
+     * @return The <a href="https://en.wikipedia.org/wiki/Mobile_country_code">
+     * mobile network code (MNC)</a> associated with the IP address and ISP.
+     * This property is available from the City and Insights web services and
+     * the GeoIP2 Enterprise database.
+     */
+    public String getMobileNetworkCode() {
+        return this.mobileNetworkCode;
+    }
+
     /**
      * @return The name of the organization associated with the IP address.
      */