Working on unit tests for web hook events.

Author: Chris Wilson

apps/sparkpost-documentor-app/src/main/java/com/sparkpost/documentor/GenerateWebhookEventPojos.java

@@ -64,21 +64,26 @@ public String renderEventClass(JSONObject eventInfo) {
         builder.append("import java.util.List;\n");
         builder.append("import java.util.Map;\n");
         builder.append("import com.yepher.jsondoc.annotations.Description;\n");
-
+        builder.append("import com.google.gson.annotations.SerializedName;\n");
+        builder.append("import com.sparkpost.model.Base;\n");
         builder.append("import lombok.Data;\n");
         builder.append("import lombok.EqualsAndHashCode;\n");
 
         builder.append("\n\n/**\n").append(eventInfo.optString("description").trim()).append("\n*/\n\n");
         builder.append("@Data\n");
-        builder.append("@EqualsAndHashCode()\n");
-        builder.append("public class " + convertToCamelCase(eventInfo.getString("display_name"), true) + "Event {\n\n");
+        builder.append("@EqualsAndHashCode(callSuper = true)\n");
+        builder.append("public class " + convertToCamelCase(eventInfo.getString("display_name"), true) + "Event  extends Base {\n\n");
 
         JSONObject fields = eventInfo.getJSONObject("event");
         Set<String> fieldNames = fields.keySet();
 
         for (String fieldName : fieldNames) {
             JSONObject field = fields.getJSONObject(fieldName);
 
+            if (fieldName.contains("_")) {
+                builder.append("\t@SerializedName(\"" + fieldName + "\")\n");
+            }
+
             //@Description(
             //        value = "A suppression list - or exclusion list, as it is sometimes called - stores a recipient's opt-out preferences.",
             //        sample = {"Array of SuppressionListEntrys"})

libs/sparkpost-lib/src/main/java/com/sparkpost/model/webhook/event/BounceEvent.java

@@ -3,6 +3,8 @@
 import java.util.List;
 import java.util.Map;
 
+import com.google.gson.annotations.SerializedName;
+import com.sparkpost.model.Base;
 import com.yepher.jsondoc.annotations.Description;
 
 import lombok.Data;
@@ -14,24 +16,27 @@
 */
 
 @Data
-@EqualsAndHashCode()
-public class BounceEvent {
+@EqualsAndHashCode(callSuper = true)
+public class BounceEvent  extends Base {
 
 	@Description(
 		value = "Canonicalized text of the response returned by the remote server due to a failed delivery attempt",
 		sample = "MAIL REFUSED - IP (a.b.c.d) is in black list")
 	private String reason;
 
+	@SerializedName("sms_src_npi")
 	@Description(
 		value = "Source numbering plan identification",
 		sample = "E164")
 	private String smsSrcNpi;
 
+	@SerializedName("template_version")
 	@Description(
 		value = "Version of the template used to construct this message",
 		sample = "1")
 	private String templateVersion;
 
+	@SerializedName("friendly_from")
 	@Description(
 		value = "Friendly sender or \"From\" header in the original email",
 		sample = "sender@example.com")
@@ -42,11 +47,13 @@ public class BounceEvent {
 		sample = "Summer deals are here!")
 	private String subject;
 
+	@SerializedName("ip_pool")
 	@Description(
 		value = "IP pool through which this message was sent",
 		sample = "Example-Ip-Pool")
 	private String ipPool;
 
+	@SerializedName("rcpt_tags")
 	@Description(
 		value = "Tags applied to the message which generated this event",
 		sample = "[\"male\",\"US\"]")
@@ -57,51 +64,61 @@ public class BounceEvent {
 		sample = "bounce")
 	private String type;
 
+	@SerializedName("num_retries")
 	@Description(
 		value = "Number of failed attempts before this message was successfully delivered; when the first attempt succeeds, zero",
 		sample = "2")
 	private String numRetries;
 
+	@SerializedName("sms_dst_npi")
 	@Description(
 		value = "Destination numbering plan identification",
 		sample = "E164")
 	private String smsDstNpi;
 
+	@SerializedName("bounce_class")
 	@Description(
 		value = "Classification code for a given message (see [Bounce Classification Codes](https://support.sparkpost.com/customer/portal/articles/1929896))",
 		sample = "1")
 	private String bounceClass;
 
+	@SerializedName("raw_rcpt_to")
 	@Description(
 		value = "Actual recipient address used on this message's SMTP envelope",
 		sample = "Recipient@example.com")
 	private String rawRcptTo;
 
+	@SerializedName("sms_src")
 	@Description(
 		value = "SMS source address",
 		sample = "1234")
 	private String smsSrc;
 
+	@SerializedName("msg_from")
 	@Description(
 		value = "Sender address used on this message's SMTP envelope",
 		sample = "sender@example.com")
 	private String msgFrom;
 
+	@SerializedName("rcpt_to")
 	@Description(
 		value = "Lowercase version of recipient address used on this message's SMTP envelope",
 		sample = "recipient@example.com")
 	private String rcptTo;
 
+	@SerializedName("subaccount_id")
 	@Description(
 		value = "Unique subaccount identifier.",
 		sample = "101")
 	private String subaccountId;
 
+	@SerializedName("transmission_id")
 	@Description(
 		value = "Transmission which originated this message",
 		sample = "65832150921904138")
 	private String transmissionId;
 
+	@SerializedName("campaign_id")
 	@Description(
 		value = "Campaign of which this message was a part",
 		sample = "Example Campaign Name")
@@ -112,91 +129,109 @@ public class BounceEvent {
 		sample = "1454442600")
 	private String timestamp;
 
+	@SerializedName("sms_coding")
 	@Description(
 		value = "Data encoding used in the SMS message",
 		sample = "ASCII")
 	private String smsCoding;
 
+	@SerializedName("rcpt_meta")
 	@Description(
 		value = "Metadata describing the message recipient",
 		sample = "{\"customKey\":\"customValue\"}")
 	private Map<String, String> rcptMeta;
 
+	@SerializedName("message_id")
 	@Description(
 		value = "SparkPost-cluster-wide unique identifier for this message",
 		sample = "000443ee14578172be22")
 	private String messageId;
 
+	@SerializedName("ip_address")
 	@Description(
 		value = "IP address of the host to which SparkPost delivered this message; in engagement events, the IP address of the host where the HTTP request originated",
 		sample = "127.0.0.1")
 	private String ipAddress;
 
+	@SerializedName("rcpt_type")
 	@Description(
 		value = "Indicates that a recipient address appeared in the Cc or Bcc header or the archive JSON array",
 		sample = "cc")
 	private String rcptType;
 
+	@SerializedName("sms_dst")
 	@Description(
 		value = "SMS destination address",
 		sample = "7876712656")
 	private String smsDst;
 
+	@SerializedName("event_id")
 	@Description(
 		value = "Unique event identifier",
 		sample = "92356927693813856")
 	private String eventId;
 
+	@SerializedName("routing_domain")
 	@Description(
 		value = "Domain receiving this message",
 		sample = "example.com")
 	private String routingDomain;
 
+	@SerializedName("sending_ip")
 	@Description(
 		value = "IP address through which this message was sent",
 		sample = "127.0.0.1")
 	private String sendingIp;
 
+	@SerializedName("sms_src_ton")
 	@Description(
 		value = "Type of number for the source address",
 		sample = "Unknown")
 	private String smsSrcTon;
 
+	@SerializedName("device_token")
 	@Description(
 		value = "Token of the device / application targeted by this PUSH notification message. Applies only when delv_method is gcm or apn.",
 		sample = "45c19189783f867973f6e6a5cca60061ffe4fa77c547150563a1192fa9847f8a")
 	private String deviceToken;
 
+	@SerializedName("raw_reason")
 	@Description(
 		value = "Unmodified, exact response returned by the remote server due to a failed delivery attempt",
 		sample = "MAIL REFUSED - IP (17.99.99.99) is in black list")
 	private String rawReason;
 
+	@SerializedName("sms_dst_ton")
 	@Description(
 		value = "Type of number for the destination address",
 		sample = "International")
 	private String smsDstTon;
 
+	@SerializedName("error_code")
 	@Description(
 		value = "Error code by which the remote server described a failed delivery attempt",
 		sample = "554")
 	private String errorCode;
 
+	@SerializedName("template_id")
 	@Description(
 		value = "Slug of the template used to construct this message",
 		sample = "templ-1234")
 	private String templateId;
 
+	@SerializedName("delv_method")
 	@Description(
 		value = "Protocol by which SparkPost delivered this message",
 		sample = "esmtp")
 	private String delvMethod;
 
+	@SerializedName("customer_id")
 	@Description(
 		value = "SparkPost-customer identifier through which this message was sent",
 		sample = "1")
 	private String customerId;
 
+	@SerializedName("msg_size")
 	@Description(
 		value = "Message's size in bytes",
 		sample = "1337")