handle date conversion

Author: lbalmaceda

src/main/java/com/auth0/client/mgmt/StatsEntity.java

@@ -1,13 +1,15 @@
 package com.auth0.client.mgmt;
 
-import com.auth0.utils.Asserts;
 import com.auth0.json.mgmt.DailyStats;
 import com.auth0.net.CustomRequest;
 import com.auth0.net.Request;
+import com.auth0.utils.Asserts;
 import com.fasterxml.jackson.core.type.TypeReference;
 import okhttp3.HttpUrl;
 import okhttp3.OkHttpClient;
 
+import java.text.SimpleDateFormat;
+import java.util.Date;
 import java.util.List;
 
 /**
@@ -46,20 +48,24 @@ public Request<Integer> getActiveUsersCount() {
      * Request the Daily Stats for a given period. A token with scope read:stats is needed.
      * See https://auth0.com/docs/api/management/v2#!/Stats/get_daily
      *
-     * @param dateFrom the first day of the period (inclusive). Must have YYYYMMDD format.
-     * @param dateTo   the last day of the period (inclusive). Must have YYYYMMDD format.
+     * @param from the first day of the period (inclusive). Time is not taken into account.
+     * @param to   the last day of the period (inclusive). Time is not taken into account.
      * @return a Request to execute.
      */
