Update model classes

This mostly syncs them to the 3.2.0 classes, dropping any breaking
change.

Author: oschwald

CHANGELOG.md

@@ -4,6 +4,8 @@ CHANGELOG
 1.19.0 (2023-11-21)
 -------------------
 
+* Updated model classes with non-breaking changes from the 3.2.0
+  release.
 * Updated Jackson and `geoip2` dependencies.
 
 1.18.0 (2021-08-31)

src/main/java/com/maxmind/minfraud/AbstractModel.java

@@ -1,31 +1,14 @@
 package com.maxmind.minfraud;
 
-import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.databind.MapperFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
-import com.fasterxml.jackson.databind.util.StdDateFormat;
-import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
-
 import java.io.IOException;
 
 public abstract class AbstractModel {
-
     /**
      * @return JSON representation of this object.
      * @throws IOException if there is an error serializing the object to JSON.
      */
     public final String toJson() throws IOException {
-        ObjectMapper mapper = new ObjectMapper();
-        mapper.registerModule(new JavaTimeModule());
-        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
-        mapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
-        mapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
-        mapper.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS);
-        mapper.setDateFormat(new StdDateFormat().withColonInTimeZone(true));
-        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
-
-        return mapper.writeValueAsString(this);
+        return Mapper.get().writeValueAsString(this);
     }
 
     @Override

src/main/java/com/maxmind/minfraud/Mapper.java

@@ -0,0 +1,27 @@
+package com.maxmind.minfraud;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.MapperFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.databind.util.StdDateFormat;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+
+class Mapper {
+    private static final ObjectMapper mapper = JsonMapper.builder()
+        .addModule(new JavaTimeModule())
+        .defaultDateFormat(new StdDateFormat().withColonInTimeZone(true))
+        .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)
+        .disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
+        .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+        .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
+        .serializationInclusion(JsonInclude.Include.NON_NULL)
+        .serializationInclusion(JsonInclude.Include.NON_EMPTY)
+        .build();
+
+    public static ObjectMapper get() {
+        return mapper;
+    }
+}

src/main/java/com/maxmind/minfraud/request/AbstractLocation.java

