Gustavo Leite de Mendonça Chaves > JIRA-REST-0.010 > JIRA::REST

Download:
JIRA-REST-0.010.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.010   Source  

NAME ^

JIRA::REST - Thin wrapper around JIRA's REST API

VERSION ^

version 0.010

SYNOPSIS ^

    use JIRA::REST;

    my $jira = JIRA::REST->new('https://jira.example.net', 'myuser', 'mypass');

    # File a bug
    my $issue = $jira->POST('/issue', undef, {
        fields => {
            project   => { key => 'PRJ' },
            issuetype => { name => 'Bug' },
            summary   => 'Cannot login',
            description => 'Bla bla bla',
        },
    });

    # Get issue
    $issue = $jira->GET("/issue/TST-101");

    # Iterate on issues
    my $search = $jira->POST('/search', undef, {
        jql        => 'project = "TST" and status = "open"',
        startAt    => 0,
        maxResults => 16,
        fields     => [ qw/summary status assignee/ ],
    });

    foreach my $issue (@{$search->{issues}}) {
        print "Found issue $issue->{key}\n";
    }

    # Iterate using utility methods
    $jira->set_search_iterator({
        jql        => 'project = "TST" and status = "open"',
        maxResults => 16,
        fields     => [ qw/summary status assignee/ ],
    });

    while (my $issue = $jira->next_issue) {
        print "Found issue $issue->{key}\n";
    }

    # Attach files using an utility method
    $jira->attach_files('TST-123', '/path/to/doc.txt', 'image.png');

DESCRIPTION ^

JIRA is a proprietary bug tracking system from Atlassian.

This module implements a very thin wrapper around JIRA's REST API which is superseding it's old SOAP API for which there is another Perl module called JIRA::Client.

CONSTRUCTOR ^

new URL, USERNAME, PASSWORD [, REST_CLIENT_CONFIG]

The constructor needs up to four arguments:

REST METHODS ^

JIRA's REST API documentation lists dozens of "resources" which can be operated via the standard HTTP requests: GET, DELETE, PUT, and POST. JIRA::REST objects implement four methods called GET, DELETE, PUT, and POST to make it easier to invoke and get results from JIRA's REST endpoints.

All four methods need two arguments:

The PUT and POST methods accept two more arguments:

All four methods return the value returned by the associated resource's method, as specified in the documentation, decoded according to its content type as follows:

Some endpoints don't return anything. In those cases, the methods return undef. The methods croak if they get any other type of values in return.

In case of errors (i.e., if the underlying HTTP method return an error code different from 2xx) the methods croak with a multi-line string like this:

    ERROR: <CODE> - <MESSAGE>
    <CONTENT-TYPE>
    <CONTENT>

So, in order to treat errors you must invoke the methods in an eval block or use any of the exception handling Perl modules, such as Try::Tiny and Try::Catch.

GET RESOURCE [, QUERY]

Returns the RESOURCE as a Perl data structure.

DELETE RESOURCE [, QUERY]

Deletes the RESOURCE.

PUT RESOURCE, QUERY, VALUE [, HEADERS]

Creates RESOURCE based on VALUE.

POST RESOURCE, QUERY, VALUE [, HEADERS]

Updates RESOURCE based on VALUE.

UTILITY METHODS ^

This module provides a few utility methods.

set_search_iterator PARAMS

Sets up an iterator for the search specified by the hash-ref PARAMS. It must be called before calls to next_issue.

PARAMS must conform with the query parameters allowed for the /rest/api/2/search JIRA REST endpoint.

next_issue

This must be called after a call to set_search_iterator. Each call returns a reference to the next issue from the filter. When there are no more issues it returns undef.

Using the set_search_iterator/next_issue utility methods you can iterate through large sets of issues without worrying about the startAt/total/offset attributes in the response from the /search REST endpoint. These methods implement the "paging" algorithm needed to work with those attributes.

attach_files ISSUE FILE...

The /issue/KEY/attachments REST endpoint, used to attach files to issues, requires a specific content type encoding which is difficult to come up with just the REST::Client interface. This utility method offers an easier interface to attach files to issues.

SEE ALSO ^

REPOSITORY ^

https://github.com/gnustavo/JIRA-REST

AUTHOR ^

Gustavo L. de M. Chaves <gnustavo@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by CPqD <www.cpqd.com.br>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: