Merge pull request #243 from SparkPost/SE-231

[SE-231] Events api added with tests

Author: sstaley-sparkpost

.gitignore

@@ -1,3 +1,6 @@
 node_modules
 xunit.xml
 test/reports/*
+
+# vscode
+.vscode

examples/events/search_message.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var key = 'YOURAPIKEY'
+  , SparkPost = require('sparkpost')
+  , client = new SparkPost(key);
+
+// Returns 1000 message events for the last hour
+
+// Promise
+client.events.searchMessage({})
+  .then(data => {
+    console.log('Congrats you can use our client library!');
+    console.log(data);
+  })
+  .catch(err => {
+    console.log('Whoops! Something went wrong');
+    console.log(err);
+  });
+
+// Callback
+client.events.searchMessage({}, function(err, data) {
+  if (err) {
+    console.log('Whoops! Something went wrong');
+    console.log(err);
+  } else {
+    console.log('Congrats you can use our client library!');
+    console.log(data);
+  }
+});

lib/events.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const api = 'events';
+
+/*
+ * "Class" declaration, Events API exposes one function:
+ * - search: retrieves list of message events according to given params
+ */
+module.exports = function(client) {
+  return {
+    /**
+     * Search for events using given parameters
+     *
+     * @param {Object} parameters
+     * @param {RequestCb} [callback]
+     * @returns {Promise}
+     */
+    searchMessage: function(parameters, callback) {
+      const options = {
+        uri: `${api}/message`
+        , qs: {}
+      };
+
+      Object.keys(parameters).forEach(function(paramname) {
+        if (Array.isArray(parameters[paramname])) {
+          options.qs[paramname] = parameters[paramname].join(',');
+        } else {
+          options.qs[paramname] = parameters[paramname];
+        }
+      });
+      return client.get(options, callback);
+    }
+  };
+};

lib/sparkpost.js

@@ -78,6 +78,7 @@ const SparkPost = function(apiKey, options) {
 
   this.inboundDomains = require('./inboundDomains')(this);
   this.messageEvents = require('./messageEvents')(this);
+  this.events = require('./events')(this);
   this.recipientLists = require('./recipientLists')(this);
   this.relayWebhooks = require('./relayWebhooks')(this);
   this.sendingDomains = require('./sendingDomains')(this);