RecommendationRequestController.java
package edu.ucsb.cs156.example.controllers;
import com.fasterxml.jackson.core.JsonProcessingException;
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;
@Tag(name = "RecommendationRequest")
@RequestMapping("/api/RecommendationRequest")
@RestController
@Slf4j
public class RecommendationRequestController extends ApiController {
@Autowired RecommendationRequestRepository recommendationRequestRepository;
/**
* List all recommendation requests.
*
* @return all recommendation requests
* @throws JsonProcessingException on serialization error
*/
@Operation(summary = "List all recommendation requests")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("/all")
public Iterable<RecommendationRequest> allRecommendationRequests()
throws JsonProcessingException {
Iterable<RecommendationRequest> requests = recommendationRequestRepository.findAll();
return requests;
}
/**
* Get a recommendation request by id.
*
* @param id the id of the recommendation request
* @return the recommendation request
*/
@Operation(summary = "Get a recommendation request by id")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("")
public RecommendationRequest getRecommendationRequest(
@Parameter(name = "id") @RequestParam Long id) {
RecommendationRequest request =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
return request;
}
/**
* Update a recommendation request by id.
*
* @param id the id of the recommendation request
* @param incoming the updated recommendation request fields
* @return the updated recommendation request
*/
@Operation(summary = "Update a recommendation request by id")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PutMapping("")
public RecommendationRequest updateRecommendationRequest(
@Parameter(name = "id") @RequestParam Long id,
@RequestBody @Valid RecommendationRequest incoming) {
RecommendationRequest request =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
request.setRequesterEmail(incoming.getRequesterEmail());
request.setProfessorEmail(incoming.getProfessorEmail());
request.setExplanation(incoming.getExplanation());
request.setDateRequested(incoming.getDateRequested());
request.setDateNeeded(incoming.getDateNeeded());
request.setDone(incoming.getDone());
recommendationRequestRepository.save(request);
return request;
}
/**
* Delete a recommendation request by id.
*
* @param id the id of the recommendation request
* @return a message indicating the record was deleted
*/
@Operation(summary = "Delete a recommendation request by id")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("")
public Object deleteRecommendationRequest(@Parameter(name = "id") @RequestParam Long id) {
RecommendationRequest request =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
recommendationRequestRepository.delete(request);
return genericMessage("record %s deleted".formatted(id));
}
/**
* Create a new recommendation request.
*
* @param requesterEmail email of the requester
* @param professorEmail email of the professor
* @param explanation explanation for the request
* @param dateRequested date the request was made
* @param dateNeeded date the letter is needed
* @param done whether the request is complete
* @return the created recommendation request
*/
@Operation(summary = "Create a new recommendation request")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PostMapping("/post")
public RecommendationRequest postRecommendationRequest(
@Parameter(name = "requesterEmail") @RequestParam String requesterEmail,
@Parameter(name = "professorEmail") @RequestParam String professorEmail,
@Parameter(name = "explanation") @RequestParam String explanation,
@Parameter(
name = "dateRequested",
description =
"date (in iso format, e.g. YYYY-mm-ddTHH:MM:SS; e.g. 2022-01-03T00:00:00)")
@RequestParam("dateRequested")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
LocalDateTime dateRequested,
@Parameter(
name = "dateNeeded",
description =
"date (in iso format, e.g. YYYY-mm-ddTHH:MM:SS; e.g. 2022-01-03T00:00:00)")
@RequestParam("dateNeeded")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
LocalDateTime dateNeeded,
@Parameter(name = "done") @RequestParam String done) {
log.info("dateRequested={}", dateRequested);
log.info("dateNeeded={}", dateNeeded);
RecommendationRequest recommendationRequest = new RecommendationRequest();
recommendationRequest.setRequesterEmail(requesterEmail);
recommendationRequest.setProfessorEmail(professorEmail);
recommendationRequest.setExplanation(explanation);
recommendationRequest.setDateRequested(dateRequested);
recommendationRequest.setDateNeeded(dateNeeded);
recommendationRequest.setDone(Boolean.parseBoolean(done));
RecommendationRequest savedRecommendationRequest =
recommendationRequestRepository.save(recommendationRequest);
return savedRecommendationRequest;
}
}