UCSBCurriculumService.java

  1. package edu.ucsb.cs156.courses.services;

  3. import com.fasterxml.jackson.databind.ObjectMapper;
  4. import edu.ucsb.cs156.courses.documents.ConvertedSection;
  5. import edu.ucsb.cs156.courses.documents.CoursePage;
  6. import java.util.Arrays;
  7. import java.util.HashMap;
  8. import java.util.List;
  9. import java.util.Map;
  10. import lombok.extern.slf4j.Slf4j;
  11. import org.springframework.beans.factory.annotation.Autowired;
  12. import org.springframework.beans.factory.annotation.Value;
  13. import org.springframework.boot.web.client.RestTemplateBuilder;
  14. import org.springframework.http.HttpEntity;
  15. import org.springframework.http.HttpHeaders;
  16. import org.springframework.http.HttpMethod;
  17. import org.springframework.http.HttpStatus;
  18. import org.springframework.http.MediaType;
  19. import org.springframework.http.ResponseEntity;
  20. import org.springframework.stereotype.Service;
  21. import org.springframework.web.client.RestTemplate;

  23. /** Service object that wraps the UCSB Academic Curriculum API */
  24. @Service
  25. @Slf4j
  26. public class UCSBCurriculumService {

  28.   @Autowired private ObjectMapper objectMapper;

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

  33.   private RestTemplate restTemplate = new RestTemplate();

  35.   public UCSBCurriculumService(RestTemplateBuilder restTemplateBuilder) throws Exception {
  36.     restTemplate = restTemplateBuilder.build();
  37.   }

  39.   public static final String CURRICULUM_ENDPOINT =
  40.       "https://api.ucsb.edu/academics/curriculums/v1/classes/search";

  42.   public static final String SUBJECTS_ENDPOINT =
  43.       "https://api.ucsb.edu/students/lookups/v1/subjects";

  45.   public static final String SECTION_ENDPOINT =
  46.       "https://api.ucsb.edu/academics/curriculums/v1/classsection/{quarter}/{enrollcode}";

  48.   public static final String ALL_SECTIONS_ENDPOINT =
  49.       "https://api.ucsb.edu/academics/curriculums/v3/classes/{quarter}/{enrollcode}";

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

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

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

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

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

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

  77.     String retVal = "";
  78.     MediaType contentType = null;
  79.     HttpStatus statusCode = null;

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

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

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

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

  102.     String arrayToJson = objectMapper.writeValueAsString(l);

  104.     return arrayToJson;
  105.   }

  107.   public String getSubjectsJSON() throws Exception {

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

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

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

  119.     String retVal = "";
  120.     MediaType contentType = null;
  121.     HttpStatus statusCode = null;

  123.     ResponseEntity<String> re =
  124.         restTemplate.exchange(SUBJECTS_ENDPOINT, HttpMethod.GET, entity, String.class);
  125.     contentType = re.getHeaders().getContentType();
  126.     statusCode = (HttpStatus) re.getStatusCode();
  127.     retVal = re.getBody();

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

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

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

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

  147.     String url = SECTION_ENDPOINT;

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

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

  155.     String retVal = "";
  156.     MediaType contentType = null;
  157.     HttpStatus statusCode = null;

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

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

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

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

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

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

  188.     String url = ALL_SECTIONS_ENDPOINT;

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

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

  196.     String retVal = "";
  197.     MediaType contentType = null;
  198.     HttpStatus statusCode = null;

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

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

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

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

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

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

  224.     String url =
  225.         "https://api.ucsb.edu/academics/curriculums/v3/classsection/" + quarter + "/" + enrollCd;

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

  229.     String retVal = "";
  230.     MediaType contentType = null;
  231.     HttpStatus statusCode = null;

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

  238.     log.info("json: {} contentType: {} statusCode: {}", retVal, contentType, statusCode);
  239.     return retVal;
  240.   }
  241. }
Created with JaCoCo 0.8.10.202304240956