diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/README.md b/README.md index 6379a41..918dbaf 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# api-basic \ No newline at end of file +# API-BASIC + +API-Basic is a simple example of CRUD using the API. + +## Routes + +| Route | HTTP method | Description| +| ---------- | ------------------- | ---------- | +| /api/users | GET | Get all the users info | +| /api/users/:id | GET | Get a single user info | +| /api/users/ | POST | Create a user | +| /api/users/:id | DELETE | Delete a user | +| /api/users/:id | PUT | Update a user with new info | + + +Create user requires {username:'', password:'', role:<'admin' or 'user'>} + +## How to Use: +Install the dependencies first and then start the app as follows: +```sh +$ npm install +$ npm start +``` +Access the website via HTTP://localhost:3000, running the app in Postman is recommended diff --git a/app.js b/app.js new file mode 100644 index 0000000..b2a5037 --- /dev/null +++ b/app.js @@ -0,0 +1,46 @@ +var express = require('express'); +var path = require('path'); +var favicon = require('serve-favicon'); +var logger = require('morgan'); +var cookieParser = require('cookie-parser'); +var bodyParser = require('body-parser'); + +var index = require('./routes/index'); +var users = require('./routes/users'); + +var app = express(); + +// view engine setup +app.set('views', path.join(__dirname, 'views')); +app.set('view engine', 'ejs'); + +// uncomment after placing your favicon in /public +//app.use(favicon(path.join(__dirname, 'public', 'favicon.ico'))); +app.use(logger('dev')); +app.use(bodyParser.json()); +app.use(bodyParser.urlencoded({ extended: false })); +app.use(cookieParser()); +app.use(express.static(path.join(__dirname, 'public'))); + +app.use('/', index); +app.use('/users', users); + +// catch 404 and forward to error handler +app.use(function(req, res, next) { + var err = new Error('Not Found'); + err.status = 404; + next(err); +}); + +// error handler +app.use(function(err, req, res, next) { + // set locals, only providing error in development + res.locals.message = err.message; + res.locals.error = req.app.get('env') === 'development' ? err : {}; + + // render the error page + res.status(err.status || 500); + res.render('error'); +}); + +module.exports = app; diff --git a/bin/www b/bin/www new file mode 100755 index 0000000..fea87fd --- /dev/null +++ b/bin/www @@ -0,0 +1,90 @@ +#!/usr/bin/env node + +/** + * Module dependencies. + */ + +var app = require('../app'); +var debug = require('debug')('api-auth:server'); +var http = require('http'); + +/** + * Get port from environment and store in Express. + */ + +var port = normalizePort(process.env.PORT || '3000'); +app.set('port', port); + +/** + * Create HTTP server. + */ + +var server = http.createServer(app); + +/** + * Listen on provided port, on all network interfaces. + */ + +server.listen(port); +server.on('error', onError); +server.on('listening', onListening); + +/** + * Normalize a port into a number, string, or false. + */ + +function normalizePort(val) { + var port = parseInt(val, 10); + + if (isNaN(port)) { + // named pipe + return val; + } + + if (port >= 0) { + // port number + return port; + } + + return false; +} + +/** + * Event listener for HTTP server "error" event. + */ + +function onError(error) { + if (error.syscall !== 'listen') { + throw error; + } + + var bind = typeof port === 'string' + ? 'Pipe ' + port + : 'Port ' + port; + + // handle specific listen errors with friendly messages + switch (error.code) { + case 'EACCES': + console.error(bind + ' requires elevated privileges'); + process.exit(1); + break; + case 'EADDRINUSE': + console.error(bind + ' is already in use'); + process.exit(1); + break; + default: + throw error; + } +} + +/** + * Event listener for HTTP server "listening" event. + */ + +function onListening() { + var addr = server.address(); + var bind = typeof addr === 'string' + ? 'pipe ' + addr + : 'port ' + addr.port; + debug('Listening on ' + bind); +} diff --git a/config/config.json b/config/config.json new file mode 100644 index 0000000..5eb9a2d --- /dev/null +++ b/config/config.json @@ -0,0 +1,9 @@ +{ + "development": { + "username": "didit", + "password": "didit", + "database": "api-basic", + "host": "127.0.0.1", + "dialect": "postgres" + } +} diff --git a/controllers/user.js b/controllers/user.js new file mode 100644 index 0000000..38c693c --- /dev/null +++ b/controllers/user.js @@ -0,0 +1,62 @@ +var db = require('../models'); + +let control = { + findAll: (req, res) => { + db.User.findAll().then((data) => { + res.send(data); + }).catch((err) => { + res.send(err); + }); + }, + findById: (req, res) => { + let id = req.params.id; + db.User.findById(id).then((data) => { + res.send(data); + }).catch((err) => { + res.send(err); + }); + }, + create: (req, res) => { + let username = req.body.username; + let password = req.body.password; + let role = req.body.role; + if (username && password && role) { + db.User.create({username:username, password:password, role:role}) + .then((data) => { + res.send(data); + }).catch((err) => { + res.send(err); + }); + } else { + res.send('username, password, role must not be empty') + } + }, + delete: (req, res) => { + let userId = req.params.id; + db.User.destroy({where: {id:userId}}) + .then((destroyed) => { + res.json(destroyed); + }).catch((err) => { + res.send(err); + }); + }, + update: (req, res) => { + let userId = req.params.id; + let newUsername = req.body.username; + let newPassword = req.body.password; + db.User.update({username:newUsername, password:newPassword}, {where:{id:userId}}) + .then((updated) => { + res.send(updated); + }).catch((err) => { + res.send(err); + }); + } + +} + +module.exports = control; + +/* +user:gurame pass:bakar role:user +user:ivan pass:habibie role:admin +*/ diff --git a/migrations/20170425074439-create-user.js b/migrations/20170425074439-create-user.js new file mode 100644 index 0000000..228545b --- /dev/null +++ b/migrations/20170425074439-create-user.js @@ -0,0 +1,33 @@ +'use strict'; +module.exports = { + up: function(queryInterface, Sequelize) { + return queryInterface.createTable('Users', { + id: { + allowNull: false, + autoIncrement: true, + primaryKey: true, + type: Sequelize.INTEGER + }, + username: { + type: Sequelize.STRING + }, + password: { + type: Sequelize.STRING + }, + role: { + type: Sequelize.STRING + }, + createdAt: { + allowNull: false, + type: Sequelize.DATE + }, + updatedAt: { + allowNull: false, + type: Sequelize.DATE + } + }); + }, + down: function(queryInterface, Sequelize) { + return queryInterface.dropTable('Users'); + } +}; \ No newline at end of file diff --git a/models/index.js b/models/index.js new file mode 100644 index 0000000..7540dba --- /dev/null +++ b/models/index.js @@ -0,0 +1,36 @@ +'use strict'; + +var fs = require('fs'); +var path = require('path'); +var Sequelize = require('sequelize'); +var basename = path.basename(module.filename); +var env = process.env.NODE_ENV || 'development'; +var config = require(__dirname + '/../config/config.json')[env]; +var db = {}; + +if (config.use_env_variable) { + var sequelize = new Sequelize(process.env[config.use_env_variable]); +} else { + var sequelize = new Sequelize(config.database, config.username, config.password, config); +} + +fs + .readdirSync(__dirname) + .filter(function(file) { + return (file.indexOf('.') !== 0) && (file !== basename) && (file.slice(-3) === '.js'); + }) + .forEach(function(file) { + var model = sequelize['import'](path.join(__dirname, file)); + db[model.name] = model; + }); + +Object.keys(db).forEach(function(modelName) { + if (db[modelName].associate) { + db[modelName].associate(db); + } +}); + +db.sequelize = sequelize; +db.Sequelize = Sequelize; + +module.exports = db; diff --git a/models/user.js b/models/user.js new file mode 100644 index 0000000..a638451 --- /dev/null +++ b/models/user.js @@ -0,0 +1,15 @@ +'use strict'; +module.exports = function(sequelize, DataTypes) { + var User = sequelize.define('User', { + username: DataTypes.STRING, + password: DataTypes.STRING, + role: DataTypes.STRING + }, { + classMethods: { + associate: function(models) { + // associations can be defined here + } + } + }); + return User; +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..2f104b3 --- /dev/null +++ b/package.json @@ -0,0 +1,21 @@ +{ + "name": "api-auth", + "version": "0.0.0", + "private": true, + "scripts": { + "start": "node ./bin/www" + }, + "dependencies": { + "body-parser": "~1.17.1", + "cookie-parser": "~1.4.3", + "debug": "~2.6.3", + "ejs": "~2.5.6", + "express": "~4.15.2", + "jsonwebtoken": "^7.4.0", + "morgan": "~1.8.1", + "password-hash": "^1.2.2", + "pg": "^6.1.5", + "sequelize": "^3.30.4", + "serve-favicon": "~2.4.2" + } +} diff --git a/public/stylesheets/style.css b/public/stylesheets/style.css new file mode 100644 index 0000000..9453385 --- /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; +} diff --git a/routes/index.js b/routes/index.js new file mode 100644 index 0000000..e23c00e --- /dev/null +++ b/routes/index.js @@ -0,0 +1,16 @@ +var express = require('express'); +var router = express.Router(); +var userControl = require('../controllers/user'); + +/* GET home page. */ +router.get('/', function(req, res, next) { + res.render('index', { title: 'Express' }); +}); + +router.get('/api/users', userControl.findAll); +router.post('/api/users', userControl.create); +router.get('/api/users/:id', userControl.findById); +router.delete('/api/users/:id', userControl.delete); +router.put('/api/users/:id', userControl.update); + +module.exports = router; diff --git a/routes/users.js b/routes/users.js new file mode 100644 index 0000000..623e430 --- /dev/null +++ b/routes/users.js @@ -0,0 +1,9 @@ +var express = require('express'); +var router = express.Router(); + +/* GET users listing. */ +router.get('/', function(req, res, next) { + res.send('respond with a resource'); +}); + +module.exports = router; diff --git a/views/error.ejs b/views/error.ejs new file mode 100644 index 0000000..7cf94ed --- /dev/null +++ b/views/error.ejs @@ -0,0 +1,3 @@ +

<%= message %>

+

<%= error.status %>

+
<%= error.stack %>
diff --git a/views/index.ejs b/views/index.ejs new file mode 100644 index 0000000..7b7a1d6 --- /dev/null +++ b/views/index.ejs @@ -0,0 +1,11 @@ + + + + <%= title %> + + + +

<%= title %>

+

Welcome to <%= title %>

+ +