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

client-api: Do not send request body for logout and logout_all

Browse Source 
Due to a clarification in the spec.
This commit is contained in:
Kévin Commaille 2024-06-22 11:38:31 +02:00 committed by Kévin Commaille
parent e815eb7603
commit 14d7415f0d
3 changed files with 134 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/ruma-client-api/CHANGELOG.md
View File

@ -34,6 +34,8 @@ Bug fixes:
- `user_id` of `SlidingSyncRoomHero` is now mandatory
- Make authentication with access token optional for the `change_password` and
`deactivate` endpoints.
- Do not send a request body for the `logout` and `logout_all` endpoints, due
to a clarification in the spec.
# 0.18.0

74
crates/ruma-client-api/src/session/logout.rs
View File

@ -8,7 +8,7 @@ pub mod v3 {
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3logout
use ruma_common::{
api::{request, response, Metadata},
api::{response, Metadata},
metadata,
};
@ -23,15 +23,10 @@ pub mod v3 {
};
/// Request type for the `logout` endpoint.
#[request(error = crate::Error)]
#[derive(Default)]
#[derive(Debug, Clone, Default)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Request {}
/// Response type for the `logout` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates an empty `Request`.
pub fn new() -> Self {
@ -39,6 +34,69 @@ pub mod v3 {
}
}
#[cfg(feature = "client")]
impl ruma_common::api::OutgoingRequest for Request {
type EndpointError = crate::Error;
type IncomingResponse = Response;
const METADATA: Metadata = METADATA;
fn try_into_http_request<T: Default + bytes::BufMut>(
self,
base_url: &str,
access_token: ruma_common::api::SendAccessToken<'_>,
considering_versions: &'_ [ruma_common::api::MatrixVersion],
) -> Result<http::Request<T>, ruma_common::api::error::IntoHttpError> {
let url = METADATA.make_endpoint_url(considering_versions, base_url, &[], "")?;
http::Request::builder()
.method(METADATA.method)
.uri(url)
.header(
http::header::AUTHORIZATION,
format!(
"Bearer {}",
access_token
.get_required_for_endpoint()
.ok_or(ruma_common::api::error::IntoHttpError::NeedsAuthentication)?,
),
)
.body(T::default())
.map_err(Into::into)
}
}
#[cfg(feature = "server")]
impl ruma_common::api::IncomingRequest for Request {
type EndpointError = crate::Error;
type OutgoingResponse = Response;
const METADATA: Metadata = METADATA;
fn try_from_http_request<B, S>(
request: http::Request<B>,
_path_args: &[S],
) -> Result<Self, ruma_common::api::error::FromHttpRequestError>
where
B: AsRef<[u8]>,
S: AsRef<str>,
{
if request.method() != METADATA.method {
return Err(ruma_common::api::error::FromHttpRequestError::MethodMismatch {
expected: METADATA.method,
received: request.method().clone(),
});
}
Ok(Self {})
}
}
/// Response type for the `logout` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {

74
crates/ruma-client-api/src/session/logout_all.rs
View File

@ -8,7 +8,7 @@ pub mod v3 {
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3logoutall
use ruma_common::{
api::{request, response, Metadata},
api::{response, Metadata},
metadata,
};
@ -23,15 +23,10 @@ pub mod v3 {
};
/// Request type for the `logout_all` endpoint.
#[request(error = crate::Error)]
#[derive(Default)]
#[derive(Debug, Clone, Default)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Request {}
/// Response type for the `logout_all` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates an empty `Request`.
pub fn new() -> Self {
@ -39,6 +34,69 @@ pub mod v3 {
}
}
#[cfg(feature = "client")]
impl ruma_common::api::OutgoingRequest for Request {
type EndpointError = crate::Error;
type IncomingResponse = Response;
const METADATA: Metadata = METADATA;
fn try_into_http_request<T: Default + bytes::BufMut>(
self,
base_url: &str,
access_token: ruma_common::api::SendAccessToken<'_>,
considering_versions: &'_ [ruma_common::api::MatrixVersion],
) -> Result<http::Request<T>, ruma_common::api::error::IntoHttpError> {
let url = METADATA.make_endpoint_url(considering_versions, base_url, &[], "")?;
http::Request::builder()
.method(METADATA.method)
.uri(url)
.header(
http::header::AUTHORIZATION,
format!(
"Bearer {}",
access_token
.get_required_for_endpoint()
.ok_or(ruma_common::api::error::IntoHttpError::NeedsAuthentication)?,
),
)
.body(T::default())
.map_err(Into::into)
}
}
#[cfg(feature = "server")]
impl ruma_common::api::IncomingRequest for Request {
type EndpointError = crate::Error;
type OutgoingResponse = Response;
const METADATA: Metadata = METADATA;
fn try_from_http_request<B, S>(
request: http::Request<B>,
_path_args: &[S],
) -> Result<Self, ruma_common::api::error::FromHttpRequestError>
where
B: AsRef<[u8]>,
S: AsRef<str>,
{
if request.method() != METADATA.method {
return Err(ruma_common::api::error::FromHttpRequestError::MethodMismatch {
expected: METADATA.method,
received: request.method().clone(),
});
}
Ok(Self {})
}
}
/// Response type for the `logout_all` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {