Merge pull request #52 from obsidian-rs/develop

Version 0.2
obsidian-rs · Apr 23, 2020 · aa0df97 · aa0df97
2 parents c264450 + b104305
commit aa0df97
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 13 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -20,15 +20,25 @@ path = 'examples/app_state.rs'
 
 [package]
 name = 'obsidian'
-version = '0.2.0-alpha.1'
+version = '0.2.0'
 authors = [
     'Gan Jun Kai <[email protected]>',
     'Wai Pai Lee <[email protected]>',
 ]
 edition = '2018'
-description = 'A Rust framework'
+description = 'Ergonomic async http framework for amazing, reliable and efficient web'
+readme = "README.md"
+homepage = "https://obsidian-rs.github.io"
 repository = 'https://github.com/obsidian-rs/obsidian'
 license = 'MIT'
+keywords = [
+    'obsidian',
+    'async',
+    'http',
+    'web',
+    'framework'
+]
+categories = ["asynchronous", "web-programming::http-server", "network-programming"]
 
 [dependencies]
 hyper = '0.13.1'

diff --git a/README.md b/README.md
@@ -15,15 +15,16 @@
     </a>
 </div>
 
-<p align="center"><strong>Obsidian</strong> is a Rust web framework with a vision to make Rust web development fun.</p>
+<p align="center"><strong>Obsidian</strong> is an ergonomic Rust async http framework for reliable and efficient web.</p>
 
 ## Hello World
+
 ```rust
 use obsidian::App;
 
 #[tokio::main]
 async fn main() {
-    let mut app = App::new();
+    let mut app: App = App::new();
     let addr = ([127, 0, 0, 1], 3000).into();
 
     app.get("/", |ctx: Context| async { ctx.build("Hello World").ok() });
@@ -37,6 +38,7 @@ async fn main() {
 ```
 
 ## Hello World (with handler function)
+
 ```rust
 use obsidian::{context::Context, App, ContextResult};
 
@@ -47,7 +49,7 @@ async fn hello_world(ctx: Context) -> ContextResult {
 
 #[tokio::main]
 async fn main() {
-    let mut app = App::new();
+    let mut app: App = App::new();
     let addr = ([127, 0, 0, 1], 3000).into();
 
     app.get("/", hello_world);
@@ -60,6 +62,7 @@ async fn main() {
 ```
 
 ## JSON Response
+
 ```rust
 use obsidian::{context::Context, App, ContextResult};
 use serde::*;
@@ -103,4 +106,4 @@ cargo run --example example
 
 ## Current State
 
-NOT READY FOR PRODUCTION!
+NOT READY FOR PRODUCTION YET!
diff --git a/examples/main.rs b/examples/main.rs
@@ -83,13 +83,11 @@ ctx.build(Response::ok().html("<!DOCTYPE html><html><head><link rel=\"shotcut ic
     app.get("/json", |ctx: Context| async {
         let point = Point { x: 1, y: 2 };
 
-        ctx.build(
-            Response::created()
-                .set_header(header::AUTHORIZATION, "token")
-                .set_header_str("X-Custom-Header", "Custom header value")
-                .json(point),
-        )
-        .ok()
+        ctx.build_json(point)
+            .with_status(StatusCode::OK)
+            .with_header(header::AUTHORIZATION, "token")
+            .with_header_str("X-Custom-Header", "Custom header value")
+            .ok()
     });
 
     app.get("/json-with-headers", |ctx: Context| async {

diff --git a/src/context.rs b/src/context.rs
@@ -341,16 +341,24 @@ impl ResponseBuilder {
         ResponseBuilder { ctx, response }
     }
 
+    /// set http status code for response
     pub fn with_status(mut self, status: StatusCode) -> Self {
         self.response = self.response.set_status(status);
         self
     }
 
+    /// set http header for response
     pub fn with_header(mut self, key: HeaderName, value: &'static str) -> Self {
         self.response = self.response.set_header(key, value);
         self
     }
 
+    /// set custom http header for response with `&str` key
+    pub fn with_header_str(mut self, key: &'static str, value: &'static str) -> Self {
+        self.response = self.response.set_header_str(key, value);
+        self
+    }
+
     pub fn with_headers(mut self, headers: Vec<(HeaderName, &'static str)>) -> Self {
         self.response = self.response.set_headers(headers);
         self