diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..727b0c103 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules +config +.idea \ No newline at end of file diff --git a/README.md b/README.md index db583ae32..12b99ea53 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,41 @@ -scripler +Scripler ======== +The Scripler web application source code repository. -The Scripler web application source code repository \ No newline at end of file +Folder Structure +---------------- + +* documentation + * Early documentation drafts of the API +* public + * Static files to be deliveredserved through the Web server +* views + * Dynamic templates that needs rendering before being served from the Web server +* config + * Configuration files for the Node.js server +* models + * The MongoDB schemas for the collections +* routes + * Application logic for the different logical domains + +Requirements +------------ + * [MongoDB][1] + * [Node.js][2] 10.0+ + +Installation +------------ + npm install + +How To Run +---------- + node app.js + + +Bcrypt Installation Problems +---------------------------- +Ask for a pre-build module, or follow the guide: +https://github.com/ncb000gt/node.bcrypt.js/#dependencies + + [1]: http://www.mongodb.org/ + [2]: http://nodejs.org/ \ No newline at end of file diff --git a/app.js b/app.js new file mode 100644 index 000000000..b352ed874 --- /dev/null +++ b/app.js @@ -0,0 +1,54 @@ +var express = require('express') + , index = require('./routes/index') + , user = require('./routes/user') + , http = require('http') + , path = require('path') + , mongoose = require('mongoose') + , conf = require('config') + , passport = require('passport') + , scriplerPassport = require('./routes/passport'); + +var app = express(); + +// db connect +mongoose.connect(conf.db.uri); + +// all environments +app.set('port', conf.app.port); +app.set('views', __dirname + '/views'); +app.set('view engine', 'ejs'); +app.engine('ejs', require('ejs-locals')); +app.use(express.logger('dev')); +app.use(express.bodyParser()); +app.use(express.methodOverride()); +app.use(express.cookieParser(conf.app.cookie_secret)); +app.use(express.session({ secret: conf.app.session_secret })); +app.use(passport.initialize()); +app.use(passport.session()); +app.use(app.router); +app.use(express.static(path.join(__dirname, 'public'))); + +// development only +if ('development' == app.get('env')) { + app.use(express.errorHandler()); +} + +/*Dummy GUI*/ +//app.get('/', index.index); +//app.get('/account', index.account); +//app.get('/login', index.login); +//app.post('/login', user.login); +//app.get('/new-user', index.newUser); +//app.post('/new-user', index.newUserPost); + +/*API*/ +app.get('/users', user.list); +app.post('/user/login', user.login); +app.post('/user/logout', user.logout); +app.post('/user/register', user.register); + +scriplerPassport.initPaths(app); + +http.createServer(app).listen(app.get('port'), function () { + console.log('Express server listening on port ' + app.get('port') + ('development' == app.get('env') ? ' - in development mode!' : '')); +}); diff --git a/oauth.txt b/documentation/oauth.txt similarity index 100% rename from oauth.txt rename to documentation/oauth.txt diff --git a/rest api.txt b/documentation/rest api.txt similarity index 100% rename from rest api.txt rename to documentation/rest api.txt diff --git a/models/project.js b/models/project.js new file mode 100644 index 000000000..80bb65157 --- /dev/null +++ b/models/project.js @@ -0,0 +1,15 @@ +var mongoose = require('mongoose') + , Schema = mongoose.Schema + , bcrypt = require('bcrypt') + , SALT_WORK_FACTOR = 10; + +/** + * User DB + */ +var ProjectSchema = new Schema({ + name: { type: String, required: true }, + order: { type: Number}, + modified: { type: Date, default: Date.now } +}); + +exports.Project = mongoose.model('Project', ProjectSchema); \ No newline at end of file diff --git a/models/user.js b/models/user.js new file mode 100644 index 000000000..bac82f0a7 --- /dev/null +++ b/models/user.js @@ -0,0 +1,48 @@ +var mongoose = require('mongoose') + , Schema = mongoose.Schema + , bcrypt = require('bcrypt') + , SALT_WORK_FACTOR = 10; + +/** + * User DB + */ +var UserSchema = new Schema({ + name: { type: String, required: true }, + email: { type: String, required: true, unique: true }, + password: { type: String, required: true }, + providers: [ {} ], + modified: { type: Date, default: Date.now } +}); + +/** Handle bcrypt password-hashing. + * Source: http://devsmash.com/blog/password-authentication-with-mongoose-and-bcrypt + */ +UserSchema.pre('save', function (next) { + var user = this; + + // only hash the password if it has been modified (or is new) + if (!user.isModified('password')) return next(); + + // generate a salt + bcrypt.genSalt(SALT_WORK_FACTOR, function (err, salt) { + if (err) return next(err); + + // hash the password along with our new salt + bcrypt.hash(user.password, salt, function (err, hash) { + if (err) return next(err); + + // override the cleartext password with the hashed one + user.password = hash; + next(); + }); + }); +}); + +UserSchema.methods.comparePassword = function (candidatePassword, cb) { + bcrypt.compare(candidatePassword, this.password, function (err, isMatch) { + if (err) return cb(err); + cb(null, isMatch); + }); +}; + +exports.User = mongoose.model('User', UserSchema); \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 000000000..578297c07 --- /dev/null +++ b/package.json @@ -0,0 +1,30 @@ +{ + "name": "scripler-server", + "description": "Scripler Server", + "version": "0.0.1", + "private": true, + "scripts": { + "start": "node app.js" + }, + "dependencies": { + "express": "3.2.4", + "config": "~0.4.25", + "mongoose": "~3.6.11", + "ejs": "~0.8.4", + "ejs-locals": "~1.0.2", + "bcrypt": "~0.7.6", + "passport": "~0.1.17", + "passport-twitter": "~0.1.5", + "passport-facebook": "~0.1.5", + "passport-linkedin": "~0.1.3", + "passport-google": "~0.3.0", + "passport-local": "~0.1.6", + "xtend": "~2.0.5" + }, + "readmeFilename": "README.md", + "main": "app.js", + "devDependencies": {}, + "repository": "", + "author": "", + "license": "BSD" +} diff --git a/public/favicon.ico b/public/favicon.ico new file mode 100644 index 000000000..032dc84a2 Binary files /dev/null and b/public/favicon.ico differ diff --git a/public/stylesheets/style.css b/public/stylesheets/style.css new file mode 100644 index 000000000..a0d284851 --- /dev/null +++ b/public/stylesheets/style.css @@ -0,0 +1,8 @@ +body { + padding: 50px; + font: 14px "Lucida Grande", Helvetica, Arial, sans-serif; +} + +a { + color: #00B7FF; +} \ No newline at end of file diff --git a/routes/index.js b/routes/index.js new file mode 100644 index 000000000..538bf1cfc --- /dev/null +++ b/routes/index.js @@ -0,0 +1,25 @@ +var user = require('./user'); + +exports.index = function (req, res) { + res.render('index', {user: req.user}); +}; +exports.account = function (req, res) { + res.render('account', { user: req.user }); +}; +exports.login = function (req, res) { + res.render('login', { user: req.user, message: req.session.messages }); +}; + +exports.newUser = function (req, res) { + res.render('new-user', { user: req.user, message: req.session.messages }); +}; + +exports.newUserPost = function (req, res, next) { + //res.send(util.inspect(req.body, false, null)); + var email = req.body.email + if (!email) { + req.session.messages = ["You need to enter an email address!"]; + return res.redirect('/new-user'); + } + user.register(req, res); +} \ No newline at end of file diff --git a/routes/passport.js b/routes/passport.js new file mode 100644 index 000000000..d1c792809 --- /dev/null +++ b/routes/passport.js @@ -0,0 +1,218 @@ +var express = require('express'), + passport = require('passport'), + TwitterStrategy = require('passport-twitter').Strategy, + FacebookStrategy = require('passport-facebook').Strategy, + GoogleStrategy = require('passport-google').Strategy, + LinkedInStrategy = require('passport-linkedin').Strategy, + LocalStrategy = require('passport-local').Strategy, +//ensureLoggedIn = require('connect-ensure-login').ensureLoggedIn, + mongoose = require('mongoose'), + ObjectId = mongoose.Types.ObjectId, + extend = require('xtend'), + User = require('../models/user.js').User, +//crypto = require('crypto'), + util = require('util'), + conf = require('config') +//SALT = "s8(hb?.;*!sW" + ; + +passport.serializeUser(function (user, done) { + done(null, user._id); +}); + +passport.deserializeUser(function (uid, done) { + User.findOne({_id: uid}, function (err, user) { + done(err, user); + }); +}); + + +/* + * LOCAL ACCOUNT + */ + +// Use the LocalStrategy within Passport. +passport.use(new LocalStrategy({usernameField: 'email'}, function (email, password, done) { + User.findOne({"email": email}, function (err, user) { + if (err) { + return done(err); + } else if (user) { + // check if password is matchings + user.comparePassword(passwordpassword, function (err, isMatch) { + if (err) { + return done(err); + } else if (isMatch) { + return done(null, user); + } else { + // invalid password + return done(null, false, { message: 'Invalid password' }); + } + }); + } else { + // could not find user + return done(null, false, { message: 'Unknown user ' + email }); + } + }); +})); + +/* + * PROVIDER ACCOUNTS + */ +passport.use(new TwitterStrategy({ + consumerKey: conf.passport.twitter.consumerKey, + consumerSecret: conf.passport.twitter.consumerSecret, + callbackURL: conf.passport.twitter.callbackURL, + passReqToCallback: true + }, + function (req, token, tokenSecret, profile, done) { + addProviderToUser(profile.provider, profile.id, profile, req.user, done); + } +)); + +passport.use(new FacebookStrategy({ + clientID: conf.passport.facebook.clientID, + clientSecret: conf.passport.facebook.clientSecret, + callbackURL: conf.passport.facebook.callbackURL, + passReqToCallback: true, + profileFields: ['id', 'username', 'displayName', 'emails'] + }, + function (req, accessToken, refreshToken, profile, done) { + addProviderToUser(profile.provider, profile.id, profile, req.user, done); + } +)); + +passport.use(new GoogleStrategy({ + returnURL: conf.passport.google.returnURL, + realm: conf.passport.google.realm, + passReqToCallback: true + }, + function (req, identifier, profile, done) { + //console.log("DUMP: " + util.inspect(profile, false, null)); + addProviderToUser("google", identifier, profile, req.user, done); + } +)); + +passport.use(new LinkedInStrategy({ + consumerKey: conf.passport.linkedin.consumerKey, + consumerSecret: conf.passport.linkedin.consumerSecret, + callbackURL: conf.passport.linkedin.callbackURL, + passReqToCallback: true, + profileFields: ['id', 'name', 'emails'] + }, + function (req, token, tokenSecret, profile, done) { + addProviderToUser(profile.provider, profile.id, profile, req.user, done); + } +)); + +function addProviderToUser(provider, providerId, profile, currentUser, done) { + var providerObject = {"name": provider, "id": providerId}; + User.findOne({providers: {"$elemMatch": providerObject}}, function (err, user) { + if (user) { + //User already in database + if (currentUser && currentUser._id != user._id) { + console.log("Current user: " + currentUser); + console.log("Database user: " + user); + //TODO merge accounts? + console.log("debug: " + "User already in database, and already logged in, but not with the same account! Merge!"); + done(null, currentUser); + } else { + console.log("debug: " + "Nothing to do... User already has this account attached"); + done(null, user); + } + } else { + if (currentUser) { + //User already loggedin, so add new provider to user + var user = currentUser; + console.log("debug: " + "User already loggedin, so add new provider to user"); + user.providers.addToSet(providerObject); + done(null, user); + } else { + //New user + //TODO check if another account with same email address exists! + console.log("debug: " + "New user"); + var user = new User(); + user.providers.addToSet(providerObject); + user.name = profile.displayName; + user.email = profile.emails[0].value; + } + user.markModified('providers');//"providers" is of type "Mixed", so Mongoose, doesn't detect the change. + user.save(function (err) { + if (err) { + throw err; + } + done(null, user); + }); + } + }) +} + +function addProviderToUser(provider, providerId, profile, currentUser, done) { + var providerObject = {"name": provider, "id": providerId}; + User.findOne({providers: {"$elemMatch": providerObject}}, function (err, user) { + if (user) { + //User already in database + if (currentUser && currentUser._id != user._id) { + console.log("Current user: " + currentUser); + console.log("Database user: " + user); + //TODO merge accounts? + console.log("debug: " + "User already in database, and already logged in, but not with the same account! Merge!"); + done(null, currentUser); + } else { + console.log("debug: " + "Nothing to do... User already has this account attached"); + done(null, user); + } + } else { + if (currentUser) { + //User already loggedin, so add new provider to user + var user = currentUser; + console.log("debug: " + "User already loggedin, so add new provider to user"); + user.providers.addToSet(providerObject); + done(null, user); + } else { + //New user + //TODO check if another account with same email address exists! + console.log("debug: " + "New user"); + var user = new User(); + user.providers.addToSet(providerObject); + user.name = profile.displayName; + user.email = profile.emails[0].value; + } + user.markModified('providers');//"providers" is of type "Mixed", so Mongoose, doesn't detect the change. + user.save(function (err) { + if (err) { + throw err; + } + done(null, user); + }); + } + }) +} + + +function authnOrAuthz(provider, options) { + return function (req, res, next) { + if (!req.isAuthenticated()) { + passport.authenticate(provider, extend(options, { + successRedirect: '/settings/accounts', failureRedirect: '/login' + }))(req, res, next); + } else { + passport.authorize(provider)(req, res, next); + } + } +} + +function initPaths(app) { + app.get('/auth/twitter', authnOrAuthz('twitter')); + app.get('/auth/twitter/callback', passport.authenticate('twitter', { successReturnToOrRedirect: '/', failureRedirect: '/login' })); + + app.get('/auth/facebook', authnOrAuthz('facebook', { scope: ['email'] })); + app.get('/auth/facebook/callback', passport.authenticate('facebook', { successReturnToOrRedirect: '/', failureRedirect: '/login' })); + + app.get('/auth/google', authnOrAuthz('google')); + app.get('/auth/google/callback', passport.authenticate('google', { successReturnToOrRedirect: '/', failureRedirect: '/login' })); + + app.get('/auth/linkedin', authnOrAuthz('linkedin', {scope: ['r_basicprofile', 'r_emailaddress']})); + app.get('/auth/linkedin/callback', passport.authenticate('linkedin', { successReturnToOrRedirect: '/', failureRedirect: '/login' })); +} + +exports.initPaths = initPaths; \ No newline at end of file diff --git a/routes/project.js b/routes/project.js new file mode 100644 index 000000000..ca6a25b69 --- /dev/null +++ b/routes/project.js @@ -0,0 +1,15 @@ +var Project = require('../models/project.js').Project; + +/** + * GET projects listing. + */ + +exports.list = function (req, res) { + Project.find({}, function (err, docs) { + if (err) { + res.send({"status": -err.code, "errorMessage": "Database problem", "errorDetails": err.err}); + } else { + res.send({"status": 0, "projects": docs}); + } + }); +}; diff --git a/routes/user.js b/routes/user.js new file mode 100644 index 000000000..845194546 --- /dev/null +++ b/routes/user.js @@ -0,0 +1,90 @@ +var User = require('../models/user.js').User + , passport = require('passport'); + +/** + * GET users listing. + */ +exports.list = function (req, res) { + User.find({}, function (err, docs) { + if (err) { + res.send({"status": 0, "error": err.code, "error_text": err.err}); + } else { + res.send({"status": 1, "users": docs}); + } + }); +}; + +/** + * POST user login. + */ +exports.login = function (req, res, next) { + // passport.authenticate('local', function (err, user, info) { + // if (err) { + // return next(err) + // } + // if (!user) { + // req.session.messages = [info.message]; + // //return res.redirect('/login') + // } + // req.logIn(user, function (err) { + // if (err) { + // return next(err); + // } + // //return res.redirect('/'); + // }); + // })(req, res, next); + + User.findOne({"email": req.body.email}, function (err, user) { + if (err) { + // return error + res.send({"status": -err.code, "errorMessage": "Database problem", "errorDetails": err.err}); + } else if (user) { + // check if password is matchings + user.comparePassword(req.body.password, function (err, isMatch) { + if (err) { + // return error + res.send({"status": -err.code, "errorMessage": "Database problem", "errorDetails": err.err}); + } else if (isMatch) { + res.send({"status": 0, "user": user}); + } else { + // invalid password + res.send({"status": -1, "errorMessage": "Invalid user password"}); + } + }); + } else { + // could not find user + res.send({"status": -2, "errorMessage": "Unknown user"}); + } + }); + +}; + +/** + * POST user logout. + */ +exports.logout = function (req, res) { + res.send({"status": 0}); +}; + +/** + * POST user registration. + */ +exports.register = function (req, res) { + var user = new User({ + name: req.body.name, + email: req.body.email, + password: req.body.password + }); + user.save(function (err) { + if (err) { + // return error + if (err.code == 11000) { + res.send({"status": -1, "errorMessage": "User already registered"}); + } else { + res.send({"status": -err.code, "errorMessage": "Database problem", "errorDetails": err.err}); + } + } else { + res.send({"status": 0}); + } + }); +}; \ No newline at end of file diff --git a/views/account.ejs b/views/account.ejs new file mode 100644 index 000000000..951585d23 --- /dev/null +++ b/views/account.ejs @@ -0,0 +1,3 @@ +<% layout('layout') -%> +

User:

+
<%= user %>
\ No newline at end of file diff --git a/views/index.ejs b/views/index.ejs new file mode 100644 index 000000000..e5816115e --- /dev/null +++ b/views/index.ejs @@ -0,0 +1,7 @@ +<% layout('layout') -%> +

Scripler

+<% if (!user) { %> +

You're not supposed to be here. Visit Scripler.

+<% } else { %> +

Hello, <%= user.name %>.

+<% } %> \ No newline at end of file diff --git a/views/layout.ejs b/views/layout.ejs new file mode 100644 index 000000000..3f583c50f --- /dev/null +++ b/views/layout.ejs @@ -0,0 +1,23 @@ + + + + Scripler + + + + <% if (!user) { %> + Home | + Log In | + Create User +

+ <% } else { %> +

+ Home | + Account | + Add another login | + Log Out +

+ <% } %> + <%- body %> + + \ No newline at end of file diff --git a/views/login.ejs b/views/login.ejs new file mode 100644 index 000000000..9ee95d791 --- /dev/null +++ b/views/login.ejs @@ -0,0 +1,24 @@ +<% layout('layout') -%> +Select login-provider:
+Sign in with Twitter
+Sign in with Facebook
+Sign in with Google
+Sign in with LinkedIn
+

+Or login with a local account: +
+
+ +
+
+
+ + +
+
+ + <% if (message) { %> + <%= message %> + <% } %> +
+
\ No newline at end of file diff --git a/views/new-user.ejs b/views/new-user.ejs new file mode 100644 index 000000000..01ee509d4 --- /dev/null +++ b/views/new-user.ejs @@ -0,0 +1,28 @@ +<% layout('layout') -%> +Select login-provider:
+Sign in with Twitter
+Sign in with Facebook
+Sign in with Google
+Sign in with LinkedIn
+

+Or create a new local account: +
+
+ +
+
+
+ +
+
+
+ + +
+
+ + <% if (message) { %> + <%= message %> + <% } %> +
+
\ No newline at end of file