View source for CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)



__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The <code>Course</code> model and <code>CoursesController</code>, which are the classes primarily addressed in this project, are both critical components in providing this functionality.

== Description of Project ==
The <code>Course</code> model stores information about the instructor and institution it belongs to, and it is associated with other models such as User, Assignment, etc. The course model is responsible for completing a variety of tasks, including returning the submission directory for the course, viewing students enrolled in the course, and adding a student to the course, etc.

The <code>CoursesController</code> is responsible for managing courses. It performs CRUD operations on the Course model. It is responsible for creating, editing, deleting courses, and adding/removing teaching assistants to the course. The controller also returns a list of Teaching assistants associated with the course.

==Problem Statement==
The problem statement requires us to re-implement the Course model and CoursesController in a Rails application, with the goal of managing courses by allowing admins to create, edit, update, and delete courses, as well as create copies of existing courses. The re-implementation should follow RESTful conventions, including appropriate HTTP response codes and status codes for each endpoint. We are required to write RSpec tests for the Course model and the CoursesController, covering all endpoints and including appropriate HTTP response codes for every method. Tests for the controller will be made compatible with RSwag to generate API documentation and test REST APIs from the Swagger UI.

==Previous Work==
{| class="wikitable" style="margin-left:40px"
|-
! Index !! Previous !! Proposed || Rationale
|-
| 1 || user_on_team method in course.rb model || user_on_team method in team.rb || The functionality to check whether a user is a member of any team is associated with team model, follows Single Responsibility Principle 
|-
| 2 || copy method present in controller || copy method should be added in model as well ||  
|-
| 3 || action_allowed method in controller || action_allowed method should be in user.rb ||  It should belong to Authorization part.
|-
|} 

==Implementation==
Based on the current functionality of Course model and controller we have defined the following RESTful endpoints with their Request type which would be implemented in the controller.
====Controller====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Request Type !! Description 
|-
| 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role
|-
| 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA
|-
| 3 || new || GET || Displays the form for creating a new course
|-
| 4 || edit|| GET || Method to get the course to edit
|-
| 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database
|-
| 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database
|-
| 7 || create || POST || Creates a new course based on the form input and saves it to database
|-
| 8 || delete || DELETE || Method to delete an existing course
|-
| 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course
|-
| 10 || add_ta || POST || Method to add teaching assistant to a course
|-
| 11 || remove_ta || POST || Method to remove teaching assistant from a course
|-
| 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course
|-

|}


====Model====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Description 
|-
| 1 || get_teams || Returns any predefined teams associated with a particular course object
|-
| 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id
|-
| 3 || get_participant || Returns a single record course participant from Course Participant given parent_id
|-
| 4 || add _participant || Add a new Course Participant to the course given user_name
|-
| 5 || copy_participants || Copies all the participants from a given assignment to the current course
|-
| 6 || user_on_team || Checks whether a given user is a member of any team associated with the course
|-
| 7 || path || Returns the course's submission directory
|-

|}


==UML Diagram==
[[Image: UML.png]]

==Testing Plan==
The Course model and controller will be tested using Rspec. FactoryBot will be utilized to create test fixtures and to build the required models. As the methods in the controller are defined as RESTful endpoints. The test take into consideration that the methods return the correct status codes for the output. Based on the current functionality of Course model and controller we have defined the following test which would implemented to test the reimplemented code of course model and controller. 

====Tests====
'''Course Controller'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description 
|-
| 1 || Tests if the action_allowed disallows all actions when current user is student.
|-
| 2 || Tests if the action_allowed allows all course actions when current user is instructor.
|-
| 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.
|-
| 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.
|-
| 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.
|-
| 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.
|-
| 7 || Tests if the new method sets the private instance variable.
|-
| 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.
|-
| 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the auto_complete_for_user_name method returns a list of users.
|-
| 12 || Tests if the copy method redirects to new course when new course id fetched successfully.
|-
| 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.
|-
| 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.
|-
| 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.
|-
| 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.
|-
| 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.
|-
| 16 || Tests if the set_course_fields method sets the course fields.
|}

'''Course Model'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description 
|-
| 1 || Tests if the model validates presence of name
|-
| 2 || Tests if the model validates presence of directory_path
|-
| 3 || Tests if path method raises an error when there is no associated instructor.
|-
| 4 || Tests if path method returns a directory when there is an associated instructor.

|}

== Relevant Links ==
* '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)