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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
#![warn(rust_2018_idioms)]
#![deny(missing_copy_implementations, missing_debug_implementations, missing_docs)]
#![allow(clippy::use_self)]
use std::{
convert::{TryFrom, TryInto},
error::Error as StdError,
fmt::{Display, Formatter, Result as FmtResult},
io,
};
use http::{self, Method, StatusCode};
use ruma_identifiers;
use serde_json;
use serde_urlencoded;
#[cfg(feature = "with-ruma-api-macros")]
pub use ruma_api_macros::ruma_api;
#[cfg(feature = "with-ruma-api-macros")]
#[doc(hidden)]
pub mod exports {
pub use http;
pub use serde;
pub use serde_json;
pub use serde_urlencoded;
pub use url;
}
pub trait Endpoint: TryInto<http::Request<Vec<u8>>, Error = Error> {
type Response: TryFrom<http::Response<Vec<u8>>, Error = Error>;
const METADATA: Metadata;
}
#[derive(Debug)]
pub struct Error(pub(crate) InnerError);
impl Display for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
let message = match self.0 {
InnerError::Http(_) => "An error converting to or from `http` types occurred.".into(),
InnerError::Io(_) => "An I/O error occurred.".into(),
InnerError::SerdeJson(_) => "A JSON error occurred.".into(),
InnerError::SerdeUrlEncodedDe(_) => {
"A URL encoding deserialization error occurred.".into()
}
InnerError::SerdeUrlEncodedSer(_) => {
"A URL encoding serialization error occurred.".into()
}
InnerError::RumaIdentifiers(_) => "A ruma-identifiers error occurred.".into(),
InnerError::StatusCode(code) => format!("A HTTP {} error occurred.", code),
};
write!(f, "{}", message)
}
}
impl StdError for Error {}
#[derive(Debug)]
pub(crate) enum InnerError {
Http(http::Error),
Io(io::Error),
SerdeJson(serde_json::Error),
SerdeUrlEncodedDe(serde_urlencoded::de::Error),
SerdeUrlEncodedSer(serde_urlencoded::ser::Error),
RumaIdentifiers(ruma_identifiers::Error),
StatusCode(StatusCode),
}
impl From<http::Error> for Error {
fn from(error: http::Error) -> Self {
Self(InnerError::Http(error))
}
}
impl From<io::Error> for Error {
fn from(error: io::Error) -> Self {
Self(InnerError::Io(error))
}
}
impl From<serde_json::Error> for Error {
fn from(error: serde_json::Error) -> Self {
Self(InnerError::SerdeJson(error))
}
}
impl From<serde_urlencoded::de::Error> for Error {
fn from(error: serde_urlencoded::de::Error) -> Self {
Self(InnerError::SerdeUrlEncodedDe(error))
}
}
impl From<serde_urlencoded::ser::Error> for Error {
fn from(error: serde_urlencoded::ser::Error) -> Self {
Self(InnerError::SerdeUrlEncodedSer(error))
}
}
impl From<ruma_identifiers::Error> for Error {
fn from(error: ruma_identifiers::Error) -> Self {
Self(InnerError::RumaIdentifiers(error))
}
}
impl From<StatusCode> for Error {
fn from(error: StatusCode) -> Self {
Self(InnerError::StatusCode(error))
}
}
#[derive(Clone, Debug)]
pub struct Metadata {
pub description: &'static str,
pub method: Method,
pub name: &'static str,
pub path: &'static str,
pub rate_limited: bool,
pub requires_authentication: bool,
}
#[cfg(test)]
mod tests {
pub mod create {
use std::convert::TryFrom;
use http::{self, method::Method};
use ruma_identifiers::{RoomAliasId, RoomId};
use serde::{Deserialize, Serialize};
use serde_json;
use crate::{Endpoint, Error, Metadata};
#[derive(Debug)]
pub struct Request {
pub room_id: RoomId,
pub room_alias: RoomAliasId,
}
impl Endpoint for Request {
type Response = Response;
const METADATA: Metadata = Metadata {
description: "Add an alias to a room.",
method: Method::PUT,
name: "create_alias",
path: "/_matrix/client/r0/directory/room/:room_alias",
rate_limited: false,
requires_authentication: true,
};
}
impl TryFrom<Request> for http::Request<Vec<u8>> {
type Error = Error;
fn try_from(request: Request) -> Result<http::Request<Vec<u8>>, Self::Error> {
let metadata = Request::METADATA;
let path = metadata
.path
.to_string()
.replace(":room_alias", &request.room_alias.to_string());
let request_body = RequestBody { room_id: request.room_id };
let http_request = http::Request::builder()
.method(metadata.method)
.uri(path)
.body(serde_json::to_vec(&request_body).map_err(Error::from)?)?;
Ok(http_request)
}
}
#[derive(Debug, Serialize, Deserialize)]
struct RequestBody {
room_id: RoomId,
}
#[derive(Clone, Copy, Debug)]
pub struct Response;
impl TryFrom<http::Response<Vec<u8>>> for Response {
type Error = Error;
fn try_from(http_response: http::Response<Vec<u8>>) -> Result<Response, Self::Error> {
if http_response.status().is_success() {
Ok(Response)
} else {
Err(http_response.status().into())
}
}
}
}
}