Merge pull request #78 from seegno/enhancement/oauth-methods-options

Update OAuth methods to allow `data` and `options` override

Author: pgom

src/providers/oauth-provider.js

@@ -107,23 +107,16 @@ function OAuthProvider() {
        * Retrieves the `access_token` and stores the `response.data` on cookies
        * using the `OAuthToken`.
        *
-       * @param {object} user - Object with `username` and `password` properties.
-       * @param {object} config - Optional configuration object sent to `POST`.
+       * @param {object} data - Request content, e.g., `username` and `password`.
+       * @param {object} options - Optional configuration.
        * @return {promise} A response promise.
        */
 
-      getAccessToken(user, options) {
-        // Check if `user` has required properties.
-        if (!user || !user.username || !user.password) {
-          throw new Error('`user` must be an object with `username` and `password` properties.');
-        }
-
-        var data = {
+      getAccessToken(data, options) {
+        data = angular.extend({
           client_id: config.clientId,
-          grant_type: 'password',
-          username: user.username,
-          password: user.password
-        };
+          grant_type: 'password'
+        }, data);
 
         if (null !== config.clientSecret) {
           data.client_secret = config.clientSecret;
@@ -132,7 +125,10 @@ function OAuthProvider() {
         data = queryString.stringify(data);
 
         options = angular.extend({
-          headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
+          headers: {
+            'Authorization': undefined,
+            'Content-Type': 'application/x-www-form-urlencoded'
+          }
         }, options);
 
         return $http.post(`${config.baseUrl}${config.grantPath}`, data, options).then((response) => {
@@ -146,28 +142,30 @@ function OAuthProvider() {
        * Retrieves the `refresh_token` and stores the `response.data` on cookies
        * using the `OAuthToken`.
        *
+       * @param {object} data - Request content.
+       * @param {object} options - Optional configuration.
        * @return {promise} A response promise.
        */
 
-      getRefreshToken() {
-        var data = {
+      getRefreshToken(data, options) {
+        data = angular.extend({
           client_id: config.clientId,
           grant_type: 'refresh_token',
           refresh_token: OAuthToken.getRefreshToken(),
-        };
+        }, data);
 
         if (null !== config.clientSecret) {
           data.client_secret = config.clientSecret;
         }
 
         data = queryString.stringify(data);
 
-        var options = {
+        options = angular.extend({
           headers: {
             'Authorization': undefined,
             'Content-Type': 'application/x-www-form-urlencoded'
           }
-        };
+        }, options);
 
         return $http.post(`${config.baseUrl}${config.grantPath}`, data, options).then((response) => {
           OAuthToken.setToken(response.data);
@@ -180,24 +178,31 @@ function OAuthProvider() {
        * Revokes the `token` and removes the stored `token` from cookies
        * using the `OAuthToken`.
        *
+       * @param {object} data - Request content.
+       * @param {object} options - Optional configuration.
        * @return {promise} A response promise.
        */
 
-      revokeToken() {
-        var data = {
+      revokeToken(data, options) {
+        var refreshToken = OAuthToken.getRefreshToken();
+
+        data = angular.extend({
           client_id: config.clientId,
-          token: OAuthToken.getRefreshToken() ? OAuthToken.getRefreshToken() : OAuthToken.getAccessToken()
-        };
+          token: refreshToken ? refreshToken : OAuthToken.getAccessToken(),
+          token_type_hint: refreshToken ? 'refresh_token' : 'access_token'
+        }, data);
 
         if (null !== config.clientSecret) {
           data.client_secret = config.clientSecret;
         }
 
         data = queryString.stringify(data);
 
-        var options = {
-          headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
-        };
+        options = angular.extend({
+          headers: {
+            'Content-Type': 'application/x-www-form-urlencoded'
+          }
+        }, options);
 
         return $http.post(`${config.baseUrl}${config.revokePath}`, data, options).then((response) => {
           OAuthToken.removeToken();

test/unit/providers/oauth-provider.spec.js

@@ -158,54 +158,6 @@ describe('OAuthProvider', function() {
         client_secret: defaults.clientSecret
       });
 
-      it('should throw an error if `user` is missing', inject(function(OAuth) {
-        try {
-          OAuth.getAccessToken();
-
-          should.fail();
-        } catch(e) {
-          e.should.be.an.instanceOf(Error);
-          e.message.should.match(/user/);
-        }
-      }));
-
-      it('should throw an error if `user` is empty', inject(function(OAuth) {
-        try {
-          OAuth.getAccessToken({});
-
-          should.fail();
-        } catch(e) {
-          e.should.be.an.instanceOf(Error);
-          e.message.should.match(/user/);
-        }
-      }));
-
-      it('should throw an error if `username` is not provided', inject(function(OAuth) {
-        try {
-          OAuth.getAccessToken({
-            password: 'foo'
-          });
-
-          should.fail();
-        } catch(e) {
-          e.should.be.an.instanceOf(Error);
-          e.message.should.match(/user/);
-        }
-      }));
-
-      it('should throw an error if `password` is not provided', inject(function(OAuth) {
-        try {
-          OAuth.getAccessToken({
-            username: 'foo'
-          });
-
-          should.fail();
-        } catch(e) {
-          e.should.be.an.instanceOf(Error);
-          e.message.should.match(/user/);
-        }
-      }));
-
       it('should call `queryString.stringify`', inject(function(OAuth) {
         sinon.spy(queryString, 'stringify');
 
@@ -364,8 +316,9 @@ describe('OAuthProvider', function() {
         queryString.stringify.firstCall.args.should.have.lengthOf(1);
         queryString.stringify.firstCall.args[0].should.eql({
           client_id: defaults.clientId,
-          client_secret: defaults.clientSecret,
-          token: 'bar'
+          token: 'bar',
+          token_type_hint: 'refresh_token',
+          client_secret: defaults.clientSecret
         });
         queryString.stringify.restore();
       }));
@@ -382,6 +335,7 @@ describe('OAuthProvider', function() {
         queryString.stringify.firstCall.args[0].should.eql({
           client_id: defaults.clientId,
           token: 'foo',
+          token_type_hint: 'access_token',
           client_secret: defaults.clientSecret
         });
         queryString.stringify.restore();
@@ -391,6 +345,7 @@ describe('OAuthProvider', function() {
         var data = queryString.stringify({
           client_id: defaults.clientId,
           token: undefined,
+          token_type_hint: 'access_token',
           client_secret: defaults.clientSecret
         });
 
@@ -415,6 +370,7 @@ describe('OAuthProvider', function() {
         var data = queryString.stringify({
           client_id: defaults.clientId,
           token: 'bar',
+          token_type_hint: 'refresh_token',
           client_secret: defaults.clientSecret
         });