Merge pull request #25 from maxmind/oalders/device-and-session-inputs

Add /device/session_age, /device/session_id and /email/first_seen

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+* Added support for new Device inputs. These are:
+    * `/device/session_age`
+    * `/device/session_id`
+* Added support for new Email outputs. These are:
+    * `/email/first_seen`
+
 1.4.0 (2017-02-22)
 ------------------
 

README.md

@@ -119,6 +119,8 @@ Checked exceptions:
 Transaction request = new Transaction.Builder(
         new Device.Builder(InetAddress.getByName("1.1.1.1"))
             .acceptLanguage("en-US")
+            .sessionAge(3600.6)
+            .sessionId("foobar")
             .userAgent("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36")
             .build()
     ).account(

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

@@ -12,11 +12,15 @@ public final class Device extends AbstractModel {
     private final InetAddress ipAddress;
     private final String userAgent;
     private final String acceptLanguage;
+    private final Double sessionAge;
+    private final String sessionId;
 
     private Device(Device.Builder builder) {
         ipAddress = builder.ipAddress;
         userAgent = builder.userAgent;
         acceptLanguage = builder.acceptLanguage;
+        sessionAge = builder.sessionAge;
+        sessionId = builder.sessionId;
     }
 
     /**
@@ -27,6 +31,8 @@ public static final class Builder {
         InetAddress ipAddress;
         String userAgent;
         String acceptLanguage;
+        Double sessionAge;
+        String sessionId;
 
         /**
          * The constructor for the {@code Device.Builder} class
@@ -62,6 +68,28 @@ public Device.Builder acceptLanguage(String acceptLanguage) {
             return this;
         }
 
+        /**
+         * @param sessionAge The number of seconds between the creation of the
+         *                   user's session and the time of the transaction.
+         *                   Note that session_age is not the duration of the
+         *                   current visit, but the time since the start of the
+         *                   first visit.
+         *                   @return The builder object.
+         */
+        public Device.Builder sessionAge(Double sessionAge) { this.sessionAge =
+            sessionAge; return this; }
+
+        /**
+         * @param sessionId A string up to 255 characters in length. This is
+         *                  an ID which uniquely identifies a visitor's
+         *                  session on the site.
+         * @return The builder object.
+         */
+        public Device.Builder sessionId(String sessionId) {
+            this.sessionId = sessionId;
+            return this;
+        }
+
         /**
          * @return An instance of {@code Device} created from the
          * fields set on this builder.
@@ -87,6 +115,22 @@ public String getAcceptLanguage() {
         return acceptLanguage;
     }
 
+    /**
+     * @return The session age.
+     */
+    @JsonProperty("session_age")
+    public Double getSessionAge() {
+        return sessionAge;
+    }
+
+    /**
+     * @return The session id.
+     */
+    @JsonProperty("session_id")
+    public String getSessionId() {
+        return sessionId;
+    }
+
     /**
      * @return The IP address used in the transaction.
      */

src/main/java/com/maxmind/minfraud/response/Email.java

@@ -9,17 +9,27 @@
 public final class Email extends AbstractModel {
     private final Boolean isFree;
     private final Boolean isHighRisk;
+    private final String firstSeen;
 
     public Email(
             @JsonProperty("is_free") Boolean isFree,
-            @JsonProperty("is_high_risk") Boolean isHighRisk
+            @JsonProperty("is_high_risk") Boolean isHighRisk,
+            @JsonProperty("first_seen") String firstSeen
     ) {
         this.isFree = isFree;
         this.isHighRisk = isHighRisk;
+        this.firstSeen = firstSeen;
+    }
+
+    public Email(
+            Boolean isFree,
+            Boolean isHighRisk
+    ) {
+        this(isFree,isHighRisk,null);
     }
 
     public Email() {
-        this(null, null);
+        this(null, null, null);
     }
 
     /**
@@ -37,4 +47,14 @@ public Boolean isFree() {
     public Boolean isHighRisk() {
         return isHighRisk;
     }
+
+    /**
+     * @return A date string (e.g. 2017-04-24) to identify the date an email
+     *         address was first seen by MaxMind. This is expressed using the
+     *         ISO 8601 date format.
+     */
+    @JsonProperty("first_seen")
+    public String getFirstSeen() {
+        return firstSeen;
+    }
 }

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

@@ -35,4 +35,19 @@ public void testAcceptLanguage() throws Exception {
         Device device = new Builder(ip).acceptLanguage(al).build();
         assertEquals(al, device.getAcceptLanguage());
     }
-}
+
+
+    @Test
+    public void testSessionAge() throws Exception {
+        Double hour = 3600d;
+        Device device = new Builder(ip).sessionAge(hour).build();
+        assertEquals(hour, device.getSessionAge());
+    }
+
+    @Test
+    public void testSessionId() throws Exception {
+        String id = "foobar";
+        Device device = new Builder(ip).sessionId(id).build();
+        assertEquals(id, device.getSessionId());
+    }
+}

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

@@ -21,6 +21,8 @@ public static Transaction fullTransaction() throws Exception {
         return new Transaction.Builder(
                 new Device.Builder(InetAddress.getByName("81.2.69.160"))
                         .userAgent("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36")
+                        .sessionAge(3600.5)
+                        .sessionId("foobar")
                         .acceptLanguage("en-US,en;q=0.8")
                         .build()
         )

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

@@ -3,8 +3,10 @@
 import com.fasterxml.jackson.jr.ob.JSON;
 import org.junit.Test;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.assertNull;
 
 public class EmailTest extends AbstractOutputTest {
 
@@ -17,11 +19,31 @@ public void testEmail() throws Exception {
                         .startObject()
                         .put("is_free", false)
                         .put("is_high_risk", true)
+                        .put("first_seen", "2017-01-02")
                         .end()
                         .finish()
         );
 
         assertFalse(email.isFree());
         assertTrue(email.isHighRisk());
+        assertEquals(email.getFirstSeen(),"2017-01-02");
+    }
+
+    @Test
+    public void testEmailWithoutFirstSeen() throws Exception {
+        Email email = this.deserialize(
+                Email.class,
+                JSON.std
+                        .composeString()
+                        .startObject()
+                        .put("is_free", false)
+                        .put("is_high_risk", true)
+                        .end()
+                        .finish()
+        );
+
+        assertFalse(email.isFree());
+        assertTrue(email.isHighRisk());
+        assertNull(email.getFirstSeen());
     }
 }

src/test/resources/test-data/factors-response.json

@@ -120,6 +120,7 @@
     "reason": "custom_rule"
   },
   "email": {
+    "first_seen": "2017-01-02",
     "is_free": true,
     "is_high_risk": true
   },

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

@@ -82,6 +82,8 @@
   "device": {
     "ip_address": "81.2.69.160",
     "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36",
+    "session_age": 3600.5,
+    "session_id": "foobar",
     "accept_language": "en-US,en;q=0.8"
   }
 }

src/test/resources/test-data/insights-response.json

@@ -120,6 +120,7 @@
     "reason": "custom_rule"
   },
   "email": {
+    "first_seen": "2017-01-02",
     "is_free": true,
     "is_high_risk": true
   },