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;
/** This is a REST controller for RecommendationRequests */
@Tag(name = "RecommendationRequests")
@RequestMapping("/api/RecommendationRequest")
@RestController
@Slf4j
public class RecommendationRequestController extends ApiController {
@Autowired RecommendationRequestRepository recommendationRequestRepository;
/**
* List all RecommendationRequests
*
* @return an iterable of RecommendationRequest
*/
@Operation(summary = "List all recommendation requests")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("/all")
public Iterable<RecommendationRequest> allRecommendationRequests() {
Iterable<RecommendationRequest> recommendationRequests =
recommendationRequestRepository.findAll();
return recommendationRequests;
}
/**
* Get a single RecommendationRequest by id
*
* @param id the id of the RecommendationRequest
* @return a RecommendationRequest
*/
@Operation(summary = "Get a single recommendation request")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("")
public RecommendationRequest getById(@Parameter(name = "id") @RequestParam Long id) {
RecommendationRequest recommendationRequest =
recommendationRequestRepository
.findById(id)
.orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));
return recommendationRequest;
}
/**
* Create a new RecommendationRequest
*
* @param requesterEmail the email of the person requesting the recommendation
* @param professorEmail the email of the professor receiving the request
* @param explanation explanation of what the recommendation is for
* @param dateRequested the date and time the recommendation was requested
* @param dateNeeded the date and time by which the recommendation is needed
* @param done whether the recommendation request has been completed
* @return the saved RecommendationRequest
*/
@Operation(summary = "Create a new recommendation request")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PostMapping("/post")
public RecommendationRequest postRecommendationRequest(
@Parameter(name = "requesterEmail", description = "Email address of the requester")
@RequestParam
String requesterEmail,
@Parameter(name = "professorEmail", description = "Email address of the professor")
@RequestParam
String professorEmail,
@Parameter(name = "explanation", description = "Explanation of the recommendation request")
@RequestParam
String explanation,
@Parameter(
name = "dateRequested",
description = "Date and time requested in ISO format, e.g. 2022-05-20T00:00:00")
@RequestParam("dateRequested")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
LocalDateTime dateRequested,
@Parameter(
name = "dateNeeded",
description = "Date and time needed in ISO format, e.g. 2022-11-15T00:00:00")
@RequestParam("dateNeeded")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
LocalDateTime dateNeeded,
@Parameter(name = "done", description = "Whether the recommendation request is completed")
@RequestParam
boolean done)
throws JsonProcessingException {
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 RecommendationRequest to delete
* @return a message indicating the RecommendationRequest was deleted
*/
@Operation(summary = "Delete a recommendation request")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("")
public Object deleteRecommendationRequest(@Parameter(name = "id") @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 RecommendationRequest
*
* @param id id of the RecommendationRequest to update
* @param incoming the new RecommendationRequest
* @return the updated RecommendationRequest object
*/
@Operation(summary = "Update a single recommendation request")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PutMapping("")
public RecommendationRequest updateRecommendationRequest(
@Parameter(name = "id") @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;
}
}