chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

identifiers: Separate RoomId URI methods with and without via

Browse Source
This commit is contained in:
Kévin Commaille 2022-07-08 11:01:48 +02:00 committed by Kévin Commaille
parent fcdb2286c3
commit eb567dac73
3 changed files with 108 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
crates/ruma-common/CHANGELOG.md
View File

@ -23,6 +23,7 @@ Breaking changes:
* Move `CanonicalJson`, `CanonicalJsonObject` and `CanonicalJsonError` out of
the `serde` module and behind the cargo feature flag `canonical-json`
* Make identifiers matrix URI constructors generic over owned parameters
* Split `RoomId` matrix URI constructors between methods with and without routing
* Allow to add routing servers to `RoomId::matrix_to_event_uri()`
[spec]: https://github.com/matrix-org/matrix-spec-proposals/pull/3669

24
crates/ruma-common/src/identifiers/matrix_uri.rs
View File

@ -544,7 +544,7 @@ mod tests {
use super::{MatrixId, MatrixToUri, MatrixUri};
use crate::{
event_id, matrix_uri::UriAction, room_alias_id, room_id, server_name, user_id,
OwnedServerName, RoomOrAliasId,
RoomOrAliasId,
};
#[test]
@ -557,9 +557,13 @@ mod tests {
room_alias_id!("#ruma:notareal.hs").matrix_to_uri().to_string(),
"https://matrix.to/#/%23ruma%3Anotareal.hs"
);
assert_eq!(
room_id!("!ruma:notareal.hs").matrix_to_uri().to_string(),
"https://matrix.to/#/%21ruma%3Anotareal.hs"
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_to_uri(vec![server_name!("notareal.hs")])
.matrix_to_uri_via(vec![server_name!("notareal.hs")])
.to_string(),
"https://matrix.to/#/%21ruma%3Anotareal.hs?via=notareal.hs"
);
@ -571,13 +575,13 @@ mod tests {
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_to_event_uri(event_id!("$event:notareal.hs"), Vec::<OwnedServerName>::new())
.matrix_to_event_uri(event_id!("$event:notareal.hs"))
.to_string(),
"https://matrix.to/#/%21ruma%3Anotareal.hs/%24event%3Anotareal.hs"
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_to_event_uri(
.matrix_to_event_uri_via(
event_id!("$event:notareal.hs"),
vec![server_name!("notareal.hs")]
)
@ -804,15 +808,19 @@ mod tests {
room_alias_id!("#ruma:notareal.hs").matrix_uri(true).to_string(),
"matrix:r/ruma:notareal.hs?action=join"
);
assert_eq!(
room_id!("!ruma:notareal.hs").matrix_uri(false).to_string(),
"matrix:roomid/ruma:notareal.hs"
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_uri(vec![server_name!("notareal.hs")], false)
.matrix_uri_via(vec![server_name!("notareal.hs")], false)
.to_string(),
"matrix:roomid/ruma:notareal.hs?via=notareal.hs"
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_uri(
.matrix_uri_via(
vec![server_name!("notareal.hs"), server_name!("anotherunreal.hs")],
true
)
@ -827,13 +835,13 @@ mod tests {
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_event_uri(event_id!("$event:notareal.hs"), Vec::<OwnedServerName>::new())
.matrix_event_uri(event_id!("$event:notareal.hs"))
.to_string(),
"matrix:roomid/ruma:notareal.hs/e/event:notareal.hs"
);
assert_eq!(
room_id!("!ruma:notareal.hs")
.matrix_event_uri(
.matrix_event_uri_via(
event_id!("$event:notareal.hs"),
vec![server_name!("notareal.hs")]
)

97
crates/ruma-common/src/identifiers/room_id.rs
View File

@ -46,6 +46,29 @@ impl RoomId {
/// Create a `matrix.to` URI for this room ID.
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_to_uri_via()`].
///
/// # Example
///
/// ```
/// use ruma_common::{room_id, server_name};
///
/// assert_eq!(
/// room_id!("!somewhere:example.org").matrix_to_uri().to_string(),
/// "https://matrix.to/#/%21somewhere%3Aexample.org"
/// );
/// ```
pub fn matrix_to_uri(&self) -> MatrixToUri {
MatrixToUri::new(self.into(), vec![])
}
/// Create a `matrix.to` URI for this room ID with a list of servers that should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_to_uri()`] instead.
///
/// # Example
///
/// ```
@ -53,12 +76,14 @@ impl RoomId {
///
/// assert_eq!(
/// room_id!("!somewhere:example.org")
/// .matrix_to_uri([&*server_name!("example.org"), &*server_name!("alt.example.org")])
/// .matrix_to_uri_via([&*server_name!("example.org"), &*server_name!("alt.example.org")])
/// .to_string(),
/// "https://matrix.to/#/%21somewhere%3Aexample.org?via=example.org&via=alt.example.org"
/// );
/// ```
pub fn matrix_to_uri<T>(&self, via: T) -> MatrixToUri
///
/// [routing algorithm]: https://spec.matrix.org/v1.3/appendices/#routing
pub fn matrix_to_uri_via<T>(&self, via: T) -> MatrixToUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
@ -67,7 +92,22 @@ impl RoomId {
}
/// Create a `matrix.to` URI for an event scoped under this room ID.
pub fn matrix_to_event_uri<T>(&self, ev_id: impl Into<OwnedEventId>, via: T) -> MatrixToUri
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_to_event_uri_via()`].
pub fn matrix_to_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixToUri {
MatrixToUri::new((self.to_owned(), ev_id.into()).into(), vec![])
}
/// Create a `matrix.to` URI for an event scoped under this room ID with a list of servers that
/// should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_to_event_uri()`] instead.
///
/// [routing algorithm]: https://spec.matrix.org/v1.3/appendices/#routing
pub fn matrix_to_event_uri_via<T>(&self, ev_id: impl Into<OwnedEventId>, via: T) -> MatrixToUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
@ -82,6 +122,31 @@ impl RoomId {
///
/// If `join` is `true`, a click on the URI should join the room.
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_uri_via()`].
///
/// # Example
///
/// ```
/// use ruma_common::{room_id, server_name};
///
/// assert_eq!(
/// room_id!("!somewhere:example.org").matrix_uri(false).to_string(),
/// "matrix:roomid/somewhere:example.org"
/// );
/// ```
pub fn matrix_uri(&self, join: bool) -> MatrixUri {
MatrixUri::new(self.into(), vec![], Some(UriAction::Join).filter(|_| join))
}
/// Create a `matrix:` URI for this room ID with a list of servers that should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_uri()`] instead.
///
/// If `join` is `true`, a click on the URI should join the room.
///
/// # Example
///
/// ```
@ -89,12 +154,17 @@ impl RoomId {
///
/// assert_eq!(
/// room_id!("!somewhere:example.org")
/// .matrix_uri([&*server_name!("example.org"), &*server_name!("alt.example.org")], true)
/// .matrix_uri_via(
/// [&*server_name!("example.org"), &*server_name!("alt.example.org")],
/// true
/// )
/// .to_string(),
/// "matrix:roomid/somewhere:example.org?via=example.org&via=alt.example.org&action=join"
/// );
/// ```
pub fn matrix_uri<T>(&self, via: T, join: bool) -> MatrixUri
///
/// [routing algorithm]: https://spec.matrix.org/v1.3/appendices/#routing
pub fn matrix_uri_via<T>(&self, via: T, join: bool) -> MatrixUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
@ -107,7 +177,22 @@ impl RoomId {
}
/// Create a `matrix:` URI for an event scoped under this room ID.
pub fn matrix_event_uri<T>(&self, ev_id: impl Into<OwnedEventId>, via: T) -> MatrixUri
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_event_uri_via()`].
pub fn matrix_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixUri {
MatrixUri::new((self.to_owned(), ev_id.into()).into(), vec![], None)
}
/// Create a `matrix:` URI for an event scoped under this room ID with a list of servers that
/// should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_event_uri()`] instead.
///
/// [routing algorithm]: https://spec.matrix.org/v1.3/appendices/#routing
pub fn matrix_event_uri_via<T>(&self, ev_id: impl Into<OwnedEventId>, via: T) -> MatrixUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,