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
137
138
139
140
141
142
143
144

use crate::model::{id::Id, messaging::MessagingMessage, user::User, user_group::UserGroup};

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

pub mod create;
pub mod delete;
pub mod read;

#[derive(Serialize, Debug, Clone, TypedBuilder)]
#[serde(rename_all = "camelCase")]
#[builder(doc)]
pub struct Request {
    #[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 user_id: Option<Id<User>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub group_id: Option<Id<UserGroup>>,
    /// 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<MessagingMessage>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub until_id: Option<Id<MessagingMessage>>,
}

impl misskey_core::Request for Request {
    type Response = Vec<MessagingMessage>;
    const ENDPOINT: &'static str = "messaging/messages";
}

impl_pagination!(Request, MessagingMessage);

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

    #[tokio::test]
    async fn request_with_user() {
        let client = TestClient::new();
        let admin = client.admin.me().await;
        client
            .user
            .test(Request {
                mark_as_read: None,
                user_id: Some(admin.id),
                group_id: None,
                limit: None,
                since_id: None,
                until_id: None,
            })
            .await;
    }

    #[tokio::test]
    async fn request_with_group() {
        let client = TestClient::new();
        let group = client
            .test(crate::endpoint::users::groups::create::Request {
                name: "test".to_string(),
            })
            .await;
        client
            .test(Request {
                mark_as_read: None,
                user_id: None,
                group_id: Some(group.id),
                limit: None,
                since_id: None,
                until_id: None,
            })
            .await;
    }

    #[tokio::test]
    async fn request_with_option() {
        let client = TestClient::new();
        let admin = client.admin.me().await;
        client
            .user
            .test(Request {
                mark_as_read: Some(false),
                user_id: Some(admin.id),
                group_id: None,
                limit: None,
                since_id: None,
                until_id: None,
            })
            .await;
    }

    #[tokio::test]
    async fn request_with_limit() {
        let client = TestClient::new();
        let admin = client.admin.me().await;
        client
            .test(Request {
                mark_as_read: None,
                user_id: Some(admin.id),
                group_id: None,
                limit: Some(100),
                since_id: None,
                until_id: None,
            })
            .await;
    }

    #[tokio::test]
    async fn request_paginate() {
        let client = TestClient::new();
        let admin = client.admin.me().await;
        let user = client.user.me().await;
        let message = client
            .admin
            .test(crate::endpoint::messaging::messages::create::Request {
                text: Some("hi".to_string()),
                user_id: Some(user.id),
                group_id: None,
                file_id: None,
            })
            .await;

        client
            .user
            .test(Request {
                mark_as_read: None,
                user_id: Some(admin.id),
                group_id: None,
                limit: None,
                since_id: Some(message.id.clone()),
                until_id: Some(message.id.clone()),
            })
            .await;
    }
}