Use org.joda.time.DateTime to handle datetime objects

All datetime fields in the models are now parsed to `org.joda.time.DateTime` in UTC. This is set as a convention to avoid any inconsistencies in the timezone sent in the v2 API. `DateTimeUtils.parseISODateTimeString` will automatically detect the timezone in datetime string and return a `DateTime` object, given that the string is in ISO8601 format.

Signed-off-by: Abeer <abeer.u@instamojo.com>

Author: im-abeer

build.gradle

@@ -56,6 +56,7 @@ dependencies {
     compile group: 'commons-codec', name: 'commons-codec', version: '1.11'
     compile group: 'commons-logging', name: 'commons-logging', version: '1.2'
     compile group: 'com.google.code.gson', name: 'gson', version: '2.8.5'
+    compile group: 'joda-time', name: 'joda-time', version: '2.10.1'
 }
 
 jacocoTestReport {

src/main/java/com/instamojo/wrapper/api/InstamojoImpl.java

@@ -10,6 +10,7 @@
 import com.instamojo.wrapper.response.ApiListResponse;
 import com.instamojo.wrapper.response.ApiResponse;
 import com.instamojo.wrapper.util.Constants;
+import com.instamojo.wrapper.util.GsonWrapper;
 import com.instamojo.wrapper.util.HttpUtils;
 import org.apache.commons.codec.digest.HmacAlgorithms;
 import org.apache.commons.codec.digest.HmacUtils;
@@ -28,7 +29,7 @@ public class InstamojoImpl implements Instamojo {
 
     public InstamojoImpl(ApiContext context) {
         this.context = context;
-        this.gson = new Gson();
+        this.gson = GsonWrapper.getGson();
     }
 
     @Override

src/main/java/com/instamojo/wrapper/model/Invoice.java

@@ -1,6 +1,7 @@
 package com.instamojo.wrapper.model;
 
 import com.google.gson.annotations.SerializedName;
+import org.joda.time.DateTime;
 
 import java.util.Date;
 
@@ -12,16 +13,16 @@ public class Invoice {
     private String userUri;
 
     @SerializedName("created_at")
-    private Date createdAt;
+    private DateTime createdAt;
 
     @SerializedName("issue_date")
-    private Date issueDate;
+    private DateTime issueDate;
 
     @SerializedName("file")
     private String fileUrl;
 
     @SerializedName("last_modified")
-    private Date modifiedAt;
+    private DateTime modifiedAt;
 
     public String getId() {
         return id;
@@ -39,19 +40,19 @@ public void setUserUri(String userUri) {
         this.userUri = userUri;
     }
 
-    public Date getCreatedAt() {
+    public DateTime getCreatedAt() {
         return createdAt;
     }
 
-    public void setCreatedAt(Date createdAt) {
+    public void setCreatedAt(DateTime createdAt) {
         this.createdAt = createdAt;
     }
 
-    public Date getIssueDate() {
+    public DateTime getIssueDate() {
         return issueDate;
     }
 
-    public void setIssueDate(Date issueDate) {
+    public void setIssueDate(DateTime issueDate) {
         this.issueDate = issueDate;
     }
 
@@ -63,11 +64,11 @@ public void setFileUrl(String fileUrl) {
         this.fileUrl = fileUrl;
     }
 
-    public Date getModifiedAt() {
+    public DateTime getModifiedAt() {
         return modifiedAt;
     }
 
-    public void setModifiedAt(Date modifiedAt) {
+    public void setModifiedAt(DateTime modifiedAt) {
         this.modifiedAt = modifiedAt;
     }
 

src/main/java/com/instamojo/wrapper/model/PaymentOrder.java

@@ -1,6 +1,7 @@
 package com.instamojo.wrapper.model;
 
 import com.google.gson.annotations.SerializedName;
+import org.joda.time.DateTime;
 
 import java.util.List;
 
@@ -68,7 +69,7 @@ public class PaymentOrder {
      * The created at.
      */
     @SerializedName("created_at")
-    private String createdAt;
+    private DateTime createdAt;
 
     /**
      * The resource uri.
@@ -288,7 +289,7 @@ public void setRedirectUrl(String redirectUrl) {
      *
      * @return the created at
      */
-    public String getCreatedAt() {
+    public DateTime getCreatedAt() {
         return createdAt;
     }
 
@@ -297,7 +298,7 @@ public String getCreatedAt() {
      *
      * @param createdAt the new created at
      */
-    public void setCreatedAt(String createdAt) {
+    public void setCreatedAt(DateTime createdAt) {
         this.createdAt = createdAt;
     }
 

src/main/java/com/instamojo/wrapper/model/PaymentRequest.java

@@ -1,8 +1,8 @@
 package com.instamojo.wrapper.model;
 
 import com.google.gson.annotations.SerializedName;
+import org.joda.time.DateTime;
 
-import java.util.Date;
 import java.util.List;
 
 public class PaymentRequest {
@@ -50,10 +50,10 @@ public class PaymentRequest {
     private String webhookUrl;
 
     @SerializedName("scheduled_at")
-    private Date scheduledAt;
+    private DateTime scheduledAt;
 
     @SerializedName("expires_at")
-    private Date expiresAt;
+    private DateTime expiresAt;
 
     @SerializedName("allow_repeated_payments")
     private Boolean allowRepeatedPayments;
@@ -71,10 +71,10 @@ public class PaymentRequest {
     private Boolean markFulfilled;
 
     @SerializedName("created_at")
-    private Date createdAt;
+    private DateTime createdAt;
 
     @SerializedName("modified_at")
-    private Date modifiedAt;
+    private DateTime modifiedAt;
 
     @SerializedName("resource_uri")
     private String resourceUri;
@@ -207,19 +207,19 @@ public void setWebhookUrl(String webhookUrl) {
         this.webhookUrl = webhookUrl;
     }
 
-    public Date getScheduledAt() {
+    public DateTime getScheduledAt() {
         return scheduledAt;
     }
 
-    public void setScheduledAt(Date scheduledAt) {
+    public void setScheduledAt(DateTime scheduledAt) {
         this.scheduledAt = scheduledAt;
     }
 
-    public Date getExpiresAt() {
+    public DateTime getExpiresAt() {
         return expiresAt;
     }
 
-    public void setExpiresAt(Date expiresAt) {
+    public void setExpiresAt(DateTime expiresAt) {
         this.expiresAt = expiresAt;
     }
 
@@ -263,19 +263,19 @@ public void setMarkFulfilled(Boolean markFulfilled) {
         this.markFulfilled = markFulfilled;
     }
 
-    public Date getCreatedAt() {
+    public DateTime getCreatedAt() {
         return createdAt;
     }
 
-    public void setCreatedAt(Date createdAt) {
+    public void setCreatedAt(DateTime createdAt) {
         this.createdAt = createdAt;
     }
 
-    public Date getModifiedAt() {
+    public DateTime getModifiedAt() {
         return modifiedAt;
     }
 
-    public void setModifiedAt(Date modifiedAt) {
+    public void setModifiedAt(DateTime modifiedAt) {
         this.modifiedAt = modifiedAt;
     }
 

src/main/java/com/instamojo/wrapper/model/Payout.java

@@ -1,6 +1,7 @@
 package com.instamojo.wrapper.model;
 
 import com.google.gson.annotations.SerializedName;
+import org.joda.time.DateTime;
 
 import java.util.Date;
 
@@ -13,7 +14,7 @@ public class Payout {
     private Boolean status;
 
     @SerializedName("paid_out_at")
-    private Date paidOutAt;
+    private DateTime paidOutAt;
 
     private String currency;
 
@@ -71,11 +72,11 @@ public void setStatus(Boolean status) {
         this.status = status;
     }
 
-    public Date getPaidOutAt() {
+    public DateTime getPaidOutAt() {
         return paidOutAt;
     }
 
-    public void setPaidOutAt(Date paidOutAt) {
+    public void setPaidOutAt(DateTime paidOutAt) {
         this.paidOutAt = paidOutAt;
     }
 

src/main/java/com/instamojo/wrapper/model/Refund.java

@@ -3,6 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 import java.util.Date;
+import org.joda.time.DateTime;
 
 /**
  * The Class Refund.
@@ -31,7 +32,7 @@ public class Refund {
     private Double totalAmount;
 
     @SerializedName("created_at")
-    private Date createdAt;
+    private DateTime createdAt;
 
     public String getId() {
         return id;
@@ -89,11 +90,11 @@ public void setTotalAmount(Double totalAmount) {
         this.totalAmount = totalAmount;
     }
 
-    public Date getCreatedAt() {
+    public DateTime getCreatedAt() {
         return createdAt;
     }
 
-    public void setCreatedAt(Date createdAt) {
+    public void setCreatedAt(DateTime createdAt) {
         this.createdAt = createdAt;
     }
 

src/main/java/com/instamojo/wrapper/util/DateTimeUtils.java

@@ -0,0 +1,13 @@
+package com.instamojo.wrapper.util;
+
+import org.joda.time.DateTime;
+import org.joda.time.DateTimeZone;
+import org.joda.time.format.ISODateTimeFormat;
+
+public class DateTimeUtils {
+
+    public static DateTime parseISODateTimeString(String datetime) {
+        return ISODateTimeFormat.dateTime().withZone(DateTimeZone.UTC).parseDateTime(datetime);
+    }
+
+}

src/main/java/com/instamojo/wrapper/util/GsonWrapper.java

@@ -0,0 +1,37 @@
+package com.instamojo.wrapper.util;
+import com.google.gson.*;
+import org.joda.time.DateTime;
+import org.joda.time.DateTimeZone;
+import org.joda.time.format.ISODateTimeFormat;
+
+import java.lang.reflect.Type;
+
+
+final class DateTimeDeserializer implements JsonDeserializer<DateTime> {
+
+    @Override
+    public DateTime deserialize(JsonElement value, Type type, JsonDeserializationContext context) throws JsonParseException {
+        return value == null ? null : DateTimeUtils.parseISODateTimeString(value.getAsString());
+    }
+}
+
+final class DateTimeSerializer implements JsonSerializer<DateTime> {
+
+    @Override
+    public JsonElement serialize(DateTime dt, Type type, JsonSerializationContext context) throws JsonParseException {
+        return dt == null ? null : new JsonPrimitive(dt.toString());
+    }
+
+}
+
+
+public class GsonWrapper {
+
+    public static Gson getGson() {
+        return new GsonBuilder()
+                .registerTypeAdapter(DateTime.class, new DateTimeDeserializer())
+                .registerTypeAdapter(DateTime.class, new DateTimeSerializer())
+                .create();
+    }
+
+}

src/main/java/com/instamojo/wrapper/util/HttpUtils.java

@@ -150,11 +150,8 @@ public static String post(String url, Map<String, String> customHeaders, String
     }
 
     private static boolean isErrorStatus(int statusCode) {
-        if (statusCode >= 400 && statusCode < 600) {
-            return true;
-        }
+        return statusCode >= 400 && statusCode < 600;
 
-        return false;
     }
 
     private static void populateHeaders(HttpRequestBase httpRequestBase, Map<String, String> customHeaders) {