-    public Request<List<DailyStats>> getDailyStats(String dateFrom, String dateTo) {
-        Asserts.assertNotNull(dateFrom, "date from");
-        Asserts.assertNotNull(dateTo, "date to");
+    public Request<List<DailyStats>> getDailyStats(Date from, Date to) {
+        Asserts.assertNotNull(from, "date from");
+        Asserts.assertNotNull(to, "date to");
 
+        String dateFrom = formatDate(from);
+        String dateTo = formatDate(to);
         String url = HttpUrl.parse(baseUrl)
                 .newBuilder()
                 .addPathSegment("api")
                 .addPathSegment("v2")
                 .addPathSegment("stats")
                 .addPathSegment("daily")
+                .addQueryParameter("from", dateFrom)
+                .addQueryParameter("to", dateTo)
                 .build()
                 .toString();
 
@@ -69,4 +75,9 @@ public Request<List<DailyStats>> getDailyStats(String dateFrom, String dateTo) {
         return request;
     }
 
+    protected String formatDate(Date date) {
+        SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMdd");
+        return sdf.format(date);
+    }
+
 }

src/main/java/com/auth0/client/mgmt/TenantsEntity.java

@@ -12,7 +12,7 @@
 import java.util.Map;
 
 /**
- * Class that provides an implementation of the Tenants methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Tenants
+ * Class that provides an implementation of the Tenant Settings methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Tenants
  */
 @SuppressWarnings("WeakerAccess")
 public class TenantsEntity extends BaseManagementEntity {

src/main/java/com/auth0/json/mgmt/DailyStats.java

@@ -1,9 +1,12 @@
 package com.auth0.json.mgmt;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.Date;
+
 /**
  * Class that represents an Auth0 Daily Stats object. Related to the {@link com.auth0.client.mgmt.StatsEntity()} entity.
  */
@@ -14,8 +17,9 @@ public class DailyStats {
 
     @JsonProperty("logins")
     private Integer logins;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("date")
-    private String date;
+    private Date date;
 
     /**
      * Getter for the amount of logins on the date
@@ -32,8 +36,9 @@ public Integer getLogins() {
      *
      * @return the date to which the stats belong
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("date")
-    public String getDate() {
+    public Date getDate() {
         return date;
     }
 }

src/main/java/com/auth0/json/mgmt/guardian/Enrollment.java

@@ -1,9 +1,12 @@
 package com.auth0.json.mgmt.guardian;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.Date;
+
 /**
  * Class that represents an Auth0 Guardian Enrollment object. Related to the {@link com.auth0.client.mgmt.GuardianEntity()} entity.
  */
@@ -26,10 +29,12 @@ public class Enrollment {
     private String phoneNumber;
     @JsonProperty("auth_method")
     private String authMethod;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("enrolled_at")
-    private String enrolledAt;
+    private Date enrolledAt;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("last_auth")
-    private String lastAuth;
+    private Date lastAuth;
 
     /**
      * Getter for the enrollment ID
@@ -106,8 +111,9 @@ public String getAuthMethod() {
      *
      * @return the enrolled at.
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("enrolled_at")
-    public String getEnrolledAt() {
+    public Date getEnrolledAt() {
         return enrolledAt;
     }
 
@@ -116,8 +122,9 @@ public String getEnrolledAt() {
      *
      * @return the last authentication.
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("last_auth")
-    public String getLastAuth() {
+    public Date getLastAuth() {
         return lastAuth;
     }
 }

src/main/java/com/auth0/json/mgmt/logevents/LogEvent.java

@@ -1,9 +1,11 @@
 package com.auth0.json.mgmt.logevents;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.Date;
 import java.util.Map;
 
 /**
@@ -16,8 +18,9 @@ public class LogEvent {
 
     @JsonProperty("_id")
     private String id;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("date")
-    private String date;
+    private Date date;
     @JsonProperty("type")
     private String type;
     @JsonProperty("client_id")
@@ -48,8 +51,9 @@ public String getId() {
      *
      * @return the date.
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("date")
-    public String getDate() {
+    public Date getDate() {
         return date;
     }
 
@@ -89,7 +93,7 @@ public String getClientName() {
      * @return the IP address.
      */
     @JsonProperty("ip")
-    public String getIp() {
+    public String getIP() {
         return ip;
     }
 

src/main/java/com/auth0/json/mgmt/users/User.java

@@ -1,10 +1,8 @@
 package com.auth0.json.mgmt.users;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
-import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.*;
 
+import java.util.Date;
 import java.util.List;
 import java.util.Map;
 
@@ -50,10 +48,12 @@ public class User {
     private String givenName;
     @JsonProperty("family_name")
     private String familyName;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("created_at")
-    private String createdAt;
+    private Date createdAt;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("updated_at")
-    private String updatedAt;
+    private Date updatedAt;
     @JsonProperty("identities")
     private List<Identity> identities;
     @JsonProperty("app_metadata")
@@ -64,8 +64,9 @@ public class User {
     private List<String> multifactor;
     @JsonProperty("last_ip")
     private String lastIp;
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("last_login")
-    private String lastLogin;
+    private Date lastLogin;
     @JsonProperty("logins_count")
     private Integer loginsCount;
     @JsonProperty("blocked")
@@ -311,8 +312,9 @@ public void setFamilyName(String familyName) {
      *
      * @return the created at.
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("created_at")
-    public String getCreatedAt() {
+    public Date getCreatedAt() {
         return createdAt;
     }
 
@@ -321,8 +323,9 @@ public String getCreatedAt() {
      *
      * @return the updated at.
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("updated_at")
-    public String getUpdatedAt() {
+    public Date getUpdatedAt() {
         return updatedAt;
     }
 
@@ -401,8 +404,9 @@ public String getLastIP() {
      *
      * @return the last login.
      */
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     @JsonProperty("last_login")
-    public String getLastLogin() {
+    public Date getLastLogin() {
         return lastLogin;
     }
 

src/test/java/com/auth0/client/mgmt/StatsEntityTest.java

@@ -5,11 +5,12 @@
 import okhttp3.mockwebserver.RecordedRequest;
 import org.junit.Test;
 
+import java.util.Calendar;
+import java.util.Date;
 import java.util.List;
 
 import static com.auth0.client.MockServer.*;
-import static com.auth0.client.RecordedRequestMatcher.hasHeader;
-import static com.auth0.client.RecordedRequestMatcher.hasMethodAndPath;
+import static com.auth0.client.RecordedRequestMatcher.*;
 import static org.hamcrest.Matchers.*;
 import static org.junit.Assert.assertThat;
 
@@ -35,19 +36,27 @@ public void shouldGetActiveUsersCount() throws Exception {
     public void shouldThrowOnGetDailyStatsWithNullDateFrom() throws Exception {
         exception.expect(IllegalArgumentException.class);
         exception.expectMessage("'date from' cannot be null!");
-        api.stats().getDailyStats(null, "20161011");
+        api.stats().getDailyStats(null, new Date());
     }
 
     @Test
     public void shouldThrowOnGetDailyStatsWithNullDateTo() throws Exception {
         exception.expect(IllegalArgumentException.class);
         exception.expectMessage("'date to' cannot be null!");
-        api.stats().getDailyStats("20161011", null);
+        api.stats().getDailyStats(new Date(), null);
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void shouldGetDailyStats() throws Exception {
-        Request<List<DailyStats>> request = api.stats().getDailyStats("20161011", "20161011");
+        Calendar calendar = Calendar.getInstance();
+        calendar.set(Calendar.YEAR, 2016);
+        calendar.set(Calendar.MONTH, Calendar.OCTOBER);
+        calendar.set(Calendar.DATE, 11);
+        Date dateFrom = calendar.getTime();
+        calendar.set(Calendar.DATE, 12);
+        Date dateTo = calendar.getTime();
+        Request<List<DailyStats>> request = api.stats().getDailyStats(dateFrom, dateTo);
         assertThat(request, is(notNullValue()));
 
         server.jsonResponse(MGMT_DAILY_STATS_LIST, 200);
@@ -57,13 +66,15 @@ public void shouldGetDailyStats() throws Exception {
         assertThat(recordedRequest, hasMethodAndPath("GET", "/api/v2/stats/daily"));
         assertThat(recordedRequest, hasHeader("Content-Type", "application/json"));
         assertThat(recordedRequest, hasHeader("Authorization", "Bearer apiToken"));
+        assertThat(recordedRequest, hasQueryParameter("from", "20161011"));
+        assertThat(recordedRequest, hasQueryParameter("to", "20161012"));
 
         assertThat(response, is(notNullValue()));
     }
 
     @Test
     public void shouldReturnEmptyDailyStats() throws Exception {
-        Request<List<DailyStats>> request = api.stats().getDailyStats("20161011", "20161011");
+        Request<List<DailyStats>> request = api.stats().getDailyStats(new Date(), new Date());
         assertThat(request, is(notNullValue()));
 
         server.jsonResponse(MGMT_EMPTY_LIST, 200);
@@ -72,4 +83,16 @@ public void shouldReturnEmptyDailyStats() throws Exception {
         assertThat(response, is(notNullValue()));
         assertThat(response, is(emptyCollectionOf(DailyStats.class)));
     }
+
+    @Test
+    public void shouldFormatDateToYYYYMMDD() throws Exception {
+        Calendar calendar = Calendar.getInstance();
+        calendar.set(Calendar.YEAR, 2010);
+        //Calendar.MONTH starts at 0 being January
+        calendar.set(Calendar.MONTH, Calendar.JANUARY);
+        calendar.set(Calendar.DATE, 22);
+
+        assertThat(api.stats().formatDate(calendar.getTime()), is("20100122"));
+
+    }
 }

src/test/java/com/auth0/json/JsonTest.java

@@ -5,9 +5,15 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import java.io.IOException;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.TimeZone;
 
 public class JsonTest<T> {
 
+    private static final String DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
+
     private ObjectMapper mapper;
 
     public JsonTest() {
@@ -25,4 +31,10 @@ public T fromJSON(String json, Class<T> tClazz) throws IOException {
     public T fromJSON(String json, TypeReference<T> tReference) throws IOException {
         return mapper.readValue(json, tReference);
     }
+
+    protected Date parseJSONDate(String dateString) throws ParseException {
+        SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT);
+        sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
+        return sdf.parse(dateString);
+    }
 }

src/test/java/com/auth0/json/mgmt/DailyStatsTest.java

@@ -4,6 +4,7 @@
 import org.junit.Test;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
 
@@ -15,7 +16,7 @@ public void shouldDeserialize() throws Exception {
         DailyStats stats = fromJSON(json, DailyStats.class);
 
         assertThat(stats, is(notNullValue()));
-        assertThat(stats.getDate(), is("2017-01-18T17:45:08.328Z"));
+        assertThat(stats.getDate(), is(equalTo(parseJSONDate("2017-01-18T17:45:08.328Z"))));
         assertThat(stats.getLogins(), is(123));
     }