UCSBCurriculumService.java

package edu.ucsb.cs156.courses.services;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import edu.ucsb.cs156.courses.documents.ConvertedSection;
import edu.ucsb.cs156.courses.documents.CoursePage;
import edu.ucsb.cs156.courses.documents.GERequirement;
import edu.ucsb.cs156.courses.documents.Primary;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

/** Service object that wraps the UCSB Academic Curriculum API */
@Service
@Slf4j
public class UCSBCurriculumService {

  @Autowired private ObjectMapper objectMapper;

  @Value("${app.ucsb.api.consumer_key}")
  private String apiKey;

  @Value("${app.ucsb.api.host}")
  private String apiHost;

  private static final Duration CONNECT_TIMEOUT = Duration.ofSeconds(10);
  private static final Duration READ_TIMEOUT = Duration.ofSeconds(60);

  private RestTemplate restTemplate = new RestTemplate();

  public UCSBCurriculumService(RestTemplateBuilder restTemplateBuilder) throws Exception {
    restTemplate =
        restTemplateBuilder.connectTimeout(CONNECT_TIMEOUT).readTimeout(READ_TIMEOUT).build();
  }

  public static final String CURRICULUM_ENDPOINT =
      "{apiHost}/academics/curriculums/v1/classes/search";

  public static final String SUBJECTS_ENDPOINT = "{apiHost}/students/lookups/v1/subjects";

  public static final String SECTION_ENDPOINT =
      "{apiHost}/academics/curriculums/v1/classsection/{quarter}/{enrollcode}";

  public static final String ALL_SECTIONS_ENDPOINT =
      "{apiHost}/academics/curriculums/v3/classes/{quarter}/{enrollcode}";

  public static final String FINALS_ENDPOINT = "{apiHost}/academics/curriculums/v3/finals";

  public static final String GE_ENDPOINT = "{apiHost}/students/lookups/v1/requirements";

  public String getJSON(String subjectArea, String quarter, String courseLevel) throws Exception {

    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "1.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String params =
        String.format(
            "?quarter=%s&subjectCode=%s&objLevelCode=%s&pageNumber=%d&pageSize=%d&includeClassSections=%s",
            quarter, subjectArea, courseLevel, 1, 100, "true");
    String url = CURRICULUM_ENDPOINT + params;

    if (courseLevel.equals("A")) {
      params =
          String.format(
              "?quarter=%s&subjectCode=%s&pageNumber=%d&pageSize=%d&includeClassSections=%s",
              quarter, subjectArea, 1, 100, "true");
      url = CURRICULUM_ENDPOINT + params;
    }

    url = url.replace("{apiHost}", apiHost);

    log.info("url=" + url);

    String retVal = "";
    MediaType contentType = null;
    HttpStatus statusCode = null;

    ResponseEntity<String> re = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    log.trace("json: {}", retVal);
    log.info("contentType: {} statusCode: {}", contentType, statusCode);
    return retVal;
  }

  public List<ConvertedSection> getConvertedSections(
      String subjectArea, String quarter, String courseLevel) throws Exception {
    String json = getJSON(subjectArea, quarter, courseLevel);
    CoursePage coursePage = objectMapper.readValue(json, CoursePage.class);
    List<ConvertedSection> result = coursePage.convertedSections();
    return result;
  }

  /**
   * This method retrieves course information and reformats it so that each primary is a single
   * object, that has a list of all of it's secondaries.
   *
   * <p>As a reminder, the UCSB course registration systems (GOLD, Blue, Star, etc.) treat all
   * courses as "sections", even what we typically call "lectures". In the database, some courses
   * have both primary and secondary sections. Primary sections have section numbers ending in 00
   * (e.g. 100, 200, 300, up to 9900), while secondaries have numbers ending with 01, 02, 03, etc.
   * and "belong" with a primary.
   *
   * <p>What we typically refer to as "lectures" are primary sections ending in 00 (e.g. 100, 200,
   * 300). What we typically refer to as discussion sections are secondaries and end with 01, 02,
   * 03, etc.
   *
   * <p>
   *
   * <p>The UCSB API <i>almost</i> does this, but not quite. It returns a list of all sections, but
   * does not group them into primaries and secondaries. This method relies on the <code>
   * getPrimaries</code> method of the <code>Page</code> class to reformat the data so that each
   * primary section is a single object, with a list of all of its secondaries.
   *
   * @param subjectArea
   * @param quarter
   * @param courseLevel
   * @return a list of Primaries
   * @throws Exception
   */
  public List<Primary> getPrimaries(String subjectArea, String quarter, String courseLevel)
      throws Exception {
    String json = getJSON(subjectArea, quarter, courseLevel);
    CoursePage coursePage = objectMapper.readValue(json, CoursePage.class);
    List<Primary> result = coursePage.getPrimaries();
    return result;
  }

