luminal-handler 0.0.5

Slightly more convenient API on top of hyper::server::Service
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

//! This create wraps `hyper::server::Service` with a slightly more convenient interface.
//!
//! The request is wrapped with a new enum that helps provide additional information along with the
//! request and uses a more liberal error type to allow users to map their own error to an actual
//! http response.
extern crate futures;
extern crate http;
extern crate hyper;

use futures::future::{self, Future};
use hyper::Body;
use hyper::server::{Request, Response, Service};

// A convenience alias.
pub type LuminalFuture = Box<Future<Item = Response, Error = hyper::Error>>;

/// Trait for handling a request, returning either a success `Response` or an error `Response`.
pub trait Handler {
    fn handle(&self, req: http::Request<Body>) -> Result<LuminalFuture, Response>;
}

/// An impl of `hyper::Service` that consumes an impl of `Handler`.
pub struct HandlerService<H: Handler> {
    handler: H,
}

impl<H: Handler> HandlerService<H> {
    pub fn new(handler: H) -> Self {
        HandlerService { handler }
    }
}

impl<H: Handler> Service for HandlerService<H> {
    type Request = Request;
    type Response = Response;
    type Error = hyper::Error;
    type Future = LuminalFuture;

    /// Dispatches to the owned `Handler`, marshalling success or error into the response.
    fn call(&self, request: Request) -> Self::Future {
        match self.handler.handle(request.into()) {
            Ok(response) => response,
            Err(error) => Box::new(future::ok(error)),
        }
    }
}

/// Accepts a function or closure that takes an `HttpRequest` and returns a compatible `Result`.
pub fn handler_fn<F>(func: F) -> HandlerFn<F>
where
    F: Fn(http::Request<Body>) -> Result<LuminalFuture, Response>,
{
    HandlerFn { func }
}

/// Holds a function to dispatch to via its impl of `Handler<E>`.
pub struct HandlerFn<F>
where
    F: Fn(http::Request<Body>) -> Result<LuminalFuture, Response>,
{
    func: F,
}

impl<F> Handler for HandlerFn<F>
where
    F: Fn(http::Request<Body>) -> Result<LuminalFuture, Response>,
{
    fn handle(&self, req: http::Request<Body>) -> Result<LuminalFuture, Response> {
        (self.func)(req)
    }
}

#[cfg(test)]
mod tests {
    extern crate tokio_core;

    use futures::Stream;
    use hyper::Method;
    use hyper::{Body, StatusCode};

    use self::tokio_core::reactor::Core;

    use super::*;

    enum TestHandler {
        Success(String),
        Failure(String),
    }

    impl Handler for TestHandler {
        fn handle(&self, _request: http::Request<Body>) -> Result<LuminalFuture, Response> {
            match *self {
                TestHandler::Success(ref body) => {
                    let body: String = body.clone();
                    Ok(Box::new(futures::future::ok(
                        Response::new().with_status(StatusCode::Ok).with_body(body),
                    )))
                }
                TestHandler::Failure(ref error) => {
                    let body: String = error.clone();
                    Err(Response::new()
                        .with_status(StatusCode::InternalServerError)
                        .with_body(body))
                }
            }
        }
    }

    fn test_fn(_req: http::Request<Body>) -> Result<LuminalFuture, Response> {
        Ok(Box::new(futures::future::ok(
            Response::new()
                .with_status(StatusCode::Ok)
                .with_body(String::from("test")),
        )))
    }

    #[test]
    fn test_success() {
        let handler = TestHandler::Success(String::from("Success"));
        let service = HandlerService::new(handler);

        assert_call(&service, Method::Get, "/foo", (&StatusCode::Ok, "Success"));
    }

    #[test]
    fn test_failure() {
        let handler = TestHandler::Failure(String::from("Error"));
        let service = HandlerService::new(handler);

        assert_call(
            &service,
            Method::Get,
            "/foo",
            (&StatusCode::InternalServerError, "Error"),
        );
    }

    #[test]
    fn test_handler_fn() {
        let handler = handler_fn(test_fn);
        let service = HandlerService::new(handler);

        assert_call(&service, Method::Get, "/foo", (&StatusCode::Ok, "test"));
    }

    fn assert_call<H>(
        service: &HandlerService<H>,
        method: Method,
        uri: &str,
        expected: (&StatusCode, &str),
    ) where
        H: Handler,
    {
        let uri = uri.parse()
            .expect("Should have been able to convert to uri");
        let req: Request<Body> = Request::new(method, uri);

        let work = service.call(req);

        let mut core = Core::new().expect("Should have been able to create core");

        let response = core.run(work)
            .expect("Should have been able to run router call");

        assert_eq!(
            *expected.0,
            response.status(),
            "Should have received {} status.",
            expected.0
        );

        let body = core.run(response.body().concat2())
            .expect("Should have been able to resolve body concat");
        let body: &[u8] = &body.to_vec();

        assert_eq!(
            expected.1.as_bytes(),
            body,
            "Should have received correct body content"
        );
    }
}