Bug fixes for problems experienced using apiKey and edit calls (#99)

* Fixing alwaysUseGet feature and adding a test for it.  Moving apiKey into headers for all requests when apiKey is used and adding to edit test

Author: jwiggins78

package.json

@@ -1,6 +1,6 @@
 {
   "name": "workfront-api",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "A Workfront API for the Node.js and the Web",
   "main": "dist/workfront.js",
   "module": "es/index.js",

src/Api.ts

@@ -31,7 +31,10 @@ export interface IHttpOptions {
     method?: string
     url: string
     alwaysUseGet?: boolean
-    headers: {sessionID?: string}
+    headers: {
+        sessionID?: string,
+        apiKey?: string
+    }
 }
 export type TFields = string | string[]
 
@@ -60,8 +63,12 @@ export class Api {
     constructor(config) {
         this._httpOptions = {
             url: config.url,
+            alwaysUseGet: config.alwaysUseGet,
             headers: {}
         }
+        if (config.apiKey) {
+            this._httpOptions.headers.apiKey = config.apiKey
+        }
         // Append version to path if provided
         let path
         if (['internal', 'unsupported', 'asp'].indexOf(config.version) >= 0) {
@@ -85,20 +92,20 @@ export class Api {
      */
     getApiKey(username: string, password: string): Promise<string> {
         return new Promise((resolve, reject) => {
-            if (typeof this._httpParams.apiKey !== 'undefined') {
-                resolve(this._httpParams.apiKey)
+            if (typeof this._httpOptions.headers.apiKey !== 'undefined') {
+                resolve(this._httpOptions.headers.apiKey)
             }
             else {
                 this.execute('USER', null, 'getApiKey', {username, password}).then((getApiKeyData) => {
                     if (getApiKeyData.result === '') {
                         this.execute('USER', null, 'generateApiKey', {username, password}).then((generateApiKeyData) => {
-                            this._httpParams.apiKey = generateApiKeyData.result
-                            resolve(this._httpParams.apiKey)
+                            this._httpOptions.headers.apiKey = generateApiKeyData.result
+                            resolve(this._httpOptions.headers.apiKey)
                         }, reject)
                     }
                     else {
-                        this._httpParams.apiKey = getApiKeyData.result
-                        resolve(this._httpParams.apiKey)
+                        this._httpOptions.headers.apiKey = getApiKeyData.result
+                        resolve(this._httpOptions.headers.apiKey)
                     }
                 }, reject)
             }
@@ -151,7 +158,7 @@ export class Api {
         return new Promise((resolve, reject) => {
             this.execute('USER', null, 'clearApiKey').then((result) => {
                 if (result) {
-                    delete this._httpParams.apiKey
+                    delete this._httpOptions.headers.apiKey
                     resolve()
                 } else {
                     reject()
@@ -362,6 +369,9 @@ export class Api {
         if (this._httpOptions.headers.sessionID) {
             headers.append('sessionID', this._httpOptions.headers.sessionID)
         }
+        else if (this._httpOptions.headers.apiKey) {
+            headers.append('apiKey', this._httpOptions.headers.apiKey)
+        }
 
         let bodyParams = null, queryString = ''
         if (NodeFormData && params instanceof NodeFormData) {
@@ -385,7 +395,7 @@ export class Api {
         }
 
         return fetch(options.url + options.path + queryString, {
-            method: method,
+            method: alwaysUseGet ? 'GET' : method,
             headers: headers,
             body: bodyParams,
             credentials: 'same-origin'
@@ -413,7 +423,7 @@ export class Api {
      * @return {string} returns the given api key value
      */
     setApiKey(apiKey) {
-        return this._httpParams.apiKey = apiKey
+        return this._httpOptions.headers.apiKey = apiKey
     }
 
     /**

test/integration/edit.spec.ts

@@ -28,7 +28,8 @@ describe('Edit', function() {
 
     beforeEach(function() {
         this.api = new Workfront.Api({
-            url: API_URL
+            url: API_URL,
+            apiKey: 'testapikey'
         })
     })
     afterEach(function() {
@@ -56,6 +57,7 @@ describe('Edit', function() {
             const [url, opts] = fetchMock.lastCall('edit')
             should(opts.method).equal('PUT')
             should(url).endWith(objCode + '/' + objID)
+            should(opts.headers.get('apiKey')).equal('testapikey')
             should(opts.body).containEql('name=' + encodeURIComponent('api test 2'))
 
             should(data).have.properties(['ID', 'name', 'objCode'])

test/integration/editUsingGet.spec.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright 2015 Workfront
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as fetchMock from 'fetch-mock'
+import * as should from 'should'
+
+import * as Workfront from '../../src/index'
+
+const API_URL = 'http://foobar:8080'
+
+describe('Edit', function() {
+
+    afterEach(fetchMock.reset)
+    afterEach(fetchMock.restore)
+
+    beforeEach(function() {
+        this.api = new Workfront.Api({
+            url: API_URL,
+            apiKey: 'testapikey',
+            alwaysUseGet: true
+        })
+    })
+    afterEach(function() {
+        this.api = undefined
+    })
+
+    beforeEach(function() {
+        fetchMock.mock(
+            `begin:${API_URL}/attask/api/`,
+            require('../../fixtures/edit.json'),
+            {
+                name: 'edit'
+            }
+        )
+    })
+
+    it('makes a GET request with method=PUT and with proper params and return the edited object', function() {
+        const params = {
+            name: 'api test 2'
+        }
+        const objCode = 'PROJ',
+            objID = 'foobar'
+
+        return this.api.edit(objCode, objID, params).then(function(data) {
+            const [url, opts] = fetchMock.lastCall('edit')
+            should(opts.method).equal('GET')
+            should(url).endWith(objCode + '/' + objID)
+            should(opts.headers.get('apiKey')).equal('testapikey')
+            should(opts.body).containEql('name=' + encodeURIComponent('api test 2'))
+            should(opts.body).containEql('method=PUT')
+
+            should(data).have.properties(['ID', 'name', 'objCode'])
+            should(data.objCode).equal(objCode)
+            should(data.name).equal(params.name)
+        })
+    })
+})