Use ZonedDateTime for request event time

Author: oschwald

CHANGELOG.md

@@ -9,6 +9,9 @@ CHANGELOG
 * 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)
 -------------------

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/test/java/com/maxmind/minfraud/request/EventTest.java

@@ -4,6 +4,7 @@
 import com.maxmind.minfraud.request.Event.Type;
 import org.junit.Test;
 
+import java.time.ZonedDateTime;
 import java.util.Date;
 
 import static org.junit.Assert.assertEquals;
@@ -23,12 +24,19 @@ public void testShopId() throws Exception {
     }
 
     @Test
-    public void testTime() throws Exception {
+    public void testTimeWithDate() throws Exception {
         Date date = new Date();
         Event event = new Builder().time(date).build();
         assertEquals(date, event.getTime());
     }
 
+    @Test
+    public void testTimeWithZonedDateTime() throws Exception {
+        ZonedDateTime date = ZonedDateTime.now();
+        Event event = new Builder().time(date).build();
+        assertEquals(date, event.getDateTime());
+    }
+
     @Test
     public void testType() throws Exception {
         Event event = new Builder().type(Type.ACCOUNT_CREATION).build();

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

@@ -8,7 +8,7 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Paths;
-import java.text.SimpleDateFormat;
+import java.time.ZonedDateTime;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.*;
 
@@ -32,7 +32,6 @@ public static Transaction fullTransactionEmailMd5() throws Exception {
     }
 
     private static Transaction makeTransaction(Email e) throws Exception {
-        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
         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")
@@ -46,7 +45,7 @@ private static Transaction makeTransaction(Email e) throws Exception {
                                 .Builder()
                                 .transactionId("txn3134133")
                                 .shopId("s2123")
-                                .time(dateFormat.parse("2012-04-12T23:20:50.52Z"))
+                                .time(ZonedDateTime.parse("2012-04-12T23:20:50.52Z"))
                                 .type(Event.Type.PURCHASE)
                                 .build()
                 )

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

@@ -19,7 +19,7 @@ public void testDevice() throws Exception {
                         .put("confidence", 99)
                         .put("id", "C8D3BE1A-BE26-11E5-8C50-1B575C37265F")
                         .put("last_seen", "2016-06-08T14:16:38Z")
-                        .put("local_time", "2018-04-05T15:21:00-07:00")
+                        .put("local_time", "2018-04-05T15:21:01-07:00")
                         .end()
                         .finish()
         );
@@ -28,8 +28,8 @@ public void testDevice() throws Exception {
         assertEquals(UUID.fromString("C8D3BE1A-BE26-11E5-8C50-1B575C37265F"), device.getId());
         assertEquals("2016-06-08T14:16:38Z", device.getLastSeen());
         assertEquals("2016-06-08T14:16:38Z", device.getLastSeenDateTime().toString());
-        assertEquals("2018-04-05T15:21:00-07:00", device.getLocalTime());
-        assertEquals("2018-04-05T15:21:00-07:00", device.getLocalDateTime().toString());
+        assertEquals("2018-04-05T15:21:01-07:00", device.getLocalTime());
+        assertEquals("2018-04-05T15:21:01-07:00", device.getLocalDateTime().toString());
 
     }
 }

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

@@ -2,7 +2,7 @@
   "event": {
     "transaction_id": "txn3134133",
     "shop_id": "s2123",
-    "time": "2012-04-12T23:20:50.052+00:00",
+    "time": "2012-04-12T23:20:50.52Z",
     "type": "purchase"
   },
   "account": {

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

@@ -2,7 +2,7 @@
   "event": {
     "transaction_id": "txn3134133",
     "shop_id": "s2123",
-    "time": "2012-04-12T23:20:50.052+00:00",
+    "time": "2012-04-12T23:20:50.52Z",
     "type": "purchase"
   },
   "account": {