From 0d8cdd38f15c9da7784fbadf314181fa308f6fa9 Mon Sep 17 00:00:00 2001
From: Sahat Yalkabov <sakhat@gmail.com>
Date: Fri, 14 Feb 2014 11:29:28 -0500
Subject: [PATCH] Added comments explaining what each authentication strategy
 is used for.

---
 config/passport.js | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/config/passport.js b/config/passport.js
index 8fce0eabd3..dd57db5376 100755
--- a/config/passport.js
+++ b/config/passport.js
@@ -1,14 +1,14 @@
+var _ = require('underscore');
 var passport = require('passport');
 var LocalStrategy = require('passport-local').Strategy;
-var OAuthStrategy = require('passport-oauth').OAuthStrategy;
-var OAuth2Strategy = require('passport-oauth').OAuth2Strategy;
 var FacebookStrategy = require('passport-facebook').Strategy;
 var TwitterStrategy = require('passport-twitter').Strategy;
 var GitHubStrategy = require('passport-github').Strategy;
 var GoogleStrategy = require('passport-google-oauth').OAuth2Strategy;
+var OAuthStrategy = require('passport-oauth').OAuthStrategy; // Tumblr
+var OAuth2Strategy = require('passport-oauth').OAuth2Strategy; // Venmo, Foursquare
 var User = require('../models/User');
 var secrets = require('./secrets');
-var _ = require('underscore');
 
 passport.serializeUser(function(user, done) {
   done(null, user.id);
@@ -20,6 +20,10 @@ passport.deserializeUser(function(id, done) {
   });
 });
 
+/**
+ * Sign in using Email and Password.
+ */
+
 passport.use(new LocalStrategy({ usernameField: 'email' }, function(email, password, done) {
   User.findOne({ email: email }, function(err, user) {
     if (!user) return done(null, false, { message: 'Email ' + email + ' not found'});
@@ -205,6 +209,11 @@ passport.use(new GoogleStrategy(secrets.google, function(req, accessToken, refre
   }
 }));
 
+/**
+ * Tumblr API
+ * Uses OAuth 1.0a Strategy.
+ */
+
 passport.use('tumblr', new OAuthStrategy({
     requestTokenURL: 'http://www.tumblr.com/oauth/request_token',
     accessTokenURL: 'http://www.tumblr.com/oauth/access_token',
@@ -224,6 +233,11 @@ passport.use('tumblr', new OAuthStrategy({
   }
 ));
 
+/**
+ * Foursquare API
+ * Uses OAuth 2.0 Strategy.
+ */
+
 passport.use('foursquare', new OAuth2Strategy({
     authorizationURL: 'https://foursquare.com/oauth2/authorize',
     tokenURL: 'https://foursquare.com/oauth2/access_token',
@@ -242,6 +256,11 @@ passport.use('foursquare', new OAuth2Strategy({
   }
 ));
 
+/**
+ * Venmo API
+ * Uses OAuth 2.0 Strategy.
+ */
+
 passport.use('venmo', new OAuth2Strategy({
     authorizationURL: 'https://api.venmo.com/v1/oauth/authorize',
     tokenURL: 'https://api.venmo.com/v1/oauth/access_token',
@@ -260,11 +279,19 @@ passport.use('venmo', new OAuth2Strategy({
   }
 ));
 
+/**
+ * Login Required middleware.
+ */
+
 exports.isAuthenticated = function(req, res, next) {
   if (req.isAuthenticated()) return next();
   res.redirect('/login');
 };
 
+/**
+ * Authorization Required middleware.
+ */
+
 exports.isAuthorized = function(req, res, next) {
   var provider = req.path.split('/').slice(-1)[0];
   if (_.findWhere(req.user.tokens, { kind: provider })) next();