Tests and documenation

Author: itoche

README.md

@@ -25,19 +25,54 @@ or
     $ cd node-jira
     $ npm install
 
-## Example ##
+## Examples ##
 
-Find the status of an issue.
+### Create the JIRA client ###
 
     JiraApi = require('jira').JiraApi;
-
+    
     var jira = new JiraApi('https', config.host, config.port, config.user, config.password, '2.0.alpha1');
+
+### Find the status of an issue ###
+
     jira.findIssue(issueNumber, function(error, issue) {
         console.log('Status: ' + issue.fields.status.name);
     });
 
+
 Currently there is no explicit login call necessary as each API call uses Basic Authentication to authenticate. 
 
+### Get an issue remote links ###
+
+Returns an array of remote links data.
+
+    jira.getRemoteLinks(issueKey, function(err, links) {
+        if (!err) {
+            console.log(issueKey + ' has ' + links.length + ' web links');
+        }
+    });
+
+### Create a remote link on an issue ###
+
+Returns an array of remote links data.
+    
+    // create a web link to a GitHub issue
+    var linkData = {
+        "object": {
+            "url" : "https://github.com/steves/node-jira/issues/1",
+            "title": "Add getVersions and createVersion functions",
+            "icon" : {
+                "url16x16": "https://github.com/favicon.ico"
+            }
+        }
+    };
+    
+    jira.createRemoteLink(issueKey, linkData, function (err, link) {
+        
+    });
+
+More information can be found by checking [JIRA Developer documentation](https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links#JIRARESTAPIforRemoteIssueLinks-CreatingLinks).
+
 ## Options ##
 
 JiraApi options:
@@ -84,6 +119,9 @@ JiraApi options:
   *  Add a worklog
   *  Add new estimate for worklog
   *  Add a comment
+  *  Remote links (aka Web Links)
+    * Create a remote link on an issue
+    * Get all remote links of an issue
 *  Transitions
   *  List
 *  Users

lib/jira.js

@@ -603,7 +603,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     /**
      * Retrieves the remote links associated with the given issue.
      *
-     * @param issueNumber - The internal id (not the issue key) of the issue
+     * @param issueNumber - The internal id or key of the issue
      * @param callback
      */
     this.getRemoteLinks = function getRemoteLinks(issueNumber, callback) {
@@ -623,7 +623,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
             }
 
             if (response.statusCode === 404) {
-                callback('Invalid issue.');
+                callback('Invalid issue number.');
                 return;
             }
 

spec/jira.spec.coffee

@@ -626,3 +626,58 @@ describe "Node Jira Tests", ->
         # Successful Request
         @jira.request.mostRecentCall.args[1] null, statusCode:200, body: issues: ['test']
         expect(@cb).toHaveBeenCalledWith null, issues: ['test']
+
+    it "Finds the remote links of an issue", ->
+        options =
+          rejectUnauthorized: true
+          uri: makeUrl "issue/1/remotelink"
+          method: 'GET'
+          json: true
+          auth:
+            user: 'test'
+            pass: 'test'
+        @jira.getRemoteLinks 1, @cb
+        expect(@jira.request)
+        .toHaveBeenCalledWith(options, jasmine.any(Function))
+
+        # Invalid issue number (different than unable to find??)
+        @jira.request.mostRecentCall.args[1] null, statusCode:404, null
+        expect(@cb).toHaveBeenCalledWith 'Invalid issue number.'
+
+        # Unable to find issue
+        @jira.request.mostRecentCall.args[1] null, statusCode:401, null
+        expect(@cb).toHaveBeenCalledWith(
+          '401: Unable to connect to JIRA during request.')
+
+        # Successful Request
+        @jira.request.mostRecentCall.args[1] null,
+          statusCode:200, body:"none"
+        expect(@cb).toHaveBeenCalledWith(null, 'none')
+
+    it "Creates a remote link", ->
+        options =
+          rejectUnauthorized: true
+          uri: makeUrl "issue/1/remotelink"
+          method: 'POST'
+          json: true
+          body: 'test'
+          auth:
+            user: 'test'
+            pass: 'test'
+
+        @jira.createRemoteLink 1, 'test', @cb
+        expect(@jira.request).toHaveBeenCalledWith options, jasmine.any(Function)
+
+        # Invalid Issue
+        @jira.request.mostRecentCall.args[1] null, statusCode:404, null
+        expect(@cb).toHaveBeenCalledWith 'Cannot create remote link. Invalid issue.'
+
+        response =
+          statusCode:400
+          body:
+            errors:
+              title: 'test'
+        @jira.request.mostRecentCall.args[1] null, response
+        expect(@cb).toHaveBeenCalledWith(
+          'Cannot create remote link. test')
+