  public String getJSONByGE(String quarter, String area) throws Exception {
    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "1.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String params =
        String.format("?quarter=%s&areas=%s&pageNumber=%d&pageSize=%d", quarter, area, 1, 500);
    String url = (CURRICULUM_ENDPOINT + params).replace("{apiHost}", apiHost);

    log.info("url=" + url);

    String retVal = "";
    MediaType contentType = null;
    HttpStatus statusCode = null;

    ResponseEntity<String> re = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    log.trace("json: {}", retVal);
    log.info("contentType: {} statusCode: {}", contentType, statusCode);
    return retVal;
  }

  public List<Primary> getPrimariesByGE(String quarter, String area) throws Exception {
    String json = getJSONByGE(quarter, area);
    CoursePage coursePage = objectMapper.readValue(json, CoursePage.class);
    List<Primary> result = coursePage.getPrimaries();
    return result;
  }

  public String getSectionJSON(String subjectArea, String quarter, String courseLevel)
      throws Exception {
    List<ConvertedSection> l = getConvertedSections(subjectArea, quarter, courseLevel);

    String arrayToJson = objectMapper.writeValueAsString(l);

    return arrayToJson;
  }

  public String getSubjectsJSON() throws Exception {

    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "1.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String url = SUBJECTS_ENDPOINT.replace("{apiHost}", apiHost);

    log.info("url=" + url);

    String retVal = "";
    MediaType contentType = null;
    HttpStatus statusCode = null;

    ResponseEntity<String> re = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    log.info("json: {} contentType: {} statusCode: {}", retVal, contentType, statusCode);
    return retVal;
  }

  /**
   * This method retrieves exactly one section matching the enrollCode and quarter arguments, if
   * such a section exists.
   */
  public String getSection(String enrollCode, String quarter) throws Exception {

    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "1.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String url = SECTION_ENDPOINT.replace("{apiHost}", apiHost);

    log.info("url=" + url);

    Map<String, String> params = new HashMap<>();
    params.put("quarter", quarter);
    params.put("enrollcode", enrollCode);

    String retVal = "";
    MediaType contentType = null;
    HttpStatus statusCode = null;

    ResponseEntity<String> re =
        restTemplate.exchange(url, HttpMethod.GET, entity, String.class, params);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    if (retVal.equals("null")) {
      retVal = "{\"error\": \"Enroll code doesn't exist in that quarter.\"}";
    }

    log.info("json: {} contentType: {} statusCode: {}", retVal, contentType, statusCode);
    return retVal;
  }

  /**
   * This method retrieves all of the sections related to a certain enroll code. For example, if the
   * enrollCode is for a discussion section, the lecture section and all related discussion sections
   * will also be returned.
   */
  public String getAllSections(String enrollCode, String quarter) throws Exception {

    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "3.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String url = ALL_SECTIONS_ENDPOINT.replace("{apiHost}", apiHost);

    log.info("url=" + url);

    Map<String, String> params = new HashMap<>();
    params.put("quarter", quarter);
    params.put("enrollcode", enrollCode);

    String retVal = "";
    MediaType contentType = null;
    HttpStatus statusCode = null;

    ResponseEntity<String> re =
        restTemplate.exchange(url, HttpMethod.GET, entity, String.class, params);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    if (retVal.equals("null")) {
      retVal = "{\"error\": \"Enroll code doesn't exist in that quarter.\"}";
    }

    log.info("json: {} contentType: {} statusCode: {}", retVal, contentType, statusCode);
    return retVal;
  }

  public String getJSONbyQtrEnrollCd(String quarter, String enrollCd) throws Exception {

    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "1.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String url = "{apiHost}/academics/curriculums/v3/classsection/" + quarter + "/" + enrollCd;
    url = url.replace("{apiHost}", apiHost);

    log.info("url=" + url);

    String retVal = "";
    MediaType contentType = null;
    HttpStatus statusCode = null;

    ResponseEntity<String> re = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    log.info("json: {} contentType: {} statusCode: {}", retVal, contentType, statusCode);
    return retVal;
  }

