Merge pull request #101 from maxmind/greg/email-domain-first-seen

Support /email/domain/first_seen and use Java 8 time types throughout

Author: horgh

CHANGELOG.md

@@ -1,6 +1,18 @@
 CHANGELOG
 =========
 
+1.12.0
+-------------------
+
+* Added support for the new email output `/email/domain/first_seen` This can
+  be accessed via `response.getEmail().getDomain().getFirstSeen()`.
+* Added `Device.getLastSeenDateTime()`, `Device.getLocalDateTime()`,
+  `Email.getFirstSeenDate()`, and `GeoIp2Location.getLocalDateTime()` methods
+  that return `java.time` objects rather than strings.
+* The request event time is now stored internally as a `ZonedDateTime`. An
+  `Event.Builder.time(ZonedDateTime)` method was also added to the event
+  builder.
+
 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/request/Event.java

@@ -1,15 +1,18 @@
 package com.maxmind.minfraud.request;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
 
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
 import java.util.Date;
 
 public final class Event extends AbstractModel {
 
     private final String transactionId;
     private final String shopId;
-    private final Date time;
+    private final ZonedDateTime time;
     private final Type type;
 
     private Event(Event.Builder builder) {
@@ -26,7 +29,7 @@ private Event(Event.Builder builder) {
     public static final class Builder {
         String transactionId;
         String shopId;
-        Date time;
+        ZonedDateTime time;
         Type type;
 
         /**
@@ -58,7 +61,16 @@ public Event.Builder shopId(String id) {
          * @return The builder object.
          */
         public Event.Builder time(Date date) {
-            time = new Date(date.getTime());
+            time = date.toInstant().atZone(ZoneId.systemDefault());
+            return this;
+        }
+
+        /**
+         * @param date The date and time the event occurred.
+         * @return The builder object.
+         */
+        public Event.Builder time(ZonedDateTime date) {
+            time = date;
             return this;
         }
 
@@ -99,8 +111,16 @@ public String getShopId() {
     /**
      * @return The date and time of the event.
      */
-    @JsonProperty("time")
+    @JsonIgnore
     public Date getTime() {
+        return Date.from(time.toInstant());
+    }
+
+    /**
+     * @return The date and time of the event.
+     */
+    @JsonProperty("time")
+    public ZonedDateTime getDateTime() {
         return time;
     }
 

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

@@ -1,8 +1,10 @@
 package com.maxmind.minfraud.response;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
 
+import java.time.ZonedDateTime;
 import java.util.UUID;
 
 /**
@@ -73,6 +75,18 @@ public String getLastSeen() {
         return lastSeen;
     }
 
+    /**
+     * @return The date and time of the last sighting of the device as a
+     * {@code ZonedDateTime}.
+     */
+    @JsonIgnore
+    public ZonedDateTime getLastSeenDateTime() {
+        if (lastSeen == null) {
+            return null;
+        }
+        return ZonedDateTime.parse(lastSeen);
+    }
+
     /**
      * @return The date and time of the transaction at the UTC offset
      * associated with the device. This is an RFC 3339 date-time.
@@ -81,4 +95,16 @@ public String getLastSeen() {
     public String getLocalTime() {
         return localTime;
     }
+
+    /**
+     * @return The date and time of the transaction at the UTC offset
+     * associated with the device as a {@code ZonedDateTime}.
+     */
+    @JsonIgnore
+    public ZonedDateTime getLocalDateTime() {
+        if (localTime == null) {
+            return null;
+        }
+        return ZonedDateTime.parse(localTime);
+    }
 }

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

@@ -1,8 +1,11 @@
 package com.maxmind.minfraud.response;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 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 address.
  */
@@ -11,13 +14,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 +32,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 +60,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.
@@ -84,4 +105,16 @@ public Boolean isHighRisk() {
     public String getFirstSeen() {
         return firstSeen;
     }
+
+    /**
+     * @return A date to identify the date an email address was first seen by
+     * MaxMind.
+     */
+    @JsonIgnore
+    public LocalDate getFirstSeenDate() {
+        if (firstSeen == null) {
+            return null;
+        }
+        return LocalDate.parse(firstSeen);
+    }
 }

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/main/java/com/maxmind/minfraud/response/GeoIp2Location.java

@@ -1,8 +1,11 @@
 package com.maxmind.minfraud.response;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.geoip2.record.Location;
 
+import java.time.ZonedDateTime;
+
 /**
  * This class contains minFraud response data related to the GeoIP2 Insights
  * location.
@@ -38,4 +41,16 @@ public GeoIp2Location() {
     public String getLocalTime() {
         return this.localTime;
     }
+
+    /**
+     * @return The date and time of the transaction in the time zone associated
+     * with the IP address as a {@code ZonedDateTime}.
+     */
+    @JsonIgnore
+    public ZonedDateTime getLocalDateTime() {
+        if (localTime == null) {
+            return null;
+        }
+        return ZonedDateTime.parse(localTime);
+    }
 }

src/test/java/com/maxmind/minfraud/WebServiceClientTest.java

@@ -151,13 +151,11 @@ public void test200WithInvalidJson() throws Exception {
 
     @Test
     public void testInsufficientCredit() throws Exception {
-        Exception ex = assertThrows(InsufficientFundsException.class, () -> {
-            createInsightsError(
-                    402,
-                    "application/json",
-                    "{\"code\":\"INSUFFICIENT_FUNDS\",\"error\":\"out of credit\"}"
-            );
-        });
+        Exception ex = assertThrows(InsufficientFundsException.class, () -> createInsightsError(
+                402,
+                "application/json",
+                "{\"code\":\"INSUFFICIENT_FUNDS\",\"error\":\"out of credit\"}"
+        ));
         assertEquals("out of credit", ex.getMessage());
 
     }
@@ -180,13 +178,11 @@ public void testInvalidAuth(String code) throws Exception {
 
     @Test
     public void testPermissionRequired() throws Exception {
-        Exception ex = assertThrows(PermissionRequiredException.class, () -> {
-            createInsightsError(
-                    403,
-                    "application/json",
-                    "{\"code\":\"PERMISSION_REQUIRED\",\"error\":\"Permission required\"}"
-            );
-        });
+        Exception ex = assertThrows(PermissionRequiredException.class, () -> createInsightsError(
+                403,
+                "application/json",
+                "{\"code\":\"PERMISSION_REQUIRED\",\"error\":\"Permission required\"}"
+        ));
         assertEquals("Permission required", ex.getMessage());
     }