release: v0.18.0

CHANGELOG.md

@@ -1,3 +1,12 @@
+# [0.18.0](https://github.com/upb-code-labs/main-api/compare/v0.17.0...v0.18.0) (2023-10-08)
+
+
+### Features
+
+* Get course by UUID ([#71](https://github.com/upb-code-labs/main-api/issues/71)) ([ae60ba4](https://github.com/upb-code-labs/main-api/commit/ae60ba45081750d68edb079f201f0317eecd3ceb))
+
+
+
 # [0.17.0](https://github.com/upb-code-labs/main-api/compare/v0.16.0...v0.17.0) (2023-10-06)
 
 
@@ -34,12 +43,3 @@
 
 
 
-## [0.13.3](https://github.com/upb-code-labs/main-api/compare/v0.13.2...v0.13.3) (2023-10-05)
-
-
-### Bug Fixes
-
-* Save who created admin and teacher accounts ([#63](https://github.com/upb-code-labs/main-api/issues/63)) ([313d795](https://github.com/upb-code-labs/main-api/commit/313d795ca236cbf2f188e9f3985a364a7d4ff25c))
-
-
-

__tests__/integration/courses_test.go

@@ -117,6 +117,61 @@ type InvitationCodeTestCase struct {
 	ExpectedStatusCode int
 }
 
+func TestGetCourseByUUID(t *testing.T) {
+	c := require.New(t)
+
+	// Create a course
+	courseName := "Course [Test Get Course By UUID]"
+	courseUUID, code := CreateCourse(courseName)
+	c.Equal(http.StatusCreated, code)
+	c.NotEmpty(courseUUID)
+
+	testCases := []InvitationCodeTestCase{
+		{
+			CourseUUID:         "not-valid",
+			ExpectedStatusCode: http.StatusBadRequest,
+		},
+		{
+			// Non-existent course
+			CourseUUID:         "3febe413-d8cc-4d77-961a-cba1a4eaa64e",
+			ExpectedStatusCode: http.StatusNotFound,
+		},
+		{
+			CourseUUID:         courseUUID,
+			ExpectedStatusCode: http.StatusOK,
+		},
+	}
+
+	// --- 1. Try with a teacher account ---
+	w, r := PrepareRequest("POST", "/api/v1/session/login", map[string]interface{}{
+		"email":    registeredTeacherEmail,
+		"password": registeredTeacherPass,
+	})
+	router.ServeHTTP(w, r)
+	cookie := w.Result().Cookies()[0]
+
+	for _, testCase := range testCases {
+		response, code := GetCourseByUUID(cookie, testCase.CourseUUID)
+		c.Equal(testCase.ExpectedStatusCode, code)
+
+		if code == http.StatusOK {
+			c.Equal(courseName, response["name"])
+			c.Equal(courseUUID, response["uuid"])
+			c.NotEmpty(response["color"])
+		}
+	}
+}
+
+func GetCourseByUUID(cookie *http.Cookie, courseUUID string) (response map[string]interface{}, statusCode int) {
+	endpoint := fmt.Sprintf("/api/v1/courses/%s", courseUUID)
+	w, r := PrepareRequest("GET", endpoint, nil)
+	r.AddCookie(cookie)
+	router.ServeHTTP(w, r)
+
+	jsonResponse := ParseJsonResponse(w.Body)
+	return jsonResponse, w.Code
+}
+
 func TestGetInvitationCode(t *testing.T) {
 	c := require.New(t)
 

sql/migrations/20230920232901_init.down.sql

@@ -18,7 +18,7 @@ DROP INDEX IF EXISTS idx_users_role;
 -- ## Views
 DROP VIEW IF EXISTS courses_with_color;
 
-DROP VIEW IF EXISTS courses_has_users_views;
+DROP VIEW IF EXISTS courses_has_users_view;
 
 DROP VIEW IF EXISTS users_with_creator;
 

sql/migrations/20230920232901_init.up.sql

@@ -164,7 +164,7 @@ FROM
 
 --- ### courses_has_users
 CREATE
-OR REPLACE VIEW courses_has_users_views AS
+OR REPLACE VIEW courses_has_users_view AS
 SELECT
   courses_has_users.course_id,
   courses.name AS course_name,

src/courses/application/use_cases.go

@@ -84,6 +84,26 @@ func (useCases *CoursesUseCases) SaveCourse(dto *dtos.CreateCourseDTO) (*entitie
 	return useCases.Repository.SaveCourse(dto)
 }
 
+func (useCases *CoursesUseCases) GetCourse(userUUID, courseUUID string) (*entities.Course, error) {
+	// Get the course
+	course, err := useCases.Repository.GetCourseByUUID(courseUUID)
+	if err != nil {
+		return nil, err
+	}
+
+	// Check the user is enrolled in the course
+	isStudentInCourse, err := useCases.Repository.IsUserInCourse(userUUID, courseUUID)
+	if err != nil {
+		return nil, err
+	}
+	if !isStudentInCourse {
+		return nil, errors.UserNotInCourseError{}
+	}
+
+	// Return the data
+	return course, nil
+}
+
 func (useCases *CoursesUseCases) JoinCourseUsingInvitationCode(dto *dtos.JoinCourseUsingInvitationCodeDTO) (*entities.Course, error) {
 	// Get the course by the invitation code
 	course, err := useCases.Repository.GetCourseByInvitationCode(dto.InvitationCode)
@@ -99,7 +119,7 @@ func (useCases *CoursesUseCases) JoinCourseUsingInvitationCode(dto *dtos.JoinCou
 	}
 
 	// Check if the student is already in the course
-	isStudentInCourse, err := useCases.Repository.IsStudentInCourse(dto.StudentUUID, course.UUID)
+	isStudentInCourse, err := useCases.Repository.IsUserInCourse(dto.StudentUUID, course.UUID)
 	if err != nil {
 		return nil, err
 	}
@@ -119,7 +139,7 @@ func (useCases *CoursesUseCases) GetEnrolledCourses(userUUID string) (*dtos.Enro
 
 func (useCases *CoursesUseCases) ToggleCourseVisibility(courseUUID, userUUID string) (bool, error) {
 	// Check the user is enrolled in the course
-	isStudentInCourse, err := useCases.Repository.IsStudentInCourse(userUUID, courseUUID)
+	isStudentInCourse, err := useCases.Repository.IsUserInCourse(userUUID, courseUUID)
 	if err != nil {
 		return false, err
 	}
@@ -165,7 +185,7 @@ func (useCases *CoursesUseCases) AddStudentToCourse(dto *dtos.AddStudentToCourse
 	}
 
 	// Check the student is not already in the course
-	isStudentInCourse, err := useCases.Repository.IsStudentInCourse(dto.StudentUUID, dto.CourseUUID)
+	isStudentInCourse, err := useCases.Repository.IsUserInCourse(dto.StudentUUID, dto.CourseUUID)
 	if err != nil {
 		return err
 	}

src/courses/domain/definitions/courses_repository.go

@@ -14,7 +14,7 @@ type CoursesRepository interface {
 	GetCourseByInvitationCode(invitationCode string) (*entities.Course, error)
 
 	AddStudentToCourse(studentUUID, courseUUID string) error
-	IsStudentInCourse(studentUUID, courseUUID string) (bool, error)
+	IsUserInCourse(userUUID, courseUUID string) (bool, error)
 	GetEnrolledCourses(studentUUID string) (*dtos.EnrolledCoursesDto, error)
 	GetEnrolledStudents(courseUUID string) ([]*dtos.EnrolledStudentDTO, error)
 

src/courses/infrastructure/http/http_controllers.go

@@ -63,6 +63,32 @@ func (controller *CoursesController) HandleCreateCourse(c *gin.Context) {
 	})
 }
 
+func (controller *CoursesController) HandleGetCourse(c *gin.Context) {
+	user_uuid := c.GetString("session_uuid")
+
+	// Validate course uuid
+	courseUUID := c.Param("course_uuid")
+	if err := infrastructure.GetValidator().Var(courseUUID, "uuid4"); err != nil {
+		c.JSON(http.StatusBadRequest, gin.H{
+			"message": "Invalid course uuid",
+		})
+		return
+	}
+
+	// Get course
+	course, err := controller.UseCases.GetCourse(user_uuid, courseUUID)
+	if err != nil {
+		c.Error(err)
+		return
+	}
+
+	c.JSON(http.StatusOK, gin.H{
+		"uuid":  course.UUID,
+		"name":  course.Name,
+		"color": course.Color,
+	})
+}
+
 func (controller *CoursesController) HandleGetInvitationCode(c *gin.Context) {
 	teacherUUID := c.GetString("session_uuid")
 

src/courses/infrastructure/http/http_routes.go

@@ -33,6 +33,13 @@ func StartCoursesRoutes(g *gin.RouterGroup) {
 		controller.HandleGetEnrolledCourses,
 	)
 
+	coursesGroup.GET(
+		":course_uuid",
+		infrastructure.WithAuthenticationMiddleware(),
+		infrastructure.WithAuthorizationMiddleware([]string{"teacher", "student"}),
+		controller.HandleGetCourse,
+	)
+
 	coursesGroup.GET(
 		":course_uuid/invitation-code",
 		infrastructure.WithAuthenticationMiddleware(),

src/courses/infrastructure/implementations/courses_repository.go

@@ -266,17 +266,19 @@ func (repository *CoursesPostgresRepository) AddStudentToCourse(studentUUID, cou
 	return nil
 }
 
-func (repository *CoursesPostgresRepository) IsStudentInCourse(studentUUID, courseUUID string) (bool, error) {
+func (repository *CoursesPostgresRepository) IsUserInCourse(userUUID, courseUUID string) (bool, error) {
 	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
 	defer cancel()
 
 	query := `
 		SELECT COUNT(user_id) > 0
-		FROM courses_has_users
-		WHERE course_id = $1 AND user_id = $2
+		FROM courses_has_users_view
+		WHERE course_id = $1 AND 
+		user_id = $2 AND 
+		is_user_active = TRUE
 	`
 
-	row := repository.Connection.QueryRowContext(ctx, query, courseUUID, studentUUID)
+	row := repository.Connection.QueryRowContext(ctx, query, courseUUID, userUUID)
 	if row.Err() != nil {
 		return false, row.Err()
 	}
@@ -296,7 +298,7 @@ func (repository *CoursesPostgresRepository) GetEnrolledCourses(studentUUID stri
 
 	query := `
 		SELECT course_id, course_teacher_id, course_name, course_color, is_class_hidden
-		FROM courses_has_users_views
+		FROM courses_has_users_view
 		WHERE user_id = $1
 		AND is_user_active = TRUE
 	`
@@ -381,7 +383,7 @@ func (repository *CoursesPostgresRepository) GetEnrolledStudents(courseUUID stri
 
 	query := `
 		SELECT user_id, user_full_name, user_email, user_institutional_id, is_user_active
-		FROM courses_has_users_views
+		FROM courses_has_users_view
 		WHERE course_id = $1 AND user_role = 'student'
 	`
 

version.json

@@ -1,3 +1,3 @@
 {
-  "version": "0.17.0"
+  "version": "0.18.0"
 }