  public String getFinalsInfo(String quarter, String enrollCd) throws Exception {
    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.set("ucsb-api-version", "3.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String params = String.format("?quarter=%s&enrollCode=%s", quarter, enrollCd);
    String url = (FINALS_ENDPOINT + params).replace("{apiHost}", apiHost);

    log.info("url=" + url);

    String retVal;
    MediaType contentType;
    HttpStatus statusCode;

    ResponseEntity<String> re = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
    contentType = re.getHeaders().getContentType();
    statusCode = (HttpStatus) re.getStatusCode();
    retVal = re.getBody();

    log.info("json: {} contentType: {} statusCode: {}", retVal, contentType, statusCode);
    return retVal;
  }

  public String getGeneralEducationInfo() throws Exception {
    HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.set("ucsb-api-version", "1.0");
    headers.set("ucsb-api-key", this.apiKey);

    HttpEntity<String> entity = new HttpEntity<>("body", headers);

    String url = GE_ENDPOINT.replace("{apiHost}", apiHost);

    log.info("Fetching GE areas from {}", url);
    ResponseEntity<String> response =
        restTemplate.exchange(url, HttpMethod.GET, entity, String.class);

    log.debug("GE areas JSON: {}", response.getBody());
    return response.getBody();
  }

  public List<String> getRequirementCodesByCollege(String collegeCode) throws Exception {
    String json = getGeneralEducationInfo();

    List<GERequirement> allAreas =
        objectMapper.readValue(json, new TypeReference<List<GERequirement>>() {});

    return allAreas.stream()
        .filter(area -> area.getCollegeCode().equalsIgnoreCase(collegeCode))
        .map(GERequirement::getRequirementCode)
        .distinct()
        .collect(Collectors.toList());
  }
}


















































Active mutators

CONDITIONALS_BOUNDARY
EMPTY_RETURNS
FALSE_RETURNS
INCREMENTS
INVERT_NEGS
MATH
NEGATE_CONDITIONALS
NULL_RETURNS
PRIMITIVE_RETURNS
TRUE_RETURNS
VOID_METHOD_CALLS

Tests examined

edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getRequirementCodesByCollege_filtersAndDistinct()] (4 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getSubjectsJSON_success()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getJSONbyQtrEnrollCd_success()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getConvertedSections()] (6 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getSectionJSON()] (17 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getPrimaries()] (7 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getGeneralEducationInfo_success()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getAllSections_not_found()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getAllSections_success()] (2 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getJSONByGE()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getPrimariesGE()] (12 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getSection_not_found()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getSectionsuccess()] (2 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getJSON_success()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getJSON_success_level_A()] (1 ms)
edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.services.UCSBCurriculumServiceTests]/[method:test_getFinalsInfo_success()] (1 ms)

Report generated by PIT 1.17.0

1		package edu.ucsb.cs156.courses.services;
2
3		import com.fasterxml.jackson.core.type.TypeReference;
4		import com.fasterxml.jackson.databind.ObjectMapper;
5		import edu.ucsb.cs156.courses.documents.ConvertedSection;
6		import edu.ucsb.cs156.courses.documents.CoursePage;
7		import edu.ucsb.cs156.courses.documents.GERequirement;
8		import edu.ucsb.cs156.courses.documents.Primary;
9		import java.time.Duration;
10		import java.util.Arrays;
11		import java.util.HashMap;
12		import java.util.List;
13		import java.util.Map;
14		import java.util.stream.Collectors;
15		import lombok.extern.slf4j.Slf4j;
16		import org.springframework.beans.factory.annotation.Autowired;
17		import org.springframework.beans.factory.annotation.Value;
18		import org.springframework.boot.web.client.RestTemplateBuilder;
19		import org.springframework.http.HttpEntity;
20		import org.springframework.http.HttpHeaders;
21		import org.springframework.http.HttpMethod;
22		import org.springframework.http.HttpStatus;
23		import org.springframework.http.MediaType;
24		import org.springframework.http.ResponseEntity;
25		import org.springframework.stereotype.Service;
26		import org.springframework.web.client.RestTemplate;
27
28		/** Service object that wraps the UCSB Academic Curriculum API */
29		@Service
30		@Slf4j
31		public class UCSBCurriculumService {
32
33		@Autowired private ObjectMapper objectMapper;
34
35		@Value("${app.ucsb.api.consumer_key}")
36		private String apiKey;
37
38		@Value("${app.ucsb.api.host}")
39		private String apiHost;
40

UCSBCurriculumService.java

Mutations

Active mutators

Tests examined