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

use crate::{error::Result, http::Requester, params::wrap_params};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::sync::Arc;

/// A Canvas external (LTI) tool.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ExternalTool {
    pub id: u64,
    pub name: Option<String>,
    pub description: Option<String>,
    pub url: Option<String>,
    pub domain: Option<String>,
    pub consumer_key: Option<String>,
    pub course_id: Option<u64>,
    pub account_id: Option<u64>,
    pub workflow_state: Option<String>,
    pub privacy_level: Option<String>,
    pub custom_fields: Option<Value>,
    pub course_navigation: Option<Value>,
    pub account_navigation: Option<Value>,
    pub user_navigation: Option<Value>,
    pub editor_button: Option<Value>,
    pub resource_selection: Option<Value>,
    pub homework_submission: Option<Value>,
    pub selection_width: Option<u64>,
    pub selection_height: Option<u64>,
    pub icon_url: Option<String>,
    pub is_rce_favorite: Option<bool>,
    pub is_top_nav_favorite: Option<bool>,

    #[serde(skip)]
    pub(crate) requester: Option<Arc<Requester>>,
}

/// Parameters for creating or updating an external tool.
#[derive(Debug, Default, Clone, Serialize)]
pub struct ExternalToolParams {
    pub name: Option<String>,
    pub privacy_level: Option<String>,
    pub consumer_key: Option<String>,
    pub shared_secret: Option<String>,
    pub description: Option<String>,
    pub url: Option<String>,
    pub domain: Option<String>,
    pub icon_url: Option<String>,
    pub text: Option<String>,
    pub is_rce_favorite: Option<bool>,
}

impl ExternalTool {
    fn req(&self) -> &Arc<Requester> {
        self.requester.as_ref().expect("requester not initialized")
    }

    fn parent_type(&self) -> &'static str {
        if self.course_id.is_some() {
            "course"
        } else {
            "account"
        }
    }

    fn parent_id(&self) -> u64 {
        self.course_id
            .or(self.account_id)
            .expect("ExternalTool missing course_id and account_id")
    }

    /// Update this external tool.
    ///
    /// # Canvas API
    /// `PUT /api/v1/courses/:course_id/external_tools/:id`
    /// `PUT /api/v1/accounts/:account_id/external_tools/:id`
    pub async fn edit(&self, params: ExternalToolParams) -> Result<ExternalTool> {
        let form = wrap_params("external_tool", &params);
        let mut tool: ExternalTool = self
            .req()
            .put(
                &format!(
                    "{}s/{}/external_tools/{}",
                    self.parent_type(),
                    self.parent_id(),
                    self.id
                ),
                &form,
            )
            .await?;
        tool.requester = self.requester.clone();
        Ok(tool)
    }

    /// Delete this external tool.
    ///
    /// # Canvas API
    /// `DELETE /api/v1/courses/:course_id/external_tools/:id`
    /// `DELETE /api/v1/accounts/:account_id/external_tools/:id`
    pub async fn delete(&self) -> Result<ExternalTool> {
        let mut tool: ExternalTool = self
            .req()
            .delete(
                &format!(
                    "{}s/{}/external_tools/{}",
                    self.parent_type(),
                    self.parent_id(),
                    self.id
                ),
                &[],
            )
            .await?;
        tool.requester = self.requester.clone();
        Ok(tool)
    }
}