Initial setup

Author: rousan

.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 --features="all"

.gitignore

@@ -0,0 +1,49 @@
+# 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/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+### Others ###
+.halt.releez.yml
+.idea
+routerify-websocket.iml
+
+# End of https://www.gitignore.io/api/rust,macos

Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "routerify-websocket"
+version = "0.1.0"
+description = "An websocket extension for Routerify."
+homepage = "https://github.com/routerify/routerify-websocket"
+repository = "https://github.com/routerify/routerify-websocket"
+keywords = ["routerify", "hyper-rs", "hyper", "websocket", "ws"]
+categories = ["asynchronous","web-programming","web-programming::http-server"]
+authors = ["Rousan Ali <[email protected]>"]
+readme = "README.md"
+license = "MIT"
+edition = "2018"
+
+[package.metadata.docs.rs]
+all-features = true
+
+[package.metadata.playground]
+features = ["all"]
+
+[features]
+default = []
+all = []
+
+[dependencies]
+log = "0.4"
+derive_more = "0.99"
+routerify = "1.1"
+hyper = "0.13"
+tokio-tungstenite = { version = "0.10", default-features = false, optional = true }
+headers = { version = "0.3", optional = true }
+futures = { version = "0.3", default-features = false, optional = true }
+tokio = { version = "0.2", features = ["rt-core"],  optional = true}
+
+[dev-dependencies]
+tokio = { version = "0.2", features = ["full"] }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+[![Github Actions Status](https://github.com/routerify/routerify-websocket/workflows/Test/badge.svg)](https://github.com/routerify/routerify-websocket/actions)
+[![crates.io](https://img.shields.io/crates/v/routerify-websocket.svg)](https://crates.io/crates/routerify-websocket)
+[![Documentation](https://docs.rs/routerify-websocket/badge.svg)](https://docs.rs/routerify-websocket)
+[![MIT](https://img.shields.io/crates/l/routerify-websocket.svg)](./LICENSE)
+
+# routerify-websocket
+
+An websocket extension for Routerify.
+
+[Docs](https://docs.rs/routerify-websocket)
+
+## Install
+
+Add this to your `Cargo.toml` file:
+
+```toml
+[dependencies]
+routerify = "1.1"
+routerify-websocket = "0.1.0"
+```
+
+## Example
+
+```rust
+use routerify_websocket;
+
+fn main() {
+  println!("{}", routerify_websocket::add(2, 3));
+}
+```
+
+## Contributing
+
+Your PRs and suggestions are always welcome.

examples/test.rs

@@ -0,0 +1,37 @@
+use hyper::{Body, Request, Response, Server};
+use routerify::prelude::*;
+use routerify::{Middleware, Router, RouterService};
+use std::{convert::Infallible, net::SocketAddr};
+
+async fn ws_handler(_: Request<Body>) -> Result<Response<Body>, Infallible> {
+    Ok(Response::new(Body::from("ws handler")))
+}
+
+async fn logger(req: Request<Body>) -> Result<Request<Body>, Infallible> {
+    println!("{} {} {}", req.remote_addr(), req.method(), req.uri().path());
+    Ok(req)
+}
+
+fn router() -> Router<Body, Infallible> {
+    Router::builder()
+        .middleware(Middleware::pre(logger))
+        .get("/ws/connect", ws_handler)
+        .build()
+        .unwrap()
+}
+
+#[tokio::main]
+async fn main() {
+    let router = router();
+
+    let service = RouterService::new(router).unwrap();
+
+    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);
+    }
+}

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 --features="all"
+  - name: Run tests
+    type: auto
+    run:
+      - cargo test --release --features="all"
+  - 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-websocket/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

rustfmt.toml

@@ -0,0 +1,2 @@
+max_width = 120
+tab_spaces = 4

src/error.rs

@@ -0,0 +1,39 @@
+use derive_more::Display;
+use std::fmt::{self, Debug, Display, Formatter};
+
+type BoxError = Box<dyn std::error::Error + Send + Sync>;
+
+#[derive(Display)]
+#[display(fmt = "routerify-websocket: {}")]
+pub enum Error {
+    /// Something wrong happened.
+    #[display(fmt = "Something wrong happened: {}", _0)]
+    SomethingWrong(BoxError),
+
+    /// Something wrong happened again.
+    #[display(fmt = "Something wrong happened again: {}", data)]
+    SomethingWrongAgain { data: String },
+
+    /// Some other wrong happened.
+    #[display(fmt = "Some other wrong happened")]
+    DifferentOne,
+
+    #[doc(hidden)]
+    __Nonexhaustive,
+}
+
+impl Debug for Error {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        Display::fmt(self, f)
+    }
+}
+
+impl std::error::Error for Error {}
+
+impl PartialEq for Error {
+    fn eq(&self, other: &Self) -> bool {
+        self.to_string().eq(&other.to_string())
+    }
+}
+
+impl Eq for Error {}

src/lib.rs

@@ -0,0 +1,31 @@
+//! An websocket extension for Routerify.
+//!
+//! # Examples
+//!
+//! ```
+//! use routerify_websocket;
+//!
+//! # fn run() {
+//! println!("{}", routerify_websocket::add(2, 3));
+//! # }
+//! # run();
+//! ```
+
+pub use self::error::Error;
+
+mod error;
+
+/// This function adds two numbers.
+pub fn add(a: i32, b: i32) -> i32 {
+    a + b
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_add() {
+        assert_eq!(add(2, 2), 4);
+    }
+}