peertube 0.2.0

Peertube API client
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

pub struct Captions {
    config: crate::Config,
}

impl Captions {
    pub(crate) fn new(config: &crate::Config) -> Self {
        Self {
            config: config.clone(),
        }
    }

    /**
     * List captions of a video.
     */
    pub async fn all(&self, video_id: &str) -> crate::Result<crate::Pager<crate::data::Caption>> {
        crate::Api::get(&self.config, format!("/videos/{video_id}/captions").into()).await
    }

    /**
     * Add or replace a video caption.
     */
    pub async fn add(
        &self,
        auth: &crate::data::Token,
        video_id: &str,
        language: &str,
        captionfile: &str,
    ) -> crate::Result<()> {
        let request = crate::Request {
            path: format!("/videos/{video_id}/captions/{language}"),
            params: crate::Params::upload((), "captionfile", captionfile)?,
            auth: Some(auth.clone()),
        };

        crate::Api::put(&self.config, request).await
    }

    /**
     * Delete a video caption.
     */
    pub async fn delete(
        &self,
        auth: &crate::data::Token,
        video_id: &str,
        language: &str,
    ) -> crate::Result<()> {
        let request = crate::Request {
            path: format!("/videos/{video_id}/captions/{language}"),
            params: crate::Params::none(),
            auth: Some(auth.clone()),
        };

        crate::Api::delete(&self.config, request).await
    }
}

#[cfg(test)]
mod test {
    #[tokio::test]
    async fn all() {
        let (api, _) = crate::test::api().await;

        let captions = api
            .videos
            .captions
            .all("1cb3e9c4-2da6-4af3-804e-d4675c18e128")
            .await;

        assert!(captions.is_ok());
    }

    #[tokio::test]
    async fn add() {
        let (api, token) = crate::test::api().await;

        let status = api
            .videos
            .captions
            .add(
                &token,
                "1cb3e9c4-2da6-4af3-804e-d4675c18e128",
                "fr",
                "fixtures/caption.srt",
            )
            .await;

        assert!(status.is_ok());
    }

    #[tokio::test]
    async fn delete() {
        let (api, token) = crate::test::api().await;

        let status = api
            .videos
            .captions
            .delete(&token, "1cb3e9c4-2da6-4af3-804e-d4675c18e128", "fr")
            .await;

        assert!(status.is_ok());
    }
}