easyhttpmock 0.1.3-beta.9

EasyHttpMock is a simple HTTP mock server for testing HTTP clients.
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
use std::collections::HashMap;

use bytes::Bytes;
use http::{HeaderMap, Method, StatusCode};

/// Mock struct
pub struct Mock {
    request: Request,
    count: u32,
    match_request: Option<ActualRequest>,
}

impl Mock {
    #[inline]
    /// Create a new mock
    pub fn of(request: Request) -> Self {
        Self { request, count: 0, match_request: None }
    }

    #[inline]
    /// Report a call to this mock
    pub fn report_call(&mut self) {
        self.count += 1;
    }

    #[inline]
    /// Get the request that matched this mock
    pub fn request(&self) -> &Request {
        &self.request
    }

    #[inline]
    /// Match this mock with an actual request
    pub fn match_with(&mut self, request: ActualRequest) {
        self.match_request = Some(request);
    }
}

/// Extension trait for StatusCode to create responses
pub trait StatusCodeExt {
    /// Create a response builder with this status code
    fn respond(self) -> RespondBuilder;
}

impl StatusCodeExt for StatusCode {
    /// Create a response builder with this status code
    fn respond(self) -> RespondBuilder {
        RespondBuilder { status_code: self, headers: HashMap::new() }
    }
}

/// Extension trait for HTTP methods to create requests.
/// Allows creating requests using method names as strings or Method enum values.
///
/// # Examples
/// ``` compile_fail
/// use http::Method;
/// use deboa::request::MethodExt;
///
/// // Using Method enum
/// let request = Method::GET.has();
///
/// // Using string
/// let request = "GET".has();
/// ```
pub trait MethodExt {
    /// Create a request builder with this method
    fn has(self) -> RequestBuilder;
}

impl MethodExt for Method {
    #[inline]
    /// Create a request builder with this method
    fn has(self) -> RequestBuilder {
        match self {
            Method::GET => Request::builder(self),
            Method::POST => Request::builder(self),
            Method::PUT => Request::builder(self),
            Method::DELETE => Request::builder(self),
            Method::PATCH => Request::builder(self),
            Method::HEAD => Request::builder(self),
            Method::OPTIONS => Request::builder(self),
            _ => panic!("Method not supported"),
        }
    }
}

impl MethodExt for &str {
    #[inline]
    /// Create a request builder with this method
    fn has(self) -> RequestBuilder {
        match self {
            "GET" | "get" => Request::builder(Method::GET),
            "POST" | "post" => Request::builder(Method::POST),
            "PUT" | "put" => Request::builder(Method::PUT),
            "DELETE" | "delete" => Request::builder(Method::DELETE),
            "PATCH" | "patch" => Request::builder(Method::PATCH),
            "HEAD" | "head" => Request::builder(Method::HEAD),
            "OPTIONS" | "options" => Request::builder(Method::OPTIONS),
            _ => panic!("Method not supported"),
        }
    }
}

/// Builder for creating actual HTTP requests to be matched against mocks
pub struct ActualRequestBuilder {
    path: String,
    method: Method,
    headers: HeaderMap,
    query_params: HashMap<String, String>,
    body: String,
}

impl ActualRequestBuilder {
    #[inline]
    /// Set the path for this request
    pub fn path(mut self, path: &str) -> Self {
        self.path = path.to_string();
        self
    }

    #[inline]
    /// Set the method for this request
    pub fn method(mut self, method: Method) -> Self {
        self.method = method;
        self
    }

    #[inline]
    /// Set the headers for this request
    pub fn headers(mut self, headers: HeaderMap) -> Self {
        self.headers = headers;
        self
    }

    #[inline]
    /// Set the query parameters for this request
    pub fn query_params(mut self, query_params: HashMap<String, String>) -> Self {
        self.query_params = query_params;
        self
    }

    #[inline]
    /// Set the body for this request
    pub fn body(mut self, body: &str) -> Self {
        self.body = body.to_string();
        self
    }

    #[inline]
    /// Build the actual request
    pub fn build(self) -> ActualRequest {
        ActualRequest {
            path: self.path,
            method: self.method,
            headers: self.headers,
            query_params: self.query_params,
            body: self.body,
        }
    }
}

/// Represents an actual HTTP request that will be matched against mocks
pub struct ActualRequest {
    path: String,
    method: Method,
    headers: HeaderMap,
    query_params: HashMap<String, String>,
    body: String,
}

impl ActualRequest {
    #[inline]
    /// Create a new actual request builder
    pub fn builder() -> ActualRequestBuilder {
        ActualRequestBuilder {
            path: String::new(),
            method: Method::GET,
            headers: HeaderMap::new(),
            query_params: HashMap::new(),
            body: String::new(),
        }
    }

    #[inline]
    /// Get the path
    pub fn path(&self) -> &str {
        &self.path
    }

    #[inline]
    /// Get the method
    pub fn method(&self) -> &Method {
        &self.method
    }

    #[inline]
    /// Get the headers
    pub fn headers(&self) -> &HeaderMap {
        &self.headers
    }

    #[inline]
    /// Get the query params
    pub fn query_params(&self) -> &HashMap<String, String> {
        &self.query_params
    }

    #[inline]
    /// Get the body
    pub fn body(&self) -> &str {
        &self.body
    }
}

/// Builder for creating mock requests
pub struct RequestBuilder {
    path: String,
    method: Method,
    headers: HeaderMap,
    query_params: HashMap<String, String>,
    body: Bytes,
}

impl RequestBuilder {
    #[inline]
    /// Set the path for this request
    pub fn path(mut self, path: &str) -> Self {
        self.path = path.to_string();
        self
    }

    #[inline]
    /// Set the method for this request
    pub fn method(mut self, method: Method) -> Self {
        self.method = method;
        self
    }

    #[inline]
    /// Set the headers for this request
    pub fn headers(mut self, headers: HeaderMap) -> Self {
        self.headers = headers;
        self
    }

    #[inline]
    /// Set the query parameters for this request
    pub fn query_params(mut self, query_params: HashMap<String, String>) -> Self {
        self.query_params = query_params;
        self
    }

    #[inline]
    /// Set the body for this request
    pub fn body(mut self, body: &[u8]) -> Self {
        self.body = Bytes::from(body.to_vec());
        self
    }

    #[inline]
    /// Set the response for this request
    pub fn will_return(self, respond: Respond) -> Request {
        Request {
            path: self.path,
            method: self.method,
            headers: self.headers,
            query_params: self.query_params,
            body: self.body,
            respond,
        }
    }
}

/// Represents a mock HTTP request
pub struct Request {
    path: String,
    method: Method,
    headers: HeaderMap,
    query_params: HashMap<String, String>,
    body: Bytes,
    respond: Respond,
}

impl Request {
    #[inline]
    /// Create a new request builder
    pub fn builder(method: Method) -> RequestBuilder {
        RequestBuilder {
            path: String::new(),
            method,
            headers: HeaderMap::new(),
            query_params: HashMap::new(),
            body: Bytes::new(),
        }
    }

    #[inline]
    /// Get the path
    pub fn path(&self) -> &str {
        &self.path
    }

    #[inline]
    /// Get the method
    pub fn method(&self) -> &Method {
        &self.method
    }

    #[inline]
    /// Get the query params
    pub fn query_params(&self) -> &HashMap<String, String> {
        &self.query_params
    }

    #[inline]
    /// Get the body
    pub fn body(&self) -> &Bytes {
        &self.body
    }

    #[inline]
    /// Get the headers
    pub fn headers(&self) -> &HeaderMap {
        &self.headers
    }

    #[inline]
    /// Get the respond
    pub fn respond(&self) -> &Respond {
        &self.respond
    }
}

/// Builder for what represents a response for a request
pub struct RespondBuilder {
    status_code: StatusCode,
    headers: HashMap<String, String>,
}

impl RespondBuilder {
    #[inline]
    /// Set the status code for this response
    pub fn with_status(mut self, status: StatusCode) -> Self {
        self.status_code = status;
        self
    }

    #[inline]
    /// Set a header for this response
    pub fn with_header(mut self, key: &str, value: &str) -> Self {
        self.headers
            .insert(key.to_string(), value.to_string());
        self
    }

    #[inline]
    /// Set multiple headers for this response
    pub fn with_headers(mut self, entries: &[(&str, &str)]) -> Self {
        for (key, value) in entries {
            self.headers
                .insert(key.to_string(), value.to_string());
        }
        self
    }

    #[inline]
    /// Create an empty response
    pub fn empty(self) -> Respond {
        self.no_body()
    }

    #[inline]
    /// Create a response with no body
    pub fn no_body(self) -> Respond {
        Respond { status_code: self.status_code, headers: self.headers, body: Bytes::new() }
    }

    #[inline]
    /// Create a response with a body
    pub fn with_body(self, body: &[u8]) -> Respond {
        Respond {
            status_code: self.status_code,
            headers: self.headers,
            body: Bytes::from(body.to_vec()),
        }
    }
}

/// Represents how to respond for a request
pub struct Respond {
    status_code: StatusCode,
    headers: HashMap<String, String>,
    body: Bytes,
}

impl Respond {
    /// Initialize respond builder
    #[inline]
    /// Initialize respond builder
    pub fn builder() -> RespondBuilder {
        RespondBuilder { status_code: StatusCode::OK, headers: HashMap::new() }
    }

    #[inline]
    /// Get the status code
    pub fn status_code(&self) -> StatusCode {
        self.status_code
    }

    #[inline]
    /// Get the headers
    pub fn headers(&self) -> HashMap<String, String> {
        self.headers.clone()
    }

    #[inline]
    /// Get the body
    pub fn body(&self) -> Bytes {
        self.body.clone()
    }
}