Merge branch 'master' into rewrite

Conflicts: lib/modules/everymodule.js
bnoguchi · Mar 6, 2012 · 16590b7 · 16590b7
2 parents 4a935ed + 2dea084
commit 16590b7
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -268,29 +268,39 @@ everyauth.everymodule.handleLogout( function (req, res) {
 
   // And/or put your extra logic here
 
-  res.writeHead(303, { 'Location': this.logoutRedirectPath() });
+  this.redirect(res, this.logoutRedirectPath());
-  res.end();
 });
 ```
 
 ## Custom redirect on login or registration
 
 You may want your own callback that decides where to send a user after login or registration.  One way of doing this is with the `respondToLoginSucceed` and `respondToRegistrationSucceed` methods.  This assumes that you have set a `.redirectTo` property on your `req.session` object:
 
-```
+```javascript
 everyauth.password
   .respondToLoginSucceed( function (res, user, data) {
     if (user) {
-      res.writeHead(303, {'Location': data.session.redirectTo});
+      this.redirect(res, data.session.redirectTo)
-      res.end();
     }   
   })
   .respondToRegistrationSucceed( function (res, user, data) {
-    res.writeHead(303, {'Location': data.session.redirectTo});
+    this.redirect(res, data.session.redirectTo)
-    res.end();
   })
 ```
 
+If you are using express and want your redirects to be subject to [express
+redirect mapping](http://expressjs.com/guide.html#res.redirect\(\)), you can
+overwrite redirect method employed by everyauth.
+
+```javascript
+everyauth.everymodule
+  .performRedirect( function (res, location) {
+    res.redirect(location, 303);
+  });
+```
+
+A newly defined method will be used by everyauth to perform all redirects.
+
 # Auth Strategy Instructions
 
 ## Facebook Connect

diff --git a/lib/modules/azureacs.js b/lib/modules/azureacs.js
@@ -79,9 +79,7 @@ everyModule.submodule('azureacs')
 
   .redirectToIdentityProviderSelector( function (req, res) {
     var identityProviderSelectorUri = this.wsfederation.getRequestSecurityTokenUrl();
-
+    this.redirect(res, identityProviderSelectorUri);
-    res.writeHead(303, {'Location': identityProviderSelectorUri});
-    res.end();
   })
 
   .getToken( function (req, res) {
@@ -126,15 +124,14 @@ everyModule.submodule('azureacs')
     _auth.loggedIn = true;
     _auth.userId || (_auth.userId = acsUser.id);
     mod.user = acsUser;
-    mod.accessToken = token; 
+    mod.accessToken = token;
   })
 
   .sendResponse( function (res) {
     var redirectTo = this.redirectPath();
     if (!redirectTo)
       throw new Error('You must configure a redirectPath');
-    res.writeHead(303, {'Location': redirectTo});
+    this.redirect(res, redirectTo);
-    res.end();
   })
 
   .authCallbackDidErr( function (req) {

diff --git a/lib/modules/box.js b/lib/modules/box.js
@@ -68,10 +68,7 @@ everyModule.submodule('box')
     return promise;
   })
   .redirectToBoxAuth( function (res, ticket) {
-    res.writeHead(303, {
+    this.redirect(res, this._apiHost + '/auth/' + ticket);
-      'Location': this._apiHost + '/auth/' + ticket
-    });
-    res.end();
   })
 
   .extractAuthToken( function (req, res) {
@@ -116,8 +113,7 @@ everyModule.submodule('box')
     var redirectTo = this.redirectPath();
     if (!redirectTo)
       throw new Error('You must configure a redirectPath');
-    res.writeHead(303, {'Location': redirectTo});
+    this.redirect(res, redirectTo);
-    res.end();
   })
 
   .entryPath('/auth/box')

diff --git a/lib/modules/everymodule.js b/lib/modules/everymodule.js
@@ -253,6 +253,10 @@ var everyModule = module.exports = {
       seq.initialArgs = args;
       throw seq;
     }
+
+  , redirect: function (req, location) {
+      this._performRedirect(req, location);
+    }
 };
 
 // Inherit from EventEmitter
@@ -333,6 +337,7 @@ everyModule
         'defaults to `throw` wrapper'
     , logoutRedirectPath: 'Where to redirect the app upon logging out'
     , findUserById: 'function for fetching a user by his/her id -- used to assign to `req.user` - function (userId, callback) where function callback (err, user)'
+    , performRedirect: 'function for redirecting responses'
   })
   .get('logoutPath')
     .step('handleLogout')
@@ -341,11 +346,15 @@ everyModule
   .logoutPath('/logout')
   .handleLogout( function (req, res) {
     req.logout();
-    res.writeHead(303, { 'Location': this.logoutRedirectPath() });
+    this.redirect(res, this.logoutRedirectPath());
-    res.end();
   })
   .logoutRedirectPath('/');
 
