canvasapi 0.5.0

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

//! Canvas structs that are not part of the API, but are needed for the library.

use crate::models::prelude::*;
use crate::requests::*;

/// Contains information about the server URL and the API access token.
///
/// # Example
/// ```
/// # use canvasapi::canvas::CanvasInformation;
/// let canvas = CanvasInformation::new("https://canvas.test.be", "MY_TOKEN");
/// ```
#[derive(Debug)]
pub struct CanvasInformation<'i> {
    base_url: &'i str,
    token: &'i str,
}

impl<'i> CanvasInformation<'i> {
    /// Create a new instance of the Canvas API.
    pub fn new(base_url: &'i str, token: &'i str) -> Self {
        Self { base_url, token }
    }

    pub(crate) fn add_url_prefix(&self, url: &str) -> String {
        format!("{}/api/v1/{}", self.base_url, url)
    }

    /// Create a client for a get request.
    /// This adds the url and the token.
    #[cfg(not(feature = "blocking"))]
    pub(crate) fn get_request(&self, url: String) -> reqwest::RequestBuilder {
        reqwest::Client::new().get(&url).bearer_auth(self.token)
    }

    #[cfg(feature = "blocking")]
    pub(crate) fn get_request(&self, url: String) -> reqwest::blocking::RequestBuilder {
        reqwest::blocking::Client::new()
            .get(&url)
            .bearer_auth(self.token)
    }

    pub(crate) fn get_token(&self) -> &str {
        self.token
    }
}