logo
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

//! `GET /_matrix/client/*/user/{userId}/rooms/{roomId}/tags`

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

    use ruma_common::{api::ruma_api, events::tag::Tags, RoomId, UserId};

    ruma_api! {
        metadata: {
            description: "Get the tags associated with a room.",
            method: GET,
            name: "get_tags",
            r0_path: "/_matrix/client/r0/user/:user_id/rooms/:room_id/tags",
            stable_path: "/_matrix/client/v3/user/:user_id/rooms/:room_id/tags",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The user whose tags will be retrieved.
            #[ruma_api(path)]
            pub user_id: &'a UserId,

            /// The room from which tags will be retrieved.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,
        }

        response: {
            /// The user's tags for the room.
            pub tags: Tags,
        }

        error: crate::Error
    }

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

    impl Response {
        /// Creates a new `Response` with the given tags.
        pub fn new(tags: Tags) -> Self {
            Self { tags }
        }
    }

    #[cfg(all(test, feature = "server"))]
    mod server_tests {
        use assign::assign;
        use ruma_common::{
            api::OutgoingResponse,
            events::tag::{TagInfo, Tags},
        };
        use serde_json::json;

        use super::Response;

        #[test]
        fn serializing_get_tags_response() {
            let mut tags = Tags::new();
            tags.insert("m.favourite".into(), assign!(TagInfo::new(), { order: Some(0.25) }));
            tags.insert("u.user_tag".into(), assign!(TagInfo::new(), { order: Some(0.11) }));
            let response = Response { tags };

            let http_response = response.try_into_http_response::<Vec<u8>>().unwrap();

            let json_response: serde_json::Value =
                serde_json::from_slice(http_response.body()).unwrap();
            assert_eq!(
                json_response,
                json!({
                    "tags": {
                        "m.favourite": {
                            "order": 0.25,
                        },
                        "u.user_tag": {
                            "order": 0.11,
                        }
                    }
                })
            );
        }
    }
}