Video Store API -- Lindsey and Ashley

.gitignore

@@ -1 +1,33 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Debug log from npm
+npm-debug.log
+
 .DS_Store
+db/

README.md

@@ -92,3 +92,5 @@ The API you build should have the following capabilities. The schema of your dat
 - We will use [Mocha](https://mochajs.org/) for tests.
 - There isn't a coverage requirement for this project, beyond demonstrating that every endpoint is covered by some manner of tests.
 
+#### Run once prior to running tests
+`DB=test npm run db:schema`

app.js

@@ -0,0 +1,52 @@
+var express = require('express');
+var path = require('path');
+var logger = require('morgan');
+var cookieParser = require('cookie-parser');
+var bodyParser = require('body-parser');
+
+var app = express();
+
+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')));
+
+// routes
+app.use('/customers', require('./routes/customers'));
+app.use('/movies', require('./routes/movies'));
+app.use('/rentals', require('./routes/rentals'));
+
+// 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 handlers
+
+// development error handler
+// will print stacktrace
+if (app.get('env') === 'development') {
+  app.use(function(err, req, res, next) {
+    res.status(err.status || 500);
+    res.render('error', {
+      message: err.message,
+      error: err
+    });
+  });
+}
+
+// production error handler
+// no stacktraces leaked to user
+app.use(function(err, req, res, next) {
+  res.status(err.status || 500);
+  res.render('error', {
+    message: err.message,
+    error: {}
+  });
+});
+
+
+module.exports = app;

bin/www

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+
+/**
+ * Module dependencies.
+ */
+
+var app = require('../app');
+var debug = require('debug')('C3Projects--VideoStoreAPI: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);
+}

controllers/customers.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var Customer = require('../models/customer');
+
+var Controller = {
+  index: function(req, res, next) {
+    if (req.query.status == 'overdue') {
+      new Customer().overdue(Controller.sendJSON.bind(res));
+    } else if (req.query.sort) {
+      new Customer().sortBy(req.query.sort, req.query.n, req.query.p, Controller.sendJSON.bind(res));
+    } else {
+      new Customer().all(Controller.sendJSON.bind(res));
+    }
+  },
+
+  rentals: function(req, res, next) {
+    new Customer().rentals(req.params.id, Controller.formatRentalsSendJON.bind(res));
+  },
+
+  formatRentalsSendJON: function(err, res) {
+    var results = { current: [], past: [] };
+
+    for (var i = 0; i < res.length; i++) {
+      if (res[i].return_date) {
+        results.past.push(res[i]);
+      } else {
+        results.current.push(res[i]);
+      }
+    }
+
+    Controller.sendJSON.call(this, err, results);
+  },
+
+  sendJSON: function(err, res) {
+    if (err) {
+      var status = err.status == 400 ? 400 : 500;
+      this.status(status).json(err.message);
+    } else {
+      this.status(200).json(res);
+    }
+  }
+}
+
+module.exports = Controller;

controllers/movies.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var Movie = require('../models/movie');
+
+var Controller = {
+  index: function(req, res, next) {
+    if (req.query.sort) {
+      new Movie().sortBy(req.query.sort, req.query.n, req.query.p, Controller.sendJSON.bind(res));
+    } else {
+      new Movie().all(Controller.sendJSON.bind(res));
+    }
+  },
+
+  show: function(req, res, next) {
+    new Movie().findBy('title', req.params.title, Controller.formatThenSendJSON.bind(res));
+  },
+
+  formatThenSendJSON: function(err, results) {
+    new Movie().numAvail(results[0].title, function(err, otherResults) {
+      results = results[0];
+      results.num_available = otherResults[0].num_available;
+
+      Controller.sendJSON.apply(this, [err, results]);
+
+    }.bind(this));
+
+  },
+
+  customers: function(req, res, next) {
+    if (req.query.status == 'current') {
+      new Movie().customersCurrent(req.params.title, Controller.sendJSON.bind(res));
+    } else if (req.query.status == 'past') {
+      new Movie().customersPast(req.params.title, req.query.sort, Controller.sendJSON.bind(res));
+    } else {
+      res.status(400).json("Bad request");
+    }
+  },
+
+  sendJSON: function(err, res) {
+    if (err) {
+      var status = err.status == 400 ? 400 : 500;
+      this.status(status).json(err.message);
+    } else {
+      this.status(200).json(res);
+    }
+  }
+}
+
+module.exports = Controller;

controllers/rentals.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var Rental = require('../models/rental');
+
+var Controller = {
+  create: function(req, res, next) {
+    var rental = new Rental()
+    rental.checkOut(req.body, Controller.sendJSON.bind(res));
+  },
+
+  update: function(req, res, next) {
+    new Rental().checkIn(req.body.movie_title, req.body.return_date, req.params.customer_id, Controller.sendJSON.bind(res))
+  },
+
+  sendJSON: function(err, res) {
+    if (err) {
+      var status = err.status == 400 ? 400 : 500;
+      this.status(status).json(err.message);
+    } else {
+      this.status(200).json(res);
+    }
+  }
+}
+
+module.exports = Controller;

documentation.txt

@@ -0,0 +1,69 @@
+### Customers
+GET '/customers'
+  // => [{<customer>}, {<customer>}] <-- includes customer attributes
+  - See a list of customers with overdue movies
+    // ?&status=overdue
+  - Retrive a subset of customers
+    - Given a sort column, return _n_ customer records, offset by _p_ records (this will be used to create "pages" of customers)
+      // ?&n=12&p=2&sort=_____
+        // sort options: name, registered_at, postal_code
+      - Sort columns are
+        - `name`
+        - `registered_at`
+        - `postal_code`
+GET 'customers/:id/rentals'
+  - Given a customers `id`...
+    - List the movies they _currently_ have checked out
+      + include rental id
+    - List the movies a customer has checked out in the past
+      + include rental id
+      - ordered by check out date
+      - includes return date
+
+### Movies
+GET '/movies'
+  // => [{<movie>}, {<movie>}] <-- includes movie attributes
+  // OPTIONAL
+  // ?n=12&p=2&sort=_____
+    // sort options: title, release_date
+  - Retrieve a list of all movies
+  - Retrieve a subset of movies
+    - Given a sort column, return _n_ movie records, offset by _p_ records (this will be used to create "pages" of movies)
+      - Sort columns are
+        - `title`
+        - `release_date`
+GET 'movies/:title/customers'
+  // => {<movie>} <-- title is REQUIRED TO BE unique
+  // ?status=____&sort=_____
+    // status options: current, past
+    // status required for this endpoint
+    // sort options: id, name, checkout_date
+    // sort required for status past
+  - Given a movies `title`...
+    + include rental ids
+    - Get a list of customers that have _currently_ checked out a copy of the film
+    - See a list of customers that have _currently_ checked out any of the movie's inventory
+
+    - Get a list of customers that have checked out a copy _in the past_
+      - ordered by customer `id`
+      - ordered by customer `name`
+      - ordered by check out date
+
+GET '/movies/:title'
+  // => {<movie>} <-- title is REQUIRED TO BE unique
+  - Look a movie up by title to see
+    - its synopsis
+    - release date
+    - and inventory total
+    - Know if a movie has any inventory available to rent (num avail, num checked out, which/whatever)
+
+### Rental
+- Given a customer's `id` and a movie's `title` ...
+POST '/rentals'
+  // in the body, include customer/movie details
+  - "check out" one of the movies inventory to the customer
+    - Establish a return date
+    - Charge the customers account (cost up to you)
+PUT '/rentals/:customer_id'
+  - "check in" one of customers rentals
+    - return the movie to its inventory