E2484. Reimplement participants_controller.rb

app/controllers/api/v1/participants_controller.rb

@@ -0,0 +1,194 @@
+class Api::V1::ParticipantsController < ApplicationController
+  include ParticipantsHelper
+
+  # Return a list of participants for a given user
+  # params - user_id
+  # GET /participants/user/:user_id
+  def user_index
+    user = find_user if params[:user_id].present?
+    return if params[:user_id].present? && user.nil?
+
+    participants = filter_user_participants(user)
+
+    if participants.nil?
+      render json: participants.errors, status: :unprocessable_entity
+    else
+      render json: participants, status: :ok
+    end
+  end
+
+  # Return a list of participants for a given assignment
+  # params - assignment_id
+  # GET /participants/assignment/:assignment_id
+  def assignment_index
+    assignment = find_assignment if params[:assignment_id].present?
+    return if params[:assignment_id].present? && assignment.nil?
+
+    participants = filter_assignment_participants(assignment)
+
+    if participants.nil?
+      render json: participants.errors, status: :unprocessable_entity
+    else
+      render json: participants, status: :ok
+    end
+  end
+
+  # Return a specified participant
+  # params - id
+  # GET /participants/:id
+  def show
+    participant = Participant.find(params[:id])
+
+    if participant.nil?
+      render json: participant.errors, status: :unprocessable_entity
+    else
+      render json: participant, status: :created
+    end
+  end
+
+  # Assign the specified authorization to the participant and add them to an assignment
+  # POST /participants/:authorization
+  def add
+    user = find_user
+    return unless user
+
+    assignment = find_assignment
+    return unless assignment
+
+    authorization = validate_authorization
+    return unless authorization
+
+    permissions = retrieve_participant_permissions(authorization)
+
+    participant = assignment.add_participant(user)
+    participant.authorization = authorization
+    participant.can_submit = permissions[:can_submit]
+    participant.can_review = permissions[:can_review]
+    participant.can_take_quiz = permissions[:can_take_quiz]
+    participant.can_mentor = permissions[:can_mentor]
+
+    if participant.save
+      render json: participant, status: :created
+    else
+      render json: participant.errors, status: :unprocessable_entity
+    end
+  end
+
+  # Update the specified participant to the specified authorization
+  # PATCH /participants/:id/:authorization
+  def update_authorization
+    participant = find_participant
+    return unless participant
+
+    authorization = validate_authorization
+    return unless authorization
+
+    permissions = retrieve_participant_permissions(authorization)
+
+    participant.authorization = authorization
+    participant.can_submit = permissions[:can_submit]
+    participant.can_review = permissions[:can_review]
+    participant.can_take_quiz = permissions[:can_take_quiz]
+    participant.can_mentor = permissions[:can_mentor]
+
+    if participant.save
+      render json: participant, status: :created
+    else
+      render json: participant.errors, status: :unprocessable_entity
+    end
+  end
+
+  # Delete a participant
+  # params - id
+  # DELETE /participants/:id
+  def destroy
+    participant = Participant.find_by(id: params[:id])
+
+    if participant.nil?
+      render json: { error: 'Not Found' }, status: :not_found
+    elsif participant.destroy
+      successful_deletion_message = if params[:team_id].nil?
+                                      "Participant #{params[:id]} in Assignment #{params[:assignment_id]} has been deleted successfully!"
+                                    else
+                                      "Participant #{params[:id]} in Team #{params[:team_id]} of Assignment #{params[:assignment_id]} has been deleted successfully!"
+                                    end
+      render json: { message: successful_deletion_message }, status: :ok
+    else
+      render json: participant.errors, status: :unprocessable_entity
+    end
+  end
+
+  # Permitted parameters for creating a Participant object
+  def participant_params
+    params.require(:participant).permit(:user_id, :assignment_id, :authorization, :can_submit,
+                                        :can_review, :can_take_quiz, :can_mentor, :handle,
+                                        :team_id, :join_team_request_id, :permission_granted,
+                                        :topic, :current_stage, :stage_deadline)
+  end
+
+  private
+
+  # Filters participants based on the provided user
+  # Returns participants ordered by their IDs
+  def filter_user_participants(user)
+    participants = Participant.all
+    participants = participants.where(user_id: user.id) if user
+    participants.order(:id)
+  end
+
+  # Filters participants based on the provided assignment
+  # Returns participants ordered by their IDs
+  def filter_assignment_participants(assignment)
+    participants = Participant.all
+    participants = participants.where(assignment_id: assignment.id) if assignment
+    participants.order(:id)
+  end
+
+  # Finds a user based on the user_id parameter
+  # Returns the user if found
+  def find_user
+    user_id = params[:user_id]
+    user = User.find_by(id: user_id)
+    render json: { error: 'User not found' }, status: :not_found unless user
+    user
+  end
+
+  # Finds an assignment based on the assignment_id parameter
+  # Returns the assignment if found
+  def find_assignment
+    assignment_id = params[:assignment_id]
+    assignment = Assignment.find_by(id: assignment_id)
+    render json: { error: 'Assignment not found' }, status: :not_found unless assignment
+    assignment
+  end
+
+  # Finds a participant based on the id parameter
+  # Returns the participant if found
+  def find_participant
+    participant_id = params[:id]
+    participant = Participant.find_by(id: participant_id)
+    render json: { error: 'Participant not found' }, status: :not_found unless participant
+    participant
+  end
+
+  # Validates that the authorization parameter is present and is one of the following valid authorizations: reader, reviewer, submitter, mentor
+  # Returns the authorization if valid
+  def validate_authorization
+    valid_authorizations = %w[reader reviewer submitter mentor]
+    authorization = params[:authorization]
+    authorization = authorization.downcase if authorization.present?
+
+    unless authorization
+      render json: { error: 'authorization is required' }, status: :unprocessable_entity
+      return
+    end
+
+    unless valid_authorizations.include?(authorization)
+      render json: { error: 'authorization not valid. Valid authorizations are: Reader, Reviewer, Submitter, Mentor' },
+             status: :unprocessable_entity
+      return
+    end
+
+    authorization
+  end
+end

