Skip to content

feat: update to gotham 0.5 #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sat0yu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: update to gotham 0.5 #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ description = "A small crate to add basic CORS functionality to Gotham apps"
repository = "https://github.com/simpleweb/gotham-cors-middleware"
readme = "./README.md"
license = "MIT OR Apache-2.0"
edition = "2018"

[dependencies]
futures = "0.1"
gotham = "0.2"
gotham_derive = "0.2"
hyper = "0.11"
futures = "0.3"
gotham = "0.5"
gotham_derive = "0.5"
unicase = "2.1"

[dev-dependencies]
Expand Down
217 changes: 124 additions & 93 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,21 @@
#[macro_use]
extern crate gotham_derive;

extern crate futures;
extern crate gotham;
extern crate hyper;
extern crate unicase;

use futures::Future;
use gotham::handler::HandlerFuture;
use gotham::middleware::Middleware;
use gotham::state::{FromState, State};
use hyper::header::{
AccessControlAllowCredentials, AccessControlAllowHeaders, AccessControlAllowMethods,
AccessControlAllowOrigin, AccessControlMaxAge, Headers, Origin,
use futures::prelude::*;
use gotham::{
handler::HandlerFuture,
hyper::{
header::{
HeaderMap, HeaderValue, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS,
ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_MAX_AGE,
AUTHORIZATION, CONTENT_TYPE, ORIGIN,
},
Method,
},
middleware::Middleware,
state::{FromState, State},
};
use hyper::Method;
use std::option::Option;
use unicase::Ascii;
use std::{option::Option, pin::Pin};

/// Struct to perform the necessary CORS
/// functionality needed. Allows some
Expand Down Expand Up @@ -73,17 +72,16 @@ impl CORSMiddleware {
/// ```rust
/// extern crate gotham;
/// extern crate gotham_cors_middleware;
/// extern crate hyper;
///
/// use gotham::pipeline::new_pipeline;
/// use gotham::{
/// pipeline::{new_pipeline, single::single_pipeline},
/// router::{Router, builder::*},
/// hyper::Method,
/// };
/// use gotham_cors_middleware::CORSMiddleware;
/// use gotham::pipeline::single::single_pipeline;
/// use gotham::router::builder::*;
/// use gotham::router::Router;
/// use hyper::Method;
///
/// fn create_custom_middleware() -> CORSMiddleware {
/// let methods = vec![Method::Delete, Method::Get, Method::Head, Method::Options];
/// let methods = vec![Method::DELETE, Method::GET, Method::HEAD, Method::OPTIONS];
///
/// let max_age = 1000;
///
Expand Down Expand Up @@ -120,13 +118,13 @@ impl CORSMiddleware {
/// values, use the new() function.
pub fn default() -> CORSMiddleware {
let methods = vec![
Method::Delete,
Method::Get,
Method::Head,
Method::Options,
Method::Patch,
Method::Post,
Method::Put,
Method::DELETE,
Method::GET,
Method::HEAD,
Method::OPTIONS,
Method::PATCH,
Method::POST,
Method::PUT,
];

let origin = None;
Expand All @@ -137,42 +135,63 @@ impl CORSMiddleware {
}

impl Middleware for CORSMiddleware {
fn call<Chain>(self, state: State, chain: Chain) -> Box<HandlerFuture>
fn call<Chain>(self, state: State, chain: Chain) -> Pin<Box<HandlerFuture>>
where
Chain: FnOnce(State) -> Box<HandlerFuture>,
Chain: FnOnce(State) -> Pin<Box<HandlerFuture>>,
{
let settings = self.clone();
let f = chain(state).map(|(state, response)| {
let origin: String;
if settings.origin.is_none() {
let origin_raw = Headers::borrow_from(&state).get::<Origin>().clone();
let ori = match origin_raw {
Some(o) => o.to_string(),
None => "*".to_string(),
};

origin = ori;
} else {
origin = settings.origin.unwrap();
let f = chain(state).and_then(|(state, mut response)| {
let origin = match self.origin {
Some(o) => o,
None => {
let origin_raw = HeaderMap::borrow_from(&state).get(ORIGIN).clone();
match origin_raw {
Some(o) => o.to_str().unwrap().to_string(),
None => "*".to_string(),
}
}
};

let mut headers = Headers::new();

headers.set(AccessControlAllowCredentials);
headers.set(AccessControlAllowHeaders(vec![
Ascii::new("Authorization".to_string()),
Ascii::new("Content-Type".to_string()),
]));
headers.set(AccessControlAllowOrigin::Value(origin));
headers.set(AccessControlAllowMethods(settings.methods));
headers.set(AccessControlMaxAge(settings.max_age));

let res = response.with_headers(headers);

(state, res)
let methods = self
.methods
.iter()
.map(|m| String::from(m.as_str()))
.collect::<Vec<String>>()
.join(", ");

let headers = vec![AUTHORIZATION, CONTENT_TYPE]
.iter()
.map(|m| String::from(m.as_str()))
.collect::<Vec<String>>()
.join(", ");

response.headers_mut().insert(
ACCESS_CONTROL_ALLOW_CREDENTIALS,
HeaderValue::from_str("true").unwrap(),
);

response.headers_mut().insert(
ACCESS_CONTROL_ALLOW_ORIGIN,
HeaderValue::from_str(&origin).unwrap(),
);

response.headers_mut().insert(
ACCESS_CONTROL_ALLOW_HEADERS,
HeaderValue::from_str(&headers).unwrap(),
);

response.headers_mut().insert(
ACCESS_CONTROL_ALLOW_METHODS,
HeaderValue::from_str(&methods).unwrap(),
);

response
.headers_mut()
.insert(ACCESS_CONTROL_MAX_AGE, HeaderValue::from(self.max_age));

future::ok((state, response))
});

Box::new(f)
f.boxed()
}
}

Expand All @@ -182,41 +201,37 @@ mod tests {

use super::*;

use futures::future;
use gotham::http::response::create_response;
use gotham::pipeline::new_pipeline;
use gotham::pipeline::single::single_pipeline;
use gotham::router::builder::*;
use gotham::router::Router;
use gotham::test::TestServer;
use hyper::Method::Options;
use hyper::StatusCode;
use hyper::{Get, Head};
use gotham::{
handler::IntoResponse,
helpers::http::response::create_response,
hyper::{Method, StatusCode},
pipeline::{new_pipeline, single::single_pipeline},
router::{builder::*, Router},
test::TestServer,
};

// Since we cannot construct 'State' ourselves, we need to test via an 'actual' app
fn handler(state: State) -> Box<HandlerFuture> {
fn handler(state: State) -> (State, impl IntoResponse) {
let body = "Hello World".to_string();

let response = create_response(
&state,
StatusCode::Ok,
Some((body.into_bytes(), mime::TEXT_PLAIN)),
);
let response = create_response(&state, StatusCode::OK, mime::TEXT_PLAIN, body.into_bytes());

Box::new(future::ok((state, response)))
(state, response)
}

fn default_router() -> Router {
let (chain, pipeline) =
single_pipeline(new_pipeline().add(CORSMiddleware::default()).build());

build_router(chain, pipeline, |route| {
route.request(vec![Get, Head, Options], "/").to(handler);
route
.request(vec![Method::GET, Method::HEAD, Method::OPTIONS], "/")
.to(handler);
})
}

fn custom_router() -> Router {
let methods = vec![Method::Delete, Method::Get, Method::Head, Method::Options];
let methods = vec![Method::DELETE, Method::GET, Method::HEAD, Method::OPTIONS];

let max_age = 1000;

Expand All @@ -229,7 +244,9 @@ mod tests {
);

build_router(chain, pipeline, |route| {
route.request(vec![Get, Head, Options], "/").to(handler);
route
.request(vec![Method::GET, Method::HEAD, Method::OPTIONS], "/")
.to(handler);
})
}

Expand All @@ -243,17 +260,24 @@ mod tests {
.perform()
.unwrap();

assert_eq!(response.status(), StatusCode::Ok);
assert_eq!(response.status(), StatusCode::OK);
let headers = response.headers();
assert_eq!(
headers
.get::<AccessControlAllowOrigin>()
.get(ACCESS_CONTROL_ALLOW_ORIGIN)
.unwrap()
.to_str()
.unwrap()
.to_string(),
"*".to_string()
);
assert_eq!(
headers.get::<AccessControlMaxAge>().unwrap().to_string(),
headers
.get(ACCESS_CONTROL_MAX_AGE)
.unwrap()
.to_str()
.unwrap()
.to_string(),
"86400".to_string()
);
}
Expand All @@ -268,24 +292,31 @@ mod tests {
.perform()
.unwrap();

assert_eq!(response.status(), StatusCode::Ok);
assert_eq!(response.status(), StatusCode::OK);
let headers = response.headers();
assert_eq!(
headers
.get::<AccessControlAllowOrigin>()
.get(ACCESS_CONTROL_ALLOW_ORIGIN)
.unwrap()
.to_str()
.unwrap()
.to_string(),
"http://www.example.com".to_string()
);
assert_eq!(
headers.get::<AccessControlMaxAge>().unwrap().to_string(),
headers
.get(ACCESS_CONTROL_MAX_AGE)
.unwrap()
.to_str()
.unwrap()
.to_string(),
"1000".to_string()
);
}

#[test]
fn test_new_cors_middleware() {
let methods = vec![Method::Delete, Method::Get, Method::Head, Method::Options];
let methods = vec![Method::DELETE, Method::GET, Method::HEAD, Method::OPTIONS];

let max_age = 1000;

Expand All @@ -306,13 +337,13 @@ mod tests {
fn test_default_cors_middleware() {
let test = CORSMiddleware::default();
let methods = vec![
Method::Delete,
Method::Get,
Method::Head,
Method::Options,
Method::Patch,
Method::Post,
Method::Put,
Method::DELETE,
Method::GET,
Method::HEAD,
Method::OPTIONS,
Method::PATCH,
Method::POST,
Method::PUT,
];

assert_eq!(test.methods, methods);
Expand Down