Create checkin form submit endpoint

Author: Joshua Zhou

controllers/checkin.controller.js

@@ -0,0 +1,31 @@
+"use strict";
+
+const Services = {
+    Sheets: require('../services/sheets.service')
+};
+
+/**
+ * @function submitCheckin
+ * @param {{body: {formData: Object}}} req
+ * @param {*} res
+ * @return {JSON} Success status
+ * @description Handles the check-in form submission and adds data to Google Sheets
+ */
+async function submitCheckin(req, res) {
+    try {
+        await Services.Sheets.appendCheckinData(req.body.formData);
+        return res.status(200).json({
+            message: "Check-in data successfully submitted",
+            data: {}
+        });
+    } catch (error) {
+        return res.status(500).json({
+            message: "Error submitting check-in data",
+            data: {}
+        });
+    }
+}
+
+module.exports = {
+    submitCheckin
+}; 

middlewares/validators/checkin.validator.js

@@ -0,0 +1,18 @@
+"use strict";
+
+const { body } = require('express-validator');
+
+/**
+ * Validator for check-in form submission
+ */
+const checkinValidator = [
+    body('formData.teamMember1').notEmpty().withMessage('Team member 1 is required'),
+    body('formData.teamMember2').optional(),
+    body('formData.teamMember3').optional(),
+    body('formData.teamMember4').optional(),
+    body('formData.prizeCategories').isArray().withMessage('Prize categories must be an array'),
+    body('formData.sponsorChallenges').isArray().withMessage('Sponsor challenges must be an array'),
+    body('formData.workshopsAttended').isArray().withMessage('Workshops attended must be an array')
+];
+
+module.exports = checkinValidator; 

routes/api/checkin.js

@@ -0,0 +1,47 @@
+"use strict";
+
+const express = require("express");
+const router = express.Router();
+const Controllers = {
+    Checkin: require("../../controllers/checkin.controller")
+};
+const Middleware = {
+    Auth: require("../../middlewares/auth.middleware"),
+    Validators: {
+        checkinValidator: require("../../middlewares/validators/checkin.validator")
+    }
+};
+
+/**
+ * @api {post} /api/hacker/checkin Submit check-in form data
+ * @apiName SubmitCheckin
+ * @apiGroup Checkin
+ * @apiVersion 1.0.0
+ *
+ * @apiParam {Object} formData The check-in form data
+ * @apiParam {String} formData.teamMember1 First team member's name
+ * @apiParam {String} [formData.teamMember2] Second team member's name
+ * @apiParam {String} [formData.teamMember3] Third team member's name
+ * @apiParam {String} [formData.teamMember4] Fourth team member's name
+ * @apiParam {String[]} formData.prizeCategories Array of prize categories
+ * @apiParam {String[]} formData.sponsorChallenges Array of sponsor challenges
+ * @apiParam {String[]} formData.workshopsAttended Array of workshops attended
+ *
+ * @apiSuccess {String} message Success message
+ *
+ * @apiError {String} message Error message
+ */
+router.post(
+    "/checkin",
+    Middleware.Auth.ensureAuthenticated(),
+    Middleware.Validators.checkinValidator,
+    Controllers.Checkin.submitCheckin
+);
+
+function activate(apiRouter) {
+    apiRouter.use("/hacker", router);
+}
+
+module.exports = {
+    activate: activate
+}; 

services/sheets.service.js

@@ -0,0 +1,76 @@
+"use strict";
+
+const { google } = require('googleapis');
+const Logger = require('./logger.service');
+
+class SheetsService {
+    constructor() {
+        this.spreadsheetId = process.env.SPREADSHEET_ID;
+        if (!this.spreadsheetId) {
+            Logger.error('SPREADSHEET_ID is not set in environment variables');
+            throw new Error('SPREADSHEET_ID is not set in environment variables');
+        }
+
+        // Initialize Google Sheets API
+        this.sheets = google.sheets('v4');
+        
+        // Set up authentication using service account credentials
+        this.auth = new google.auth.GoogleAuth({
+            credentials: {
+                type: process.env.TYPE,
+                project_id: process.env.PROJECT_ID,
+                private_key_id: process.env.PRIVATE_KEY_ID,
+                private_key: process.env.PRIVATE_KEY.replace(/\\n/g, '\n'),
+                client_email: process.env.CLIENT_EMAIL,
+                client_id: process.env.CLIENT_ID,
+                auth_uri: process.env.AUTH_URI,
+                token_uri: process.env.TOKEN_URI,
+                auth_provider_x509_cert_url: process.env.AUTH_PROVIDER_X509_CERT_URL,
+                client_x509_cert_url: process.env.CLIENT_X509_CERT_URL
+            },
+            scopes: ['https://www.googleapis.com/auth/spreadsheets']
+        });
+    }
+
+    /**
+     * Append check-in data to the spreadsheet
+     * @param {Object} formData The check-in form data
+     * @returns {Promise<void>}
+     */
+    async appendCheckinData(formData) {
+        try {
+            const authClient = await this.auth.getClient();
+            
+            // Format the data for the spreadsheet
+            const values = [[
+                new Date().toISOString(),
+                formData.teamMember1,
+                formData.teamMember2,
+                formData.teamMember3,
+                formData.teamMember4,
+                formData.prizeCategories.join(', '),
+                formData.sponsorChallenges.join(', '),
+                formData.workshopsAttended.join(', ')
+            ]];
+
+            const request = {
+                spreadsheetId: this.spreadsheetId,
+                range: 'Sheet1!A:H', // Adjust range as needed
+                valueInputOption: 'USER_ENTERED',
+                insertDataOption: 'INSERT_ROWS',
+                resource: {
+                    values: values
+                },
+                auth: authClient
+            };
+
+            await this.sheets.spreadsheets.values.append(request);
+            Logger.info('Successfully appended check-in data to spreadsheet');
+        } catch (error) {
+            Logger.error('Error appending data to spreadsheet:', error);
+            throw error;
+        }
+    }
+}
+
+module.exports = new SheetsService();