canvas-lms-api 0.7.0

Rust client for the Instructure Canvas LMS REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use canvas_lms_api::resources::role::RoleParams;
use canvas_lms_api::Canvas;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

fn role_json(id: u64, label: &str) -> serde_json::Value {
    serde_json::json!({
        "id": id,
        "label": label,
        "role": label,
        "base_role_type": "StudentEnrollment",
        "workflow_state": "active"
    })
}

async fn make_account(server: &MockServer) -> canvas_lms_api::resources::account::Account {
    Mock::given(method("GET"))
        .and(path("/api/v1/accounts/1"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 1})))
        .mount(server)
        .await;
    Canvas::new(&server.uri(), "token")
        .unwrap()
        .get_account(1)
        .await
        .unwrap()
}

#[tokio::test]
async fn test_get_role() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/v1/accounts/1/roles/3"))
        .respond_with(ResponseTemplate::new(200).set_body_json(role_json(3, "CustomStudent")))
        .mount(&server)
        .await;

    let account = make_account(&server).await;
    let r = account.get_role(3).await.unwrap();
    assert_eq!(r.label.as_deref(), Some("CustomStudent"));
}

#[tokio::test]
async fn test_get_roles() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/v1/accounts/1/roles"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([
            role_json(1, "StudentEnrollment"),
            role_json(2, "TeacherEnrollment")
        ])))
        .mount(&server)
        .await;

    let account = make_account(&server).await;
    let roles = account.get_roles().collect_all().await.unwrap();
    assert_eq!(roles.len(), 2);
}

#[tokio::test]
async fn test_create_role() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/v1/accounts/1"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 1})))
        .mount(&server)
        .await;
    Mock::given(method("POST"))
        .and(path("/api/v1/accounts/1/roles"))
        .respond_with(ResponseTemplate::new(200).set_body_json(role_json(10, "SuperStudent")))
        .mount(&server)
        .await;

    let canvas = Canvas::new(&server.uri(), "token").unwrap();
    let account = canvas.get_account(1).await.unwrap();
    let r = account
        .create_role(
            "SuperStudent",
            RoleParams {
                base_role_type: Some("StudentEnrollment".into()),
                ..Default::default()
            },
        )
        .await
        .unwrap();
    assert_eq!(r.label.as_deref(), Some("SuperStudent"));
}

#[tokio::test]
async fn test_deactivate_role() {
    let server = MockServer::start().await;
    Mock::given(method("DELETE"))
        .and(path("/api/v1/accounts/1/roles/3"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "id": 3, "label": "CustomStudent", "workflow_state": "inactive"
        })))
        .mount(&server)
        .await;

    let account = make_account(&server).await;
    let r = account.deactivate_role(3).await.unwrap();
    assert_eq!(r.workflow_state.as_deref(), Some("inactive"));
}

#[tokio::test]
async fn test_activate_role() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/api/v1/accounts/1/roles/3/activate"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "id": 3, "label": "CustomStudent", "workflow_state": "active"
        })))
        .mount(&server)
        .await;

    let account = make_account(&server).await;
    let r = account.activate_role(3).await.unwrap();
    assert_eq!(r.workflow_state.as_deref(), Some("active"));
}

#[tokio::test]
async fn test_update_role() {
    let server = MockServer::start().await;
    Mock::given(method("PUT"))
        .and(path("/api/v1/accounts/1/roles/3"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "id": 3, "label": "CustomStudent", "workflow_state": "active"
        })))
        .mount(&server)
        .await;

    let account = make_account(&server).await;
    let r = account
        .update_role(3, canvas_lms_api::resources::role::RoleParams::default())
        .await
        .unwrap();
    assert_eq!(r.label.as_deref(), Some("CustomStudent"));
}