Git Product home page Git Product logo

jira-rest's Introduction

NAME

JIRA::REST - Alternative Jira REST client

VERSION

version 0.01

SYNOPSIS

use JIRA::REST;

my $client = JIRA::REST->new(
    username => 'username',
    password => 'password',
    base_url => 'http://jira.mycompany.com',
);
my $issue = $client->get_issue( 'TICKET-12' );
print $issue->{fields}{priority}{value}{name}."\n";

DESCRIPTION

JIRA::REST is a wrapper for the JIRA REST API. It is a thin wrapper, returning the decoded version of the JSON without any munging or mangling.

JIRA::REST is *heavily* based upon JIRA::Client::REST. The primary difference is that the latter library uses Net::HTTP::Spore, and this library just uses LWP directly. Additionally, this library has more flexible and (IMO) more sane method signatures. Finally, this library also currently implements more of the JIRA REST API than JIRA::Client::REST

ATTRIBUTES

api_prefix

Set/Get the initial part of the URL for the JIRA instance

Example: '/rest/api/latest/'

Default: '/rest/api/latest/'

base_url

Set/Get the base host part of the URL for the JIRA instance.

Example: 'https://jira.yourcompany.com'

No default; required attribute.

debug

Debug flag. Makes the copious outputs.

password

Set/Get the password to use when connecting to JIRA.

username

Set/Get the username to use when connecting to JIRA.

METHODS

create_issue( %args )

Create an issue with the provided arguments. Returns the issue ID for the newly generated issue or throws an exception.

Example:

my $new_issue_id = $client->create_issue(
  fields => {
    assignee    => { name => 'jira.username' } ,
    project     => { key => 'PROJECTKEY' } ,
    summary     => 'short summary' ,
    description => 'long description' ,
    issuetype   => { name => 'Type' } ,
  },
);

delete_issue_link( %args )

Delete a link between two issues

get_issue( %args )

Get the issue with the supplied id. Returns a HashRef of data.

get_issue_createmeta( %args )

Get the meta data (required and optional fields, etc.) for creating issues.

get_issue_link_types()

Get a list of all possible issue link types

get_issue_transitions( %args )

Get the transitions possible for this issue by the current user.

get_issue_votes( %args )

Get voters on the issue.

get_issue_watchers( %args )

Get watchers on the issue.

get_project( %args )

Get the project for the specifed key.

get_project_versions( %args )

Get the versions for the project with the specified key.

get_version( %args )

Get the version with the specified id.

link_issues( %args )

Link together two issues

post_comment( %args )

Post a comment on an issue

search( %args )

Search for issues

unvote_for_issue( %args )

Remove your vote from an issue.

unwatch_issue( %args )

Remove a watcher from an issue.

vote_for_issue( %args )

Cast your vote in favor of an issue.

watch_issue( %args )

Watch an issue. (Or have someone else watch it.)

AUTHOR

John SJ Anderson [email protected]

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Infinity Interactive.

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

jira-rest's People

Contributors

genehack avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.