app/helpers/participants_helper.rb

@@ -0,0 +1,28 @@
+module ParticipantsHelper
+  # ===========================================================
+  # A participant can be one of the following authorizations:
+  # Reader
+  # Reviewer
+  # Submitter
+  # Mentor
+  # ===========================================================
+  # Grant a participant permissions to submit, review,
+  # take quizzes, and mentor based on their authorization
+  def retrieve_participant_permissions(authorization)
+    default_permissions = {
+      can_submit: true,
+      can_review: true,
+      can_take_quiz: true,
+      can_mentor: false
+    }
+
+    permissions_map = {
+      'reader' => { can_submit: false },
+      'reviewer' => { can_submit: false, can_take_quiz: false },
+      'submitter' => { can_review: false, can_take_quiz: false },
+      'mentor' => { can_mentor: true }
+    }
+
+    default_permissions.merge(permissions_map[authorization])
+  end
+end

app/models/course.rb

@@ -49,4 +49,4 @@ def copy_course
     new_course.name += '_copy'
     new_course.save
   end
-end
+end

app/models/participant.rb

@@ -1,9 +1,17 @@
 class Participant < ApplicationRecord
+  # Associations
   belongs_to :user
   belongs_to :assignment, foreign_key: 'assignment_id', inverse_of: false
   has_many   :join_team_requests, dependent: :destroy
   belongs_to :team, optional: true
 
+  delegate :course, to: :assignment
+
+  # Validations
+  validates :user_id, presence: true
+  validates :assignment_id, presence: true
+
+  # Methods
   def fullname
     user.fullname
   end

app/models/user.rb

@@ -17,6 +17,7 @@ class User < ApplicationRecord
   has_many :assignments
   has_many :teams_users, dependent: :destroy
   has_many :teams, through: :teams_users
+  has_many :participants
 
   scope :students, -> { where role_id: Role::STUDENT }
   scope :tas, -> { where role_id: Role::TEACHING_ASSISTANT }

config/routes.rb

@@ -109,6 +109,17 @@
           get :processed, action: :processed_requests
         end
       end
+
+      resources :participants do
+        collection do
+          get '/user/:user_id', to: 'participants#user_index'
+          get '/assignment/:assignment_id', to: 'participants#assignment_index'
+          get '/:id', to: 'participants#show'
+          post '/:authorization', to: 'participants#add'
+          patch '/:id/:authorization', to: 'participants#update_authorization'
+          delete '/:id', to: 'participants#destroy'
+        end
+      end
     end
   end
 end

db/migrate/20231026002451_add_can_submit_to_participant.rb

@@ -1,5 +1,5 @@
-class AddCanSubmitToParticipant < ActiveRecord::Migration[7.0]
-  def change
-    add_column :participants, :can_submit, :boolean, :default => true
-  end
-end
+class AddCanSubmitToParticipant < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :can_submit, :boolean, :default => true
+  end
+end

db/migrate/20231026002543_add_can_review_to_participant.rb

@@ -1,5 +1,5 @@
-class AddCanReviewToParticipant < ActiveRecord::Migration[7.0]
-  def change
-    add_column :participants, :can_review, :boolean, :default => true
-  end
-end
+class AddCanReviewToParticipant < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :can_review, :boolean, :default => true
+  end
+end

db/migrate/20241201224112_add_can_take_quiz_to_participants.rb

@@ -0,0 +1,5 @@
+class AddCanTakeQuizToParticipants < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :can_take_quiz, :boolean
+  end
+end

db/migrate/20241201224137_add_can_mentor_to_participants.rb

@@ -0,0 +1,5 @@
+class AddCanMentorToParticipants < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :can_mentor, :boolean
+  end
+end

db/migrate/20241202165201_add_authorization_to_participants.rb

@@ -0,0 +1,5 @@
+class AddAuthorizationToParticipants < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :authorization, :string
+  end
+end