edu.ksu.canvas.impl.CourseImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation
A native Java library to talk to the Canvas REST API
The newest version!
package edu.ksu.canvas.impl;

import com.google.gson.reflect.TypeToken;
import edu.ksu.canvas.interfaces.CourseReader;
import edu.ksu.canvas.interfaces.CourseWriter;
import edu.ksu.canvas.model.Course;
import edu.ksu.canvas.model.Deposit;
import edu.ksu.canvas.model.Progress;
import edu.ksu.canvas.model.status.Conclude;
import edu.ksu.canvas.model.status.Delete;
import edu.ksu.canvas.net.Response;
import edu.ksu.canvas.net.RestClient;
import edu.ksu.canvas.oauth.OauthToken;
import edu.ksu.canvas.requestOptions.*;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;


public class CourseImpl extends BaseImpl implements CourseReader, CourseWriter {
    private static final Logger LOG = LoggerFactory.getLogger(CourseImpl.class);

    public CourseImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient,
                      int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls) {
        super(canvasBaseUrl, apiVersion, oauthToken, restClient, connectTimeout, readTimeout,
                paginationPageSize, serializeNulls);
    }

    @Override
    public List listCurrentUserCourses(ListCurrentUserCoursesOptions options) throws IOException {
        LOG.debug("listing courses for user");
        String url = buildCanvasUrl("courses/", options.getOptionsMap());
        return getListFromCanvas(url);
    }

    public List listUserCourses(ListUserCoursesOptions options) throws  IOException {
        LOG.debug("listing course for user {}", options.getUserId());
        String url = buildCanvasUrl("users/" + options.getUserId() + "/courses", options.getOptionsMap());
        return getListFromCanvas(url);
    }

    @Override
    public Optional getSingleCourse(GetSingleCourseOptions options) throws IOException {
        LOG.debug("getting course {}", options.getCourseId());
        String path = "";
        String accountId = options.getAccount();
        if (accountId != null) {
            path += "accounts/"+accountId+ "/courses/";
        } else {
            path = "courses/";
        }
        String url = buildCanvasUrl(path + options.getCourseId(), options.getOptionsMap());

        return retrieveCourseFromCanvas(oauthToken, url);
    }

    @Override
    public Optional getSingleCourse(String accountId, GetSingleCourseOptions options) throws IOException {
        LOG.debug("getting course {} in account {}", options.getCourseId(), accountId);
        String url = buildCanvasUrl("accounts/"+ accountId+ "/courses/"+ options.getCourseId(), options.getOptionsMap());
        return retrieveCourseFromCanvas(oauthToken, url);
    }

    private Optional retrieveCourseFromCanvas(OauthToken oauthToken, String url) throws IOException {
        Response response = canvasMessenger.getSingleResponseFromCanvas(oauthToken, url);
        if (response.getErrorHappened() || response.getResponseCode() != 200) {
            return Optional.empty();
        }
        return responseParser.parseToObject(Course.class, response);
    }

    @Override
    public Optional createCourse(String accountId, Course course) throws IOException {
        LOG.debug("creating course in account {}", accountId);
        String url = buildCanvasUrl("accounts/" + accountId + "/courses", Collections.emptyMap());
        Response response = canvasMessenger.sendJsonPostToCanvas(oauthToken, url, course.toJsonObject(serializeNulls));
        return responseParser.parseToObject(Course.class, response);
    }

    @Override
    public Optional updateCourse(Course course) throws IOException {
        LOG.debug("updating course{}", course.getId());
        String url = buildCanvasUrl("courses/" + course.getId(), Collections.emptyMap());
        Response response = canvasMessenger.sendJsonPutToCanvas(oauthToken, url, course.toJsonObject(serializeNulls));
        return responseParser.parseToObject(Course.class, response);
    }

    @Override
    public Optional updateCourse(String id, Course course) throws IOException {
        LOG.debug("updating course {}", id);
        // TODO At some point we need to sort this out better throughout the library
        String url = buildCanvasUrl("courses/" + encode(id), Collections.emptyMap());
        Response response = canvasMessenger.sendJsonPutToCanvas(oauthToken, url, course.toJsonObject(serializeNulls));
        return responseParser.parseToObject(Course.class, response);
    }

    @Override
    public Boolean deleteCourse(String courseId) throws IOException {
        LOG.debug("Deleting course {}", courseId);
        Map> postParams = new HashMap<>();
        postParams.put("event", Collections.singletonList("delete"));
        String createdUrl = buildCanvasUrl("courses/" + courseId, Collections.emptyMap());
        Response response = canvasMessenger.deleteFromCanvas(oauthToken, createdUrl, postParams);
        if (response.getErrorHappened() || response.getResponseCode() != 200) {
            LOG.debug("Failed to delete course, error message: " + response.toString());
            return false;
        }
        Optional responseParsed = responseParser.parseToObject(Delete.class, response);

        return responseParsed.map(r -> r.getDelete()).orElse(false);
    }

    @Override
    public Boolean deleteCourse(DeleteCourseOptions options) throws IOException {
        LOG.debug("Deleting course {}", options.getCourseId());
        String path = "";
        String accountId = options.getAccountId();
        if (accountId != null) {
            path += "accounts/"+accountId+ "/courses/";
        } else {
            path = "courses/";
        }
        String url = buildCanvasUrl(path + options.getCourseId(), Collections.emptyMap());
        Response response = canvasMessenger.deleteFromCanvas(oauthToken, url, options.getOptionsMap());
        if (response.getErrorHappened() || response.getResponseCode() != 200) {
            LOG.debug("Failed to delete course, error message: {}", response);
            return false;
        }

        // The response from Canvas depends on the value of the event parameter.
        if (options.getEventType() == DeleteCourseOptions.EventType.DELETE) {
            Optional responseParsed = responseParser.parseToObject(Delete.class, response);
            return responseParsed.map(Delete::getDelete).orElse(false);
        } else if (options.getEventType() == DeleteCourseOptions.EventType.CONCLUDE) {
            Optional responseParsed = responseParser.parseToObject(Conclude.class, response);
            return responseParsed.map(Conclude::getConclude).orElse(false);
        } else {
            throw new IllegalArgumentException("Unknown Canvas response: " + response.getContent());
        }
    }

    @Override
    public List listActiveCoursesInAccount(ListActiveCoursesInAccountOptions options) throws IOException {
        String url = buildCanvasUrl("accounts/" + options.getAccountId() + "/courses", options.getOptionsMap());
        return getListFromCanvas(url);
    }

    @Override
    public Optional uploadFile(String courseId, UploadOptions uploadOptions) throws IOException {
        String url = buildCanvasUrl("courses/"+ courseId+ "/files", Collections.emptyMap());
        Response response = canvasMessenger.sendToCanvas(oauthToken, url, uploadOptions.getOptionsMap());
        return responseParser.parseToObject(Deposit.class, response);
    }

    @Override
    public Optional batchUpdateCourseState(String accountId, Course.CourseEvent event, String... courseIds) throws IOException {
        if(StringUtils.isBlank(accountId) || event == null || courseIds == null || courseIds.length == 0) {
            throw new IllegalArgumentException("Must supply account, event, and list of courses");
        }
        if(Course.CourseEvent.claim == event) {
            throw new IllegalArgumentException("This method can not be used to claim courses");
        }
        LOG.debug("Updating course workflow state for {} course(s)", courseIds.length);

        Map> requestParams = new HashMap<>();
        requestParams.put("event", Collections.singletonList(event.toString()));
        requestParams.put("course_ids[]", Arrays.asList(courseIds));

        String url = buildCanvasUrl("accounts/" + accountId + "/courses", Collections.emptyMap());
        Response response = canvasMessenger.putToCanvas(oauthToken, url, requestParams);

        return responseParser.parseToObject(Progress.class, response);
    }

    @Override
    protected Type listType() {
        return new TypeToken>(){}.getType();
    }

    @Override
    protected Class objectType() {
        return Course.class;
    }

}