Clever Java Library

Client library for the Clever API

Installation

Manually install the Clever JAR: https://github.com/Clever/clever-java/releases

Manually install these additional JARs:

• gson-2.6.2.jar
• gson-fire-1.8.0.jar
• hamcrest-core-1.3.jar
• joda-time-2.9.3.jar
• junit-4.12.jar
• logging-interceptor-2.7.5.jar
• okhttp-2.7.5.jar
• okio-1.6.0.jar
• swagger-annotations-1.5.9.jar

Usage

import io.swagger.client.ApiClient;
import io.swagger.client.ApiException;
import io.swagger.client.Configuration;
import io.swagger.client.api.DefaultApi;
import io.swagger.client.auth.OAuth;

public class CleverAPI {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("TODO: SET ME!");

        api = new DefaultApi();
        StudentsResponse students = api.getStudents(10, null, null);
        for (StudentResponse student : students.getData()) {
            System.out.println("Student IDs: ", student.getData().getId());
        }
    }
}

Events Usage

Since events are polymorphic, we use the type to determine how to cast them. For example:

public void processEvents(DefaultApi api) {
    EventsResponse eventsResponse = api.getEvents(10, null, null);

    for (EventResponse eventResp : eventsResponse.getData()) {
        if (eventResp.getData().getType() == "students.created") {
            StudentsCreated event = (StudentsCreated)eventResp.getData();
            // Process the event...
        }
    }
}

Generating the JAR

1. Git clone swagger-codegen (https://github.com/swagger-api/swagger-codegen)

2. Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)

3. Install Java and Maven

4. In the root directory of the swagger repo run:

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v1.2-client.yml -l java -o $PATH_TO_THIS_REPO

5. Package the JAR

mvn package

That will put the jar in: src/target/swagger-java-client-1.0.0-tests.jar

Publishing

To publish this library first set up your settings.xml (~/.m2/settings.xml) as described here: http://central.sonatype.org/pages/apache-maven.html. In particular setting up the ossrh profile using the clever-eng username / password and setting up the GPG profile with the security@clever.com PGP key.

Then run:

make publish

This will deploy to: https://oss.sonatype.org/content/groups/public/com/clever/client/

The jar will be synced over to the Maven central repository within the next few hours.

If you get an Inappropriate ioctl for device error try the commands here: https://github.com/pstadler/keybase-gpg-github/pull/13/files