Init 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

.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
+json-response.iml
+
+# End of https://www.gitignore.io/api/rust,macos

Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "json-response"
+version = "1.0.0"
+description = "A utility library to send JSON response."
+homepage = "https://github.com/routerify/json-response"
+repository = "https://github.com/routerify/json-response"
+keywords = ["routerify", "hyper-rs", "json", "response"]
+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"
+
+[dev-dependencies]
+tokio = { version = "0.2", features = ["full"] }
+stream-body = "0.1"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Boilerplato
+
+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,32 @@
+[![Github Actions Status](https://github.com/routerify/json-response/workflows/Test/badge.svg)](https://github.com/routerify/json-response/actions)
+[![crates.io](https://img.shields.io/crates/v/json-response.svg)](https://crates.io/crates/json-response)
+[![Documentation](https://docs.rs/json-response/badge.svg)](https://docs.rs/json-response)
+[![MIT](https://img.shields.io/crates/l/json-response.svg)](./LICENSE)
+
+# json-response
+
+A utility library to send JSON response.
+
+[Docs](https://docs.rs/json-response)
+
+## Usage
+
+First add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+json-response = "1.0"
+```
+
+An example:
+```rust
+use json_response;
+
+fn main() {
+  println!("{}", json_response::add(2, 3));
+}
+```
+
+## Contributing
+
+Your PRs and suggestions are always welcome.

examples/test.rs

@@ -0,0 +1,5 @@
+use json_response;
+
+fn main() {
+    println!("{}", json_response::add(2, 3));
+}

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/json-response/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/lib.rs

@@ -0,0 +1,117 @@
+//! An utility library to send JSON response.
+//!
+//! # Examples
+//!
+//! ```
+//! use json_response;
+//!
+//! # fn run() {
+//! println!("{}", json_response::add(2, 3));
+//! # }
+//! # run();
+//! ```
+
+use crate::prelude::*;
+use http::StatusCode;
+use hyper::{header, Body, Response};
+use serde::Serialize;
+
+pub struct JsonResponse<T = ()>
+where
+    T: Serialize,
+{
+    inner: Inner<T>,
+}
+
+enum Inner<T> {
+    Success(SuccessData<T>),
+    Error(ErrorData),
+}
+
+#[derive(Serialize, Debug, Clone)]
+#[serde(rename_all = "camelCase")]
+struct SuccessData<T> {
+    status: Status,
+    code: u16,
+    data: T,
+}
+
+#[derive(Serialize, Debug, Clone)]
+#[serde(rename_all = "camelCase")]
+struct ErrorData {
+    status: Status,
+    code: u16,
+    message: String,
+}
+
+#[derive(Serialize, Debug, Clone)]
+enum Status {
+    #[serde(rename = "Success")]
+    SUCCESS,
+    #[serde(rename = "Failed")]
+    FAILED,
+}
+
+impl<T: Serialize> JsonResponse<T> {
+    pub fn with_success(code: StatusCode, data: T) -> Self {
+        JsonResponse {
+            inner: Inner::Success(SuccessData {
+                status: Status::SUCCESS,
+                code: code.as_u16(),
+                data,
+            }),
+        }
+    }
+}
+
+impl JsonResponse<()> {
+    pub fn with_error<M: Into<String>>(code: StatusCode, message: M) -> Self {
+        JsonResponse {
+            inner: Inner::Error(ErrorData {
+                status: Status::FAILED,
+                code: code.as_u16(),
+                message: message.into(),
+            }),
+        }
+    }
+
+    pub fn with_error_include_code<M: Into<String>>(code: StatusCode, message: M) -> Self {
+        Self::with_error(
+            code,
+            format!("{}: {}", code.canonical_reason().unwrap(), message.into()),
+        )
+    }
+
+    pub fn with_error_code(code: StatusCode) -> Self {
+        Self::with_error(code, code.canonical_reason().unwrap().to_owned())
+    }
+}
+
+impl<T: Serialize> JsonResponse<T> {
+    pub fn into_response(self) -> crate::Result<Response<Body>> {
+        let code;
+        let body;
+
+        match self.inner {
+            Inner::Success(success_data) => {
+                code = success_data.code;
+                body = Body::from(
+                    serde_json::to_vec(&success_data)
+                        .context("JsonResponse: Failed to convert success data to JSON")?,
+                );
+            }
+            Inner::Error(err_data) => {
+                code = err_data.code;
+                body = Body::from(
+                    serde_json::to_vec(&err_data).context("JsonResponse: Failed to convert error data to JSON")?,
+                );
+            }
+        }
+
+        Ok(Response::builder()
+            .status(StatusCode::from_u16(code).unwrap())
+            .header(header::CONTENT_TYPE, "application/json; charset=utf-8")
+            .body(body)
+            .context("JsonResponse: Failed to create a response")?)
+    }
+}

tusk.yml

@@ -0,0 +1,19 @@
+options:
+  version:
+    usage: The next release version
+    short: v
+    required: true
+tasks:
+  setup:
+    run:
+      - command: cargo install cargo-watch
+      - command: cargo install releez
+  dev:
+    run:
+      - command: cargo watch --watch ./src --watch ./examples/test.rs -x 'run --example test'
+  doc:
+    run:
+      - command: cargo watch -x "doc --open"
+  release:
+    run:
+      - command: releez "${version}"