drupal_kit 0.3.3

Flexible Drupal HTTP client supporting a variety of popular contrib modules
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

use core::fmt::{self, Debug};
use std::{
    error::{self, Error},
    future::Future,
};

use http::{HeaderMap, HeaderName, HeaderValue};
use reqwest::{Body, Client, Method, RequestBuilder, Response};
use serde::de::DeserializeOwned;

/// Additional option for request.
#[derive(Clone)]
pub enum HttpRequestOption {
    /// Adds a HTTP header with name and value to the request.
    Header(HeaderName, HeaderValue),
    /// Overwrites the base url for the request.
    /// Takes precedence over the value from `get_base_url`.
    BaseUrl(String),
    /// Disables invocation of `before_request` and `after_request`
    /// for this request.
    NoBeforeAfter,
    /// Disables the use of a authentication strategy therefore
    /// making it an anonymous request.
    Anonymous,
}

/// Defines an error coming from the HttpClient.
pub type ClientError = Box<dyn Error + Send + Sync>;

#[derive(Debug)]
pub struct FailedRequestError {
    response: Response,
}

impl From<Response> for FailedRequestError {
    fn from(value: Response) -> Self {
        Self { response: value }
    }
}

impl fmt::Display for FailedRequestError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "http request failed with status code {}",
            self.response.status()
        )
    }
}

impl error::Error for FailedRequestError {}

/// Provides basic HTTP Client capabilities.
///
/// Implement this in your struct when building a custom
/// HTTP client.
///
/// The methods `before_request` and `after_request` can be used
/// to alter the request / response of the `request` method.
pub trait HttpClient {
    /// Make an HTTP request.
    ///
    /// The URL is constructed using the base url from `HttpRequestOption::BaseUrl`or `self.get_base_url()`.
    /// The given path is appended to the base url to produce the full request URL.
    ///
    ///
    fn request(
        &self,
        method: Method,
        path: &str,
        body: impl Into<Body> + Send,
        options: Vec<HttpRequestOption>,
    ) -> impl Future<Output = Result<Response, ClientError>> + Send
    where
        Self: Sync,
    {
        async move {
            let mut base_url: String = self.get_base_url().to_string();
            let mut header_map = HeaderMap::new();
            let mut no_before_after = false;

            // Handle additional request options.
            for option in &options {
                match option {
                    HttpRequestOption::Header(key, value) => {
                        header_map.insert(key.clone(), value.clone());
                    }
                    HttpRequestOption::BaseUrl(url) => {
                        base_url = url.clone();
                    }
                    HttpRequestOption::NoBeforeAfter => {
                        no_before_after = true;
                    }
                    _ => {}
                }
            }

            let url = format!("{}{}", base_url, path);
            let client = self.get_http_client();

            // Create a request builder and add modified headers.
            let req_builder = client.request(method, url).headers(header_map).body(body);

            // Allow alteration of request in impl.
            // Only on requests without the `HttpRequestOptio::NoBeforeAfter` option.
            // This is to prevent infinite loops if a `before_request` handler
            // if the handler itself calls another `request`.
            let req_builder = if !no_before_after {
                match self.before_request(req_builder, path, options).await {
                    Ok(req_builder) => req_builder,
                    Err(err) => return Err(err),
                }
            } else {
                req_builder
            };

            // Build the request.
            let req = req_builder.build()?;

            // Execute the request.
            match client.execute(req).await {
                Ok(response) => {
                    // Allow alteration of response in impl.
                    // Only on requests without the `HttpRequestOptio::NoBeforeAfter` option.
                    let response = if !no_before_after {
                        match self.after_request(response).await {
                            Ok(response) => response,
                            Err(err) => return Err(err),
                        }
                    } else {
                        response
                    };

                    Ok(response)
                }
                Err(err) => Err(Box::new(err)),
            }
        }
    }

    /// The same as `request` but deserializes json response body
    /// into a struct.
    fn request_json<T>(
        &self,
        method: Method,
        path: &str,
        body: impl Into<Body> + Send,
        options: Vec<HttpRequestOption>,
    ) -> impl Future<Output = Result<T, ClientError>> + Send
    where
        Self: Sync,
        T: DeserializeOwned + Debug,
    {
        async move {
            // Add Content-Type: application/json header by default
            // Only add Content-Type if not already set
            let mut options = options;
            if !options.iter().any(|opt| match opt {
                HttpRequestOption::Header(name, _) => name == "content-type",
                _ => false,
            }) {
                options.push(HttpRequestOption::Header(
                    HeaderName::from_static("content-type"),
                    HeaderValue::from_static("application/json"),
                ));
            }

            match self.request(method, path, body, options).await {
                Ok(response) => {
                    if response.status().is_success() {
                        let bytes = response.bytes().await?;
                        let payload = serde_json::from_slice(&bytes)?;

                        Ok(payload)
                    } else {
                        Err(Box::new(FailedRequestError::from(response))
                            as Box<dyn Error + Send + Sync>)
                    }
                }
                Err(err) => Err(err),
            }
        }
    }

    /// Modify the request before being sent.
    ///
    /// Using the given `reqwest::RequestBuilder` you can add
    /// headers and do other stuff to the request.
    fn before_request(
        &self,
        req_builder: RequestBuilder,
        _path: &str,
        _options: Vec<HttpRequestOption>,
    ) -> impl Future<Output = Result<RequestBuilder, ClientError>> + Send {
        async { Ok(req_builder) }
    }

    /// Modify a successful response.
    ///
    /// This method alters the `reqwest::Response` returned
    /// from the `request` method.
    fn after_request(
        &self,
        response: Response,
    ) -> impl Future<Output = Result<Response, ClientError>> + Send {
        async { Ok(response) }
    }

    /// Return the underlying instance of `reqwest::Client`.
    ///
    /// # Example
    ///
    /// ```rust
    /// use drupal_kit::http_client::HttpClient;
    ///
    /// struct MyHttpClient {
    ///     http_client: reqwest::Client,
    /// }
    ///
    /// impl MyHttpClient {
    ///     pub fn new() -> Self {
    ///         let http_client = reqwest::Client::new();
    ///
    ///         Self {
    ///             http_client,
    ///         }
    ///     }
    /// }
    ///
    /// impl HttpClient for MyHttpClient {
    ///     fn get_http_client(&self) -> &reqwest::Client {
    ///         &self.http_client
    ///     }
    ///
    ///     fn get_base_url(&self) -> &str {
    ///         todo!()
    ///     }
    /// }
    /// ```
    fn get_http_client(&self) -> &Client;

    /// Returns the baseurl used for every request,
    /// unless explicitly set with `HttpRequestOption::BaseUrl`.
    fn get_base_url(&self) -> &str;
}