Merge pull request #20 from maxmind/greg/cc-token

Add support for /credit_card/token input

Author: mateu

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+1.2.0
+------------------
+
+* Added `/credit_card/token` input. Use the `token(String)` method on
+  `com.maxmind.minfraud.request.CreditCard.Builder` to set it.
+* All validation regular expressions are now pre-compiled.
+
 1.1.1 (2016-10-12)
 ------------------
 

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

@@ -3,6 +3,8 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
 
+import java.util.regex.Pattern;
+
 /**
  * This class represents the shared location behavior between
  * Billing and Shipping.
@@ -40,6 +42,8 @@ protected AbstractLocation(AbstractLocation.Builder builder) {
      */
     @SuppressWarnings("unchecked")
     abstract static class Builder<T extends AbstractLocation.Builder> {
+        private static final Pattern COUNTRY_CODE_PATTERN = Pattern.compile("^[A-Z]{2}$");
+
         String firstName;
         String lastName;
         String company;
@@ -124,7 +128,7 @@ public final T region(String code) {
          *                                  country code.
          */
         public final T country(String code) {
-            if (!code.matches("[A-Z]{2}")) {
+            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;

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

@@ -3,6 +3,8 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
 
+import java.util.regex.Pattern;
+
 /**
  * The credit card information for the transaction.
  */
@@ -14,6 +16,7 @@ public final class CreditCard extends AbstractModel {
     private final String bankPhoneNumber;
     private final Character avsResult;
     private final Character cvvResult;
+    private final String token;
 
     private CreditCard(CreditCard.Builder builder) {
         issuerIdNumber = builder.issuerIdNumber;
@@ -23,18 +26,24 @@ private CreditCard(CreditCard.Builder builder) {
         bankPhoneNumber = builder.bankPhoneNumber;
         avsResult = builder.avsResult;
         cvvResult = builder.cvvResult;
+        token = builder.token;
     }
 
     /**
      * {@code Builder} creates instances of the parent {@code CreditCard}
      * 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}$");
+
         String issuerIdNumber;
         String last4Digits;
         String bankName;
         String bankPhoneCountryCode;
         String bankPhoneNumber;
+        String token;
         Character avsResult;
         Character cvvResult;
 
@@ -47,7 +56,7 @@ public static final class Builder {
          *                                  string.
          */
         public CreditCard.Builder issuerIdNumber(String number) {
-            if (!number.matches("[0-9]{6}")) {
+            if (!IIN_PATTERN.matcher(number).matches()) {
                 throw new IllegalArgumentException("The issuer ID number " + number + " is of the wrong format.");
             }
             issuerIdNumber = number;
@@ -61,7 +70,7 @@ public CreditCard.Builder issuerIdNumber(String number) {
          *                                  string.
          */
         public CreditCard.Builder last4Digits(String digits) {
-            if (!digits.matches("[0-9]{4}")) {
+            if (!LAST_4_PATTERN.matcher(digits).matches()) {
                 throw new IllegalArgumentException("The last 4 credit card digits " + digits + " are of the wrong format.");
             }
             last4Digits = digits;
@@ -117,6 +126,23 @@ public CreditCard.Builder cvvResult(Character code) {
             return this;
         }
 
+        /**
+         * @param token A token uniquely identifying the card. This should not be
+         *             the actual credit card number.
+         * @return The builder object.
+         * @throws IllegalArgumentException when the token is invalid.
+         *
+         */
+        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.");
+            }
+            this.token = token;
+            return this;
+        }
+
         /**
          * @return An instance of {@code CreditCard} created from the
          * fields set on this builder.
@@ -186,4 +212,12 @@ public Character getAvsResult() {
     public Character getCvvResult() {
         return cvvResult;
     }
+
+    /**
+     * @return A credit card token uniquely identifying the card.
+     */
+    @JsonProperty("token")
+    public String getToken() {
+        return token;
+    }
 }

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

@@ -5,6 +5,7 @@
 
 import java.math.BigDecimal;
 import java.net.URI;
+import java.util.regex.Pattern;
 
 /**
  * The order information for the transaction.
@@ -35,6 +36,8 @@ private Order(Order.Builder builder) {
      * from values set by the builder's methods.
      */
     public static final class Builder {
+        private static final Pattern CURRENCY_CODE_PATTERN = Pattern.compile("^[A-Z]{3}$");
+
         BigDecimal amount;
         String currency;
         String discountCode;
@@ -70,7 +73,7 @@ public Order.Builder amount(Double amount) {
          *                                  three-letter currency code.
          */
         public Order.Builder currency(String code) {
-            if (!code.matches("[A-Z]{3}")) {
+            if (!CURRENCY_CODE_PATTERN.matcher(code).matches()) {
                 throw new IllegalArgumentException("The currency code " + code + " is invalid.");
             }
             currency = code;

src/test/java/com/maxmind/minfraud/request/CreditCardTest.java

@@ -1,10 +1,14 @@
 package com.maxmind.minfraud.request;
 
 import com.maxmind.minfraud.request.CreditCard.Builder;
+import junitparams.JUnitParamsRunner;
+import junitparams.Parameters;
 import org.junit.Test;
+import org.junit.runner.RunWith;
 
 import static org.junit.Assert.assertEquals;
 
+@RunWith(JUnitParamsRunner.class)
 public class CreditCardTest {
 
     @Test
@@ -79,4 +83,26 @@ public void testCvvResult() throws Exception {
         CreditCard cc = new Builder().cvvResult('N').build();
         assertEquals(Character.valueOf('N'), cc.getCvvResult());
     }
+
+    @Test(expected = IllegalArgumentException.class)
+    @Parameters({"4485921507912924",
+            "432312",
+            "this is invalid",
+            "",
+            "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+    })
+    public void testInvalidToken(String token) throws Exception {
+        new Builder().token(token).build();
+    }
+
+    @Test
+    @Parameters({"t4485921507912924",
+            "a7f6%gf83fhAu",
+            "valid_token"
+    })
+    public void testValidToken(String token) throws Exception {
+        CreditCard cc = new Builder().token(token).build();
+        assertEquals(token, cc.getToken());
+    }
+
 }

src/test/java/com/maxmind/minfraud/request/RequestTestHelper.java

@@ -87,6 +87,7 @@ public static Transaction fullTransaction() throws Exception {
                                 .avsResult('Y')
                                 .cvvResult('N')
                                 .last4Digits("7643")
+                                .token("123456abc1234")
                                 .build()
                 ).order(
                         new Order.Builder()

src/test/resources/test-data/full-request.json

@@ -52,7 +52,8 @@
     "bank_phone_country_code": "1",
     "bank_phone_number": "800-342-1232",
     "avs_result": "Y",
-    "cvv_result": "N"
+    "cvv_result": "N",
+    "token": "123456abc1234"
   },
   "order": {
     "amount": 323.21,