Merge pull request #255 from markalbrand56/mark

Mark

backend/configs/envs.go

@@ -8,6 +8,7 @@ import (
 	"os"
 )
 
+// EnvPG carga las variables de entorno, primero desde el sistema operativo, y si no están, desde un archivo .env
 func EnvPG() map[string]string {
 	envs := make(map[string]string)
 
@@ -32,6 +33,7 @@ func EnvPG() map[string]string {
 	return envs
 }
 
+// loadSystemEnv carga las variables de entorno desde el sistema operativo, en vez de un archivo .env
 func loadSystemEnv() (map[string]string, error) {
 	envs := make(map[string]string)
 

backend/configs/setup.go

@@ -16,6 +16,7 @@ const (
 	Admin   = "admin"
 )
 
+// SetupDB configura la conexión a la base de datos
 func SetupDB() {
 	envs := EnvPG()
 
@@ -28,6 +29,7 @@ func SetupDB() {
 	DB = db
 }
 
+// CreateDirIfNotExist crea un directorio si no existe
 func CreateDirIfNotExist(path string) (bool, error) {
 	if _, err := os.Stat(path); os.IsNotExist(err) {
 		fmt.Println("Directory " + path + " does not exist. Creating...")

backend/main.go

@@ -7,11 +7,12 @@ import (
 )
 
 func main() {
-	// create directory for uploads
+	// create directory for profile pictures
 	if _, err := configs.CreateDirIfNotExist("./uploads"); err != nil {
 		panic(err)
 	}
 
+	// create directory for pdf files
 	if _, err := configs.CreateDirIfNotExist("./uploads/pdf"); err != nil {
 		panic(err)
 	}
@@ -23,9 +24,13 @@ func main() {
 	routes.Routes(router)
 	configs.SetupDB()
 
-	router.Run(":8080")
+	err := router.Run(":8080")
+	if err != nil {
+		return
+	}
 }
 
+// CORS permite el acceso a la API desde cualquier origen
 func CORS() gin.HandlerFunc {
 	// Reference: https://github.com/gin-contrib/cors/issues/29
 	return func(c *gin.Context) {

backend/middlewares/middlewares.go

@@ -7,12 +7,13 @@ import (
 	"net/http"
 )
 
+// JwtAuthentication Middleware usado para verificar si el token es válido
 func JwtAuthentication() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		err := utils.TokenValid(c)
 		if err != nil {
 			c.JSON(http.StatusUnauthorized, responses.StandardResponse{
-				Status:  401,
+				Status:  http.StatusUnauthorized,
 				Message: "Unauthorized, token is invalid: " + err.Error(),
 				Data:    nil,
 			})

backend/models/carrera.go

@@ -10,6 +10,7 @@ func (Carrera) TableName() string {
 	return "carrera"
 }
 
+// CarreraGet es la estructura de la tabla carrera en la base de datos
 type CarreraGet struct {
 	Id_Carrera  int    `json:"id_carrera"`
 	Nombre      string `json:"nombre"`

backend/models/estudiante.go

@@ -4,8 +4,6 @@ import (
 	"time"
 )
 
-// Mensaje es la estructura de la tabla estudiante en la base de datos
-
 type Estudiante struct {
 	IdEstudiante string    `json:"id_estudiante"`
 	Dpi          string    `json:"dpi"`

backend/models/message.go

@@ -14,7 +14,7 @@ type Mensaje struct {
 	Tiempo        time.Time `json:"tiempo"`
 }
 
-// mensajeGet es la estructura de la tabla mensaje en la base de datos
+// MensajeGet es la estructura de la tabla mensaje en la base de datos
 type MensajeGet struct {
 	ID_mensaje     int       `json:"id_mensaje"`
 	IdEmisor       string    `json:"id_emisor"`

backend/models/user.go

@@ -20,6 +20,7 @@ func (Usuario) TableName() string {
 	return "usuario"
 }
 
+// SaveUser guarda un usuario en la base de datos
 func (u *Usuario) SaveUser() (*Usuario, error) {
 	err := configs.DB.Create(&u).Error
 
@@ -30,6 +31,7 @@ func (u *Usuario) SaveUser() (*Usuario, error) {
 	return u, nil
 }
 
+// BeforeSave se llama antes de guardar un usuario en la base de datos, se encripta la contraseña
 func (u *Usuario) BeforeSave() error {
 	hashedPassword, err := bcrypt.GenerateFromPassword([]byte(u.Contra), bcrypt.DefaultCost)
 
@@ -43,6 +45,7 @@ func (u *Usuario) BeforeSave() error {
 	return nil
 }
 
+// GetUserByUsername busca un usuario por su nombre de usuario
 func GetUserByUsername(username string) (Usuario, error) {
 	var user Usuario
 

backend/responses/responses.go

@@ -1,5 +1,6 @@
 package responses
 
+// StandardResponse es la estructura de una respuesta estándar
 type StandardResponse struct {
 	Status  int                    `json:"status"`
 	Message string                 `json:"message"`

backend/utils/file.go

@@ -9,6 +9,7 @@ import (
 	"path/filepath"
 )
 
+// Contains verifica si un string está en un slice de strings
 func Contains(slice []string, item string) bool {
 	for _, s := range slice {
 		if s == item {
@@ -19,6 +20,7 @@ func Contains(slice []string, item string) bool {
 	return false
 }
 
+// UploadFileToServer sube un archivo al File Server
 func UploadFileToServer(url string, bearer string, fileHeader *multipart.FileHeader, dst string) error {
 	// Abrir el archivo
 	f, err := fileHeader.Open()

backend/utils/token.go

@@ -10,6 +10,7 @@ import (
 	"time"
 )
 
+// GenerateToken genera un token JWT
 func GenerateToken(username string, userType string) (string, error) {
 	tokenLifespan, err := strconv.Atoi(os.Getenv("TOKEN_HOUR_LIFESPAN"))
 
@@ -27,6 +28,7 @@ func GenerateToken(username string, userType string) (string, error) {
 	return token.SignedString([]byte(os.Getenv("API_SECRET")))
 }
 
+// TokenValid verifica si un token es válido
 func TokenValid(c *gin.Context) error {
 	tokenString := ExtractTokenFromRequest(c)
 	_, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
@@ -41,6 +43,7 @@ func TokenValid(c *gin.Context) error {
 	return nil
 }
 
+// ExtractTokenFromRequest extrae el token de una request
 func ExtractTokenFromRequest(c *gin.Context) string {
 	token := c.Query("token")
 	if token != "" {
@@ -53,12 +56,13 @@ func ExtractTokenFromRequest(c *gin.Context) string {
 	return ""
 }
 
+// TokenExtractUsername extrae el username de un token
 func TokenExtractUsername(c *gin.Context) (string, error) {
 
 	tokenString := ExtractTokenFromRequest(c)
 	token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
 		if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
-			return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"])
+			return nil, fmt.Errorf("unexpected signing method: %v", token.Header["alg"])
 		}
 		return []byte(os.Getenv("API_SECRET")), nil
 	})
@@ -74,12 +78,13 @@ func TokenExtractUsername(c *gin.Context) (string, error) {
 	return "", nil
 }
 
+// TokenExtractRole extrae el rol de un token
 func TokenExtractRole(c *gin.Context) (string, error) {
 
 	tokenString := ExtractTokenFromRequest(c)
 	token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
 		if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
-			return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"])
+			return nil, fmt.Errorf("unexpected signing method: %v", token.Header["alg"])
 		}
 		return []byte(os.Getenv("API_SECRET")), nil
 	})