Writing RESTful web services using Node.js - Frontend Dev Conf 2013, Minsk

Slide 1

Slide 1 text

@jakobmattsson

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

Started out doing consulting

Slide 4

Slide 4 text

TUBSUVQT 3FDSVJUJOH "EWFSUJTJOH 'FFECBDL

Slide 5

Slide 5 text

2 000 000 000 writes/day!

Slide 6

Slide 6 text

Quick and easy customer feedback Touch&Tell helps you ﬁnd out what your guests really think about your establishment or event. You ask questions, they answer. It’s that simple.

Slide 7

Slide 7 text

Writing RESTful web services using Node.js

Slide 8

Slide 8 text

Comparison Rocket science Product demo Silver bullet

Slide 9

Slide 9 text

Comparison Rocket science Product demo Silver bullet NOT

Slide 10

Slide 10 text

What is it then?

Slide 11

Slide 11 text

Imagination Quantity Bottom up Principles

Slide 12

Slide 12 text

From zero to: - Getting a server up and running - Getting, storing and updating data - Declaring the service interface - Authenticating the user

Slide 13

Slide 13 text

Also... CoffeeScript

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

Node.js

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

Node.js is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient, perfect for data-intensive real-time applications that run across distributed devices.

Slide 18

Slide 18 text

Slide 19

Slide 19 text

fs = require('fs') fs.readFile 'meaning_of_life.txt', 'utf-8', (err, data) -> console.log(data) console.log('end')

Slide 20

Slide 20 text

end 42

Slide 21

Slide 21 text

Several protocols, including TCP and HTTP, are built in to node.

Slide 22

Slide 22 text

http = require('http') onRequest = (req, res) -> res.writeHead(200, { 'Content-Type': 'text/plain' }) res.end('Hello World\n') http.createServer(onRequest).listen(1337)

Slide 23

Slide 23 text

npm

Slide 24

Slide 24 text

npm is a package manager for node. You can use it to install and publish your node programs. ”It manages dependencies and does other cool stuff.”

Slide 25

Slide 25 text

npm install underscore

Slide 26

Slide 26 text

_ = require('underscore') numbers = _.range(1, 10) console.log(_.last(numbers))

Slide 27

Slide 27 text

Connect

Slide 28

Slide 28 text

Connect is a midleware framework for node. It’s shipping with over 18 bundled middleware. It has a rich selection of 3rd-party middleware.

Slide 29

Slide 29 text

npm install connect

Slide 30

Slide 30 text

connect = require('connect') app = connect() app.listen(3000) // last line equivalent to // http.createServer(app).listen(3000);

Slide 31

Slide 31 text

connect = require('connect') app = connect() app.use connect.basicAuth (user, pass) -> return user == 'jakob' && pass == 'fdc13' app.use (req, res) -> res.writeHead(200, { 'Content-Type': 'text/plain' }) res.end('Hello World\n') app.listen(3000)

Slide 32

Slide 32 text

logger csrf compress basicAuth bodyParser json urlencoded multipart cookieParser session cookieSession methodOverride responseTime staticCache static directory vhost favicon limit query errorHandler Request logger with custom format support Cross-site request forgery protection Gzip compression middleware Basic http authentication Extensible request body parser Application/json parser Application/x-www-form-urlencoded parser Multipart/form-data parser Cookie parser Session management support with bundled MemoryStore Cookie-based session support Faux HTTP method support Calculates response-time and exposes via X-Response-Time Memory cache layer for the static() middleware Streaming static file server supporting Range and more Directory listing middleware Virtual host sub-domain mapping middleware Efficient favicon server (with default icon) Limit the bytesize of request bodies Automatic querystring parser, populating req.query Flexible error handler

Slide 33

Slide 33 text

Express

Slide 34

Slide 34 text

High performance high class web development for Node.js

Slide 35

Slide 35 text

npm install express

Slide 36

Slide 36 text

express = require('express') app = express.createServer() app.get '/', (req, res) -> res.send('Hello World') app.get '/users/:id', (req, res) -> res.send('user ' + req.params.id) app.listen(3000)

Slide 37

Slide 37 text

express = require('express') app = express.createServer() before1 = (req, res, next) -> req.foo = 'bar' next() before2 = (req, res, next) -> res.header('X-Time', new Date().getTime()) next() app.get '/', before1, (req, res) -> res.send('Hello World') app.get '/users/:id', [before1, before2], (req, res) -> console.log(req.foo) res.send('user ' + req.params.id) app.listen(3000)

Slide 38

Slide 38 text

Data storage

Slide 39

Slide 39 text

But which one?

Slide 40

Slide 40 text

Schemaless is a lie

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Mongoose

Slide 43

Slide 43 text

Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment.

Slide 44

Slide 44 text

npm install mongoose

Slide 45

Slide 45 text

mongoose = require 'mongoose' mongoose.connect 'mongodb://localhost/tamblr' model = (name, schema) -> mongoose.model name, new mongoose.Schema schema, strict: true users = model 'users' name: type: String default: '' bio: type: String default: 'IE6-lover' age: type: Number default: null

Slide 46

Slide 46 text

blogs = model 'blogs' name: type: String default: '' description: type: String default: '' users: type: ObjectId ref: 'users'

