From 8fab2d03bce82e4dee798ebffb1e93c557f62a4b Mon Sep 17 00:00:00 2001
From: Zach Berwaldt <zberwaldt@tutamail.com>
Date: Thu, 7 Mar 2024 23:16:22 -0500
Subject: feat: Update authentication route and add comments to exported
 members

- The authentication route in the API has been updated to use a new router setup function.
- Comments have been added to all exported members of the `auth.go` module in the internal controllers package.
---
 api/internal/controllers/auth.go  | 11 ++++++++++-
 api/internal/controllers/stats.go |  6 +++++-
 2 files changed, 15 insertions(+), 2 deletions(-)

(limited to 'api/internal/controllers')

diff --git a/api/internal/controllers/auth.go b/api/internal/controllers/auth.go
index de9ed05..58653d0 100644
--- a/api/internal/controllers/auth.go
+++ b/api/internal/controllers/auth.go
@@ -14,6 +14,11 @@ import (
 	"water/api/internal/database"
 )
 
+
+
+// AuthHandler is a function that handles users' authentication. It checks if the request
+// has valid credentials, authenticates the user and sets the user's session.
+// If the authentication is successful, it will allow the user to access protected routes.
 func AuthHandler (c *gin.Context) {
 	username, password, ok := c.Request.BasicAuth()
 	if !ok {
@@ -55,7 +60,11 @@ func AuthHandler (c *gin.Context) {
 	c.JSON(http.StatusOK, gin.H{"token": apiToken, "user": user, "preferences": preference})
 }
 
-// generatToken will g
+
+// generateToken is a helper function used in the AuthHandler. It generates a random token for API authentication.
+// This function creates an empty byte slice of length 32 and fills it with cryptographic random data using the rand.Read function.
+// If an error occurs during the generation, it will return an empty string.
+// The generated cryptographic random data is then encoded into a base64 string and returned.
 func generateToken() string {
 	token := make([]byte, 32)
 	_, err := rand.Read(token)
diff --git a/api/internal/controllers/stats.go b/api/internal/controllers/stats.go
index d8ed434..2234787 100644
--- a/api/internal/controllers/stats.go
+++ b/api/internal/controllers/stats.go
@@ -8,6 +8,10 @@ import (
 	"water/api/internal/models"
 )
 
+// TODO: add comments to all exported members of package.
+
+// GetAllStatistics connects to the database and queries for all statistics in the database.
+// If none have been found it will return an error, otherwise a 200 code is sent along with the list of statistics.
 func GetAllStatistics(c *gin.Context) {
 	db := database.EstablishDBConnection()
 	defer func(db *sql.DB) {
@@ -78,7 +82,7 @@ func PostNewStatistic(c *gin.Context) {
 	c.JSON(http.StatusCreated, gin.H{"status": "created", "id": id})
 }
 
-func GetWeeklyStatistics (c *gin.Context) {
+func GetWeeklyStatistics(c *gin.Context) {
 	db := database.EstablishDBConnection()
 	defer func(db *sql.DB) {
 		err := db.Close()
-- 
cgit v1.1