Feature/better error

README.md

@@ -22,6 +22,14 @@
   <img alt="Obsidian serve" src="./screenshot/serve.png" >
 </div>
 
+## Get Started
+```toml
+[dependencies]
+# add these 2 dependencies in Cargo.toml file
+obsidian = "0.2.2"
+tokio = "0.2.21"
+```
+
 ## Hello World
 
 ```rust
@@ -30,44 +38,32 @@ use obsidian::{context::Context, App};
 #[tokio::main]
 async fn main() {
     let mut app: App = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
-
     app.get("/", |ctx: Context| async { ctx.build("Hello World").ok() });
-
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    }).await;
+    app.listen(3000).await;
 }
 ```
 
 ## Hello World (with handler function)
 
 ```rust
-use obsidian::{context::Context, App, ContextResult};
+use obsidian::{context::Context, handler::ContextResult, App};
 
 async fn hello_world(ctx: Context) -> ContextResult {
     ctx.build("Hello World").ok()
 }
 
-
 #[tokio::main]
 async fn main() {
     let mut app: App = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
-
     app.get("/", hello_world);
-
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    })
-    .await;
+    app.listen(3000).await;
 }
 ```
 
 ## JSON Response
 
 ```rust
-use obsidian::{context::Context, App, ContextResult};
+use obsidian::{context::Context, handler::ContextResult, App};
 use serde::*;
 
 async fn get_user(ctx: Context) -> ContextResult {
@@ -85,28 +81,33 @@ async fn get_user(ctx: Context) -> ContextResult {
 #[tokio::main]
 async fn main() {
     let mut app: App = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
-
     app.get("/user", get_user);
-
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    })
-    .await;
+    app.listen(3000).await;
 }
 
 ```
 
-## Example Files
+## More Examples
 
