Adding support for Message Event API

Author: Chris Wilson

apps/sparkpost-samples-app/src/main/java/com/sparkpost/samples/MessageEventSearchSample.java

@@ -0,0 +1,86 @@
+
+package com.sparkpost.samples;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.apache.log4j.Level;
+import org.apache.log4j.Logger;
+
+import com.sparkpost.Client;
+import com.sparkpost.exception.SparkPostErrorServerResponseException;
+import com.sparkpost.exception.SparkPostException;
+import com.sparkpost.model.responses.MessageEventsResponse;
+import com.sparkpost.resources.ResourceMessageEvents;
+import com.sparkpost.sdk.samples.helpers.SparkPostBaseApp;
+import com.sparkpost.transport.IRestConnection;
+import com.sparkpost.transport.RestConnection;
+
+/**
+ * Note: This code has a lot of redundancy so it is easy to copy and paste into your own code base as a starting point.
+ * Also, This code does not do any of the error checking that should be done in production code.
+ */
+public class MessageEventSearchSample extends SparkPostBaseApp {
+
+    static final Logger logger = Logger.getLogger(CreateTemplateSimple.class);
+
+    public static void main(String[] args) throws SparkPostException, IOException, InterruptedException {
+        Logger.getRootLogger().setLevel(Level.DEBUG);
+
+        MessageEventSearchSample app = new MessageEventSearchSample();
+        app.doSearch();
+    }
+
+    private void doSearch() throws SparkPostException, IOException, InterruptedException {
+        boolean dumpResult = false;
+        Client client = this.newConfiguredClient();
+        IRestConnection connection = new RestConnection(client, getEndPoint());
+
+        MessageEventsResponse response = null;
+        do {
+            if (response == null) {
+                response = ResourceMessageEvents.searchMessageEvents(connection, 10);
+            } else {
+                try {
+                    response = ResourceMessageEvents.nextMessageEvents(connection, response);
+                } catch (SparkPostErrorServerResponseException e) {
+                    if (e.getResponseCode() == 429) {
+                        // We hit rate limit. Retry request again after a delay
+                        System.out.println("Hit the rate limit!!! Will retry after delay...");
+                        Thread.sleep(30000);
+                        continue;
+                    }
+                    throw e;
+                }
+            }
+
+            if (response == null) {
+                return;
+            } else if (response.getResponseCode() != 200) {
+                System.err.println(response);
+                return;
+            }
+
+            if (dumpResult) {
+                System.out.println("Response: " + response);
+
+                List<Map<String, Object>> results = response.getResults();
+                for (Map<String, Object> result : results) {
+                    System.out.println("\nResult (" + result.get("type") + ")");
+                    Set<String> keySet = result.keySet();
+                    for (String key : keySet) {
+                        // Print out result
+                        System.out.println("\t" + key + " = " + result.get(key));
+                    }
+                }
+            }
+            System.out.println("Total Count: " + response.getTotalCount());
+            System.out.println("Links: " + response.getLinks());
+            System.out.println("Has Next Page: " + response.hasNext());
+
+        } while (response != null && response.hasNext());
+    }
+
+}

libs/sparkpost-lib/src/main/java/com/sparkpost/model/responses/MessageEventsResponse.java

@@ -0,0 +1,50 @@
+
+package com.sparkpost.model.responses;
+
+import java.util.List;
+import java.util.Map;
+
+import com.google.gson.annotations.SerializedName;
+import com.yepher.jsondoc.annotations.Description;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class MessageEventsResponse extends Response {
+
+    // {"results":[],"total_count":0,"links":[]}
+    @Description(value = "results", sample = {"\"results\": [ {\"count_injected\": 633,...}]"})
+    @SerializedName("results")
+    private List<Map<String, Object>> results;
+
+    @Description(value = "links", sample = {"{ \"href\": \"/api/v1/message-events\", \"rel\": \"message-events\", \"method\": \"GET\" }"})
+    @SerializedName("links")
+    private List<Map<String, String>> links;
+
+    @Description(value = "total_count", sample = {"{ \"total_count\": 0 }"})
+    @SerializedName("total_count")
+    private int totalCount;
+
+    public boolean hasNext() {
+        String next = nextPageUrl();
+        return next != null && nextPageUrl().length() > 0;
+    }
+
+    public String nextPageUrl() {
+        if (this.links.size() == 0) {
+            return "";
+        }
+
+        for (Map<String, String> element : this.links) {
+            String value = element.get("rel");
+            if ("next".equalsIgnoreCase(value)) {
+                return element.get("href");
+            }
+        }
+
+        return "";
+    }
+
+}

libs/sparkpost-lib/src/main/java/com/sparkpost/resources/ResourceMessageEvents.java

@@ -0,0 +1,68 @@
+
+package com.sparkpost.resources;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+
+import com.sparkpost.exception.SparkPostException;
+import com.sparkpost.model.responses.MessageEventsResponse;
+import com.sparkpost.model.responses.Response;
+import com.sparkpost.transport.IRestConnection;
+
+/**
+ * Resource collection that is a 1-to-1 match to the Metrics SparkPost API.<br>
+ * <br>
+ * See <a href="https://developers.sparkpost.com/api/message-events.html/">Message Events
+ * API</a>
+ */
+public class ResourceMessageEvents {
+
+    public static MessageEventsResponse searchMessageEvents(IRestConnection conn) throws SparkPostException {
+        Endpoint ep = new Endpoint("message-events");
+        Response response = conn.get(ep);
+
+        MessageEventsResponse messageResponse = MessageEventsResponse.decode(response, MessageEventsResponse.class);
+        return messageResponse;
+    }
+
+    public static MessageEventsResponse searchMessageEvents(IRestConnection conn, int perPage) throws SparkPostException {
+        Endpoint ep = new Endpoint("message-events");
+        ep.addParam("per_page", perPage);
+        Response response = conn.get(ep);
+
+        MessageEventsResponse messageResponse = MessageEventsResponse.decode(response, MessageEventsResponse.class);
+        return messageResponse;
+    }
+
+    public static MessageEventsResponse nextMessageEvents(IRestConnection conn, MessageEventsResponse page) throws SparkPostException {
+        if (page.hasNext() == false) {
+            return null;
+        }
+
+        String next = page.nextPageUrl();
+        try {
+            URI uri = new URI(next);
+
+            String path = uri.getPath();
+            path = path.replaceFirst("/api/v1/", "");
+            Endpoint ep = new Endpoint(path);
+
+            String query = uri.getQuery();
+            if (query.length() > 0) {
+                String[] split = query.split("&");
+                for (String element : split) {
+                    String[] fields = element.split("=");
+                    ep.addParam(fields[0], fields[1]);
+                }
+            }
+
+            Response response = conn.get(ep);
+
+            MessageEventsResponse messageResponse = MessageEventsResponse.decode(response, MessageEventsResponse.class);
+            return messageResponse;
+        } catch (URISyntaxException e) {
+            throw new SparkPostException(e);
+        }
+    }
+
+}