ruma-client-api 0.14.1

Types for the endpoints in the Matrix client-server 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

//! `POST /_matrix/client/*/user/{userId}/filter`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3useruseridfilter

    use ruma_common::{api::ruma_api, UserId};

    use crate::filter::{FilterDefinition, IncomingFilterDefinition};

    ruma_api! {
        metadata: {
            description: "Create a new filter for event retrieval.",
            method: POST,
            name: "create_filter",
            r0_path: "/_matrix/client/r0/user/:user_id/filter",
            stable_path: "/_matrix/client/v3/user/:user_id/filter",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The ID of the user uploading the filter.
            ///
            /// The access token must be authorized to make requests for this user ID.
            #[ruma_api(path)]
            pub user_id: &'a UserId,

            /// The filter definition.
            #[ruma_api(body)]
            pub filter: FilterDefinition<'a>,
        }

        response: {
            /// The ID of the filter that was created.
            pub filter_id: String,
        }

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given user ID and filter definition.
        pub fn new(user_id: &'a UserId, filter: FilterDefinition<'a>) -> Self {
            Self { user_id, filter }
        }
    }

    impl Response {
        /// Creates a new `Response` with the given filter ID.
        pub fn new(filter_id: String) -> Self {
            Self { filter_id }
        }
    }

    #[cfg(all(test, any(feature = "client", feature = "server")))]
    mod tests {
        use matches::assert_matches;

        #[cfg(feature = "server")]
        #[test]
        fn deserialize_request() {
            use ruma_common::api::IncomingRequest as _;

            use super::IncomingRequest;

            assert_matches!(
                IncomingRequest::try_from_http_request(
                    http::Request::builder()
                        .method(http::Method::POST)
                        .uri("https://matrix.org/_matrix/client/r0/user/@foo:bar.com/filter")
                        .body(b"{}" as &[u8])
                        .unwrap(),
                    &["@foo:bar.com"]
                ),
                Ok(IncomingRequest { user_id, filter })
                if user_id == "@foo:bar.com" && filter.is_empty()
            );
        }

        #[cfg(feature = "client")]
        #[test]
        fn serialize_request() {
            use ruma_common::{
                api::{MatrixVersion, OutgoingRequest, SendAccessToken},
                user_id,
            };

            use crate::filter::FilterDefinition;

            assert_matches!(
                super::Request::new(user_id!("@foo:bar.com"), FilterDefinition::default())
                    .try_into_http_request::<Vec<u8>>(
                        "https://matrix.org",
                        SendAccessToken::IfRequired("tok"),
                        &[MatrixVersion::V1_1]
                    ),
                Ok(res) if res.body() == b"{}"
            );
        }
    }
}