Add support for custom inputs

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+1.5.0 (2017-07-07)
+------------------
+
+* Added support for custom inputs. These can be set up from your account portal.
 * Added support for new Device inputs. These are:
     * `/device/session_age`
     * `/device/session_id`

README.md

@@ -206,6 +206,13 @@ Transaction request = new Transaction.Builder(
             .price(3.)
             .quantity(1)
             .build()
+    ).customInputs(
+        new CustomInputs.Builder()
+            .put("float_input", 12.1)
+            .put("integer_input", 3123)
+            .put("string_input", "This is a string input.")
+            .put("boolean_input", true)
+            .build()
     ).build();
 
 WebServiceClient client = new WebServiceClient.Builder(6, "ABCD567890").build();

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

@@ -0,0 +1,114 @@
+package com.maxmind.minfraud.request;
+
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.maxmind.minfraud.AbstractModel;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+/**
+ * Custom inputs to be used in
+ * <a href="https://www.maxmind.com/en/minfraud-interactive/#/custom-rules">Custom Rules</a>.
+ * In order to use custom inputs, you must set them up from your account portal.
+ */
+public final class CustomInputs extends AbstractModel {
+    private final Map<String, Object> inputs;
+
+    private CustomInputs(Builder builder) {
+        inputs = Collections.unmodifiableMap(new HashMap<>(builder.inputs));
+    }
+
+    /**
+     * {@code Builder} creates instances of {@code CustomInputs}
+     * from values set by the builder's methods.
+     */
+    public static class Builder {
+        private static final long NUM_MAX = 1L << 53;
+        private static final Pattern KEY_PATTERN = Pattern.compile("^[a-z0-9_]{1,25}$");
+
+        final Map<String, Object> inputs = new HashMap<>();
+
+        /**
+         * Add a string custom input.
+         *
+         * @param key The key for the custom input as defined on your account
+         *            portal.
+         * @param value The custom input value. Must be less than 256 characters
+         *              and must not contain new lines.
+         * @return The builder object.
+         * @throws IllegalArgumentException when the key or value are invalid.
+         */
+        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.");
+            inputs.put(key, value);
+            return this;
+        }
+
+        /**
+         * Add a numeric custom input.
+         *
+         * @param key The key for the custom input as defined on your account
+         *            portal.
+         * @param value The custom input value. Must be between -2^53 and 2^53,
+         *              exclusive.
+         * @return The builder object.
+         * @throws IllegalArgumentException when the key or value are invalid.
+         */
+        public Builder put(String key, Number value) {
+            validateKey(key);
+            double doubleValue = value.doubleValue();
+            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.");
+            inputs.put(key, value);
+            return this;
+        }
+
+        /**
+         * Add a boolean custom input.
+         *
+         * @param key The key for the custom input as defined on your account
+         *            portal.
+         * @param value The custom input value.
+         * @return The builder object.
+         * @throws IllegalArgumentException when the key or value are invalid.
+         */
+        public Builder put(String key, boolean value) {
+            validateKey(key);
+            inputs.put(key, value);
+            return this;
+        }
+
+        /**
+         * @return An instance of {@code CustomInputs} created from the
+         * fields set on this builder.
+         */
+        public CustomInputs build() {
+            return new CustomInputs(this);
+        }
+
+
+        private void validateKey(String key) {
+            if (!KEY_PATTERN.matcher(key).matches()) {
+                throw new IllegalArgumentException("The custom input key "
+                        + key + " is invalid.");
+            }
+        }
+    }
+
+    /**
+     * @return an unmodifiable map containing the custom inputs.
+     */
+    @JsonAnyGetter
+    public Map<String, Object> getInputs() {
+        return inputs;
+    }
+}

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

@@ -13,6 +13,7 @@ public final class Transaction extends AbstractModel {
     private final Account account;
     private final Billing billing;
     private final CreditCard creditCard;
+    private final CustomInputs customInputs;
     private final Device device;
     private final Email email;
     private final Event event;
@@ -25,6 +26,7 @@ private Transaction(Transaction.Builder builder) {
         account = builder.account;
         billing = builder.billing;
         creditCard = builder.creditCard;
+        customInputs = builder.customInputs;
         device = builder.device;
         email = builder.email;
         event = builder.event;
@@ -42,6 +44,7 @@ public static class Builder {
         Account account;
         Billing billing;
         CreditCard creditCard;
+        CustomInputs customInputs;
         Device device;
         Email email;
         Event event;
@@ -89,6 +92,15 @@ public Builder creditCard(CreditCard val) {
             return this;
         }
 
+        /**
+         * @param val The CustomInputs object.
+         * @return The builder object.
+         */
+        public Builder customInputs(CustomInputs val) {
+            customInputs = val;
+            return this;
+        }
+
         /**
          * @param val The Email object.
          * @return The builder object.
@@ -178,6 +190,14 @@ public CreditCard getCreditCard() {
         return creditCard;
     }
 
+    /**
+     * @return The CustomInputs object.
+     */
+    @JsonProperty("custom_inputs")
+    public CustomInputs getCustomInputs() {
+        return customInputs;
+    }
+
     /**
      * @return The Device object.
      */

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

@@ -0,0 +1,59 @@
+package com.maxmind.minfraud.request;
+
+import org.junit.Test;
+
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+
+public class CustomInputsTest {
+    @Test
+    public void TestPuttingTypes() {
+        Map<String, Object> inputs = new CustomInputs.Builder()
+                .put("string_input_1", "test string")
+                .put("int_input", 19)
+                .put("long_input", 12L)
+                .put("float_input", 3.2f)
+                .put("double_input", 32.123d)
+                .put("bool_input", true)
+                .build().getInputs();
+
+        assertEquals("test string", inputs.get("string_input_1"));
+        assertEquals(19, inputs.get("int_input"));
+        assertEquals(12L, inputs.get("long_input"));
+        assertEquals(3.2f, inputs.get("float_input"));
+        assertEquals(32.123d, inputs.get("double_input"));
+        assertEquals(true, inputs.get("bool_input"));
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testInvalidKey() throws Exception {
+        new CustomInputs.Builder().put("InvalidKey", 1);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testStringThatIsTooLong() throws Exception {
+        new CustomInputs.Builder().put("string",
+                new String(new char[256]).replace('\0', 'x'));
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testStringWithNewLine() throws Exception {
+        new CustomInputs.Builder().put("string", "test\n");
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testTooLargeLong() throws Exception {
+        new CustomInputs.Builder().put("long", 1L << 53);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testTooSmallLong() throws Exception {
+        new CustomInputs.Builder().put("long", -(1L << 53));
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testTooLargeDouble() throws Exception {
+        new CustomInputs.Builder().put("double", (double) (1L << 53));
+    }
+}

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

@@ -116,6 +116,13 @@ public static Transaction fullTransaction() throws Exception {
                                 .quantity(1)
                                 .price(100.)
                                 .build()
+                ).customInputs(
+                        new CustomInputs.Builder()
+                            .put("float_input", 12.1)
+                            .put("integer_input", 3123)
+                            .put("string_input", "This is a string input.")
+                            .put("boolean_input", true)
+                            .build()
                 ).build();
     }
 

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

@@ -29,6 +29,12 @@ public void testCreditCard() throws Exception {
         Transaction request = this.builder().creditCard(new CreditCard.Builder().bankName("name").build()).build();
         assertEquals("name", request.getCreditCard().getBankName());
     }
+    @Test
+    public void testCustomInputs() throws Exception {
+        Transaction request = this.builder().customInputs(
+                new CustomInputs.Builder().put("key", "value").build()).build();
+        assertEquals("value", request.getCustomInputs().getInputs().get("key"));
+    }
 
     @Test
     public void testDevice() throws Exception {

src/test/java/com/maxmind/minfraud/response/DispositionTest.java

@@ -3,8 +3,6 @@
 import com.fasterxml.jackson.jr.ob.JSON;
 import org.junit.Test;
 
-import java.util.UUID;
-
 import static org.junit.Assert.assertEquals;
 
 public class DispositionTest extends AbstractOutputTest {

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

@@ -55,6 +55,12 @@
     "cvv_result": "N",
     "token": "123456abc1234"
   },
+  "custom_inputs": {
+    "float_input": 12.1,
+    "integer_input": 3123,
+    "string_input": "This is a string input.",
+    "boolean_input": true
+  },
   "order": {
     "amount": 323.21,
     "currency": "USD",