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.

4 files changed, 22 insertions, 8 deletions

diff --git a/api/cmd/main_test.go b/api/cmd/main_test.go
index a6c8381..049cf6e 100644
--- a/api/cmd/main_test.go
+++ b/api/cmd/main_test.go
@@ -6,6 +6,7 @@ import (
         "net/http"
         "net/http/httptest"
         "testing"
+        "water/api/internal/router"
 
         "github.com/spf13/viper"
         "github.com/stretchr/testify/assert"
@@ -26,7 +27,7 @@ func getTestUserCredentials() (string, string) {
 }
 
 func TestAuthRoute(t *testing.T) {
-        router := setupRouter()
+        r := router.SetupRouter()
         
         username, password := getTestUserCredentials()
 
@@ -39,7 +40,7 @@ func TestAuthRoute(t *testing.T) {
                 t.Fatalf("Failed to create request: %v", err)
         }
         req.SetBasicAuth(username, password)
-        router.ServeHTTP(w, req)
+        r.ServeHTTP(w, req)
 
         assert.Equal(t, http.StatusOK, w.Code, "response should return a 200 code")
 
@@ -56,12 +57,12 @@ func TestAuthRoute(t *testing.T) {
 }
 
 func TestAuthRouteFailure(t *testing.T) {
-        router := setupRouter()
+        r := router.SetupRouter()
 
         w := httptest.NewRecorder()
         req, _ := http.NewRequest("POST", "/api/v1/auth", nil)
         req.SetBasicAuth("asdf", "asdf")
-        router.ServeHTTP(w, req)
+        r.ServeHTTP(w, req)
 
         assert.Equal(t, http.StatusUnauthorized, w.Code, "should return a 401 code")
 }
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()
diff --git a/api/internal/database/database.go b/api/internal/database/database.go
index 19ae818..7af9780 100644
--- a/api/internal/database/database.go
+++ b/api/internal/database/database.go
@@ -7,14 +7,14 @@ import (
 )
 
 func SetupDatabase() {
-        _, err := sql.Open("sqlite3", "water.db")
+        _, err := sql.Open("sqlite3", "water.sqlite3")
         if err != nil {
                 log.Fatal(err)
         }
 }
 
 func EstablishDBConnection() *sql.DB {
-        db, err := sql.Open("sqlite3", "../../db/water.sqlite3")
+        db, err := sql.Open("sqlite3", "../db/water.sqlite3")
         if err != nil {
                 panic(err)
         }