Middleware-based compression and decompression (#194)

Middleware-based compression and decompression

Author: fairingrey

.travis.yml

@@ -6,8 +6,8 @@ before_script: |
   rustup component add rustfmt clippy
 script: |
   cargo fmt --all -- --check &&
-  cargo clippy --all -- -D clippy::all &&
+  cargo clippy --all --all-features -- -D clippy::all &&
   cargo build --no-default-features --verbose &&
-  cargo build --all --verbose &&
-  cargo test  --all --verbose
+  cargo build --all --all-features --verbose &&
+  cargo test --all --all-features --verbose
 cache: cargo

Cargo.toml

@@ -1,6 +1,7 @@
 [workspace]
 members = [
     "tide",
+    "tide-compression",
     "examples",
 ]
 

tide-compression/Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+authors = [
+    "Tide Developers",
+]
+description = "Compression-related middleware for Tide"
+documentation = "https://docs.rs/tide-compression"
+keywords = ["tide", "web", "async", "middleware", "compression"]
+categories = ["network-programming", "compression", "asynchronous"]
+edition = "2018"
+license = "MIT OR Apache-2.0"
+name = "tide-compression"
+readme = "README.md"
+repository = "https://github.com/rustasync/tide"
+version = "0.1.0"
+
+[dependencies]
+tide = { path = "../tide" }
+accept-encoding = "0.2.0-alpha.2"
+bytes = "0.4.12"
+futures-preview = "0.3.0-alpha.16"
+http = "0.1"
+http-service = "0.2.0"
+
+[dependencies.async-compression]
+default-features = false
+features = ["stream", "gzip", "zlib", "brotli", "zstd"]
+version = "0.1.0-alpha.1"
+
+[dev-dependencies]
+http-service-mock = "0.2.0"

tide-compression/README.md

@@ -0,0 +1,16 @@
+# tide-compression
+
+This crate provides compression-related middleware for Tide.
+
+## Examples
+
+Examples are in the `/examples` folder of this crate.
+
+__Simple Example__
+
+You can test the simple example by running `cargo run --example simple` while in this crate's directory, and then running either of the following commands:
+
+```console
+$ curl http://127.0.0.1:8000/ -v
+$ echo 'why hello there' | gzip | curl -v --compressed -H 'Content-Encoding: gzip' 'http://127.0.0.1:8000/echo' --data-binary @-
+```

tide-compression/examples/simple.rs

@@ -0,0 +1,22 @@
+#![feature(async_await)]
+use tide::{App, Context};
+use tide_compression::{Compression, Decompression, Encoding};
+
+// Returns a portion of the lorem ipsum text.
+async fn lorem_ipsum(_cx: Context<()>) -> String {
+    String::from("Lorem ipsum dolor sit amet, consectetur adipiscing elit.")
+}
+
+// Echoes the request body in bytes.
+async fn echo_bytes(mut cx: Context<()>) -> Vec<u8> {
+    cx.body_bytes().await.unwrap()
+}
+
+pub fn main() {
+    let mut app = App::new();
+    app.at("/").get(lorem_ipsum);
+    app.at("/echo").post(echo_bytes);
+    app.middleware(Compression::with_default(Encoding::Brotli));
+    app.middleware(Decompression::new());
+    app.run("127.0.0.1:8000").unwrap();
+}