added support for custom headers for api key auths

Author: JonathanMontane

.gitignore

@@ -56,3 +56,4 @@ lib/
 .DS_Store
 deploy-script.sh
 coverage/
+.nyc_output/

src/serializers/paw/Serializer.js

@@ -442,15 +442,15 @@ methods.convertAuthIntoDynamicValue = (auth) => {
  * @param {Environment} environment: the environment in which this auth value is applicable.
  * @param {Auth} auth: the auth to add to the domain
  * @param {string} key: the name of the auth
- * @returns {EnvironmentVariable} the newly created environment variable.
+ * @returns {{ variable: EnvironmentVariable, auth: Auth }} the newly created environment variable.
  */
 methods.addAuthToDomain = (domain, environment, auth, key) => {
   const variable = domain.createEnvironmentVariable(key)
   const dv = methods.convertAuthIntoDynamicValue(auth)
   const ds = methods.wrapDV(dv)
   variable.setValue(ds, environment)
 
-  return variable
+  return { variable, auth }
 }
 
 /**
@@ -1041,26 +1041,33 @@ methods.convertAuthFromReference = (store, reference) => {
  * converts a reference or an auth into a DynamicString Entry.
  * @param {Store} store: the store used to resolve references
  * @param {Auth|Reference} authOrReference: the record to convert into a DynamicString
- * @returns {DynamicString} the corresponding DynamicString
+ * @returns {{ variable: DynamicString, auth: Auth }} the corresponding DynamicString
  */
 methods.convertReferenceOrAuthToDsEntry = (store, authOrReference) => {
   if (authOrReference instanceof Reference) {
     return methods.convertAuthFromReference(store, authOrReference)
   }
 
   const dv = methods.convertAuthIntoDynamicValue(authOrReference)
-  return methods.wrapDV(dv)
+  return { variable: methods.wrapDV(dv), auth: authOrReference }
 }
 
 // TODO create Variable DS that has enum with all auth possible
 /**
  * sets the Auth DynamicString as am Authorization Header.
  * @param {PawRequest} pawRequest: the paw request to update
- * @param {DynamicString} auth: the DynamicString representing an auth
+ * @param {Objecti} authData: the object containing the auth representation as a DynamicString and
+ * the original auth Record.
+ * @param {DynamicString} variable: the DynamicString representing an auth
+ * @param {Auth} auth: the original auth
  * @returns {PawRequest} the update paw request
  */
-methods.addAuthToRequest = (pawRequest, auth) => {
-  pawRequest.setHeader('Authorization', auth)
+methods.addAuthToRequest = (pawRequest, { variable, auth }) => {
+  let authName = 'Authorization'
+  if (auth instanceof Auth.ApiKey) {
+    authName = auth.get('name')
+  }
+  pawRequest.setHeader(authName, variable)
   return pawRequest
 }
 

src/serializers/paw/__tests__/Serializer.spec.js

@@ -746,7 +746,7 @@ describe('serializers/paw/Serializer.js', () => {
       spyOn(__internals__, 'convertAuthIntoDynamicValue').andReturn(123)
       spyOn(__internals__, 'wrapDV').andReturn('123')
 
-      const expected = variable
+      const expected = { variable, auth }
       const actual = __internals__.addAuthToDomain(domain, environment, auth, key)
 
       expect(domain.createEnvironmentVariable).toHaveBeenCalledWith(key)
@@ -2040,7 +2040,7 @@ describe('serializers/paw/Serializer.js', () => {
       const store = new Store()
       const auth = new Auth.Basic()
 
-      const expected = '123'
+      const expected = { variable: '123', auth }
       const actual = __internals__.convertReferenceOrAuthToDsEntry(store, auth)
 
       expect(actual).toEqual(expected)
@@ -2051,12 +2051,27 @@ describe('serializers/paw/Serializer.js', () => {
     it('should work', () => {
       const pawReq = { setHeader: () => {} }
       spyOn(pawReq, 'setHeader').andReturn(123)
-      const auth = 'some dynamic string'
+      const authData = { variable: 'some dynamic string', auth: new Auth.Basic() }
+
+      const expected = pawReq
+      const actual = __internals__.addAuthToRequest(pawReq, authData)
+
+      expect(pawReq.setHeader).toHaveBeenCalledWith('Authorization', authData.variable)
+      expect(actual).toEqual(expected)
+    })
+
+    it('should work with ApiKeys custom headers', () => {
+      const pawReq = { setHeader: () => {} }
+      spyOn(pawReq, 'setHeader').andReturn(123)
+      const authData = {
+        variable: 'some dynamic string',
+        auth: new Auth.ApiKey({ name: 'X-Auth-Token' })
+      }
 
       const expected = pawReq
-      const actual = __internals__.addAuthToRequest(pawReq, auth)
+      const actual = __internals__.addAuthToRequest(pawReq, authData)
 
-      expect(pawReq.setHeader).toHaveBeenCalledWith('Authorization', auth)
+      expect(pawReq.setHeader).toHaveBeenCalledWith('X-Auth-Token', authData.variable)
       expect(actual).toEqual(expected)
     })
   })