oauth10a 3.0.0

A rust implementation of the oauth 1.0a protocol fully-async with logging, metrics and tracing facilities
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
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
250
251
252
253
254
255
256
257
258
259

//! `RESTful` API client.

use core::fmt;

use reqwest::{
    IntoUrl, Method, StatusCode,
    header::{self, HeaderValue},
};
use serde::{Serialize, de::DeserializeOwned};

use crate::execute::ExecuteRequest;

pub const APPLICATION_JSON: HeaderValue = HeaderValue::from_static("application/json");

pub const UTF8: HeaderValue = HeaderValue::from_static("utf-8");

// REST ERROR //////////////////////////////////////////////////////////////////

#[derive(Debug, thiserror::Error)]
pub enum RestError<E> {
    #[error(transparent)]
    Execute(E),
    #[error("failed to serialize body, {0}")]
    Serialize(serde_json::Error),
    #[error("invalid url endpoint, {0}")]
    Url(reqwest::Error),
    #[error("failed to aggregate body, {0}")]
    BodyAggregation(reqwest::Error),
    #[error("failed to insert header: too many entries")]
    TooManyHeaders(#[from] header::MaxSizeReached),
    #[error("failed to deserialize body, {0}")]
    Deserialize(serde_json::Error),
}

// ERROR RESPONSE //////////////////////////////////////////////////////////////

#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, thiserror::Error)]
#[error("error response with status code {status_code}, {value:?}")]
pub struct ErrorResponse<E = serde_json::Value> {
    pub status_code: StatusCode,
    pub value: E,
}

// REST CLIENT /////////////////////////////////////////////////////////////////

/// Extension trait for HTTP clients for working with `RESTful` web APIs.
pub trait RestClient<X>: ExecuteRequest {
    /// Creates and executes an HTTP request that expects to receive a response
    /// which JSON body deserializes to `O` if status code is success and to `E`
    /// otherwise.
    fn request<I, O, E>(
        &self,
        method: &Method,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync;

    fn get<O, E>(
        &self,
        endpoint: X,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync;

    fn post<I, O, E>(
        &self,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync;

    fn put<I, O, E>(
        &self,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync;

    fn patch<I, O, E>(
        &self,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync;

    fn delete<E>(
        &self,
        endpoint: X,
    ) -> impl Future<Output = Result<Result<(), ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        E: DeserializeOwned + fmt::Debug + Send + Sync;
}

impl<X: IntoUrl + fmt::Debug + Send, T: ExecuteRequest> RestClient<X> for T {
    #[cfg_attr(feature = "tracing", tracing::instrument)]
    async fn request<I, O, E>(
        &self,
        method: &Method,
        endpoint: X,
        payload: &I,
    ) -> Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync,
    {
        let buf = serde_json::to_vec(payload).map_err(RestError::Serialize)?;

        let url = endpoint.into_url().map_err(RestError::Url)?;

        let mut request = reqwest::Request::new(method.to_owned(), url);

        let headers = request.headers_mut();
        let _ = headers.try_insert(header::CONTENT_TYPE, APPLICATION_JSON)?;
        let _ = headers.try_insert(header::CONTENT_LENGTH, HeaderValue::from(buf.len()))?;
        let _ = headers.try_insert(header::ACCEPT_CHARSET, UTF8)?;
        let _ = headers.try_insert(header::ACCEPT, APPLICATION_JSON)?;

        *request.body_mut() = Some(buf.into());

        let response = self
            .execute_request(request)
            .await
            .map_err(RestError::Execute)?;

        let status_code = response.status();

        let full = response.bytes().await.map_err(RestError::BodyAggregation)?;

        if !status_code.is_success() {
            let value = serde_json::from_slice(&full).map_err(RestError::Deserialize)?;
            return Ok(Err(ErrorResponse { status_code, value }));
        }

        let value = serde_json::from_slice(&full).map_err(RestError::Deserialize)?;

        Ok(Ok(value))
    }

    #[cfg_attr(feature = "tracing", tracing::instrument)]
    async fn get<O, E>(
        &self,
        endpoint: X,
    ) -> Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>
    where
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync,
    {
        let url = endpoint.into_url().map_err(RestError::Url)?;

        let mut request = reqwest::Request::new(Method::GET, url);

        let headers = request.headers_mut();
        let _ = headers.try_insert(header::ACCEPT_CHARSET, UTF8)?;
        let _ = headers.try_insert(header::ACCEPT, APPLICATION_JSON)?;

        let response = self
            .execute_request(request)
            .await
            .map_err(RestError::Execute)?;

        let status_code = response.status();

        let full = response.bytes().await.map_err(RestError::BodyAggregation)?;

        if !status_code.is_success() {
            let value = serde_json::from_slice(&full).map_err(RestError::Deserialize)?;
            return Ok(Err(ErrorResponse { status_code, value }));
        }

        let value = serde_json::from_slice(&full).map_err(RestError::Deserialize)?;

        Ok(Ok(value))
    }

    #[cfg_attr(feature = "tracing", tracing::instrument)]
    fn post<I, O, E>(
        &self,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync,
    {
        self.request(&Method::POST, endpoint, payload)
    }

    #[cfg_attr(feature = "tracing", tracing::instrument)]
    fn put<I, O, E>(
        &self,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync,
    {
        self.request(&Method::PUT, endpoint, payload)
    }

    #[cfg_attr(feature = "tracing", tracing::instrument)]
    fn patch<I, O, E>(
        &self,
        endpoint: X,
        payload: &I,
    ) -> impl Future<Output = Result<Result<O, ErrorResponse<E>>, RestError<Self::Error>>> + Send
    where
        I: ?Sized + Serialize + fmt::Debug + Send + Sync,
        O: DeserializeOwned + fmt::Debug + Send + Sync,
        E: DeserializeOwned + fmt::Debug + Send + Sync,
    {
        self.request(&Method::PATCH, endpoint, payload)
    }

    #[cfg_attr(feature = "tracing", tracing::instrument)]
    async fn delete<E>(
        &self,
        endpoint: X,
    ) -> Result<Result<(), ErrorResponse<E>>, RestError<Self::Error>>
    where
        E: DeserializeOwned + fmt::Debug + Send + Sync,
    {
        let url = endpoint.into_url().map_err(RestError::Url)?;

        let request = reqwest::Request::new(Method::DELETE, url);

        let response = self
            .execute_request(request)
            .await
            .map_err(RestError::Execute)?;

        let status_code = response.status();

        if !status_code.is_success() {
            let full = response.bytes().await.map_err(RestError::BodyAggregation)?;
            let value = serde_json::from_slice(&full).map_err(RestError::Deserialize)?;
            return Ok(Err(ErrorResponse { status_code, value }));
        }

        Ok(Ok(()))
    }
}