Skip to content

Much more robust API (may help a lot of people) #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dstroot wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Much more robust API (may help a lot of people) #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9fd3f6
Much more robust API
Jan 25, 2013
efffd87
More Robust API
Jan 25, 2013
d1c8fb1
Fixed dashboard so it doesn't count itself
Jan 25, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion public/dashboard.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h5>active visitors</h5>
console.log('Socket connected');

socket.on('pageview', function (msg) {
$('#connections').html(msg.connections);
$('#connections').html(msg.connections - 1); // less one since we don't count our own dashboard connection
if (msg.url) {
if ($('#visits tr').length > 10) {
$('#visits tr:last').remove();
Expand Down
173 changes: 137 additions & 36 deletions routes/wines.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,74 +19,169 @@ db.open(function(err, db) {
}
});

// GET /wines/:id
exports.findById = function(req, res) {

// At some point we may want to lock this api down!
// If this is on the Internet someone could easily
// steal, modify or delete your data! Need something like
// this on our api (assuming we have people authenticate):
// if (req.session.userAuthenticated) {

// We don't want the browser to cache the results
res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');
Copy link

@d48 d48 Jan 25, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just a watcher on this repo but wanted to comment that it's awesome that you've added no caching ✨

Copy link
Author

@dstroot dstroot Jan 25, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Ryan!

On Thu, Jan 24, 2013 at 8:45 PM, Ryan Regalado notifications@github.comwrote:

In routes/wines.js:

exports.findById = function(req, res) {
+

  • // At some point we may want to lock this api down!
  • // If this is on the Internet someone could easily
  • // steal, modify or delete your data! Need something like
  • // this on our api (assuming we have people authenticate):
  • // if (req.session.userAuthenticated) {
  • // We don't want the browser to cache the results
  • res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');

I'm just a watcher on this repo but wanted to comment that it's awesome
that you've added no caching [image: ✨]

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/6/files#r2770226.

  • Dan Stroot


var id = req.params.id;
console.log('Retrieving wine: ' + id);
db.collection('wines', function(err, collection) {
collection.findOne({'_id':new BSON.ObjectID(id)}, function(err, item) {
res.send(item);
// need to validate the id is in a valid format (24 hex)
var regexObj = /^[A-Fa-f0-9]{24}$/;
if (regexObj.test(id)) {
db.collection('wines', function(err, collection) {
// We will search for all docs with that ID
collection.find({'_id':new BSON.ObjectID(id)}).toArray(function(err, items) {
if (err) {
//console.log('Error getting wine by ID: ' + id + ' Error: ' + err);
res.json(500, {'error':'An error has occurred!'});
} else if (items.length != 1) {
//console.log('Wine not found. ID: ' + id);
res.json(404, {'message':'item not found'});
} else {
//console.log('Success getting wine by ID: ' + id);
res.json(200, items[0]);
}
});
});
});
} else {
//console.log('Error invalid ID format: ' + id);
res.json(500, {'error':'invalid ID format'});
}
};

// GET /wines
exports.findAll = function(req, res) {
// We don't want the browser to cache the results
res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');

db.collection('wines', function(err, collection) {
collection.find().toArray(function(err, items) {
res.send(items);
if (err) {
//console.log('Error getting all wines: ' + err);
res.json(500, {'error':'An error has occurred!'});
} else {
//console.log('Success getting all wines.');
res.json(200, items);
}
});
});
};

// POST /wines
exports.addWine = function(req, res) {

// We don't want the browser to cache the results
res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');

var wine = req.body;
console.log('Adding wine: ' + JSON.stringify(wine));
db.collection('wines', function(err, collection) {
collection.insert(wine, {safe:true}, function(err, result) {
if (err) {
res.send({'error':'An error has occurred'});
//console.log('Error adding wine: ' + err);
res.json(500, {'error':'An error has occurred'});
} else {
console.log('Success: ' + JSON.stringify(result[0]));
res.send(result[0]);
//console.log('Success adding wine: ' + JSON.stringify(result[0]));
res.json(201, result[0]);
}
});
});
}

// PUT /wines/:id
exports.updateWine = function(req, res) {

// We don't want the browser to cache the results
res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');

var id = req.params.id;
var wine = req.body;
delete wine._id;
console.log('Updating wine: ' + id);
console.log(JSON.stringify(wine));
db.collection('wines', function(err, collection) {
collection.update({'_id':new BSON.ObjectID(id)}, wine, {safe:true}, function(err, result) {
if (err) {
console.log('Error updating wine: ' + err);
res.send({'error':'An error has occurred'});
} else {
console.log('' + result + ' document(s) updated');
res.send(wine);
}
delete wine._id; // remove the ID field

// need to validate the id is in a valid format (24 hex)
var regexObj = /^[A-Fa-f0-9]{24}$/;
if (regexObj.test(id)) {
db.collection('wines', function(err, collection) {
// Let's see if we find the item before we try to update it
collection.find({'_id':new BSON.ObjectID(id)}).toArray(function(err, items) {
if (err) {
// handle error (500)
//console.log('Error updating wine: ' + err);
res.json(500, {'error':'An error has occurred'});
} else if (items.length != 1) {
// item doesn't exist (or we have bigger issues)
//console.log('Wine to update not found: ' + id);
res.json(404, {'message':'Wine to update not found: ' + id});
} else {
// Update item
collection.update({'_id':new BSON.ObjectID(id)}, wine, {safe:true}, function(err, result) {
if (err) {
//console.log('Error updating wine. ID: ' + id + ' Error: ' + err);
res.json(500, {'error':'An error has occurred!'});
} else {
//console.log('Success updating wine: ' + result + ' document(s) updated');
res.json(200, wine);
}
});
}
});
});
});
} else {
//console.log('Error invalid ID format: ' + id);
res.json(500, {'error':'invalid ID format'});
}
}

// DELETE /wines/:id
exports.deleteWine = function(req, res) {

// We don't want the browser to cache the results
res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');

var id = req.params.id;
console.log('Deleting wine: ' + id);
db.collection('wines', function(err, collection) {
collection.remove({'_id':new BSON.ObjectID(id)}, {safe:true}, function(err, result) {
if (err) {
res.send({'error':'An error has occurred - ' + err});
} else {
console.log('' + result + ' document(s) deleted');
res.send(req.body);
}
// need to validate the id is in a valid format (24 hex)
var regexObj = /^[A-Fa-f0-9]{24}$/;

if (regexObj.test(id)) {
db.collection('wines', function(err, collection) {
// Let's see if we find the item before we try to delete it
collection.find({'_id':new BSON.ObjectID(id)}).toArray(function(err, items) {
if (err) {
// handle error (500)
console.log('Error deleting wine: ' + err);
res.json(500, {'error':'An error has occurred'});
} else if (items.length != 1) {
// item doesn't exist (or we have bigger issues)
console.log('Cannot delete, wine not found: ' + id);
res.json(404, {'message':'Cannot delete, wine not found. ID: ' + id});
} else {
// Remove item
collection.remove({'_id':new BSON.ObjectID(id)}, {safe:true}, function(err, result) {
if (err) {
//console.log('Error deleting wine. ID: ' + id + ' Error: ' + err);
res.json(500, {'error':'An error has occurred - ' + err});
} else {
//console.log('Success deleting wine: ' + result + ' document(s) deleted');
// HTTP 204 No Content: The server successfully processed the request, but is not returning any content
res.json(204);
}
});
}
});
});
});
} else {
//console.log('Error invalid ID format: ' + id);
res.json(500, {'error':'invalid ID format'});
}
}

/*--------------------------------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
// Populate database with sample data -- Only used once: the first time the application is started.
// You'd typically not find this code in a real-life app, since the database would already exist.
var populateDB = function() {
Expand Down Expand Up @@ -260,7 +355,7 @@ var populateDB = function() {
grapes: "Zinfandel",
country: "USA",
region: "California",
description: "o yourself a favor and have a bottle (or two) of this fine zinfandel on hand for your next romantic outing. The only thing that can make this fine choice better is the company you share it with.",
description: "Do yourself a favor and have a bottle (or two) of this fine zinfandel on hand for your next romantic outing. The only thing that can make this fine choice better is the company you share it with.",
picture: "fourvines.jpg"
},
{
Expand Down Expand Up @@ -310,7 +405,13 @@ var populateDB = function() {
}];

db.collection('wines', function(err, collection) {
collection.insert(wines, {safe:true}, function(err, result) {});
collection.insert(wines, {safe:true}, function(err, result) {
if (err) {
console.log('Error adding sample wines: ' + err);
} else {
console.log('Success adding sample wines');
}
});
});

};