Support for registering, listing and deleting webhooks

Author: Toehio

lib/jira.js

@@ -142,18 +142,23 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
 
     // This is the same almost every time, refactored to make changing it
     // later, easier
-    this.makeUri = function(pathname, altBase) {
+    this.makeUri = function(pathname, altBase, altApiVersion) {
         var basePath = 'rest/api/';
         if (altBase != null) {
             basePath = altBase;
         }
 
+        var apiVersion = this.apiVersion;
+        if (altApiVersion != null) {
+          apiVersion = altApiVersion;
+        }
+
         var uri = url.format({
             protocol: this.protocol,
             hostname: this.host,
             auth: this.username + ':' + this.password,
             port: this.port,
-            pathname: basePath + this.apiVersion + pathname
+            pathname: basePath + apiVersion + pathname
         });
         return uri;
     };
@@ -1421,4 +1426,178 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
         });
     };
 
+    // ## Register a webhook ##
+    // ### Takes ###
+    //
+    // *  webhook: properly formatted webhook
+    // *  callback: for when it's done
+    //
+    // ### Returns ###
+    // *  error string
+    // *  success object
+    //
+    // [Jira Doc](https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview)
+    /*
+     * Success object in the format:
+     * {
+     *   name: 'my first webhook via rest',
+     *   events: [],
+     *   url: 'http://www.example.com/webhooks',
+     *   filter: '',
+     *   excludeIssueDetails: false,
+     *   enabled: true,
+     *   self: 'http://localhost:8090/rest/webhooks/1.0/webhook/5',
+     *   lastUpdatedUser: 'user',
+     *   lastUpdatedDisplayName: 'User Name',
+     *   lastUpdated: 1383247225784
+     * }
+     */
+    this.registerWebhook = function(webhook, callback) {
+        var options = {
+            rejectUnauthorized: this.strictSSL,
+            uri: this.makeUri('/webhook', 'rest/webhooks/', '1.0'),
+            method: 'POST',
+            json: true,
+            body: webhook
+        };
+
+        this.request(options, function(error, response, body) {
+
+            if (error) {
+                callback(error, null);
+                return;
+            }
+
+            if (response.statusCode === 201) {
+                callback(null, body);
+                return;
+            }
+
+            callback(response.statusCode + ': Error while registering new webhook');
+
+        });
+    };
+
+    // ## List all registered webhooks ##
+    // ### Takes ###
+    //
+    // *  callback: for when it's done
+    //
+    // ### Returns ###
+    // *  error string
+    // *  array of webhook objects
+    //
+    // [Jira Doc](https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview)
+    /*
+     * Webhook object in the format:
+     * {
+     *   name: 'my first webhook via rest',
+     *   events: [],
+     *   url: 'http://www.example.com/webhooks',
+     *   filter: '',
+     *   excludeIssueDetails: false,
+     *   enabled: true,
+     *   self: 'http://localhost:8090/rest/webhooks/1.0/webhook/5',
+     *   lastUpdatedUser: 'user',
+     *   lastUpdatedDisplayName: 'User Name',
+     *   lastUpdated: 1383247225784
+     * }
+     */
+    this.listWebhooks = function(callback) {
+        var options = {
+            rejectUnauthorized: this.strictSSL,
+            uri: this.makeUri('/webhook', 'rest/webhooks/', '1.0'),
+            method: 'GET',
+            json: true
+        };
+
+        this.request(options, function(error, response, body) {
+
+            if (error) {
+                callback(error, null);
+                return;
+            }
+
+            if (response.statusCode === 200) {
+                callback(null, body);
+                return;
+            }
+
+            callback(response.statusCode + ': Error while listing webhooks');
+
+        });
+    };
+
+    // ## Get a webhook by its ID ##
+    // ### Takes ###
+    //
+    // *  webhookID: id of webhook to get
+    // *  callback: for when it's done
+    //
+    // ### Returns ###
+    // *  error string
+    // *  webhook object
+    //
+    // [Jira Doc](https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview)
+    this.getWebhook = function(webhookID, callback) {
+        var options = {
+            rejectUnauthorized: this.strictSSL,
+            uri: this.makeUri('/webhook/' + webhookID, 'rest/webhooks/', '1.0'),
+            method: 'GET',
+            json: true
+        };
+
+        this.request(options, function(error, response, body) {
+
+            if (error) {
+                callback(error, null);
+                return;
+            }
+
+            if (response.statusCode === 200) {
+                callback(null, body);
+                return;
+            }
+
+            callback(response.statusCode + ': Error while getting webhook');
+
+        });
+    };
+
+    // ## Delete a registered webhook ##
+    // ### Takes ###
+    //
+    // *  webhookID: id of the webhook to delete
+    // *  callback: for when it's done
+    //
+    // ### Returns ###
+    // *  error string
+    // *  success string
+    //
+    // [Jira Doc](https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview)
+    this.deleteWebhook = function(webhookID, callback) {
+        var options = {
+            rejectUnauthorized: this.strictSSL,
+            uri: this.makeUri('/webhook/' + webhookID, 'rest/webhooks/', '1.0'),
+            method: 'DELETE',
+            json: true
+        };
+
+        this.request(options, function(error, response, body) {
+
+            if (error) {
+                callback(error, null);
+                return;
+            }
+
+            if (response.statusCode === 204) {
+                callback(null, "Success");
+                return;
+            }
+
+            callback(response.statusCode + ': Error while deleting webhook');
+
+        });
+    };
+
 }).call(JiraApi.prototype);