synergia-jira-connector
Advanced tools
Node.JS module which provides easy-to-use access to the Jira REST API.
Starting with version 1.0.0, all functions and parameters utilize xxxId instead of xxxID.
Prior to this update, this naming convention was inconsistent and easily confused.
Please update your code accordingly.
Install with npm:
$ npm install jira-connector
Install via Git clone:
$ git clone https://github.com/floralvikings/jira-connector.git
$ cd jira-connector
$ npm install
The documentation for jira-connector can be found in the source; If you'd like to view the source as an HTML document, you can use JSDoc to generate these pages. Simply run:
$ jsdoc -c jsdoc.json
In the jira-connector source directory. This will create a docs directory, containing the HTML
markup for the docs.
Also, the official Jira API docs are very useful; many of the functions in jira-connector use the exact same format as the request bodies of these endpoints.
Retrieve an issue from Jira, and print its summary to the console.
var JiraClient = require('jira-connector');
var jira = new JiraClient( {
host: 'jenjinstudios.atlassian.net'
});
jira.issue.getIssue({
issueKey: 'JWR-19'
}, function(error, issue) {
console.log(issue.fields.summary);
});
First, the JiraApi class is imported from the jira-connector module. This class
provides access to the Jira REST endpoints, organized into related classes.
The issue property of the JiraApi class is used to retrieve and modify Jira Issues.
All of the methods in the jira-connector API classes take two arguments; the opts and callback.
opts argument specifies the options that will be used when communicating with the Jira API. For a detailed
list of options, see the documentation for the method into which you are passing the options.callback argument should be a function expecting two arguments; and error, and the results of the API
request.Depending on the Jira instance to which you are connecting, authentication may or may not be required for various API calls.
jira-connector supports two forms of authentication:
This is not recommended; it will require you to provide a username and password each time you connect to the Jira instance. However, jira-connector supports it for users who are unable to use OAuth.
Example:
var JiraClient = require('jira-connector');
var jira = new JiraClient( {
host: 'jenjinstudios.atlassian.net',
basic_auth: {
username: 'SirUserOfName',
password: 'Password123'
}
});
Also not recommended, but slightly better than the above; it will require you to provide a Base64 encoded username and password (a Base64 encoding in the format of "username:password") each time you connect to the Jira instance.
More examples here.
Example:
var JiraClient = require('jira-connector');
var jira = new JiraClient( {
host: 'jenjinstudios.atlassian.net',
basic_auth: {
base64: 'U2lyVXNlck9mTmFtZTpQYXNzd29yZDEyMw=='
}
});
// Base64 encoding of 'SirUserOfName:Password123'
This should be the preferred method of authentication; it is more secure and does not require disclosing your password.
However, setting up OAuth access in Jira can be somewhat complicated; first the Jira administrator must create an Application Link; for instructions on how to do this, see Linking to Another Application.
This example may also be helpful in configuring OAuth Access.
Once the Application Link has been created, you will need the private key that corresponds to the public key used to create the link, and the consumer key that was provided when the link was created.
Once you have this data, you will need to generate an OAuth token and secret for your account; jira-connector provides helper functions for exactly this purpose:
var JiraClient = require('./index.js');
JiraClient.oauth_util.getAuthorizeURL({
host: 'jenjinstudios.atlassian.net',
oauth: {
consumer_key: 'your-consumer-key',
private_key: '-----BEGIN RSA PRIVATE KEY-----\n' +
'SomePrivateKeyHere\n' +
'-----END RSA PRIVATE KEY-----'
}
}, function (error, oauth) {
console.log(oauth);
});
This will output something similar to the following:
{
url: 'https://jenjinstudios.atlassian.net/plugins/servlet/oauth/authorize?oauth_token=some-token-here',
token: 'some-token-here',
token_secret: 'some-secret-here'
}
You can then visit the specified URL, which will display a page asking you to allow or deny the request for access. Allowing access will display a verifier code. Once you have this code, you can swap out your current OAuth token for an Access Token with all the permissions of your account; jira-connector provides a function to help with this:
var JiraClient = require('./index.js');
JiraClient.oauth_util.swapRequestTokenWithAccessToken({
host: 'jenjinstudios.atlassian.net',
oauth: {
token: 'your-oauth-token',
token_secret: 'your-token-secret',
oauth_verifier: 'verifier-code-from-jira',
consumer_key: 'your-consumer-key',
private_key: '-----BEGIN RSA PRIVATE KEY-----\n' +
'SomePrivateKeyHere\n' +
'-----END RSA PRIVATE KEY-----'
}
}, function (error, accessToken) {
console.log(accessToken);
});
This will query Jira for an Access Token, which will then be printed to the screen. Finally, you're ready to access Jira with OAuth!
var JiraClient = require('./index.js');
var jira = new JiraClient({
host: 'jenjinstudios.atlassian.net',
oauth: {
consumer_key: 'your-consumer-key',
private_key: '-----BEGIN RSA PRIVATE KEY-----\n' +
'SomePrivateKey\n' +
'-----END RSA PRIVATE KEY-----',
token: 'your-access-token',
token_secret: 'your-token-secret'
}
});
// Jira is now authenticted with your account!
You can also use a Cookie Jar for your request. It could be an easier way to prompt for a login only once, without the pain of setting up an OAuth method.
For example, using though-cookie-filestore:
var JiraClient = require('../jira-connector'),
FileCookieStore = require('tough-cookie-filestore'),
request = require('request'),
path = require('path');
var jar = request.jar(new FileCookieStore(path.join(__dirname, 'cookies.json')));
// For the first connection
var jira = new JiraClient( {
host: 'jenjinstudios.atlassian.net',
basic_auth: {
username: 'SirUserOfName',
password: 'Password123'
},
cookie_jar: jar
});
// For the following connections
var jira = new JiraClient( {
host: 'jenjinstudios.atlassian.net',
cookie_jar: jar
});
In this example, all your cookies are save in a file, cookies.json. Currently, the file MUST exist, it's a
limitation from though-cookie-filestore...
You can now only use the Cookie Jar for all the following request, as long as the file exists and the cookie is still valid!
FAQs
Easy to use NodeJS wrapper for the Jira REST API.
The npm package synergia-jira-connector receives a total of 8 weekly downloads. As such, synergia-jira-connector popularity was classified as not popular.
We found that synergia-jira-connector demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.