Slide 47

Slide 47 text

posts = model 'posts' title: type: String default: '' body: type: String default: '' published: type: Date blogs: type: ObjectId ref: 'blogs'

Slide 48

Slide 48 text

list = (model, callback) -> model.find {}, callback get = (model, id, callback) -> model.findById id, callback del = (model, id, callback) -> model.remove { _id: id }, callback put = (model, id, data, callback) -> model.update { _id: id }, data, { multi: false }, callback post = (model, data, callback) -> new model(data).save callback

Slide 49

Slide 49 text

app.get '/users/:id', (req, res) -> get users, req.params.id, (err, data) -> res.json data

Slide 50

Slide 50 text

copy-paste!

Slide 51

Slide 51 text

POST /users GET /users GET /users/42 DELETE /users/42 PUT /users/42 POST /blogs GET /blogs GET /blogs/42 DELETE /blogs/42 PUT /blogs/42 POST /posts GET /posts GET /posts/42 DELETE /posts/42 PUT /posts/42

Slide 52

Slide 52 text

or should we?

Slide 53

Slide 53 text

models = [users, blogs, posts] Object.keys(models).forEach (modelName) -> app.get "/#{modelName}", (req, res) -> list models[modelName], (err, data) -> res.json data app.get "/#{modelName}/:id", (req, res) -> get models[modelName], req.params.id, (err, data) -> res.json data app.post "/#{modelName}", (req, res) -> post models[modelName], req.body, (err, data) -> res.json data app.del "/#{modelName}/:id", (req, res) -> del models[modelName], req.parmas.id, (err, count) -> res.json { count: count } app.put "/#{modelName}/:id", (req, res) -> put models[modelName], req.params.id, req.body, (err, count) -> res.json { count: count }

Slide 54

Slide 54 text

Slide 55

Slide 55 text

But what about the relations/associations?

Slide 56

Slide 56 text

POST /users/42/blogs GET /users/42/blogs POST /blogs/42/posts GET /blogs/42/posts

Slide 57

Slide 57 text

paths = models[modelName].schema.paths owners = Object.keys(paths).filter (p) -> paths[p].options.type == ObjectId && typeof paths[p].options.ref == 'string' .map (x) -> paths[x].options.ref owners.forEach (owner) -> app.get "/#{owner}/:id/#{name}", (req, res) -> listSub models[name], owner, req.params.id, (err, data) -> res.json data app.post "/#{owner}/:id/#{name}", (req, res) -> postSub models[name], req.body, owner, req.params.id, (err, data) -> res.json data

Slide 58

Slide 58 text

POST /users/42/blogs GET /users/42/blogs POST /blogs/42/posts GET /blogs/42/posts

Slide 59

Slide 59 text

Keep on generating!

Slide 60

Slide 60 text

Authentication

Slide 61

Slide 61 text

npm install passport npm install passport-local

Slide 62

Slide 62 text

passport = require('passport') passportLocal = require('passport-local') passport.use new passportLocal.Strategy (user, pass, done) -> findUserPlz { username: user, password: pass }, (err, user) -> done(err, user) app.use(passport.initialize()) app.use(passport.authenticate('local'))

Slide 63

Slide 63 text

npm install passport-twitter

Slide 64

Slide 64 text

passport = require('passport') twitter = require('passport-twitter') keys = { consumerKey: TWITTER_CONSUMER_KEY consumerSecret: TWITTER_CONSUMER_SECRET callbackURL: "http://127.0.0.1:3000/auth/twitter/callback" } passport.use new twitter.Strategy keys, (t, ts, profile, done) -> findOrCreateUserPlz { twitterId: profile.id }, (err, user) -> done(err, user) app.use(passport.initialize()) app.use(passport.authenticate('twitter'))

Slide 65

Slide 65 text

Part 2 Convention

Slide 66

Slide 66 text

ALL CHARACTERS AND EVENTS IN THIS SHOW-- EVENT THOSE BASED ON REAL PEOPLE--ARE ENTIRELY FICTIONAL. ALL CELEBERTY VOICES ARE IMPERSONATED.....POORLY. THE FOLLOWING PROGRAM CONTAINS COARSE LANGUAGE AND DUE TO ITS CONTENT IT SHOULD NOT BE VIEWED BE ANYONE

Slide 67

Slide 67 text

Verbs vs Nouns

Slide 68

Slide 68 text

/users /users/42 /blogs /blogs/73 /posts /posts/314

Slide 69

Slide 69 text

GET /users GET /users/42 POST /users PUT /users/42 DELETE /users DELETE /users/42

Slide 70

Slide 70 text

Associations

Slide 71

Slide 71 text

/users /blogs /posts

Slide 72

Slide 72 text

/users /blogs /posts /users/42/blogs /blogs/314/posts

Slide 73

Slide 73 text

/users /blogs /posts /users/42/blogs /blogs/314/posts /users/42/blogs/314/posts

Slide 74

Slide 74 text

/users /blogs /posts /users/42/blogs /blogs/314/posts /users/42/blogs/314/posts

Slide 75

Slide 75 text

/users /blogs /posts /users/42/blogs /blogs/314/posts /users/42/blogs/314/posts Keep URLs short. Don’t overqualify.