Support extra params when refreshing token

Author: fiznool

lib/refresh.js

@@ -1,5 +1,9 @@
 'use strict';
 
+var isString = function(str) {
+  return typeof str === 'string' || str instanceof String;
+};
+
 var AuthTokenRefresh = {};
 
 AuthTokenRefresh._strategies = {};
@@ -16,10 +20,12 @@ AuthTokenRefresh._strategies = {};
  * @param {String|Strategy} name
  * @param {Strategy} passport strategy
  */
-AuthTokenRefresh.use = function(name, strategy) {
-  if(arguments.length === 1) {
-    // Infer name from strategy
+AuthTokenRefresh.use = function(name, strategy, params) {
+  if(!isString(name)) {
+    params = strategy;
     strategy = name;
+
+    // Infer name from strategy
     name = strategy && strategy.name;
   }
 
@@ -37,6 +43,9 @@ AuthTokenRefresh.use = function(name, strategy) {
     throw new Error('Cannot register: not an OAuth2 strategy');
   }
 
+  params = params || {};
+  params.grant_type = 'refresh_token';
+
   // Use the strategy's OAuth2 object, since it might have been overwritten.
   // https://github.com/fiznool/passport-oauth2-refresh/issues/3
   var OAuth2 = strategy._oauth2.constructor;
@@ -45,7 +54,7 @@ AuthTokenRefresh.use = function(name, strategy) {
   // Use the strategy's _refreshURL, if defined,
   // otherwise use the regular accessTokenUrl.
   AuthTokenRefresh._strategies[name] = {
-    strategy: strategy,
+    params: params,
     refreshOAuth2: new OAuth2(
       strategy._oauth2._clientId,
       strategy._oauth2._clientSecret,
@@ -82,8 +91,7 @@ AuthTokenRefresh.requestNewAccessToken = function(name, refreshToken, done) {
     return done(new Error('Strategy was not registered to refresh a token'));
   }
 
-  var params = { grant_type: 'refresh_token' };
-  strategy.refreshOAuth2.getOAuthAccessToken(refreshToken, params, done);
+  strategy.refreshOAuth2.getOAuthAccessToken(refreshToken, strategy.params, done);
 };
 
 module.exports = AuthTokenRefresh;

test/refresh.spec.js

@@ -34,7 +34,8 @@ describe('Auth token refresh', function() {
 
       AuthTokenRefresh.use('explicit_name', strategy);
 
-      expect(AuthTokenRefresh._strategies.explicit_name.strategy).to.equal(strategy);expect(AuthTokenRefresh._strategies.strategy).to.be.undefined;
+      expect(AuthTokenRefresh._strategies.explicit_name).to.be.defined;
+      expect(AuthTokenRefresh._strategies.internal_name).to.be.undefined;
     });
 
     it('should add a strategy without an explicitly defined name', function() {
@@ -45,7 +46,7 @@ describe('Auth token refresh', function() {
 
       AuthTokenRefresh.use(strategy);
 
-      expect(AuthTokenRefresh._strategies.internal_name.strategy).to.equal(strategy);
+      expect(AuthTokenRefresh._strategies.internal_name).to.be.defined;
     });
 
     it('should add a strategy with a refreshURL', function() {
@@ -56,7 +57,6 @@ describe('Auth token refresh', function() {
       };
 
       AuthTokenRefresh.use(strategy);
-      expect(AuthTokenRefresh._strategies.test_strategy.strategy).to.equal(strategy);
       expect(AuthTokenRefresh._strategies.test_strategy.refreshOAuth2._accessTokenUrl).to.equal('refreshURL');
     });
 
@@ -67,7 +67,6 @@ describe('Auth token refresh', function() {
       };
 
       AuthTokenRefresh.use(strategy);
-      expect(AuthTokenRefresh._strategies.test_strategy.strategy).to.equal(strategy);
       expect(AuthTokenRefresh._strategies.test_strategy.refreshOAuth2._accessTokenUrl).to.equal('accessTokenUrl');
     });
 
@@ -81,7 +80,41 @@ describe('Auth token refresh', function() {
       AuthTokenRefresh.use(strategy);
       expect(AuthTokenRefresh._strategies.test_strategy.refreshOAuth2).to.not.equal(strategyOAuth2);
       expect(AuthTokenRefresh._strategies.test_strategy.refreshOAuth2).to.be.instanceof(OAuth2);
+    });
+
+    it('should add a strategy with an explicit name and params', function() {
+      var strategyOAuth2 = newOAuth2();
+      var strategy = {
+        name: 'test_strategy',
+        _oauth2: strategyOAuth2
+      };
+      var params = {
+        some: 'extra_param'
+      };
+
+      AuthTokenRefresh.use('explicit_strategy', strategy, params);
+      expect(AuthTokenRefresh._strategies.explicit_strategy.params).to.eql({
+        some: 'extra_param',
+        grant_type: 'refresh_token'
+      });
+      expect(AuthTokenRefresh._strategies.test_strategy).to.be.undefined;
+    });
+
+    it('should add a strategy with explicit params', function() {
+      var strategyOAuth2 = newOAuth2();
+      var strategy = {
+        name: 'test_strategy',
+        _oauth2: strategyOAuth2
+      };
+      var params = {
+        some: 'extra_param'
+      };
 
+      AuthTokenRefresh.use(strategy, params);
+      expect(AuthTokenRefresh._strategies.test_strategy.params).to.eql({
+        some: 'extra_param',
+        grant_type: 'refresh_token'
+      });
     });
 
     it('should not add a null strategy', function() {
@@ -143,6 +176,9 @@ describe('Auth token refresh', function() {
 
       AuthTokenRefresh._strategies = {
         test_strategy: {
+          params: {
+            grant_type: 'refresh_token'
+          },
           refreshOAuth2: {
             getOAuthAccessToken: getOAuthAccessTokenSpy
           }