118ea0f85a
* Add blurhash to profile and avatar endpoints. * Add `blurhash` fields to `GET /_matrix/federation/v1/query/profile` and `m.room.member`. * Add `generate_blurhash` field to `PUT /_matrix/media/r0/upload`
109 lines
3.4 KiB
Rust
109 lines
3.4 KiB
Rust
//! [PUT /_matrix/client/r0/profile/{userId}/avatar_url](https://matrix.org/docs/spec/client_server/r0.6.0#put-matrix-client-r0-profile-userid-avatar-url)
|
|
|
|
use ruma_api::ruma_api;
|
|
use ruma_identifiers::{MxcUri, UserId};
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Set the avatar URL of the user.",
|
|
method: PUT,
|
|
name: "set_avatar_url",
|
|
path: "/_matrix/client/r0/profile/:user_id/avatar_url",
|
|
rate_limited: true,
|
|
authentication: AccessToken,
|
|
}
|
|
|
|
request: {
|
|
/// The user whose avatar URL will be set.
|
|
#[ruma_api(path)]
|
|
pub user_id: &'a UserId,
|
|
|
|
/// The new avatar URL for the user.
|
|
///
|
|
/// `None` is used to unset the avatar.
|
|
///
|
|
/// If you activate the `compat` feature, this field being an empty string in JSON will give
|
|
/// you `None` here.
|
|
#[cfg_attr(
|
|
feature = "compat",
|
|
serde(
|
|
default,
|
|
deserialize_with = "ruma_serde::empty_string_as_none",
|
|
serialize_with = "ruma_serde::none_as_empty_string"
|
|
)
|
|
)]
|
|
#[cfg_attr(
|
|
not(feature = "compat"),
|
|
serde(skip_serializing_if = "Option::is_none")
|
|
)]
|
|
pub avatar_url: Option<&'a MxcUri>,
|
|
|
|
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
|
|
///
|
|
/// This uses the unstable prefix in
|
|
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
|
|
#[cfg(feature = "unstable-pre-spec")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "unstable-pre-spec")))]
|
|
#[serde(rename = "xyz.amorgan.blurhash")]
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub blurhash: Option<&'a str>,
|
|
}
|
|
|
|
#[derive(Default)]
|
|
response: {}
|
|
|
|
error: crate::Error
|
|
}
|
|
|
|
impl<'a> Request<'a> {
|
|
/// Creates a new `Request` with the given user ID and avatar URL.
|
|
pub fn new(user_id: &'a UserId, avatar_url: Option<&'a MxcUri>) -> Self {
|
|
Self {
|
|
user_id,
|
|
avatar_url,
|
|
#[cfg(feature = "unstable-pre-spec")]
|
|
blurhash: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Response {
|
|
/// Creates an empty `Response`.
|
|
pub fn new() -> Self {
|
|
Self
|
|
}
|
|
}
|
|
|
|
#[cfg(all(test, feature = "server"))]
|
|
mod tests {
|
|
use matches::assert_matches;
|
|
use ruma_api::IncomingRequest as _;
|
|
|
|
use super::IncomingRequest;
|
|
|
|
#[test]
|
|
fn deserialize_unset_request() {
|
|
assert_matches!(
|
|
IncomingRequest::try_from_http_request(
|
|
http::Request::builder()
|
|
.method("PUT")
|
|
.uri("https://bar.org/_matrix/client/r0/profile/@foo:bar.org/avatar_url")
|
|
.body(&[] as &[u8]).unwrap(),
|
|
).unwrap(),
|
|
IncomingRequest { user_id, avatar_url: None, .. } if user_id == "@foo:bar.org"
|
|
);
|
|
|
|
#[cfg(feature = "compat")]
|
|
assert_matches!(
|
|
IncomingRequest::try_from_http_request(
|
|
http::Request::builder()
|
|
.method("PUT")
|
|
.uri("https://bar.org/_matrix/client/r0/profile/@foo:bar.org/avatar_url")
|
|
.body(serde_json::to_vec(&serde_json::json!({ "avatar_url": "" })).unwrap())
|
|
.unwrap(),
|
|
).unwrap(),
|
|
IncomingRequest { user_id, avatar_url: None, .. } if user_id == "@foo:bar.org"
|
|
);
|
|
}
|
|
}
|