-Example are located in `example/main.rs`.
+Examples are located in `example` folder. You can run these examples by using:
+```bash
+cargo run --example [name]
 
-## Run Example
+// show a list of available examples
+cargo run --example 
 
-```
+// run the example
 cargo run --example example
 ```
 
+## App Lifecycle
+![app lifecycle](./screenshot/lifecycle.png)
+
+## Contributors
+<a href="https://github.com/obsidian-rs/obsidian/graphs/contributors">
+  <img src="https://contributors-img.web.app/image?repo=obsidian-rs/obsidian" />
+</a>
+
 ## Current State
 
-NOT READY FOR PRODUCTION YET!
+Under active development and **NOT READY FOR PRODUCTION YET!**

examples/app_state.rs

@@ -1,4 +1,4 @@
-use obsidian::{context::Context, App, ObsidianError};
+use obsidian::{context::Context, App};
 
 #[derive(Clone)]
 pub struct AppState {
@@ -8,21 +8,20 @@ pub struct AppState {
 #[tokio::main]
 async fn main() {
     let mut app: App<AppState> = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
 
     app.set_app_state(AppState {
-        db_connection_string: "localhost:1433".to_string()
+        db_connection_string: "localhost:1433".to_string(),
     });
 
-    app.get("/", |ctx: Context| async { 
-        let app_state = ctx.get::<AppState>().ok_or(ObsidianError::NoneError)?;
-        let res = Some(format!("connection string: {}", &app_state.db_connection_string));
+    app.get("/", |ctx: Context| async move {
+        let app_state = ctx.get::<AppState>().unwrap();
+        let res = Some(format!(
+            "connection string: {}",
+            &app_state.db_connection_string
+        ));
 
-        ctx.build(res).ok() 
+        res
     });
 
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    })
-    .await;
+    app.listen(3000).await;
 }

examples/hello.rs

@@ -3,12 +3,8 @@ use obsidian::{context::Context, App};
 #[tokio::main]
 async fn main() {
     let mut app: App = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
 
-    app.get("/", |ctx: Context| async { ctx.build("Hello World").ok() });
+    app.get("/", |_ctx: Context| async { "Hello, Obsidian!" });
 
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    })
-    .await;
+    app.listen(3000).await;
 }

examples/hello_handler.rs

@@ -1,18 +1,15 @@
-use obsidian::{context::Context, App, ContextResult};
+use obsidian::{context::Context, handler::ContextResult, App};
 
+// this is handler function
 async fn hello_world(ctx: Context) -> ContextResult {
     ctx.build("Hello World").ok()
 }
 
 #[tokio::main]
 async fn main() {
     let mut app: App = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
 
     app.get("/", hello_world);
 
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    })
-    .await;
+    app.listen(3000).await;
 }

examples/json.rs

@@ -1,27 +1,28 @@
-use obsidian::{context::Context, App, ContextResult};
+use obsidian::{context::Context, handler::ContextResult, router::Response, App};
 use serde::*;
 
-async fn get_user(ctx: Context) -> ContextResult {
-    #[derive(Serialize, Deserialize)]
+async fn get_user(mut ctx: Context) -> ContextResult {
+    #[derive(Serialize, Deserialize, Debug)]
     struct User {
         name: String,
     };
 
-    let user = User {
-        name: String::from("Obsidian"),
+    #[derive(Serialize, Deserialize, Debug)]
+    struct UserParam {
+        name: String,
+        age: i8,
     };
-    ctx.build_json(user).ok()
+
+    let user: UserParam = ctx.json().await?;
+
+    Ok(Response::ok().json(user))
 }
 
 #[tokio::main]
 async fn main() {
-    let mut app: App = App::new();
-    let addr = ([127, 0, 0, 1], 3000).into();
+    let mut app: App = App::default();
 
     app.get("/user", get_user);
 
-    app.listen(&addr, || {
-        println!("server is listening to {}", &addr);
-    })
-    .await;
+    app.listen(3000).await;
 }

examples/main.rs

@@ -7,7 +7,7 @@ use std::{fmt, fmt::Display};
 use obsidian::{
     context::Context,
     router::{header, Responder, Response, Router},
-    App, ObsidianError, StatusCode,
+    App, StatusCode,
 };
 
 // Testing example
@@ -66,20 +66,18 @@ impl Display for JsonTest {
 //         .header("X-Custom-Header", "custom-value")
 //         .header("X-Custom-Header-2", "custom-value-2")
 //         .header("X-Custom-Header-3", "custom-value-3")
-//         .set_headers(headers)
-//         .status(StatusCode::CREATED)
+//         .set_headers(headers) .status(StatusCode::CREATED)
 // }
 
 #[tokio::main]
 async fn main() {
     let mut app: App = App::default();
-    let addr = ([127, 0, 0, 1], 3000).into();
 
-    app.get("/", |ctx: Context| async {
+    app.get("/", |ctx: Context| async move {
 ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut icon\" href=\"favicon.ico\" type=\"image/x-icon\" sizes=\"32x32\" /></head> <h1>Hello Obsidian</h1></html>")).ok()
     });
 
-    app.get("/json", |ctx: Context| async {
+    app.get("/json", |ctx: Context| async move {
         let point = Point { x: 1, y: 2 };
 
         ctx.build_json(point)
@@ -89,7 +87,7 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
             .ok()
     });
 
-    app.get("/user", |mut ctx: Context| async {
+    app.get("/user", |mut ctx: Context| async move {
         #[derive(Serialize, Deserialize, Debug)]
         struct QueryString {
             id: String,
@@ -112,11 +110,11 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
         ctx.build("").ok()
     });
 
-    app.patch("/patch-here", |ctx: Context| async {
+    app.patch("/patch-here", |ctx: Context| async move {
         ctx.build("Here is patch request").ok()
     });
 
-    app.get("/json-with-headers", |ctx: Context| async {
+    app.get("/json-with-headers", |ctx: Context| async move {
         let point = Point { x: 1, y: 2 };
 
         let custom_headers = vec![
@@ -139,7 +137,7 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
         .ok()
     });
 
-    app.get("/string-with-headers", |ctx: Context| async {
+    app.get("/string-with-headers", |ctx: Context| async move {
         let custom_headers = vec![
             ("X-Custom-Header-1", "Custom header 1"),
             ("X-Custom-Header-2", "Custom header 2"),
@@ -157,37 +155,37 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
             .ok()
     });
 
-    app.get("/empty-body", |ctx: Context| async {
+    app.get("/empty-body", |ctx: Context| async move {
         ctx.build(StatusCode::OK).ok()
     });
 
-    app.get("/vec", |ctx: Context| async {
+    app.get("/vec", |ctx: Context| async move {
         ctx.build(vec![1, 2, 3])
             .with_status(StatusCode::CREATED)
             .ok()
     });
 
-    app.get("/String", |ctx: Context| async {
+    app.get("/String", |ctx: Context| async move {
         ctx.build("<h1>This is a String</h1>".to_string()).ok()
     });
 
-    app.get("/test/radix", |ctx: Context| async {
+    app.get("/test/radix", |ctx: Context| async move {
         ctx.build("<h1>Test radix</h1>".to_string()).ok()
     });
 
-    app.get("/team/radix", |ctx: Context| async {
+    app.get("/team/radix", |ctx: Context| async move {
         ctx.build("Team radix".to_string()).ok()
     });
 
-    app.get("/test/radix2", |ctx: Context| async {
+    app.get("/test/radix2", |ctx: Context| async move {
         ctx.build("<h1>Test radix2</h1>".to_string()).ok()
     });
 
-    app.get("/jsontest", |ctx: Context| async {
+    app.get("/jsontest", |ctx: Context| async move {
         ctx.build_file("./testjson.html").await.ok()
     });
 
-    app.get("/jsan", |ctx: Context| async {
+    app.get("/jsan", |ctx: Context| async move {
         ctx.build("<h1>jsan</h1>".to_string()).ok()
     });
 
@@ -202,10 +200,7 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
     });
 
     app.get("router/test", |ctx: Context| async move {
-        let result = ctx
-            .extensions()
-            .get::<LoggerExampleData>()
-            .ok_or(ObsidianError::NoneError)?;
+        let result = ctx.extensions().get::<LoggerExampleData>().unwrap();
 
         dbg!(&result.0);
 
@@ -300,11 +295,11 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
     app.use_service(logger_example);
 
     app.scope("params", |router: &mut Router| {
-        router.get("/test-next-wild/*", |ctx: Context| async {
+        router.get("/test-next-wild/*", |ctx: Context| async move {
             ctx.build("<h1>test next wild</h1>".to_string()).ok()
         });
 
-        router.get("/*", |ctx: Context| async {
+        router.get("/*", |ctx: Context| async move {
             ctx.build(
                 "<h1>404 Not Found</h1>"
                     .to_string()
@@ -316,5 +311,5 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
 
     app.use_static_to("/files/", "/assets/");
 
-    app.listen(&addr, || {}).await;
+    app.listen(3000).await
 }

examples/middleware/logger_example.rs

@@ -3,7 +3,9 @@ use async_trait::async_trait;
 #[cfg(debug_assertions)]
 use colored::*;
 
-use obsidian::{context::Context, middleware::Middleware, ContextResult, EndpointExecutor};
+use obsidian::{
+    context::Context, handler::ContextResult, middleware::Middleware, EndpointExecutor,
+};
 
 #[derive(Default)]
 pub struct LoggerExample {}