Merge pull request #141 from maxmind/horgh/ip-optional

Update for IP being optional

Author: oschwald

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 -------------------
 * The HTTP client now allows up to 20 connections to be active at once.
   Previously the limit was 2. Reported by mjancewicz. GitHub #110.
+* The device IP address is no longer a required input.
 
 1.15.0 (2020-07-09)
 -------------------

README.md

@@ -129,7 +129,6 @@ Checked exceptions:
 ### Insights
 
 ```java
-
 Transaction request = new Transaction.Builder(
         new Device.Builder(InetAddress.getByName("1.1.1.1"))
             .acceptLanguage("en-US")
@@ -231,7 +230,6 @@ Transaction request = new Transaction.Builder(
 
 WebServiceClient client = new WebServiceClient.Builder(6, "ABCD567890").build();
 
-
 System.out.println(client.insights(request));
 ```
 

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

@@ -147,7 +147,6 @@ public WebServiceClient.Builder disableHttps() {
             return this;
         }
 
-
         /**
          * @param val The host to use.
          * @return Builder object
@@ -166,7 +165,6 @@ public WebServiceClient.Builder port(int val) {
             return this;
         }
 
-
         /**
          * @param val List of locale codes to use in name property from most
          *            preferred to least preferred.

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

@@ -35,16 +35,18 @@ public static final class Builder {
         String sessionId;
 
         /**
-         * The constructor for the {@code Device.Builder} class
+         * Constructor for the {@code Device.Builder} class
+         */
+        public Builder() {
+        }
+
+        /**
+         * Constructor for the {@code Device.Builder} class
          *
          * @param ipAddress The IP address associated with the device used
          *                  by the customer in the transaction.
          */
         public Builder(InetAddress ipAddress) {
-            if (ipAddress == null) {
-                throw new IllegalArgumentException("ipAddress must not be null");
-            }
-
             this.ipAddress = ipAddress;
         }
 
@@ -68,6 +70,16 @@ public Device.Builder acceptLanguage(String acceptLanguage) {
             return this;
         }
 
+        /**
+         * @param ipAddress The IP address associated with the device used
+         *                  by the customer in the transaction.
+         * @return The builder object.
+         */
+        public Device.Builder ipAddress(InetAddress ipAddress) {
+            this.ipAddress = ipAddress;
+            return this;
+        }
+
         /**
          * @param sessionAge The number of seconds between the creation of the
          *                   user's session and the time of the transaction.
@@ -139,7 +151,6 @@ public String getSessionId() {
      */
     @JsonProperty("ip_address")
     public InetAddress getIpAddress() {
-
         return ipAddress;
     }
 }

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

@@ -54,14 +54,17 @@ public static class Builder {
         final List<ShoppingCartItem> shoppingCart = new ArrayList<>();
 
         /**
-         * The constructor for {@code Builder}
+         * Constructor for {@code Builder}
+         */
+        public Builder() {
+        }
+
+        /**
+         * Constructor for {@code Builder}
          *
          * @param device The {@code Device} model for the request
          */
         public Builder(Device device) {
-            if (device == null) {
-                throw new IllegalArgumentException("device must not be null");
-            }
             this.device = device;
         }
 
@@ -101,6 +104,15 @@ public Builder customInputs(CustomInputs val) {
             return this;
         }
 
+        /**
+         * @param val The Device object.
+         * @return The builder object.
+         */
+        public Builder device(Device val) {
+            device = val;
+            return this;
+        }
+
         /**
          * @param val The Email object.
          * @return The builder object.

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

@@ -17,11 +17,23 @@ public DeviceTest() throws UnknownHostException {
     }
 
     @Test
-    public void testIpAddress() throws Exception {
+    public void testConstructorWithoutIP() throws Exception {
+        Device device = new Builder().build();
+        assertEquals(null, device.getIpAddress());
+    }
+
+    @Test
+    public void testIpAddressThroughConstructor() throws Exception {
         Device device = new Builder(ip).build();
         assertEquals(ip, device.getIpAddress());
     }
 
+    @Test
+    public void testIpAddress() throws Exception {
+        Device device = new Builder().ipAddress(ip).build();
+        assertEquals(ip, device.getIpAddress());
+    }
+
     @Test
     public void testUserAgent() throws Exception {
         String ua = "Mozila 5";
@@ -36,7 +48,6 @@ public void testAcceptLanguage() throws Exception {
         assertEquals(al, device.getAcceptLanguage());
     }
 
-
     @Test
     public void testSessionAge() throws Exception {
         Double hour = 3600d;

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

@@ -12,6 +12,12 @@ private Transaction.Builder builder() throws UnknownHostException {
         return new Transaction.Builder(new Device.Builder(InetAddress.getByName("152.216.7.110")).build());
     }
 
+    @Test
+    public void testConstructorWithoutDevice() throws Exception {
+        Transaction request = new Transaction.Builder().build();
+        assertEquals(null, request.getDevice());
+    }
+
     @Test
     public void testAccount() throws Exception {
         Transaction request = this.builder().account(new Account.Builder().userId("1").build()).build();
@@ -43,6 +49,19 @@ public void testDevice() throws Exception {
         assertEquals(InetAddress.getByName("152.216.7.110"), request.getDevice().getIpAddress());
     }
 
+    @Test
+    public void testDeviceThroughMethod() throws Exception {
+        InetAddress ip = InetAddress.getByName("152.216.7.110");
+
+        Device device = new Device.Builder().ipAddress(ip).build();
+
+        Transaction request = new Transaction.Builder()
+            .device(device)
+            .build();
+
+        assertEquals(ip, request.getDevice().getIpAddress());
+    }
+
     @Test
     public void testEmail() throws Exception {
         Transaction request = this.builder().email(new Email.Builder().domain("test.com").build()).build();