Merge pull request #48 from Woellchen/feature/retrieve_backlog

add a method that allows to retrieve a backlog by the rapid view id

Author: Steven Surowiec

lib/jira.js

@@ -1660,5 +1660,95 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
         });
     };
 
+    // ## Retrieve the backlog of a certain Rapid View ##
+	// ### Takes ###
+	// *  rapidViewId: rapid view id
+	// *  callback: for when it's done
+	//
+	// ### Returns ###
+	// *  error string
+	// *  backlog object
+	/*
+	 * Backlog item is in the format:
+	 *  {
+	 *      "sprintMarkersMigrated": true,
+	 *      "issues": [
+	 *          {
+	 *              "id": 67890,
+	 *              "key": "KEY-1234",
+	 *              "summary": "Issue Summary",
+	 *              ...
+	 *          }
+	 *      ],
+	 *      "rankCustomFieldId": 12345,
+	 *      "sprints": [
+	 *          {
+	 *              "id": 123,
+	 *              "name": "Sprint Name",
+	 *              "state": "FUTURE",
+	 *              ...
+	 *          }
+	 *      ],
+	 *      "supportsPages": true,
+	 *      "projects": [
+	 *          {
+	 *              "id": 567,
+	 *              "key": "KEY",
+	 *              "name": "Project Name"
+	 *          }
+	 *      ],
+	 *      "epicData": {
+	 *          "epics": [
+	 *              {
+	 *                  "id": 9876,
+	 *                  "key": "KEY-4554",
+	 *                  "typeName": "Epic",
+	 *                  ...
+	 *              }
+	 *          ],
+	 *          "canEditEpics": true,
+	 *          "supportsPages": true
+	 *      },
+	 *      "canManageSprints": true,
+	 *      "maxIssuesExceeded": false,
+	 *      "queryResultLimit": 2147483647,
+	 *      "versionData": {
+	 *          "versionsPerProject": {
+	 *              "567": [
+	 *                  {
+	 *                      "id": 8282,
+	 *                      "name": "Version Name",
+	 *                      ...
+	 *                  }
+	 *              ]
+	 *          },
+	 *          "canCreateVersion": true
+	 *      }
+	 *  }
+	 */
+	this.getBacklogForRapidView = function(rapidViewId, callback) {
+		var options = {
+			rejectUnauthorized: this.strictSSL,
+			uri: this.makeUri('/xboard/plan/backlog/data?rapidViewId=' + rapidViewId, 'rest/greenhopper/'),
+			method: 'GET',
+			json: true
+		};
+
+		this.doRequest(options, function(error, response) {
+			if (error) {
+				callback(error, null);
+
+				return;
+			}
+
+			if (response.statusCode === 200) {
+				callback(null, response.body);
+
+				return;
+			}
+
+			callback(response.statusCode + ': Error while retrieving backlog');
+		});
+	};
 
 }).call(JiraApi.prototype);

spec/jira.spec.coffee

@@ -548,3 +548,23 @@ describe "Node Jira Tests", ->
         # Successful Request
         @jira.request.mostRecentCall.args[1] null, statusCode:200, "body"
         expect(@cb).toHaveBeenCalledWith null, "body"
+
+    it "Retrieves a Rapid View Backlog", ->
+        options =
+            rejectUnauthorized: true
+            uri: makeUrl("xboard/plan/backlog/data?rapidViewId=123", true)
+            method: 'GET'
+            json: true
+            auth:
+              user: 'test'
+              pass: 'test'
+
+        @jira.getBacklogForRapidView 123, @cb
+        expect(@jira.request).toHaveBeenCalledWith options, jasmine.any(Function)
+
+        @jira.request.mostRecentCall.args[1] null, statusCode:500
+        expect(@cb).toHaveBeenCalledWith '500: Error while retrieving backlog'
+
+        # Successful Request
+        @jira.request.mostRecentCall.args[1] null, statusCode:200, body: issues: ['test']
+        expect(@cb).toHaveBeenCalledWith null, issues: ['test']