ArticlesController.java
package edu.ucsb.cs156.example.controllers;
import edu.ucsb.cs156.example.entities.Article;
import edu.ucsb.cs156.example.entities.UCSBDate;
import edu.ucsb.cs156.example.errors.EntityNotFoundException;
import edu.ucsb.cs156.example.repositories.ArticlesRepository;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;
import com.fasterxml.jackson.core.JsonProcessingException;
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;
import jakarta.validation.Valid;
import java.time.LocalDateTime;
/**
* This is a REST controller for Articles
*/
@Tag(name = "Articles")
@RequestMapping("/api/articles")
@RestController
@Slf4j
public class ArticlesController extends ApiController {
@Autowired
ArticlesRepository articleRepository;
/**
* List all articles
*
* @return an iterable of Article
*/
@Operation(summary= "List all articles")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("/all")
public Iterable<Article> allArticles() {
Iterable<Article> articles = articleRepository.findAll();
return articles;
}
/**
* Create a new article
*
* @param title the title of the article
* @param url the url of the article
* @param explanation the explanation of the article
* @param email the email associated with the article
* @param dateAdded the date
* @return the saved article
*/
@Operation(summary= "Create a new article")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PostMapping("/post")
public Article postArticle(
@Parameter(name="title") @RequestParam String title,
@Parameter(name="url") @RequestParam String url,
@Parameter(name="explanation") @RequestParam String explanation,
@Parameter(name="email") @RequestParam String email,
@Parameter(name="dateAdded", description="(in iso format, e.g. YYYY-mm-ddTHH:MM:SS; see https://en.wikipedia.org/wiki/ISO_8601)") @RequestParam("dateAdded") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime dateAdded)
throws JsonProcessingException {
// For an explanation of @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
// See: https://www.baeldung.com/spring-date-parameters
log.info("dateAdded={}", dateAdded);
Article article = new Article();
article.setTitle(title);
article.setUrl(url);
article.setExplanation(explanation);
article.setEmail(email);
article.setDateAdded(dateAdded);
Article savedArticle = articleRepository.save(article);
return savedArticle;
}
/**
* Delete a Article
*
* @param id the id of the article to delete
* @return a message indicating the article was deleted
*/
@Operation(summary= "Delete a Article")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("")
public Object deleteArticle(
@Parameter(name="id") @RequestParam Long id) {
Article article = articleRepository.findById(id)
.orElseThrow(() -> new EntityNotFoundException(Article.class, id));
articleRepository.delete(article);
return genericMessage("Article with id %s deleted".formatted(id));
}
/**
* Update a single article
*
* @param id id of the article to update
* @param incoming the new article
* @return the updated article object
*/
@Operation(summary= "Update a single article")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PutMapping("")
public Article updateArticle(
@Parameter(name="id") @RequestParam Long id,
@RequestBody @Valid Article incoming) {
Article article = articleRepository.findById(id)
.orElseThrow(() -> new EntityNotFoundException(Article.class, id));
article.setDateAdded(incoming.getDateAdded());
article.setEmail(incoming.getEmail());
article.setExplanation(incoming.getExplanation());
article.setTitle(incoming.getTitle());
article.setUrl(incoming.getUrl());
articleRepository.save(article);
return article;
}
/**
* Get a single date by id
*
* @param id the id of the date
* @return a UCSBDate
*/
@Operation(summary= "Get a single article")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("")
public Article getById(
@Parameter(name="id") @RequestParam Long id) {
Article article = articleRepository.findById(id)
.orElseThrow(() -> new EntityNotFoundException(Article.class, id));
return article;
}
}