RecommendationRequestController.java
package edu.ucsb.cs156.example.controllers;
import edu.ucsb.cs156.example.entities.RecommendationRequest;
import edu.ucsb.cs156.example.errors.EntityNotFoundException;
import edu.ucsb.cs156.example.repositories.RecommendationRequestRepository;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import java.time.LocalDateTime;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/** This is a REST controller for RecommendationRequests */
@Tag(name = "RecommendationRequest")
@RequestMapping("/api/RecommendationRequest")
@RestController
@Slf4j
public class RecommendationRequestController extends ApiController {
@Autowired RecommendationRequestRepository recommendationRequestRepository;
/**
* List all recommendation requests
*
* @return an iterable of RecommendationRequest
*/
@Operation(summary = "List all recommendation requests")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("/all")
public Iterable<RecommendationRequest> allRecommendationRequests() {
Iterable<RecommendationRequest> requests = recommendationRequestRepository.findAll();
return requests;
}
/**
* Get a single recommendation request by id
*
* @param id the id of the recommendation request
* @return a RecommendationRequest
*/
@Operation(
summary = "Get a single recommendation request",
description =
"Returns the recommendation request with the given id, or a 404 error if no recommendation request has that id")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("")
public RecommendationRequest getById(
@Parameter(name = "id", description = "id of the recommendation request to get") @RequestParam
Long id) {
RecommendationRequest recommendationRequest =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
return recommendationRequest;
}
/**
* Create a new recommendation request
*
* @param requesterEmail the email of the student requesting the recommendation
* @param professorEmail the email of the professor being asked for the recommendation
* @param explanation what the recommendation is for (e.g. the program being applied to)
* @param dateRequested the date the recommendation was requested
* @param dateNeeded the date by which the recommendation is needed
* @param done whether the recommendation request has been fulfilled
* @return the saved recommendation request
*/
@Operation(summary = "Create a new recommendation request")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PostMapping("/post")
public RecommendationRequest postRecommendationRequest(
@Parameter(
name = "requesterEmail",
description = "email of the student requesting the recommendation")
@RequestParam
String requesterEmail,
@Parameter(
name = "professorEmail",
description = "email of the professor being asked for the recommendation")
@RequestParam
String professorEmail,
@Parameter(
name = "explanation",
description =
"what the recommendation is for (e.g. the program or position being applied to)")
@RequestParam
String explanation,
@Parameter(
name = "dateRequested",
description =
"date the recommendation was requested (in iso format, e.g. YYYY-mm-ddTHH:MM:SS; see https://en.wikipedia.org/wiki/ISO_8601)")
@RequestParam("dateRequested")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
LocalDateTime dateRequested,
@Parameter(
name = "dateNeeded",
description =
"date by which the recommendation is needed (in iso format, e.g. YYYY-mm-ddTHH:MM:SS; see https://en.wikipedia.org/wiki/ISO_8601)")
@RequestParam("dateNeeded")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
LocalDateTime dateNeeded,
@Parameter(
name = "done",
description = "whether the recommendation request has been fulfilled")
@RequestParam
boolean done) {
// For an explanation of @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
// See: https://www.baeldung.com/spring-date-parameters
log.info("dateRequested={}, dateNeeded={}", dateRequested, dateNeeded);
RecommendationRequest recommendationRequest = new RecommendationRequest();
recommendationRequest.setRequesterEmail(requesterEmail);
recommendationRequest.setProfessorEmail(professorEmail);
recommendationRequest.setExplanation(explanation);
recommendationRequest.setDateRequested(dateRequested);
recommendationRequest.setDateNeeded(dateNeeded);
recommendationRequest.setDone(done);
RecommendationRequest savedRecommendationRequest =
recommendationRequestRepository.save(recommendationRequest);
return savedRecommendationRequest;
}
/**
* Delete a RecommendationRequest
*
* @param id the id of the recommendation request to delete
* @return a message indicating the recommendation request was deleted
*/
@Operation(
summary = "Delete a recommendation request",
description =
"Deletes the recommendation request with the given id and returns a message confirming it was deleted, or a 404 error if no recommendation request has that id")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("")
public Object deleteRecommendationRequest(
@Parameter(name = "id", description = "id of the recommendation request to delete")
@RequestParam
Long id) {
RecommendationRequest recommendationRequest =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
recommendationRequestRepository.delete(recommendationRequest);
return genericMessage("RecommendationRequest with id %s deleted".formatted(id));
}
/**
* Update a single recommendation request
*
* @param id id of the recommendation request to update
* @param incoming the new values for the recommendation request
* @return the updated recommendation request
*/
@Operation(
summary = "Update a single recommendation request",
description =
"Replaces requesterEmail, professorEmail, explanation, dateRequested, dateNeeded, and done of the recommendation request with the given id using the values in the JSON request body (any id in the body is ignored); dates are in iso format, e.g. YYYY-mm-ddTHH:MM:SS. Returns the updated recommendation request, or a 404 error if no recommendation request has that id")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PutMapping("")
public RecommendationRequest updateRecommendationRequest(
@Parameter(name = "id", description = "id of the recommendation request to update")
@RequestParam
Long id,
@RequestBody @Valid RecommendationRequest incoming) {
RecommendationRequest recommendationRequest =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
recommendationRequest.setRequesterEmail(incoming.getRequesterEmail());
recommendationRequest.setProfessorEmail(incoming.getProfessorEmail());
recommendationRequest.setExplanation(incoming.getExplanation());
recommendationRequest.setDateRequested(incoming.getDateRequested());
recommendationRequest.setDateNeeded(incoming.getDateNeeded());
recommendationRequest.setDone(incoming.getDone());
recommendationRequestRepository.save(recommendationRequest);
return recommendationRequest;
}
}