ruma-common 0.18.0

Common types for other ruma crates.
Documentation 
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
121
122
123
124
125
126
127
128
129
130
131
132

use std::borrow::Cow;

use assert_matches2::assert_matches;
use http::header::{CONTENT_DISPOSITION, LOCATION};
use ruma_common::{
    api::{
        IncomingRequest, IncomingResponse, MatrixVersion, OutgoingRequest, OutgoingResponse,
        SupportedVersions,
        auth_scheme::NoAuthentication,
        error::{
            DeserializationError, FromHttpRequestError, FromHttpResponseError,
            HeaderDeserializationError,
        },
        request, response,
    },
    http_headers::{ContentDisposition, ContentDispositionType},
    metadata,
};

metadata! {
    method: GET,
    rate_limited: false,
    authentication: NoAuthentication,
    history: {
        unstable => "/_matrix/my/endpoint",
    }
}

/// Request type for the `required_headers` endpoint.
#[request]
pub struct Request {
    #[ruma_api(header = LOCATION)]
    pub location: String,
    #[ruma_api(header = CONTENT_DISPOSITION)]
    pub content_disposition: ContentDisposition,
}

/// Response type for the `required_headers` endpoint.
#[response]
pub struct Response {
    #[ruma_api(header = LOCATION)]
    pub stuff: String,
    #[ruma_api(header = CONTENT_DISPOSITION)]
    pub content_disposition: ContentDisposition,
}

#[test]
fn request_serde() {
    let location = "https://other.tld/page/";
    let content_disposition = ContentDisposition::new(ContentDispositionType::Attachment)
        .with_filename(Some("my_file".to_owned()));
    let req =
        Request { location: location.to_owned(), content_disposition: content_disposition.clone() };
    let supported =
        SupportedVersions { versions: [MatrixVersion::V1_1].into(), features: Default::default() };

    let mut http_req = req
        .clone()
        .try_into_http_request::<Vec<u8>>("https://homeserver.tld", (), Cow::Owned(supported))
        .unwrap();
    assert_matches!(http_req.headers().get(LOCATION), Some(_));
    assert_matches!(http_req.headers().get(CONTENT_DISPOSITION), Some(_));

    let req2 = Request::try_from_http_request::<_, &str>(http_req.clone(), &[]).unwrap();
    assert_eq!(req2.location, location);
    assert_eq!(req2.content_disposition, content_disposition);

    // Try removing the headers.
    http_req.headers_mut().remove(LOCATION).unwrap();
    http_req.headers_mut().remove(CONTENT_DISPOSITION).unwrap();

    let err = Request::try_from_http_request::<_, &str>(http_req.clone(), &[]).unwrap_err();
    assert_matches!(
        err,
        FromHttpRequestError::Deserialization(DeserializationError::Header(
            HeaderDeserializationError::MissingHeader(_)
        ))
    );

    // Try setting invalid header.
    http_req.headers_mut().insert(LOCATION, location.try_into().unwrap());
    http_req.headers_mut().insert(CONTENT_DISPOSITION, ";".try_into().unwrap());

    let err = Request::try_from_http_request::<_, &str>(http_req, &[]).unwrap_err();
    assert_matches!(
        err,
        FromHttpRequestError::Deserialization(DeserializationError::Header(
            HeaderDeserializationError::InvalidHeader(_)
        ))
    );
}

#[test]
fn response_serde() {
    let location = "https://other.tld/page/";
    let content_disposition = ContentDisposition::new(ContentDispositionType::Attachment)
        .with_filename(Some("my_file".to_owned()));
    let res =
        Response { stuff: location.to_owned(), content_disposition: content_disposition.clone() };

    let mut http_res = res.clone().try_into_http_response::<Vec<u8>>().unwrap();
    assert_matches!(http_res.headers().get(LOCATION), Some(_));
    assert_matches!(http_res.headers().get(CONTENT_DISPOSITION), Some(_));

    let res2 = Response::try_from_http_response(http_res.clone()).unwrap();
    assert_eq!(res2.stuff, location);
    assert_eq!(res2.content_disposition, content_disposition);

    // Try removing the headers.
    http_res.headers_mut().remove(LOCATION).unwrap();
    http_res.headers_mut().remove(CONTENT_DISPOSITION).unwrap();

    let err = Response::try_from_http_response(http_res.clone()).unwrap_err();
    assert_matches!(
        err,
        FromHttpResponseError::Deserialization(DeserializationError::Header(
            HeaderDeserializationError::MissingHeader(_)
        ))
    );

    // Try setting invalid header.
    http_res.headers_mut().insert(LOCATION, location.try_into().unwrap());
    http_res.headers_mut().insert(CONTENT_DISPOSITION, ";".try_into().unwrap());

    let err = Response::try_from_http_response(http_res).unwrap_err();
    assert_matches!(
        err,
        FromHttpResponseError::Deserialization(DeserializationError::Header(
            HeaderDeserializationError::InvalidHeader(_)
        ))
    );
}