jira-term

<!DOCTYPE html> <html> <head> <title>jira-cli.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="data-utils.html"> data-utils.coffee </a> <a class="source" href="format-options.html"> format-options.coffee </a> <a class="source" href="jira-cli.html"> jira-cli.coffee </a> <a class="source" href="jira.html"> jira.coffee </a> <a class="source" href="pretty-printer.html"> pretty-printer.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> jira-cli.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> Because colors are pretty removed ansi-colors in favor of colors. Cleaner IMO. </td> <td class="code"> <div class="highlight"><pre>colors = require 'colors'</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <a href="pretty-printer.html">PrettyPrinter docs/source</a> </td> <td class="code"> <div class="highlight"><pre>PrettyPrinter = require('./pretty-printer').PrettyPrinter JiraApi = require('jira').JiraApi</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Enum for search types, used in the stdout formatting a wee bit hacky at the moment </td> <td class="code"> <div class="highlight"><pre>searchTypes = {Issue:0, List:1}</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h2>JiraHelper</h2> This does the fancy talking to JiraApi for us. It formats the objects the way that Jira expects them to come in. Basically a wrapper for node-jira-devel </td> <td class="code"> <div class="highlight"><pre>class JiraHelper</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h2>Constructor</h2> Builds a new JiraCli with the config settings </td> <td class="code"> <div class="highlight"><pre> constructor: (@config)-> unless @config.strictSSL? @config.strictSSL = true unless @config.protocol? @config.protocol = 'http:' @jira = new JiraApi(@config.protocol, @config.host, @config.port, @config.user, @config.password, '2', false, @config.strictSSL) @response = null @error = null @pp = new PrettyPrinter dieWithFire: -> process.exit()</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h2>Get Issue</h2> Searches Jira for the issue number requested this can be either a key AB-123 or just the number 123456 </td> <td class="code"> <div class="highlight"><pre> getIssue: (issueNum, details)-> @jira.findIssue issueNum, (error, response) => if response? @response = response @pp.prettyPrintIssue response, details else @error = error if error? @pp.prettyPrintError "Error finding issue: #{error}"</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h2>Get Issue Types</h2> Gets a list of all the available issue types </td> <td class="code"> <div class="highlight"><pre> getIssueTypes: (callback)-> @jira.listIssueTypes (error, response) => if response? callback response else @pp.prettyPrintError "Error listing issueTypes: #{error}" @dieWithFire() createIssueObject: (project, summary, issueType, description, criteria) -></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> TO DO: the last arg should be an array of keys and values that are non-standard </td> <td class="code"> <div class="highlight"><pre> fields: project: { key :project } summary: summary issuetype: { id:issueType } assignee: { name:@config.user } description: description customfield_10503: criteria</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h2>Add Issue</h2> <h3>Takes</h3> <ul> <li>summary: details for the title of the issue</li> <li>description: more detailed than summary</li> <li>issue type: Id of the type (types are like bug, feature)</li> <li>project: this is the id of the project that you're assigning the issue to</li> </ul> </td> <td class="code"> <div class="highlight"><pre> addIssue: (summary, description, issueType, project, criteria) -> newIssue = @createIssueObject project, summary, issueType, description, criteria @jira.addNewIssue newIssue, (error, response) => if response? @response = response if response? @pp.prettyPrintSuccess "Issue #{response.key} has been created" else</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> The error object is non-standard here from Jira, I'll parse it better later </td> <td class="code"> <div class="highlight"><pre> @error = error if error? @msg = "Error creating issue: #{JSON.stringify(error)}" @pp.prettyPrintError @msg @dieWithFire()</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h2>Delete an Issue</h2> Deletes an issue (if you have permissions) from Jira. I haven't tested this successfully because I don't have permissions. </td> <td class="code"> <div class="highlight"><pre> deleteIssue: (issueNum)-></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> Don't have permissions currently </td> <td class="code"> <div class="highlight"><pre> @jira.deleteIssue issueNum, (error, response) => if response? @response = response @pp.prettyPrintSuccess "Issue #{issueNum} was deleted" else @error = error if error? @pp.prettyPrintError "Error deleting issue: #{error}"</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <h2>Add Worklog Item</h2> Adds a simple worklog to an issue </td> <td class="code"> <div class="highlight"><pre> addWorklog: (issueId, comment, timeSpent, exit)-> worklog = comment:comment timeSpent:timeSpent @jira.addWorklog issueId, worklog, (error, response)=> if response? @pp.prettyPrintSuccess "Worklog was added" else @error = error if error? @pp.prettyPrintError "Error adding worklog: #{error}" @dieWithFire() if exit</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <h2>List Transitions</h2> List the transitions available for an issue </td> <td class="code"> <div class="highlight"><pre> listTransitions: (issueNum, callback) -> @jira.listTransitions issueNum, (error, transitions)=> if transitions? callback transitions else @pp.prettyPrintError "Error getting transitions: #{error}" @dieWithFire()</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <h2>Transition Issue</h2> Transitions an issue in Jira <h3>Takes</h3> <ul> <li>issueNum: the Id of the issue (either the AB-123 or the 123456)</li> <li>transitionNum: this is the id of the transition to apply to the issue</li> </ul> </td> <td class="code"> <div class="highlight"><pre> transitionIssue: (issueNum, transitionNum)-> issueUpdate = transition: id:transitionNum @jira.transitionIssue issueNum, issueUpdate, (error, response) => if response? @response = response @pp.prettyPrintLog "Issue #{issueNum} " + "was transitioned" # #{color("transitioned", "green")}" else @error = error if error? @pp.prettyPrintError "Error transitioning issue: #{error}" @dieWithFire()</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <h2>Search Jira</h2> Passes a jql formatted query to jira for search <h3>Takes</h3> <ul> <li>searchQuery: a jql formatted search query string shows all otherwise</li> </ul> </td> <td class="code"> <div class="highlight"><pre> searchJira: (searchQuery, details, type)-> fields = ["summary", "status", "assignee"] @jira.searchJira searchQuery, fields, (error, issueList) => if issueList? @myIssues = issueList for issue in issueList.issues switch type when searchTypes.Issue @pp.prettyPrintIssue issue, details else # less is better as default @pp.prettyPrintList issue, details else @error = error if error? @pp.prettyPrintError "Error retreiving issues list: #{error}"</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> <h2>Get My Issues</h2> Gets a list of issues for the user listed in the config <h3>Takes</h3> <ul> <li>open: <code>boolean</code> which indicates if only open items should be shown, shows all otherwise</li> </ul> </td> <td class="code"> <div class="highlight"><pre> getMyIssues: (open, details, projects)-> jql = "assignee = \"#{@config.user}\"" if open jql += ' AND resolution = unresolved' jql += projects if projects? @searchJira jql, details return</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> <h2>List all Projects</h2> This lists all the projects viewable with your account </td> <td class="code"> <div class="highlight"><pre> getMyProjects: (callback)-> @jira.listProjects (error, projectList) => if projectList? callback projectList else @pp.prettyPrintError "Error listing projects: #{error}" @dieWithFire() module.exports = { JiraHelper } </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>