canvas-lms-api 0.6.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

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

fn tab_json(id: &str, position: u64) -> serde_json::Value {
    serde_json::json!({
        "id": id,
        "label": "Assignments",
        "type": "internal",
        "hidden": false,
        "position": position,
        "visibility": "public"
    })
}

#[tokio::test]
async fn test_course_tab_update() {
    let server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/api/v1/courses/1"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 1})))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/api/v1/courses/1/tabs"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([
            tab_json("home", 1),
            tab_json("assignments", 2),
        ])))
        .mount(&server)
        .await;
    Mock::given(method("PUT"))
        .and(path("/api/v1/courses/1/tabs/assignments"))
        .respond_with(ResponseTemplate::new(200).set_body_json(tab_json("assignments", 3)))
        .mount(&server)
        .await;

    let canvas = Canvas::new(&server.uri(), "test-token").unwrap();
    let course = canvas.get_course(1).await.unwrap();

    let tabs: Vec<_> = course.get_tabs().collect_all().await.unwrap();
    assert_eq!(tabs.len(), 2);
    assert_eq!(tabs[1].course_id, Some(1));

    let updated = tabs[1]
        .update(UpdateTabParams {
            position: Some(3),
            ..Default::default()
        })
        .await
        .unwrap();
    assert_eq!(updated.position, Some(3));
    assert_eq!(updated.id.as_deref(), Some("assignments"));
}

#[tokio::test]
async fn test_group_tab_update_fails() {
    // A Tab without course_id (e.g. from a group) cannot be updated — returns error.
    let server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/api/v1/courses/1"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 1})))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/api/v1/courses/1/tabs"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(serde_json::json!([tab_json("home", 1)])),
        )
        .mount(&server)
        .await;

    let canvas = Canvas::new(&server.uri(), "test-token").unwrap();
    let course = canvas.get_course(1).await.unwrap();
    let mut tabs: Vec<_> = course.get_tabs().collect_all().await.unwrap();

    // Clear course_id to simulate a group tab
    tabs[0].course_id = None;
    let result = tabs[0]
        .update(UpdateTabParams {
            position: Some(1),
            ..Default::default()
        })
        .await;

    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        canvas_lms_api::CanvasError::BadRequest { .. }
    ));
}