jira_cli

A ruby wrapper for JIRA Command Line Interface Bob Swift Atlassian Add-on

• Java version 8 (1.8) or higher).
• Bob Swift's JIRA CLI Client: CLI Client Installation and Use
  • It is recommended that you follow the best practices and create a shell script encapsulating the jira server URL, username, and password.
  • Alternatively, the jira_cli gem can be configured to explictly use these configuration options and the path the the cli jar file.

Add to your application's Gemfile:

gem 'jira_cli', '~> 1.0'

jira_cli has a wrapper class with all of Bob Swift's JIRA cli actions (Full documentation here) defined as singleton methods.

This example will display the results of the getServerInfo cli action:

jira = JiraCli::Wrapper.instance
puts jira.get_server_info

In general, all singleton methods have the same name as their CLI conterpart except that the name is converted from camel case to underscore and the arguments are keywords.

For example, you might execute the following statement with Bob Swift's CLI:

jira --action createIssue --project "PROJKEY" --type "Bug" --summary "This is a new issue"

The equivalent in ruby would be:

jira = JiraCli::Wrapper.instance
begin
  create_response = jira.create_issue(project: 'PROJKEY', type: 'Bug', summary: 'This is a new issue')
  puts "Issue created: #{create_response}"
rescue Exception => e
  puts "Jira CLI returned an error: #{e}"
end

Most methods will simply return the response from the cli as a String. If the cli command returns an error (i.e. the process writes to standard error), an exception is raised.

There are a handful of CLI actions that have a response in CSV format (such as listing issues or projects). You can optionally have jira_cli convert the csv response into a hashe by passing parse_response: true. E.g.,

jira.get_issue_list(jql: 'project=DELETEME', parse_response: true).each do |issue_id, issue_details|
  puts "Issue ID: #{issue_id}"
  puts "Issue attributes: #{issue_details}"
end

The methods that currently support the parse_response argument are:

By default JiraCli::Wrapper.instance will make system calls to the Bob Swift JIRA CLI with the assumption you have set up a shell script in your PATH which can be invoked in the format:

jira --action someCliAction --firstArgument "some value"

If your environment is not configured in this manner, you can alternatively configure the gem like this:

JiraCli.setup do |config|
  config.cli_jar_path = '/path/to/jira-cli-6.7.0.jar'
  config.server_url   = 'http://jira.mywebsite.com'
  config.user         = 'my_username'
  config.password     = 'my_password'
end

jira = JiraCli::Wrapper.instance

With this configuration, if you were to call jira.get_server_info the system call that gets executed is:

java -jar "/path/to/jira-cli-6.7.0.jar" --server "http://jira.mywebsite.com" --user "my_username" --password "my_password" --action "getServerInfo"

The following examples are based on the examples documented in Bob Swift's CLI project: Examples

Bug reports and pull requests are welcome on GitHub at https://github.com/seanhuber/jira_cli.

Any and all credit is given to Bob Swift's JIRA Command Line adapter and client. This gem is only a ruby wrapper around a well-documented, feature-rich, java-based utility: JIRA Command Line Interface [Bob Swift Atlassian Add-on]

The gem is available as open source under the terms of the MIT License.