misskey-api 0.2.0

API bindings of Misskey, including requests/responses of endpoints and messages on channels
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

use std::collections::HashSet;

use crate::model::{
    id::Id,
    notification::{Notification, NotificationType},
};

use serde::Serialize;
use typed_builder::TypedBuilder;

#[derive(Serialize, Default, Debug, Clone, TypedBuilder)]
#[serde(rename_all = "camelCase")]
#[builder(doc)]
pub struct Request {
    /// 1 .. 100
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub limit: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub since_id: Option<Id<Notification>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub until_id: Option<Id<Notification>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub following: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub mark_as_read: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub include_types: Option<HashSet<NotificationType>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub exclude_types: Option<HashSet<NotificationType>>,
}

impl misskey_core::Request for Request {
    type Response = Vec<Notification>;
    const ENDPOINT: &'static str = "i/notifications";
}

impl_pagination!(Request, Notification);

#[cfg(test)]
mod tests {
    use super::Request;
    use crate::test::{ClientExt, TestClient};

    #[tokio::test]
    async fn request() {
        let client = TestClient::new();
        client.test(Request::default()).await;
    }

    #[tokio::test]
    async fn request_with_limit() {
        let client = TestClient::new();
        client
            .test(Request {
                limit: Some(100),
                since_id: None,
                until_id: None,
                following: None,
                mark_as_read: None,
                include_types: None,
                exclude_types: None,
            })
            .await;
    }

    #[tokio::test]
    async fn request_with_options() {
        use crate::model::notification::NotificationType;

        let client = TestClient::new();
        client
            .test(Request {
                limit: None,
                since_id: None,
                until_id: None,
                following: Some(true),
                mark_as_read: Some(false),
                include_types: Some(
                    vec![NotificationType::Follow, NotificationType::Reply]
                        .into_iter()
                        .collect(),
                ),
                exclude_types: Some(vec![NotificationType::Mention].into_iter().collect()),
            })
            .await;
    }

    #[tokio::test]
    #[cfg(feature = "12-27-0")]
    async fn request_paginate() {
        let client = TestClient::new();
        client
            .test(crate::endpoint::notifications::create::Request {
                body: "hi".to_string(),
                header: None,
                icon: None,
            })
            .await;

        let mut notification = None;
        while notification.is_none() {
            notification = client
                .test(Request {
                    limit: None,
                    since_id: None,
                    until_id: None,
                    following: None,
                    mark_as_read: None,
                    include_types: None,
                    exclude_types: None,
                })
                .await
                .pop();
        }
        let notification_id = notification.unwrap().id;

        client
            .test(Request {
                limit: None,
                since_id: Some(notification_id.clone()),
                until_id: Some(notification_id.clone()),
                following: None,
                mark_as_read: None,
                include_types: None,
                exclude_types: None,
            })
            .await;
    }
}