+everyModule.performRedirect( function(res, location) {
+  res.writeHead(303, { 'Location': location });
+  res.end();
+});
+
 everyModule.moduleTimeout(10000);
 everyModule.moduleErrback( function (err) {
   if (! (err instanceof Error)) {

diff --git a/lib/modules/googlehybrid.js b/lib/modules/googlehybrid.js
@@ -54,8 +54,7 @@ openidModule.submodule('googlehybrid')
 
     this.relyingParty.authenticate('http://www.google.com/accounts/o8/id', false, function (err,authenticationUrl){
       if(err) return p.fail(err);
-      res.writeHead(302, { Location: authenticationUrl });
+      this.redirect(res, authenticationUrl);
-      res.end();
     });
   }) 
   .entryPath('/auth/googlehybrid')

diff --git a/lib/modules/linkedin.js b/lib/modules/linkedin.js
@@ -29,8 +29,7 @@ oauthModule.submodule('linkedin')
   .callbackPath('/auth/linkedin/callback')
 
   .redirectToProviderAuth( function (res, token) {
-    res.writeHead(303, { 'Location': 'https://www.linkedin.com' + this.authorizePath() + '?oauth_token=' + token });
+    this.redirect(res, 'https://www.linkedin.com' + this.authorizePath() + '?oauth_token=' + token);
-    res.end();
   })
 
   .fetchOAuthUser( function (accessToken, accessTokenSecret, params) {

diff --git a/lib/modules/oauth.js b/lib/modules/oauth.js
@@ -130,8 +130,7 @@ everyModule.submodule('oauth')
     if (this._sendCallbackWithAuthorize) {
       redirectTo += '&oauth_callback=' + this._myHostname + this._callbackPath;
     }
-    res.writeHead(303, { 'Location': redirectTo });
+    this.redirect(res, redirectTo);
-    res.end();
   })
 
   // Steps for GET `callbackPath`
@@ -202,8 +201,7 @@ everyModule.submodule('oauth')
     var redirectTo = this.redirectPath();
     if (!redirectTo)
       throw new Error('You must configure a redirectPath');
-    res.writeHead(303, {'Location': redirectTo});
+    this.redirect(res, redirectTo);
-    res.end();
   })
 
   .waitForPriorRequestToWriteSession( function (req, res) {

diff --git a/lib/modules/oauth2.js b/lib/modules/oauth2.js
@@ -125,8 +125,7 @@ everyModule.submodule('oauth2')
     return url + '?' + querystring.stringify(params);
   })
   .requestAuthUri( function (res, authUri) {
-    res.writeHead(303, {'Location': authUri});
+    this.redirect(res, authUri);
-    res.end();
   })
   .getCode( function (req, res) {
     var parsedUrl = url.parse(req.url, true);
@@ -221,8 +220,7 @@ everyModule.submodule('oauth2')
     var redirectTo = this._redirectPath;
     if (!redirectTo)
       throw new Error('You must configure a redirectPath');
-    res.writeHead(303, {'Location': redirectTo});
+    this.redirect(res, redirectTo);
-    res.end();
   })
 
   .authCallbackDidErr( function (req, res) {

diff --git a/lib/modules/openid.js b/lib/modules/openid.js
@@ -52,8 +52,7 @@ everyModule.submodule('openid')
 
     this.relyingParty.authenticate(req.query[this.openidURLField()], false, function(err,authenticationUrl){
       if(err) return p.fail(err);
-      res.writeHead(302, { Location: authenticationUrl });
+      this.redirect(res, authenticationUrl);
-      res.end();
     });
   })
   .verifyAttributes(function(req,res) {
@@ -75,8 +74,7 @@ everyModule.submodule('openid')
     var redirectTo = this.redirectPath();
     if (!redirectTo)
       throw new Error('You must configure a redirectPath');
-    res.writeHead(303, {'Location': redirectTo});
+    this.redirect(res, redirectTo);
-    res.end();
   })
   .redirectPath('/')
   .entryPath('/auth/openid')

diff --git a/lib/modules/password.js b/lib/modules/password.js
@@ -205,8 +205,7 @@ everyModule.submodule('password')
   })
   .respondToLoginSucceed( function (res, user) {
     if (user) {
-      res.writeHead(303, {'Location': this.loginSuccessRedirect()});
+      this.redirect(res, this.loginSuccessRedirect());
-      res.end();
     }
   })
   .respondToLoginFail( function (req, res, errors, login) {
@@ -327,8 +326,7 @@ everyModule.submodule('password')
     return user;
   })
   .respondToRegistrationSucceed( function (res, user) {
-    res.writeHead(303, {'Location': this.registerSuccessRedirect()});
+    this.redirect(res, this.registerSuccessRedirect());
-    res.end();
   })
 
   .stepseq('registrationFailSteps')

diff --git a/lib/modules/tripit.js b/lib/modules/tripit.js
@@ -12,8 +12,7 @@ oauthModule.submodule('tripit')
     if (this.sendCallbackWithAuthorize()) {
       redirectTo += '&oauth_callback=' + this.myHostname() + this.callbackPath();
     }
-    res.writeHead(303, { 'Location': redirectTo });
+    this.redirect(res, redirectTo);
-    res.end();
   })
   .fetchOAuthUser( function (accessToken, accessTokenSecret, params) {
     var promise = this.Promise();