Modularized card v deck methods and routing; created appropriate sub-directories, and moved associated functionality to assigned locations

Author: taoantaoan

server/controllers/cardControllers.js

@@ -1,6 +1,5 @@
 /*
  * This controller handles routes to localhost:3000/card
- * 
  * "Queries are Not Promises," from mongo docs: https://mongoosejs.com/docs/queries.html
  */
 
@@ -9,7 +8,7 @@ const CardModel = require('../models/card');
 const cardController = {};
 
 cardController.addCard = (req, res, next) => {
-  // receive request access request.body and destructure model
+  // deconstruct properties required in mongoose/mongo model from request.body
   const { term, definition, deckId } = req.body;
   // instantiate a new card document via the mongoose model
   CardModel.create({ term, definition, deckId })
@@ -20,47 +19,4 @@ cardController.addCard = (req, res, next) => {
     .catch(() => next(new Error('Error in addCard create method')));
 };
 
-cardController.readDeckOfCards = (req, res, next) => {
-  // const { deckId } = req.params; // deckId = '1' (string type)
-  /*
-    req.params = {
-      deckId: 1
-    }
-  */
-  const { deckId } = req.params; // deckId = '1' (string type)
-  console.log(deckId); // 1
-  // declare constant using mongo db query
-  const query = CardModel.find({deckId});
-
-  // create functional promise out of mongodb query
-  const promise = query.exec();
-
-  promise
-    .then((data) => {
-      res.locals.data = data;
-      console.log(res.locals.data);
-      next();
-    })
-    .catch(() => next(new Error('Error in readCard read method')));
-};
-
-// cardController.readCard = (req, res, next) => {
-//   // receive request access request.params and deconstruct model
-//   const { cardId } = req.params;
-
-//   // declare constant using mongo db query
-//   const query = CardModel.findById(cardId);
-
-//   // create functional promise out of mongodb query
-//   const promise = query.exec();
-
-//   promise
-//     .then((data) => {
-//       res.locals.data = data;
-//       console.log(res.locals.data);
-//       next();
-//     })
-//     .catch(() => next(new Error('Error in readCard read method')));
-// };
-
 module.exports = cardController;

server/controllers/deckControllers.js

@@ -0,0 +1,28 @@
+/*
+ * This controller handles routes to localhost:3000/card
+ * "Queries are Not Promises," from mongo docs: https://mongoosejs.com/docs/queries.html
+ */
+
+const CardModel = require('../models/card');
+
+const deckController = {};
+
+deckController.readDeckOfCards = (req, res, next) => {
+  // deconstruct property required in mongoose/mongo model's find method from request.params
+  const { deckId } = req.params;
+  // declare constant using mongo db query
+  const query = CardModel.find({ deckId });
+
+  // create functional promise out of mongodb query
+  const promise = query.exec();
+
+  promise
+    .then((data) => {
+      res.locals.data = data;
+      console.log(res.locals.data);
+      next();
+    })
+    .catch(() => next(new Error('Error in readDeckOfCards read method')));
+};
+
+module.exports = deckController;

server/routes/cardRoutes.js

@@ -3,28 +3,13 @@
  */
 
 const express = require('express');
-const cardRouter = express.Router();
 const cardController = require('../controllers/cardControllers');
 
-// /card/ routes post requests to '/' to cardController
+const cardRouter = express.Router();
+
+// directs post requests made to the root endpoint of /card to the cardController
 cardRouter.post('/', cardController.addCard, (req, res) => {
   res.status(200).send(res.locals.newCard);
 });
 
-// [ ] hypothesis ... don't need a colon with params ...
-// /deck/[number]
-cardRouter.get('/deck/:deckId', cardController.readDeckOfCards, (req, res) => {
-  /*
-    from axios: https://oscards/deck/1
-    processed in express: req.params = {
-      deckId: 1
-    }
-  */
-  res.status(200).send(res.locals.data);
-});
-
-// cardRouter.get('/', cardController.readCard, (req, res) => {
-//   res.status(200).send(res.locals.data);
-// });
-
-module.exports = cardRouter;
+module.exports = cardRouter;

server/routes/deckRoutes.js

@@ -0,0 +1,15 @@
+/*
+ * This router handles routes to localhost:3000/deck
+ */
+
+const express = require('express');
+const deckController = require('../controllers/deckControllers');
+
+const deckRouter = express.Router();
+
+// directs get requests made to the root endpoint of /deck to the deckController
+deckRouter.get('/:deckId', deckController.readDeckOfCards, (req, res) => {
+  res.status(200).send(res.locals.data);
+});
+
+module.exports = deckRouter;

server/server.js

@@ -7,13 +7,14 @@ const mongoose = require('mongoose');
 // invocation of dot env to access API keys
 require('dotenv').config();
 
-// creation of express instance 
+// creation of express instance
 const app = express();
 const PORT = 3000;
 const mongoURI = `${process.env.MONGO_URI}`;
 
 // connect to instance of mongodb atlas
-mongoose.connect(mongoURI, { useNewUrlParser: true, useUnifiedTopology: true})
+mongoose
+  .connect(mongoURI, { useNewUrlParser: true, useUnifiedTopology: true })
   .then(() => {
     app.listen(PORT, () => console.log(`Listening on PORT: ${PORT}`));
   })
@@ -28,22 +29,23 @@ if (process.env.NODE_ENV === 'production') {
   app.use('/dist', express.static(path.join(__dirname, '../dist')));
 }
 
-// instantiate router(s) for data calls 
+// instantiate router(s) for data calls
 const cardRouter = require('./routes/cardRoutes.js');
+const deckRouter = require('./routes/deckRoutes.js');
+
 app.use('/card', cardRouter);
+app.use('/deck', deckRouter);
 
 // serve index.html on the route '/'
-app.get('/', (req, res) => {
-  return res.status(200).sendFile(path.join(__dirname, '../client/src/index.html'));
-});
+app.get('/', (req, res) =>
+  res.status(200).sendFile(path.join(__dirname, '../client/src/index.html'))
+);
 
-// 404 error
-app.use('*', (req, res) => {
-  res.status(404).send('Not Found');
-});
+// create 404 error
+app.use('*', (req, res) => res.status(404).send('Not Found'));
 
-// global error handler
-app.use((err, req, res, next) => {
+// create global error handler
+app.use((err, req, res) => {
   console.log(err);
   res.status(500).send('Internal Server Error');
-});
+});