Add support for /email/domain/first_seen

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+1.12.0
+-------------------
+
+* Added support for the new email output `/email/domain/first_seen` This can
+  be accessed via `response.getEmail().getDomain().getFirstSeen()`.
+
 1.11.0 (2020-02-21)
 -------------------
 

pom.xml

@@ -47,13 +47,18 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.10.2</version>
+            <version>2.10.3</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>
             <version>2.10.3</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+            <version>2.10.3</version>
+        </dependency>
         <dependency>
             <groupId>com.maxmind.geoip2</groupId>
             <artifactId>geoip2</artifactId>

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

@@ -5,6 +5,7 @@
 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;
 
@@ -16,12 +17,13 @@ public abstract class AbstractModel {
      */
     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.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
+        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
 
         return mapper.writeValueAsString(this);
     }

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

@@ -7,6 +7,7 @@
 import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.util.StdDateFormat;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import com.maxmind.minfraud.exception.*;
 import com.maxmind.minfraud.request.Transaction;
 import com.maxmind.minfraud.response.FactorsResponse;
@@ -62,6 +63,7 @@ private WebServiceClient(WebServiceClient.Builder builder) {
         mapper = new ObjectMapper();
         mapper.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS);
         mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
+        mapper.registerModule(new JavaTimeModule());
         mapper.setDateFormat(new StdDateFormat().withColonInTimeZone(true));
 
         RequestConfig.Builder configBuilder = RequestConfig.custom()

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

@@ -11,13 +11,16 @@ public final class Email extends AbstractModel {
     private final Boolean isFree;
     private final Boolean isHighRisk;
     private final String firstSeen;
+    private final EmailDomain domain;
 
     public Email(
+            @JsonProperty("domain") EmailDomain domain,
             @JsonProperty("is_disposable") Boolean isDisposable,
             @JsonProperty("is_free") Boolean isFree,
             @JsonProperty("is_high_risk") Boolean isHighRisk,
             @JsonProperty("first_seen") String firstSeen
     ) {
+        this.domain = domain;
         this.isDisposable = isDisposable;
         this.isFree = isFree;
         this.isHighRisk = isHighRisk;
@@ -26,6 +29,15 @@ public Email(
 
     // The following constructors are for backward compatibility and
     // can be removed as part of a major release
+    public Email(
+            Boolean isDisposable,
+            Boolean isFree,
+            Boolean isHighRisk,
+            String firstSeen
+    ) {
+        this(null, isDisposable, isFree, isHighRisk, firstSeen);
+    }
+
     public Email(
             Boolean isFree,
             Boolean isHighRisk,
@@ -45,6 +57,12 @@ public Email() {
         this(null, null, null);
     }
 
+    /**
+     * @return The {@code EmailDomain} model object.
+     */
+    public EmailDomain getDomain() {
+        return domain;
+    }
 
     /**
      * @return Whether the email address is from a disposable email provider.

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

@@ -0,0 +1,28 @@
+package com.maxmind.minfraud.response;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.maxmind.minfraud.AbstractModel;
+
+import java.time.LocalDate;
+
+/**
+ * This class contains minFraud response data related to the email domain.
+ */
+public final class EmailDomain extends AbstractModel {
+    private final LocalDate firstSeen;
+
+    public EmailDomain(
+            @JsonProperty("first_seen") LocalDate firstSeen
+    ) {
+        this.firstSeen = firstSeen;
+    }
+
+    /**
+     * @return A date to identify the date an email domain was first
+     * seen by MaxMind.
+     */
+    @JsonProperty("first_seen")
+    public LocalDate getFirstSeen() {
+        return firstSeen;
+    }
+}

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

@@ -1,19 +1,26 @@
 package com.maxmind.minfraud.response;
 
+import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.InjectableValues;
 import com.fasterxml.jackson.databind.InjectableValues.Std;
+import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.util.StdDateFormat;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
 import java.io.IOException;
 import java.util.Collections;
 
 public abstract class AbstractOutputTest {
 
     <T> T deserialize(Class<T> cls, String json) throws IOException {
-        ObjectMapper mapper = new ObjectMapper();
+        ObjectMapper         mapper = new ObjectMapper();
+        mapper.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS);
+        mapper.enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
+        mapper.registerModule(new JavaTimeModule());
+        mapper.setDateFormat(new StdDateFormat().withColonInTimeZone(true));
         InjectableValues inject = new Std().addValue(
                 "locales", Collections.singletonList("en"));
         return mapper.readerFor(cls).with(inject).readValue(json);
     }
-
 }

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

@@ -0,0 +1,26 @@
+package com.maxmind.minfraud.response;
+
+import com.fasterxml.jackson.jr.ob.JSON;
+import org.junit.Test;
+
+import java.time.LocalDate;
+
+import static org.junit.Assert.*;
+
+public class EmailDomainTest extends AbstractOutputTest {
+
+    @Test
+    public void testEmailDomain() throws Exception {
+        EmailDomain domain = this.deserialize(
+                EmailDomain.class,
+                JSON.std
+                        .composeString()
+                        .startObject()
+                        .put("first_seen", "2014-02-03")
+                        .end()
+                        .finish()
+        );
+
+        assertEquals(LocalDate.parse("2014-02-03"), domain.getFirstSeen());
+    }
+}

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

@@ -3,6 +3,8 @@
 import com.fasterxml.jackson.jr.ob.JSON;
 import org.junit.Test;
 
+import java.time.LocalDate;
+
 import static org.junit.Assert.*;
 
 public class EmailTest extends AbstractOutputTest {
@@ -14,6 +16,9 @@ public void testEmail() throws Exception {
                 JSON.std
                         .composeString()
                         .startObject()
+                        .startObjectField("domain")
+                        .put("first_seen", "2014-02-03")
+                        .end()
                         .put("is_disposable", false)
                         .put("is_free", false)
                         .put("is_high_risk", true)
@@ -22,6 +27,7 @@ public void testEmail() throws Exception {
                         .finish()
         );
 
+        assertEquals(LocalDate.parse("2014-02-03"), email.getDomain().getFirstSeen());
         assertFalse(email.isDisposable());
         assertFalse(email.isFree());
         assertTrue(email.isHighRisk());

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

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.jr.ob.JSON;
 import org.junit.Test;
 
+import java.time.LocalDate;
 import java.util.UUID;
 
 import static org.junit.Assert.assertEquals;
@@ -21,6 +22,11 @@ public void testInsights() throws Exception {
                         .startObjectField("disposition")
                         .put("action", "accept")
                         .end()
+                        .startObjectField("email")
+                        .startObjectField("domain")
+                        .put("first_seen", "2014-02-03")
+                        .end()
+                        .end()
                         .startObjectField("ip_address")
                         .startObjectField("country")
                         .put("iso_code", "US")
@@ -53,6 +59,7 @@ public void testInsights() throws Exception {
         );
 
         assertEquals("disposition", "accept", insights.getDisposition().getAction());
+        assertEquals("email domain first seen", LocalDate.parse("2014-02-03"), insights.getEmail().getDomain().getFirstSeen());
         assertEquals("correct country ISO", "US", insights.getIpAddress().getCountry().getIsoCode());
         assertTrue("correct credit card prepaid", insights.getCreditCard().isPrepaid());
         assertTrue("correct shipping address is in IP country", insights.getShippingAddress().isInIpCountry());