@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
-
 import java.util.regex.Pattern;
 
 /**
@@ -129,7 +128,8 @@ public final T region(String code) {
          */
         public final T country(String code) {
             if (!COUNTRY_CODE_PATTERN.matcher(code).matches()) {
-                throw new IllegalArgumentException("Expected two-letter country code in the ISO 3166-1 alpha-2 format");
+                throw new IllegalArgumentException(
+                    "Expected two-letter country code in the ISO 3166-1 alpha-2 format");
             }
             country = code;
             return (T) this;

src/main/java/com/maxmind/minfraud/request/Account.java

@@ -2,7 +2,10 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
-import org.apache.commons.codec.digest.DigestUtils;
+import java.math.BigInteger;
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
 
 /**
  * Account related data for the minFraud request
@@ -46,8 +49,15 @@ public Account.Builder userId(String id) {
          * @return The builder object.
          */
         public Account.Builder username(String username) {
-            this.usernameMd5 = DigestUtils.md5Hex(username);
-            return this;
+            try {
+                MessageDigest d = MessageDigest.getInstance("MD5");
+                d.update(username.getBytes(StandardCharsets.UTF_8));
+                BigInteger i = new BigInteger(1, d.digest());
+                this.usernameMd5 = String.format("%032x", i);
+                return this;
+            } catch (NoSuchAlgorithmException e) {
+                throw new RuntimeException("No MD5 algorithm for MessageDigest!", e);
+            }
         }
 
         /**

src/main/java/com/maxmind/minfraud/request/CreditCard.java

@@ -2,29 +2,30 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
-
 import java.util.regex.Pattern;
 
 /**
  * The credit card information for the transaction.
  */
 public final class CreditCard extends AbstractModel {
     private final String issuerIdNumber;
-    private final String last4Digits;
+    private final String lastDigits;
     private final String bankName;
     private final String bankPhoneCountryCode;
     private final String bankPhoneNumber;
+    private final String country;
     private final Character avsResult;
     private final Character cvvResult;
     private final String token;
     private final Boolean was3dSecureSuccessful;
 
     private CreditCard(CreditCard.Builder builder) {
         issuerIdNumber = builder.issuerIdNumber;
-        last4Digits = builder.last4Digits;
+        lastDigits = builder.lastDigits;
         bankName = builder.bankName;
         bankPhoneCountryCode = builder.bankPhoneCountryCode;
         bankPhoneNumber = builder.bankPhoneNumber;
+        country = builder.country;
         avsResult = builder.avsResult;
         cvvResult = builder.cvvResult;
         token = builder.token;
@@ -36,47 +37,53 @@ private CreditCard(CreditCard.Builder builder) {
      * from values set by the builder's methods.
      */
     public static final class Builder {
-        private static final Pattern IIN_PATTERN = Pattern.compile("^[0-9]{6}$");
-        private static final Pattern LAST_4_PATTERN = Pattern.compile("^[0-9]{4}$");
-        private static final Pattern TOKEN_PATTERN = Pattern.compile("^(?![0-9]{1,19}$)[\\x21-\\x7E]{1,255}$");
+        private static final Pattern COUNTRY_CODE_PATTERN = Pattern.compile("^[A-Z]{2}$");
+        private static final Pattern IIN_PATTERN = Pattern.compile("^(?:[0-9]{6}|[0-9]{8})$");
+        private static final Pattern LAST_DIGITS_PATTERN =
+            Pattern.compile("^(?:[0-9]{2}|[0-9]{4})$");
+        private static final Pattern TOKEN_PATTERN =
+            Pattern.compile("^(?![0-9]{1,19}$)[\\x21-\\x7E]{1,255}$");
 
         String issuerIdNumber;
-        String last4Digits;
+        String lastDigits;
         String bankName;
         String bankPhoneCountryCode;
         String bankPhoneNumber;
+        String country;
         String token;
         Character avsResult;
         Character cvvResult;
         Boolean was3dSecureSuccessful;
 
         /**
          * @param number The issuer ID number for the credit card. This is the
-         *               first 6 digits of the credit card number. It
+         *               first 6 or 8 digits of the credit card number. It
          *               identifies the issuing bank.
          * @return The builder object.
          * @throws IllegalArgumentException when number is not a six digit
          *                                  string.
          */
         public CreditCard.Builder issuerIdNumber(String number) {
             if (!IIN_PATTERN.matcher(number).matches()) {
-                throw new IllegalArgumentException("The issuer ID number " + number + " is of the wrong format.");
+                throw new IllegalArgumentException(
+                    "The issuer ID number " + number + " is of the wrong format.");
             }
             issuerIdNumber = number;
             return this;
         }
 
         /**
-         * @param digits The last four digits of the credit card number.
+         * @param digits The last two or four digits of the credit card number.
          * @return The builder object.
-         * @throws IllegalArgumentException when number is not a four digit
+         * @throws IllegalArgumentException when number is not a two or four digit
          *                                  string.
          */
         public CreditCard.Builder last4Digits(String digits) {
-            if (!LAST_4_PATTERN.matcher(digits).matches()) {
-                throw new IllegalArgumentException("The last 4 credit card digits " + digits + " are of the wrong format.");
+            if (!LAST_DIGITS_PATTERN.matcher(digits).matches()) {
+                throw new IllegalArgumentException(
+                    "The last credit card digits " + digits + " are of the wrong format.");
             }
-            last4Digits = digits;
+            lastDigits = digits;
             return this;
         }
 
@@ -109,6 +116,25 @@ public CreditCard.Builder bankPhoneNumber(String number) {
             return this;
         }
 
+        /**
+         * @param code The two character ISO 3166-1 alpha-2 country code where
+         *             the issuer of the card is located. This may be passed
+         *             instead of issuerIdNumber if you do not wish to pass
+         *             partial account numbers, or if your payment processor
+         *             does not provide them.
+         * @return The builder object.
+         * @throws IllegalArgumentException when code is not a two-letter
+         *                                  country code.
+         */
+        public CreditCard.Builder country(String code) {
+            if (!COUNTRY_CODE_PATTERN.matcher(code).matches()) {
+                throw new IllegalArgumentException(
+                    "Expected two-letter country code in the ISO 3166-1 alpha-2 format");
+            }
+            country = code;
+            return this;
+        }
+
         /**
          * @param code The address verification system (AVS) check result, as
          *             returned to you by the credit card processor. The
@@ -145,8 +171,8 @@ public CreditCard.Builder cvvResult(Character code) {
         public CreditCard.Builder token(String token) {
             if (!TOKEN_PATTERN.matcher(token).matches()) {
                 throw new IllegalArgumentException("The credit card token was invalid. "
-                        + "Tokens must be non-space ASCII printable characters. If the "
-                        + "token consists of all digits, it must be more than 19 digits.");
+                    + "Tokens must be non-space ASCII printable characters. If the "
+                    + "token consists of all digits, it must be more than 19 digits.");
             }
             this.token = token;
             return this;
@@ -188,11 +214,11 @@ public String getIssuerIdNumber() {
     }
 
     /**
-     * @return The last 4 digits of the credit card number.
+     * @return The last two or four digits of the credit card number.
      */
     @JsonProperty("last_4_digits")
     public String getLast4Digits() {
-        return last4Digits;
+        return lastDigits;
     }
 
     /**
@@ -221,6 +247,15 @@ public String getBankPhoneNumber() {
         return bankPhoneNumber;
     }
 
+    /**
+     * @return The two character ISO 3166-1 alpha-2 country code where the
+     * issuer of the card is located.
+     */
+    @JsonProperty("country")
+    public String getCountry() {
+        return country;
+    }
+
     /**
      * @return The address verification system (AVS) check result, as
      * returned to you by the credit card processor. The minFraud service
@@ -250,12 +285,12 @@ public String getToken() {
 
     /**
      * @return An indication of whether or not the outcome of 3D-Secure
-     *         verification (e.g. Safekey, SecureCode, Verified by Visa) was
-     *         successful, as provided by the end user. {@code true} if customer
-     *         verification was successful, or {@code false} if the customer
-     *         failed verification. {@code null} if 3-D Secure verification was
-     *         not used, was unavailable, or resulted in another outcome other
-     *         than success or failure.
+     * verification (e.g. Safekey, SecureCode, Verified by Visa) was
+     * successful, as provided by the end user. {@code true} if customer
+     * verification was successful, or {@code false} if the customer
+     * failed verification. {@code null} if 3-D Secure verification was
+     * not used, was unavailable, or resulted in another outcome other
+     * than success or failure.
      */
     @JsonProperty("was_3d_secure_successful")
     public Boolean getWas3dSecureSuccessful() {

src/main/java/com/maxmind/minfraud/request/CustomInputs.java

@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.maxmind.minfraud.AbstractModel;
-
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
@@ -42,10 +41,11 @@ public static class Builder {
          */
         public Builder put(String key, String value) {
             validateKey(key);
-            if (value.length() > 255 || value.contains("\n"))
-                throw new IllegalArgumentException("The custom input string " +
-                        value + " is invalid. The string be less than" +
-                        "256 characters and the string must not contain a newline.");
+            if (value.length() > 255 || value.contains("\n")) {
+                throw new IllegalArgumentException("The custom input string "
+                    + value + " is invalid. The string be less than"
+                    + "256 characters and the string must not contain a newline.");
+            }
             inputs.put(key, value);
             return this;
         }
@@ -63,11 +63,12 @@ public Builder put(String key, String value) {
         public Builder put(String key, Number value) {
             validateKey(key);
             double doubleValue = value.doubleValue();
-            if (doubleValue <= -NUM_MAX || doubleValue >= NUM_MAX)
+            if (doubleValue <= -NUM_MAX || doubleValue >= NUM_MAX) {
                 throw new IllegalArgumentException(
-                        "The custom input number " + value + "is invalid. " +
-                                "The number must be between -" + NUM_MAX +
-                                " and " + NUM_MAX + ", exclusive.");
+                    "The custom input number " + value + "is invalid. "
+                        + "The number must be between -" + NUM_MAX
+                        + " and " + NUM_MAX + ", exclusive.");
+            }
             inputs.put(key, value);
             return this;
         }
@@ -99,7 +100,7 @@ public CustomInputs build() {
         private void validateKey(String key) {
             if (!KEY_PATTERN.matcher(key).matches()) {
                 throw new IllegalArgumentException("The custom input key "
-                        + key + " is invalid.");
+                    + key + " is invalid.");
             }
         }
     }

src/main/java/com/maxmind/minfraud/request/Device.java

@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
-
 import java.net.InetAddress;
 
 /**
@@ -90,7 +89,7 @@ public Device.Builder ipAddress(InetAddress ipAddress) {
          */
         public Device.Builder sessionAge(Double sessionAge) {
             this.sessionAge =
-                    sessionAge;
+                sessionAge;
             return this;
         }