CourseOverTimeDescriptionController.java

package edu.ucsb.cs156.courses.controllers;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import edu.ucsb.cs156.courses.collections.ConvertedSectionCollection;
import edu.ucsb.cs156.courses.documents.ConvertedSection;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/public/description")
public class CourseOverTimeDescriptionController {

  private ObjectMapper mapper = new ObjectMapper();

  @Autowired ConvertedSectionCollection convertedSectionCollection;

  @Operation(summary = "Get a list of courses over time, filtered by course title or description")
  @GetMapping(value = "/search", produces = "application/json")
  public ResponseEntity<String> search(
      @Parameter(
              name = "startQtr",
              description =
                  "Starting quarter in yyyyq format, e.g. 20232 for S23, 20234 for F23, etc. (1=Winter, 2=Spring, 3=Summer, 4=Fall)",
              example = "20232",
              required = true)
          @RequestParam
          String startQtr,
      @Parameter(
              name = "endQtr",
              description =
                  "Ending quarter in yyyyq format, e.g. 20232 for S23, 20234 for F23, etc. (1=Winter, 2=Spring, 3=Summer, 4=Fall)",
              example = "20232",
              required = true)
          @RequestParam
          String endQtr,
      @Parameter(
              name = "searchTerms",
              description =
                  "Search terms to filter by course title or description, e.g. 'data science', 'computer architecture', etc.",
              example = "Data",
              required = true)
          @RequestParam
          String searchTerms,
      @Parameter(
              name = "lectureOnly",
              description = "Lectures only",
              example = "true",
              required = true)
          @RequestParam
          boolean lectureOnly)
      throws JsonProcessingException {
    List<ConvertedSection> courseResults;
    String sectionRegex = lectureOnly ? ".*00$" : ".*";
    String escapedSearchTerms = Pattern.quote(searchTerms);

    courseResults =
        new ArrayList<>(
            convertedSectionCollection.findByQuarterRangeAndSearchTerms(
                startQtr, endQtr, escapedSearchTerms, sectionRegex));

    courseResults.sort(new ConvertedSection.ConvertedSectionSortDescendingByQuarterComparator());
    String body = mapper.writeValueAsString(courseResults);
    return ResponseEntity.ok().body(body);
  }
}