Merge pull request #54 from nagyv/master

OAuth support + new estimates on addWorklog

Author: tebriel

lib/jira.js

@@ -49,7 +49,8 @@
 // *  `Jira API Version<string>`: Known to work with `2` and `2.0.alpha1`
 // *  `verbose<bool>`: Log some info to the console, usually for debugging
 // *  `strictSSL<bool>`: Set to false if you have self-signed certs or something non-trustworthy
-//
+// * `oauth`: A disctionary of `consumer_key`, `consumer_secret`, `access_token` and `access_token_secret` to be used for OAuth authentication.
+// 
 // ## Implemented APIs ##
 //
 // *  Authentication
@@ -122,10 +123,11 @@
 // *  _0.0.3 Added APIs and Docco documentation_
 // *  _0.0.2 Initial version_
 var url = require('url'),
-    logger = console;
+    logger = console,
+    OAuth = require("oauth");
 
 
-var JiraApi = exports.JiraApi = function(protocol, host, port, username, password, apiVersion, verbose, strictSSL) {
+var JiraApi = exports.JiraApi = function(protocol, host, port, username, password, apiVersion, verbose, strictSSL, oauth) {
     this.protocol = protocol;
     this.host = host;
     this.port = port;
@@ -165,11 +167,19 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     };
 
     this.doRequest = function(options, callback) {
-        options.auth = {
+        if(oauth && oauth.consumer_key && oauth.consumer_secret) {
+          options.oauth = {
+            consumer_key: oauth.consumer_key,
+            consumer_secret: oauth.consumer_secret,
+            token: oauth.access_token,
+            token_secret: oauth.access_token_secret
+          };
+        } else {
+          options.auth = {
             'user': this.username,
             'pass': this.password
-        };
-
+          };
+        }
         this.request(options, callback);
     };
 
@@ -1355,10 +1365,14 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
      *      "id": "100028"
      *  }
      */
-    this.addWorklog = function(issueId, worklog, callback) {
+    this.addWorklog = function(issueId, worklog, newEstimate, callback) {
+        if(typeof callback == 'undefined') {
+          callback = newEstimate
+          newEstimate = false
+        }
         var options = {
             rejectUnauthorized: this.strictSSL,
-            uri: this.makeUri('/issue/' + issueId + '/worklog'),
+            uri: this.makeUri('/issue/' + issueId + '/worklog' + (newEstimate ? "?adjustEstimate=new&newEstimate=" + newEstimate : "")),
             body: worklog,
             method: 'POST',
             followAllRedirects: true,

package.json

@@ -22,7 +22,8 @@
     }
   ],
   "dependencies": {
-    "request": "<2.16.0"
+    "request": "<2.16.0",
+    "oauth": "^0.9.11"
   },
   "scripts": {
     "test": "grunt test"
@@ -33,6 +34,7 @@
     "grunt-docco": "^0.3.3",
     "grunt-jasmine-node": "^0.2.1",
     "coffee-script": "^1.7.1",
-    "grunt-jslint": "^1.1.8"
+    "grunt-jslint": "^1.1.8",
+    "rewire": "^2.0.0"
   }
 }

spec/jira.spec.coffee

@@ -1,6 +1,7 @@
 url         = require 'url'
 
-nodeJira    = require '../lib/jira'
+rewire = require 'rewire'
+nodeJira    = rewire '../lib/jira'
 
 describe "Node Jira Tests", ->
     makeUrl = (path, altBase) ->
@@ -15,10 +16,38 @@ describe "Node Jira Tests", ->
 
 
     beforeEach ->
+        OAuth = nodeJira.__get__ "OAuth"
+        OAuth.OAuth.prototype = jasmine.createSpyObj 'OAuth', ['getOAuthRequestToken', '_encodeData']
+        nodeJira.__set__ "OAuth", OAuth
+
         @jira = new nodeJira.JiraApi 'http', 'localhost', 80, 'test', 'test', 2
         spyOn @jira, 'request'
         @cb = jasmine.createSpy 'callback'
 
+    it "Sets basic auth if oauth is not passed in", ->
+        options =
+            auth =
+              user: 'test'
+              pass: 'test'
+        @jira.doRequest options, @cb
+        expect(@jira.request)
+            .toHaveBeenCalledWith(options, jasmine.any(Function))
+
+    it "Sets OAuth oauth for the requests if oauth is passed in", ->
+        options = 
+            oauth = 
+              consumer_key: 'ck'
+              consumer_secret: 'cs'
+              access_token: 'ac'
+              access_token_secret: 'acs'
+        # oauth = new OAuth.OAuth(null, null, oauth.consumer_key, oauth.consumer_secret, null, null, "RSA-SHA1")
+        @jira = new nodeJira.JiraApi 'http', 'localhost', 80, 'test', 'test', 2, false, false, options.oauth
+        spyOn @jira, 'request'
+
+        @jira.doRequest options, @cb
+        expect(@jira.request)
+            .toHaveBeenCalledWith(options, jasmine.any(Function))
+
     it "Sets strictSSL to false when passed in", ->
         expected = false
         jira = new nodeJira.JiraApi 'http', 'localhost', 80, 'test', 'test', 2, false, expected
@@ -529,6 +558,35 @@ describe "Node Jira Tests", ->
         @jira.request.mostRecentCall.args[1] null, statusCode:201
         expect(@cb).toHaveBeenCalledWith null, "Success"
 
+    it "Adds a worklog to a project with remaining time set", ->
+        options =
+            rejectUnauthorized: true
+            uri: makeUrl "issue/1/worklog?adjustEstimate=new&newEstimate=1h"
+            body: 'aWorklog'
+            method: 'POST'
+            followAllRedirects: true
+            json: true
+            auth:
+              user: 'test'
+              pass: 'test'
+
+        @jira.addWorklog 1, 'aWorklog', '1h', @cb
+        expect(@jira.request).toHaveBeenCalledWith options, jasmine.any(Function)
+
+        @jira.request.mostRecentCall.args[1] null, statusCode:400,
+            '{"body:"none"}'
+        expect(@cb).toHaveBeenCalledWith 'Invalid Fields: "{\\"body:\\"none\\"}"'
+
+        @jira.request.mostRecentCall.args[1] null, statusCode:403
+        expect(@cb).toHaveBeenCalledWith 'Insufficient Permissions'
+
+        @jira.request.mostRecentCall.args[1] null, statusCode:401
+        expect(@cb).toHaveBeenCalledWith '401: Error while updating'
+
+        # Successful Request
+        @jira.request.mostRecentCall.args[1] null, statusCode:201
+        expect(@cb).toHaveBeenCalledWith null, "Success"
+
     it "Lists Issue Types", ->
         options =
             rejectUnauthorized: true