Send extra params when requesting access token instead

Author: fiznool

lib/refresh.js

@@ -1,9 +1,5 @@
 'use strict';
 
-var isString = function(str) {
-  return typeof str === 'string' || str instanceof String;
-};
-
 var AuthTokenRefresh = {};
 
 AuthTokenRefresh._strategies = {};
@@ -20,12 +16,10 @@ AuthTokenRefresh._strategies = {};
  * @param {String|Strategy} name
  * @param {Strategy} passport strategy
  */
-AuthTokenRefresh.use = function(name, strategy, params) {
-  if(!isString(name)) {
-    params = strategy;
-    strategy = name;
-
+AuthTokenRefresh.use = function(name, strategy) {
+  if(arguments.length === 1) {
     // Infer name from strategy
+    strategy = name;
     name = strategy && strategy.name;
   }
 
@@ -43,9 +37,6 @@ AuthTokenRefresh.use = function(name, strategy, params) {
     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;
@@ -54,7 +45,7 @@ AuthTokenRefresh.use = function(name, strategy, params) {
   // Use the strategy's _refreshURL, if defined,
   // otherwise use the regular accessTokenUrl.
   AuthTokenRefresh._strategies[name] = {
-    params: params,
+    strategy: strategy,
     refreshOAuth2: new OAuth2(
       strategy._oauth2._clientId,
       strategy._oauth2._clientSecret,
@@ -81,17 +72,27 @@ AuthTokenRefresh.has = function(name) {
  *                                 been registered.
  * @param  {String}   refreshToken Refresh token to be sent to request
  *                                 a new access token.
+ * @param  {Object}   params       (optional) an object containing additional
+ *                                 params to use when requesting the token.
  * @param  {Function} done         Callback when all is done.
  */
-AuthTokenRefresh.requestNewAccessToken = function(name, refreshToken, done) {
+AuthTokenRefresh.requestNewAccessToken = function(name, refreshToken, params, done) {
+  if(arguments.length === 3) {
+    done = params;
+    params = {};
+  }
+
   // Send a request to refresh an access token, and call the passed
   // callback with the result.
   var strategy = AuthTokenRefresh._strategies[name];
   if(!strategy) {
     return done(new Error('Strategy was not registered to refresh a token'));
   }
 
-  strategy.refreshOAuth2.getOAuthAccessToken(refreshToken, strategy.params, done);
+  params = params || {};
+  params.grant_type = 'refresh_token';
+
+  strategy.refreshOAuth2.getOAuthAccessToken(refreshToken, params, done);
 };
 
 module.exports = AuthTokenRefresh;

test/refresh.spec.js

@@ -34,8 +34,7 @@ describe('Auth token refresh', function() {
 
       AuthTokenRefresh.use('explicit_name', strategy);
 
-      expect(AuthTokenRefresh._strategies.explicit_name).to.be.defined;
-      expect(AuthTokenRefresh._strategies.internal_name).to.be.undefined;
+      expect(AuthTokenRefresh._strategies.explicit_name.strategy).to.equal(strategy);expect(AuthTokenRefresh._strategies.strategy).to.be.undefined;
     });
 
     it('should add a strategy without an explicitly defined name', function() {
@@ -46,7 +45,7 @@ describe('Auth token refresh', function() {
 
       AuthTokenRefresh.use(strategy);
 
-      expect(AuthTokenRefresh._strategies.internal_name).to.be.defined;
+      expect(AuthTokenRefresh._strategies.internal_name.strategy).to.equal(strategy);
     });
 
     it('should add a strategy with a refreshURL', function() {
@@ -57,6 +56,7 @@ 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,6 +67,7 @@ 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');
     });
 
@@ -80,41 +81,7 @@ 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() {
@@ -176,9 +143,6 @@ describe('Auth token refresh', function() {
 
       AuthTokenRefresh._strategies = {
         test_strategy: {
-          params: {
-            grant_type: 'refresh_token'
-          },
           refreshOAuth2: {
             getOAuthAccessToken: getOAuthAccessTokenSpy
           }
@@ -190,6 +154,23 @@ describe('Auth token refresh', function() {
       expect(getOAuthAccessTokenSpy).to.have.been.calledWith('refresh_token', { grant_type: 'refresh_token' }, done);
     });
 
+    it('should refresh a new access token with extra params', function() {
+      var getOAuthAccessTokenSpy = sinon.spy();
+      var done = sinon.spy();
+
+      AuthTokenRefresh._strategies = {
+        test_strategy: {
+          refreshOAuth2: {
+            getOAuthAccessToken: getOAuthAccessTokenSpy
+          }
+        }
+      };
+
+      AuthTokenRefresh.requestNewAccessToken('test_strategy', 'refresh_token', { some: 'extra_param' }, done);
+
+      expect(getOAuthAccessTokenSpy).to.have.been.calledWith('refresh_token', { grant_type: 'refresh_token', some: 'extra_param' }, done);
+    });
+
     it('should not refresh if the strategy was not previously registered', function() {
       var done = sinon.spy();
       var expectedErr = new Error('Strategy was not registered to refresh a token');