Skip to content

Implemented filters API #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anton-rudeshko wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Implemented filters API #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b3393d
Added getFilter
anton-rudeshko May 16, 2014
ecf8ec6
Added updateFilter
anton-rudeshko May 16, 2014
b52bf69
Added createFilter
anton-rudeshko May 16, 2014
ccd242c
Added deleteFilter
anton-rudeshko May 16, 2014
f05e766
Added myself to contributors
anton-rudeshko May 16, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 177 additions & 0 deletions lib/jira.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1023,6 +1023,183 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
});
};

// ## Get a filter by id ##
// ### Takes ###
//
// * filterId: the id of the filter
// * callback: for when it's done
//
// ### Returns ###
// * error string
// * filter object
//
// [Jira Doc](https://docs.atlassian.com/jira/REST/latest/#d2e484)
this.getFilter = function(filterId, callback) {
var options = {
rejectUnauthorized: this.strictSSL,
uri: this.makeUri('/filter/' + filterId),
method: 'GET',
followAllRedirects: true,
json: true
};

this.doRequest(options, function(error, response, body) {

if (error) {
callback(error, null);
return;
}

if (response.statusCode === 200 || response.statusCode === 204) {
callback(null, body);
return;
}

if (response.statusCode === 404) {
callback('Filter not found');
return;
}

callback(response.statusCode + ': Error while getting filter', body);

});
};

// ## Create a filter ##
// ### Takes ###
//
// * filter: an object of the new filter
// * callback: for when it's done
//
// ### Returns ###
// * error string
// * filter object
//
// [Jira Doc](https://docs.atlassian.com/jira/REST/latest/#d2e451)
//
/* {
* "name": "All Open Bugs",
* "description": "Lists all open bugs",
* "jql": "type = Bug and resolution is empty",
* "favourite": true
* }
*/
this.createFilter = function(filter, callback) {
var options = {
rejectUnauthorized: this.strictSSL,
uri: this.makeUri('/filter'),
method: 'POST',
followAllRedirects: true,
json: true,
body: filter
};

this.doRequest(options, function(error, response, body) {

if (error) {
callback(error, null);
return;
}

if (response.statusCode === 200 || response.statusCode === 204) {
callback(null, body);
return;
}

callback(response.statusCode + ': Error while creating filter', body);

});
};

// ## Delete a filter ##
// ### Takes ###
//
// * filterId: the id of the filter
// * callback: for when it's done
//
// ### Returns ###
// * error string
// * filter object
//
// [Jira Doc](https://docs.atlassian.com/jira/REST/latest/#d2e534)
this.deleteFilter = function(filterId, callback) {
var options = {
rejectUnauthorized: this.strictSSL,
uri: this.makeUri('/filter/' + filterId),
method: 'DELETE',
followAllRedirects: true,
json: true
};

this.doRequest(options, function(error, response, body) {

if (error) {
callback(error, null);
return;
}

if (response.statusCode === 204) {
callback(null, body);
return;
}

callback(response.statusCode + ': Error while deleting filter', body);

});
};

// ## Update a filter ##
// ### Takes ###
//
// * filter: an object of the new filter
// * callback: for when it's done
//
// ### Returns ###
// * error string
// * filter object
//
// [Jira Doc](https://docs.atlassian.com/jira/REST/latest/#d2e505)
//
/* {
* "id": "10000", // Required
* "name": "All Open Bugs",
* "description": "Lists all open bugs",
* "jql": "type = Bug and resolution is empty",
* "favourite": true
* }
*/
this.updateFilter = function(filter, callback) {
var options = {
rejectUnauthorized: this.strictSSL,
uri: this.makeUri('/filter/' + filter.id),
method: 'PUT',
followAllRedirects: true,
json: true,
body: filter
};

this.doRequest(options, function(error, response, body) {

if (error) {
callback(error, null);
return;
}

if (response.statusCode === 200 || response.statusCode === 204) {
callback(null, body);
return;
}

if (response.statusCode === 404) {
callback('Filter not found');
return;
}

callback(response.statusCode + ': Error while updating filter', body);

});
};

// ## List Components ##
// ### Takes ###
//
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Wrapper for the JIRA API",
"author": "Steven Surowiec <steven.surowiec@gmail.com>",
"contributors": [
"Anton Rudeshko <anton@rudeshko.com>",
"Chris Moultrie <chris@moultrie.org>"
],
"homepage": "http://github.com/steves/node-jira",
Expand Down