Add parser

rousan · rousan · commit ce8ca8fe1751 · 2020-05-02T19:31:27.000+05:30
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,16 @@
+name: Test
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run tests
+        run: cargo test --verbose
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,35 @@
+# Created by https://www.gitignore.io/api/rust,macos
+# Edit at https://www.gitignore.io/?templates=rust,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Rust ###
 # Generated by Cargo
 # will have compiled files and executables
 /target/
@@ -8,3 +40,10 @@ Cargo.lock
 
 # These are backup files generated by rustfmt
 **/*.rs.bk
+
+### Others ###
+.halt.releez.yml
+/.idea
+routerify-query.iml
+
+# End of https://www.gitignore.io/api/rust,macos
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,21 @@
+[package]
+name = "routerify-query"
+version = "1.0.0"
+description = "A Routerify middleware which parses the request query string."
+homepage = "https://github.com/routerify/routerify-query"
+repository = "https://github.com/routerify/routerify-query"
+keywords = ["routerify", "hyper-rs", "middleware", "querystring"]
+categories = ["asynchronous", "web-programming", "web-programming::http-server"]
+authors = ["Rousan Ali <hello@rousan.io>"]
+readme = "README.md"
+license = "MIT"
+edition = "2018"
+
+[dependencies]
+routerify = "1.0"
+hyper = "0.13"
+url = "2.1"
+
+[dev-dependencies]
+tokio = { version = "0.2", features = ["full"] }
+stream-body = "0.1"
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Routerify
+Copyright (c) 2020 Rousan Ali
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,2 +1,74 @@
+[![Github Actions Status](https://github.com/routerify/routerify-query/workflows/Test/badge.svg)](https://github.com/routerify/routerify-query/actions)
+[![crates.io](https://img.shields.io/crates/v/routerify-query.svg)](https://crates.io/crates/routerify-query)
+[![Documentation](https://docs.rs/routerify-query/badge.svg)](https://docs.rs/routerify-query)
+[![MIT](https://img.shields.io/crates/l/routerify-query.svg)](./LICENSE)
+
 # routerify-query
-A pre middleware which parses the request query
+
+A [`Routerify`](https://github.com/routerify/routerify) middleware which parses the request query string and populates in the `req` object.
+
+[Docs](https://docs.rs/routerify-query)
+
+## Usage
+
+First add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+routerify = "1.0"
+routerify-query = "1.0.0"
+```
+
+An example:
+```rust
+use hyper::{Body, Request, Response, Server};
+use routerify::{Router, RouterService};
+// Import the query_parser function and the RequestQueryExt trait.
+use routerify_query::{query_parser, RequestQueryExt};
+use std::{convert::Infallible, net::SocketAddr};
+
+// A handler for "/" page. Visit: "/?username=Alice&bookname=HarryPotter" to see query values.
+async fn home_handler(req: Request<Body>) -> Result<Response<Body>, Infallible> {
+    // Access the query values.
+    let user_name = req.query("username").unwrap();
+    let book_name = req.query("bookname").unwrap();
+
+    Ok(Response::new(Body::from(format!(
+        "User: {}, Book: {}",
+        user_name, book_name
+    ))))
+}
+
+// Create a router.
+fn router() -> Router<Body, Infallible> {
+    Router::builder()
+        // Attach the query_parser middleware.
+        .middleware(query_parser())
+        .get("/", home_handler)
+        .build()
+        .unwrap()
+}
+
+#[tokio::main]
+async fn main() {
+    let router = router();
+
+    // Create a Service from the router above to handle incoming requests.
+    let service = RouterService::new(router);
+
+    // The address on which the server will be listening.
+    let addr = SocketAddr::from(([127, 0, 0, 1], 3001));
+
+    // Create a server by passing the created service to `.serve` method.
+    let server = Server::bind(&addr).serve(service);
+
+    println!("App is running on: {}", addr);
+    if let Err(err) = server.await {
+        eprintln!("Server error: {}", err);
+    }
+}
+```
+
+## Contributing
+
+Your PRs and suggestions are always welcome.
diff --git a/examples/example.rs b/examples/example.rs
@@ -0,0 +1,46 @@
+use hyper::{Body, Request, Response, Server};
+use routerify::{Router, RouterService};
+// Import the query_parser function and the RequestQueryExt trait.
+use routerify_query::{query_parser, RequestQueryExt};
+use std::{convert::Infallible, net::SocketAddr};
+
+// A handler for "/" page. Visit: "/?username=Alice&bookname=HarryPotter" to see query values.
+async fn home_handler(req: Request<Body>) -> Result<Response<Body>, Infallible> {
+    // Access the query values.
+    let user_name = req.query("username").unwrap();
+    let book_name = req.query("bookname").unwrap();
+
+    Ok(Response::new(Body::from(format!(
+        "User: {}, Book: {}",
+        user_name, book_name
+    ))))
+}
+
+// Create a router.
+fn router() -> Router<Body, Infallible> {
+    Router::builder()
+        // Attach the query_parser middleware.
+        .middleware(query_parser())
+        .get("/", home_handler)
+        .build()
+        .unwrap()
+}
+
+#[tokio::main]
+async fn main() {
+    let router = router();
+
+    // Create a Service from the router above to handle incoming requests.
+    let service = RouterService::new(router);
+
+    // The address on which the server will be listening.
+    let addr = SocketAddr::from(([127, 0, 0, 1], 3001));
+
+    // Create a server by passing the created service to `.serve` method.
+    let server = Server::bind(&addr).serve(service);
+
+    println!("App is running on: {}", addr);
+    if let Err(err) = server.await {
+        eprintln!("Server error: {}", err);
+    }
+}
diff --git a/examples/test.rs b/examples/test.rs
@@ -0,0 +1,35 @@
+use hyper::{Body, Request, Response, Server};
+use routerify::{Router, RouterService};
+use routerify_query::{query_parser, RequestQueryExt};
+use std::{convert::Infallible, net::SocketAddr};
+
+async fn home_handler(req: Request<Body>) -> Result<Response<Body>, Infallible> {
+    let q = req.query("bookname");
+    dbg!(q);
+
+    Ok(Response::new(Body::from("Home page")))
+}
+
+fn router() -> Router<Body, Infallible> {
+    Router::builder()
+        .middleware(query_parser())
+        .get("/", home_handler)
+        .build()
+        .unwrap()
+}
+
+#[tokio::main]
+async fn main() {
+    let router = router();
+
+    let service = RouterService::new(router);
+
+    let addr = SocketAddr::from(([127, 0, 0, 1], 3001));
+
+    let server = Server::bind(&addr).serve(service);
+
+    println!("App is running on: {}", addr);
+    if let Err(err) = server.await {
+        eprintln!("Server error: {}", err);
+    }
+}
diff --git a/examples/test_stream_body.rs b/examples/test_stream_body.rs
@@ -0,0 +1,43 @@
+use hyper::{Body as HyperBody, Request, Response, Server};
+use routerify::{Router, RouterService};
+use routerify_query::{query_parser, RequestQueryExt};
+use std::{convert::Infallible, net::SocketAddr};
+use stream_body::StreamBody;
+
+async fn home_handler(req: Request<HyperBody>) -> Result<Response<StreamBody>, Infallible> {
+    dbg!(req.queries());
+    dbg!(req.query("name"));
+    dbg!(req.query("bookName"));
+
+    Ok(Response::new(StreamBody::from("Home page")))
+}
+
+fn router() -> Router<StreamBody, Infallible> {
+    Router::builder()
+        .middleware(query_parser())
+        .get("/", home_handler)
+        .options(
+            "/*",
+            |_req| async move { Ok(Response::new(StreamBody::from("Options"))) },
+        )
+        .any(|_req| async move { Ok(Response::new(StreamBody::from("Not Found"))) })
+        .err_handler(|err| async move { Response::new(StreamBody::from(format!("Error: {}", err))) })
+        .build()
+        .unwrap()
+}
+
+#[tokio::main]
+async fn main() {
+    let router = router();
+
+    let service = RouterService::new(router);
+
+    let addr = SocketAddr::from(([127, 0, 0, 1], 3001));
+
+    let server = Server::bind(&addr).serve(service);
+
+    println!("App is running on: {}", addr);
+    if let Err(err) = server.await {
+        eprintln!("Server error: {}", err);
+    }
+}
diff --git a/releez.yml b/releez.yml
@@ -0,0 +1,53 @@
+version: 1.0.0
+checklist:
+  - name: Checkout develop and sync with remote
+    type: auto
+    run:
+      - git checkout develop
+      - git push
+  - name: Check syntax
+    type: auto
+    run:
+      - cargo check --release
+  - name: Run tests
+    type: auto
+    run:
+      - cargo test --release
+  - name: Start a new release branch
+    type: auto
+    run:
+      - git flow release start "v${VERSION}"
+  - name: Make sure code is formatted
+    type: auto
+    run:
+      - cargo fmt
+  - name: Bump version
+    type: manual
+    instructions:
+      - Please update version with ${VERSION} in Cargo.toml file.
+      - Please update version with ${VERSION} in README.md file if needed.
+  - name: Commit changes
+    type: auto
+    run:
+      - git add --all && git commit -m "Bump version"
+  - name: Finish release branch
+    type: auto
+    run:
+      - git flow release finish -s "v${VERSION}"
+  - name: Push branches and tags to Github
+    type: auto
+    run:
+      - git checkout master
+      - git push origin master
+      - git push origin develop
+      - git push --tags
+  - name: Edit tag on Github
+    type: manual
+    instructions:
+      - Tag is pushed to Github(https://github.com/routerify/routerify-query/releases). Edit it there and make it a release.
+  - name: Publish to crates.io
+    type: auto
+    confirm: Are you sure to publish it to crates.io?
+    run:
+      - cargo publish
+      - git checkout develop
diff --git a/rustfmt.toml b/rustfmt.toml
@@ -0,0 +1,2 @@
+max_width = 120
+tab_spaces = 4
diff --git a/src/ext.rs b/src/ext.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/tusk.yml b/tusk.yml
