Skip to content

README.md

Latest commit

 

History

History
54 lines (36 loc) · 1.5 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.5 KB

JavaScript JIRA API for node.js

A node.js module, which provides an object oriented wrapper for the JIRA REST API.

This library is built to support version 2.0.alpha1 of the JIRA REST API.

JIRA REST API documentation can be found here

Installation

Install with the node package manager npm:

$ npm install jira

or

Install via git clone:

$ git clone git://git://github.com/steves/node-jira.git
$ cd node-jira
$ npm install

Example

Find the status of an issue.

JiraApi = require('jira').JiraApi;

var jira = new JiraApi('https', config.host, config.port, config.user, config.password, '2.0.alpha1');
jira.findIssue(issueNumber, function(error, issue) {
    console.log('Status: ' + issue.fields.status.value.name);
});

Currently there is no explicit login call necessary as each API call makes a call to login before processing. This causes a lot of unnecessary logins and will be cleaned up in a future version.

Implemented APIs

  • Authentication
  • Pulling an issue
  • Pulling a project
  • Pulling unresolved issues count for a specific version
  • Issue linking
  • Updating Issues
  • Creating Issues

TODO

  • API docs
  • Better most methods are currently undocumented
  • detailed JSON examples for common cases
  • Tests
  • Refactor currently implemented APIs to be more Object Oriented
  • Refactor to make use of built-in node.js events and classes
  • Auto-redirect between http and https following headers