Merge pull request #17 from tsarnadelis/alex

Fixing comment density where needed

Author: tsarnadelis

controllers/LicensePlate.js

@@ -3,22 +3,28 @@
 var utils = require('../utils/writer.js');
 var LicensePlate = require('../service/LicensePlateService');
 
+// Function to handle modifying a license plate
 module.exports.modifyPlate = function modifyPlate (req, res, next, body) {
   LicensePlate.modifyPlate(body)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+//Function to handle registering a new license plate
 module.exports.registerPlate = function registerPlate (req, res, next, body) {
   LicensePlate.registerPlate(body)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };

controllers/Payment.js

@@ -3,12 +3,15 @@
 var utils = require('../utils/writer.js');
 var Payment = require('../service/PaymentService');
 
+//Function to handle making a payment
 module.exports.makePayment = function makePayment (req, res, next, body) {
   Payment.makePayment(body)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };

controllers/Reservation.js

@@ -3,32 +3,41 @@
 var utils = require('../utils/writer.js');
 var Reservation = require('../service/ReservationService');
 
+// Function to handle deleting a reservation
 module.exports.deleteReservation = function deleteReservation (req, res, next, id) {
   Reservation.deleteReservation(id)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+//Function to handle making a reservation
 module.exports.makeReservation = function makeReservation (req, res, next, body) {
   Reservation.makeReservation(body)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+//Function to handle modifying a reservation
 module.exports.modifyReservation = function modifyReservation (req, res, next, body, spotId, userId, startTime, duration, date, id) {
   Reservation.modifyReservation(body, spotId, userId, startTime, duration, date, id)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };

controllers/Spot.js

@@ -3,52 +3,67 @@
 var utils = require('../utils/writer.js');
 var Spot = require('../service/SpotService');
 
+//Function to handle creating a new spot
 module.exports.createSpot = function createSpot (req, res, next, body) {
   Spot.createSpot(body)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+//Function to handle retrieving all spots
 module.exports.getSpots = function getSpots (req, res, next) {
   Spot.getSpots()
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+//Function to handle modifying an existing parking spot
 module.exports.modifySpot = function modifySpot (req, res, next, body, address, type, charger, id) {
   Spot.modifySpot(body, address, type, charger, id)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+// Function to handle removing a parking spot
 module.exports.removeSpot = function removeSpot (req, res, next, id) {
   Spot.removeSpot(id)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };
 
+//Function to handle searching for a parking spot
 module.exports.searchSpot = function searchSpot (req, res, next, address, type, charger) {
   Spot.searchSpot(address, type, charger)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };

controllers/SpotOwner.js

@@ -3,12 +3,15 @@
 var utils = require('../utils/writer.js');
 var SpotOwner = require('../service/SpotOwnerService');
 
+//Function to handle adding a new spot owner
 module.exports.addSpotOwner = function addSpotOwner (req, res, next, body) {
   SpotOwner.addSpotOwner(body)
     .then(function (response) {
+      // Write the response using the utility function
       utils.writeJson(res, response);
     })
     .catch(function (response) {
+      // Write the error response using the utility function
       utils.writeJson(res, response);
     });
 };

cypress/e2e/GET_spot.cy.js

@@ -1,25 +1,31 @@
 describe('GET /spot', () => {
   beforeEach(() => {
+    // Visit the Swagger UI page before each test
     cy.visit('http://localhost:8080/docs')
   })
 
   it('Title exists', () => {
+    //Check if the title contains the text 'Curbsprings API'
     cy.get('.title').should('contain.text', 'Curbsprings API')
   })
 
   it('Description exists', () => {
+    // Check if the description includes the specified text
     cy.get('.description').should('include.text', 'API for managing parking spots, reservations, users, and payments.')
   })
 
   it('All types of endpoints exists', () => {
+    // Check if there are 5 endpoint tags in the Swagger UI
     cy.get('.opblock-tag').should('have.length', 5)
   })
 
   it('Click on accordion', () => {
+    // Click on the 'GET /spot' accordion to expand it
     cy.get('#operations-Spot-getSpots').click();
   })
 
   it('Open accordion should include description', () => {
+    // Check if the expanded accordion includes the specified text
     cy.get('#operations-Spot-getSpots')
     .click()
     .find('.opblock-description')

cypress/e2e/POST_payment.cy.js

@@ -1,25 +1,31 @@
 describe('POST /payment', () => {
     beforeEach(() => {
+        // Visit the Swagger UI before each test
         cy.visit('http://localhost:8080/docs')
     })
 
     it('Title exists', () => {
+        //Check if the title contains the text 'Curbsprings API'
         cy.get('.title').should('contain.text', 'Curbsprings API')
     })
 
     it('Description exists', () => {
+        // Check if the description includes the specified text
         cy.get('.description').should('include.text', 'API for managing parking spots, reservations, users, and payments.')
     })
 
     it('All types of endpoints exists', () => {
+        // Check if there are 5 endpoint tags in the Swagger UI
         cy.get('.opblock-tag').should('have.length', 5)
     })
 
     it('Click on accordion', () => {
+        // Click on the 'POST /payment' accordion to expand it
         cy.get('#operations-Payment-makePayment').click();
     })
 
     it('Open accordion should include description', () => {
+        // Check if the expanded accordion includes the specified text
         cy.get('#operations-Payment-makePayment')
         .click()
         .find('.opblock-description')

utils/writer.js

@@ -1,29 +1,37 @@
+// Constructor for creating a response payload with a status code and payload
 var ResponsePayload = function(code, payload) {
   this.code = code;
   this.payload = payload;
 }
 
+// Function to create a ResponsePayload object with a given status code and payload
 exports.respondWithCode = function(code, payload) {
   return new ResponsePayload(code, payload);
 }
 
+// Function to write a JSON response 
 var writeJson = exports.writeJson = function(response, arg1, arg2) {
   var code;
   var payload;
-
+  
+  // If arg1 is an instance of ResponsePayload, extract the payload and code
   if(arg1 && arg1 instanceof ResponsePayload) {
     writeJson(response, arg1.payload, arg1.code);
     return;
   }
 
+  // Determine the status code from arg2 if it is an integer
   if(arg2 && Number.isInteger(arg2)) {
     code = arg2;
   }
   else {
+    // Determine the status code from arg1 if it is an integer
     if(arg1 && Number.isInteger(arg1)) {
       code = arg1;
     }
   }
+
+  // Set the payload based on the provided arguments
   if(code && arg1) {
     payload = arg1;
   }
@@ -35,9 +43,12 @@ var writeJson = exports.writeJson = function(response, arg1, arg2) {
     // if no response code given, we default to 200
     code = 200;
   }
+  // If the payload is an object, convert it to a JSON string
   if(typeof payload === 'object') {
     payload = JSON.stringify(payload, null, 2);
   }
+  // Set the response header with the response code and content type
   response.writeHead(code, {'Content-Type': 'application/json'});
+  //Send the response with the payload
   response.end(payload);
 }