Add properly typed methods for date/time accessors

Author: oschwald

CHANGELOG.md

@@ -6,6 +6,9 @@ CHANGELOG
 
 * 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.
 
 1.11.0 (2020-02-21)
 -------------------

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.
  */
@@ -102,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/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/response/DeviceTest.java

@@ -27,6 +27,9 @@ public void testDevice() throws Exception {
         assertEquals(99.0, device.getConfidence(), 1e-15);
         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());
+
     }
 }

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

@@ -31,7 +31,8 @@ public void testEmail() throws Exception {
         assertFalse(email.isDisposable());
         assertFalse(email.isFree());
         assertTrue(email.isHighRisk());
-        assertEquals(email.getFirstSeen(), "2017-01-02");
+        assertEquals("2017-01-02", email.getFirstSeen());
+        assertEquals(LocalDate.parse("2017-01-02"), email.getFirstSeenDate());
     }
 
     @Test
@@ -51,5 +52,6 @@ public void testEmailWithoutFirstSeen() throws Exception {
         assertFalse(email.isFree());
         assertTrue(email.isHighRisk());
         assertNull(email.getFirstSeen());
+        assertNull(email.getFirstSeenDate());
     }
 }

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

@@ -20,6 +20,7 @@ public void testGetLocalTime() throws Exception {
                         .finish()
         );
 
-        assertEquals(location.getLocalTime(), time);
+        assertEquals(time, location.getLocalTime());
+        assertEquals(time, location.getLocalDateTime().toString());
     }
 }