go-oneroster

README

GoOneRoster

This project aims to implement a OneRoster compliant RESTful API webserver in GO with a MongoDB backing for persistance

A detailed overview of the OneRoster specification can be found on the OneRoster site , including:

• filtering
• data structures
• endpoints
• JSON bindings

This API server attempts to extend the oneroster spec by allowing updating/insert/upserting/PUT content to all endpoints rather than just providing a read/GET interface for data.

Companion projects

Assisting this project is a collection of open tools for syncing to and from various 3rd party SIS/MIS/systems

To:

• Microsoft Teams
• Apple School Manager

From:

• WCBS PASS

With more to come. Further community support is welcome and encouraged.

Download

Pre-build binaries for windows and linux x64 are available in the releases section as well as a pre-built docker image is available:

docker pull docker.pkg.github.com/fffnite/go-oneroster/goors:0.3.0

Setup

Start up the api server with either envs or flags

flags

goors \
    -k "mySecretKey" \
    -a "HS256" \
    -m "mongodb://myinstance.domain.com:27017" \
    -p "443"

envs

GOORS_AUTH_KEY='mySecretKey'
GOORS_AUTH_KEY_ALG='HS256'
GOORS_MONGO_URI='mongodb://myinstance.domain.com:27017'
GOORS_PORT='443'

Upload Data

Import data using the sis sync tool or by making POST requests.

Query examples

# login
curl "myserver.domain.com/ims/oneroster/v1p1/login" \
    -X POST \
    -d "clientid=$ci&clientsecret=$cs"

# Upsert user id 1
curl "myserver.domain.com/ims/oneroster/v1p1/users/1" \
    -X PUT \
    -H "Authorization: Bearer $t"
    -d '{"sourcedId": "1", "status": "active", "givenName": "bob"}'

# Get all users
curl "myserver.domain.com/ims/oneroster/v1p1/users" \
    -H "Authorization: Bearer $t"

# login
$args = @{
    uri = "http://myserver.domain.com/ims/oneroster/v1p1/login"
    method = "POST"
    body = @{ "clientid" = $ci; "clientsecret" = $cs }
}
$token = Invoke-RestMethod @args

# Upsert user id 1
$upsert = @{
    uri = "http://myserver.domain.com/ims/oneroster/v1p1/users/1
    method = "PUT"
    headers = @{ "authorization" = "bearer $t"}
    body = "{""sourcedId"": ""1"", ""status"": ""active"", ""givenName"": ""bob""}"
}
Invoke-RestMethod @upsert

$getUsers = @{
    uri = "http://myserver.domain.com/ims/oneroster/v1p1/users"
    heades = @{ "authorization" = "bearer $t" }
    FollowRelLink = $true
}
Invoke-RestMethod @getUsers

Endpoints

Listed are all the currently supported endpoints. Details of the fields supported/output by these endpoints can be found on the OneRoster API docs

GET /orgs
GET /orgs/{id}
PUT /orgs/{id}

GET /academicSessions
GET /academicSessions/{id}
PUT /academicSessions/{id}

GET /courses
GET /courses/{id}
PUT /courses/{id}

GET /classes
GET /classes/{id}
PUT /classes

GET /enrollments
GET /enrollments/{id}
PUT /enrollments/{id}

GET /users
GET /users/{id}
PUT /users/{id}
PUT /users/{id}/userIds/{subId}

To Do

• Connect to SQL database
• Read from Conf.hcl
• Build DB handler
• Connect packages
• Output from DB
• Output JSON
• Output correct json from single endpoint sample
• Implement RESTful parameters & operators
• Implement logging
• Implement error handling
• Implement security
• Build core endpoints
• Sync DB
• Build extra endpoints
• Test test test