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
//! `POST /_matrix/client/*/rooms/{roomId}/invite`
//!
//! Invite a user to a room.
pub mod v3 {
//! `/v3/` ([spec (MXID)][spec-mxid], [spec (3PID)][spec-3pid])
//!
//! This endpoint has two forms: one to invite a user
//! [by their Matrix identifier][spec-mxid], and one to invite a user
//! [by their third party identifier][spec-3pid].
//!
//! [spec-mxid]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidinvite
//! [spec-3pid]: https://spec.matrix.org/latest/client-server-api/#thirdparty_post_matrixclientv3roomsroomidinvite
use ruma_common::{
OwnedRoomId, OwnedUserId,
api::{auth_scheme::AccessToken, request, response},
metadata,
};
use serde::{Deserialize, Serialize};
use crate::membership::Invite3pid;
metadata! {
method: POST,
rate_limited: true,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/{room_id}/invite",
1.1 => "/_matrix/client/v3/rooms/{room_id}/invite",
}
}
/// Request type for the `invite_user` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The room where the user should be invited.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The user to invite.
#[serde(flatten)]
pub recipient: InvitationRecipient,
/// Optional reason for inviting the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub reason: Option<String>,
}
/// Response type for the `invite_user` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given room ID and invitation recipient.
pub fn new(room_id: OwnedRoomId, recipient: InvitationRecipient) -> Self {
Self { room_id, recipient, reason: None }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
/// Distinguishes between invititations by Matrix or third party identifiers.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
#[serde(untagged)]
pub enum InvitationRecipient {
/// Used to invite user by their Matrix identifier.
UserId {
/// Matrix identifier of user.
user_id: OwnedUserId,
},
/// Used to invite user by a third party identifier.
ThirdPartyId(Invite3pid),
}
#[cfg(test)]
mod tests {
use assert_matches2::assert_matches;
use ruma_common::thirdparty::Medium;
use serde_json::{from_value as from_json_value, json};
use super::InvitationRecipient;
#[test]
fn deserialize_invite_by_user_id() {
let incoming =
from_json_value::<InvitationRecipient>(json!({ "user_id": "@carl:example.org" }))
.unwrap();
assert_matches!(incoming, InvitationRecipient::UserId { user_id });
assert_eq!(user_id, "@carl:example.org");
}
#[test]
fn deserialize_invite_by_3pid() {
let incoming = from_json_value::<InvitationRecipient>(json!({
"id_server": "example.org",
"id_access_token": "abcdefghijklmnop",
"medium": "email",
"address": "carl@example.org"
}))
.unwrap();
assert_matches!(incoming, InvitationRecipient::ThirdPartyId(third_party_id));
assert_eq!(third_party_id.id_server, "example.org");
assert_eq!(third_party_id.id_access_token, "abcdefghijklmnop");
assert_eq!(third_party_id.medium, Medium::Email);
assert_eq!(third_party_id.address, "carl@example.org");
}
}
}