async_client: add tests for enpoints, fix docs
This commit is contained in:
Devin R
parent
5ce62c9b6c
commit
522a8435d0
1 changed files with 301 additions and 30 deletions
|
|
@ -345,6 +345,7 @@ impl AsyncClient {
|
|||
/// This allows `AsyncClient` to manually sync state with the provided `StateStore`.
|
||||
///
|
||||
/// Returns true when a successful `StateStore` sync has completed.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
|
|
@ -415,8 +416,8 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room to be joined.
|
||||
pub async fn join_room_by_id(&mut self, room_id: &RoomId) -> Result<join_room_by_id::Response> {
|
||||
/// * `room_id` - The `RoomId` of the room to be joined.
|
||||
pub async fn join_room_by_id(&self, room_id: &RoomId) -> Result<join_room_by_id::Response> {
|
||||
let request = join_room_by_id::Request {
|
||||
room_id: room_id.clone(),
|
||||
third_party_signed: None,
|
||||
|
|
@ -431,7 +432,7 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * alias - The `RoomId` or `RoomAliasId` of the room to be joined.
|
||||
/// * `alias` - The `RoomId` or `RoomAliasId` of the room to be joined.
|
||||
/// An alias looks like this `#name:example.com`
|
||||
pub async fn join_room_by_id_or_alias(
|
||||
&self,
|
||||
|
|
@ -452,7 +453,7 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room to be forget.
|
||||
/// * `room_id` - The `RoomId` of the room to be forget.
|
||||
pub async fn forget_room_by_id(&self, room_id: &RoomId) -> Result<forget_room::Response> {
|
||||
let request = forget_room::Request {
|
||||
room_id: room_id.clone(),
|
||||
|
|
@ -466,21 +467,21 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room to ban the user from.
|
||||
/// * `room_id` - The `RoomId` of the room to ban the user from.
|
||||
///
|
||||
/// * user_id - The user to ban by `UserId`.
|
||||
/// * `user_id` - The user to ban by `UserId`.
|
||||
///
|
||||
/// * reason - The reason for banning this user.
|
||||
/// * `reason` - The reason for banning this user.
|
||||
pub async fn ban_user(
|
||||
&self,
|
||||
room_id: RoomId,
|
||||
user_id: UserId,
|
||||
room_id: &RoomId,
|
||||
user_id: &UserId,
|
||||
reason: Option<String>,
|
||||
) -> Result<ban_user::Response> {
|
||||
let request = ban_user::Request {
|
||||
reason,
|
||||
room_id,
|
||||
user_id,
|
||||
room_id: room_id.clone(),
|
||||
user_id: user_id.clone(),
|
||||
};
|
||||
self.send(request).await
|
||||
}
|
||||
|
|
@ -491,11 +492,11 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room the user should be kicked out of.
|
||||
/// * `room_id` - The `RoomId` of the room the user should be kicked out of.
|
||||
///
|
||||
/// * user_id - The `UserId` of the user that should be kicked out of the room.
|
||||
/// * `user_id` - The `UserId` of the user that should be kicked out of the room.
|
||||
///
|
||||
/// * reason - Optional reason why the room member is being kicked out.
|
||||
/// * `reason` - Optional reason why the room member is being kicked out.
|
||||
pub async fn kick_user(
|
||||
&self,
|
||||
room_id: &RoomId,
|
||||
|
|
@ -516,7 +517,7 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room to leave.
|
||||
/// * `room_id` - The `RoomId` of the room to leave.
|
||||
///
|
||||
pub async fn leave_room(&self, room_id: &RoomId) -> Result<leave_room::Response> {
|
||||
let request = leave_room::Request {
|
||||
|
|
@ -531,9 +532,9 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room to invite the specified user to.
|
||||
/// * `room_id` - The `RoomId` of the room to invite the specified user to.
|
||||
///
|
||||
/// * user_id - The `UserId` of the user to invite to the room.
|
||||
/// * `user_id` - The `UserId` of the user to invite to the room.
|
||||
pub async fn invite_user_by_id(
|
||||
&self,
|
||||
room_id: &RoomId,
|
||||
|
|
@ -554,9 +555,9 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` of the room to invite the specified user to.
|
||||
/// * `room_id` - The `RoomId` of the room to invite the specified user to.
|
||||
///
|
||||
/// * invite_id - A third party id of a user to invite to the room.
|
||||
/// * `invite_id` - A third party id of a user to invite to the room.
|
||||
pub async fn invite_user_by_3pid(
|
||||
&self,
|
||||
room_id: &RoomId,
|
||||
|
|
@ -576,7 +577,7 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room - The easiest way to create this request is using the `RoomBuilder`.
|
||||
/// * `room` - The easiest way to create this request is using the `RoomBuilder`.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
|
|
@ -615,7 +616,7 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * request - The easiest way to create a `Request` is using the
|
||||
/// * `request` - The easiest way to create a `Request` is using the
|
||||
/// `MessagesRequestBuilder`.
|
||||
///
|
||||
/// # Examples
|
||||
|
|
@ -656,13 +657,13 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` the user is typing in.
|
||||
/// * `room_id` - The `RoomId` the user is typing in.
|
||||
///
|
||||
/// * user_id - The `UserId` of the user that is typing.
|
||||
/// * `user_id` - The `UserId` of the user that is typing.
|
||||
///
|
||||
/// * typing - Whether the user is typing, if false `timeout` is not needed.
|
||||
/// * `typing` - Whether the user is typing, if false `timeout` is not needed.
|
||||
///
|
||||
/// * timeout - Length of time in milliseconds to mark user is typing.
|
||||
/// * `timeout` - Length of time in milliseconds to mark user is typing.
|
||||
pub async fn typing_notice(
|
||||
&self,
|
||||
room_id: &RoomId,
|
||||
|
|
@ -685,9 +686,9 @@ impl AsyncClient {
|
|||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * room_id - The `RoomId` the user is typing in.
|
||||
/// * `room_id` - The `RoomId` the user is typing in.
|
||||
///
|
||||
/// * event_id - The `UserId` of the user that is typing.
|
||||
/// * `event_id` - The `UserId` of the user that is typing.
|
||||
pub async fn read_receipt(
|
||||
&self,
|
||||
room_id: &RoomId,
|
||||
|
|
@ -1297,13 +1298,17 @@ impl AsyncClient {
|
|||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::{AsyncClient, Url};
|
||||
use super::{
|
||||
ban_user, create_receipt, create_typing_event, forget_room, invite_user, kick_user,
|
||||
leave_room,
|
||||
};
|
||||
use super::{AsyncClient, Session, Url};
|
||||
use crate::events::collections::all::RoomEvent;
|
||||
use crate::identifiers::{RoomId, UserId};
|
||||
use crate::identifiers::{EventId, RoomId, UserId};
|
||||
|
||||
use crate::test_builder::EventBuilder;
|
||||
|
||||
use mockito::mock;
|
||||
use mockito::{mock, Matcher};
|
||||
use std::convert::TryFrom;
|
||||
use std::str::FromStr;
|
||||
|
||||
|
|
@ -1407,4 +1412,270 @@ mod test {
|
|||
panic!("this request should return an `Err` variant")
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn join_room() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: UserId::try_from("@example:localhost").unwrap(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/join".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
.with_body_from_file("../test_data/room_id.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
assert_eq!(
|
||||
// this is the `join_by_room_id::Response` but since no PartialEq we check the RoomId field
|
||||
client.join_room_by_id(&room_id).await.unwrap().room_id,
|
||||
room_id
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn invite_room() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
let user = UserId::try_from("@example:localhost").unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: user.clone(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/invite".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
|
||||
if let invite_user::Response = client.invite_user_by_id(&room_id, &user).await.unwrap() {}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn leave_room() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: UserId::try_from("@example:localhost").unwrap(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/leave".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
// this is an empty JSON object
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
let response = client.leave_room(&room_id).await.unwrap();
|
||||
if let leave_room::Response = response {
|
||||
} else {
|
||||
panic!(
|
||||
"expected `ruma_client_api::leave_room::Response` found {:?}",
|
||||
response
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn ban_user() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
let user = UserId::try_from("@example:localhost").unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: user.clone(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/ban".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
// this is an empty JSON object
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
|
||||
let response = client.ban_user(&room_id, &user, None).await.unwrap();
|
||||
if let ban_user::Response = response {
|
||||
} else {
|
||||
panic!(
|
||||
"expected `ruma_client_api::ban_user::Response` found {:?}",
|
||||
response
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn kick_user() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
let user = UserId::try_from("@example:localhost").unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: user.clone(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/kick".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
// this is an empty JSON object
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
|
||||
let response = client.kick_user(&room_id, &user, None).await.unwrap();
|
||||
if let kick_user::Response = response {
|
||||
} else {
|
||||
panic!(
|
||||
"expected `ruma_client_api::kick_user::Response` found {:?}",
|
||||
response
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn forget_room() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
let user = UserId::try_from("@example:localhost").unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: user.clone(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/forget".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
// this is an empty JSON object
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
|
||||
let response = client.forget_room_by_id(&room_id).await.unwrap();
|
||||
if let forget_room::Response = response {
|
||||
} else {
|
||||
panic!(
|
||||
"expected `ruma_client_api::forget_room::Response` found {:?}",
|
||||
response
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn read_receipt() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
let user_id = UserId::try_from("@example:localhost").unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
let event_id = EventId::new("example.org").unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id,
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"POST",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/receipt".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
// this is an empty JSON object
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
|
||||
let response = client.read_receipt(&room_id, &event_id).await.unwrap();
|
||||
if let create_receipt::Response = response {
|
||||
} else {
|
||||
panic!(
|
||||
"expected `ruma_client_api::create_receipt::Response` found {:?}",
|
||||
response
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[allow(irrefutable_let_patterns)]
|
||||
async fn typing_notice() {
|
||||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||||
let user = UserId::try_from("@example:localhost").unwrap();
|
||||
let room_id = RoomId::try_from("!testroom:example.org").unwrap();
|
||||
|
||||
let session = Session {
|
||||
access_token: "1234".to_owned(),
|
||||
user_id: user.clone(),
|
||||
device_id: "DEVICEID".to_owned(),
|
||||
};
|
||||
|
||||
let _m = mock(
|
||||
"PUT",
|
||||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/typing".to_string()),
|
||||
)
|
||||
.with_status(200)
|
||||
// this is an empty JSON object
|
||||
.with_body_from_file("../test_data/logout_response.json")
|
||||
.create();
|
||||
|
||||
let client = AsyncClient::new(homeserver, Some(session)).unwrap();
|
||||
|
||||
let response = client
|
||||
.typing_notice(
|
||||
&room_id,
|
||||
&user,
|
||||
true,
|
||||
Some(std::time::Duration::from_secs(1)),
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
if let create_typing_event::Response = response {
|
||||
} else {
|
||||
panic!(
|
||||
"expected `ruma_client_api::create_typing_event::Response` found {:?}",
|
||||
response
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue