feat: ic-kit-http

.gitignore

@@ -1,10 +1,5 @@
-/target
-
-
-# Added by cargo
-#
-# already existing elements were commented out
-
-#/target
+target/
 Cargo.lock
-.dfx
+.dfx
+*.old*
+.idea/

Cargo.toml

@@ -1,18 +1,20 @@
 [workspace]
 members = [
-    "e2e",
+    "examples/hello",
     "examples/counter",
     "examples/factory_counter",
     "examples/fib",
     "examples/multi_counter",
     "examples/naming_system",
+    "examples/pastebin",
     "ic-kit",
     "ic-kit-certified",
     "ic-kit-macros",
     "ic-kit-management",
     "ic-kit-runtime",
     "ic-kit-stable",
     "ic-kit-sys",
+    "ic-kit-http",
 ]
 
 [profile.canister-release]

dfx.json

@@ -1,6 +1,12 @@
 {
   "version": 1,
+  "dfx": "0.11.1",
   "canisters": {
+    "hello": {
+      "candid": "examples/hello/candid.did",
+      "package": "ic_kit_example_hello",
+      "type": "rust"
+    },
     "counter": {
       "candid": "examples/counter/candid.did",
       "package": "ic_kit_example_counter",
@@ -15,6 +21,11 @@
       "candid": "examples/naming_system/candid.did",
       "package": "naming_system",
       "type": "rust"
+    },
+    "pastebin": {
+      "candid": "examples/pastebin/candid.did",
+      "package": "ic_kit_example_pastebin",
+      "type": "rust"
     }
   },
   "networks": {

examples/README.md

@@ -4,5 +4,25 @@ This directory contains some example canister's implemented using the IC Kit. Ea
 to be as simple as possible to demonstrate one aspect of the IC Kit and a possible design pattern
 you can also use to develop canisters.
 
+Hello World:
+
+- [Hello](hello/): A simple canister that returns a greeting.
+
 Simple State Manipulation:
-- Counter
+
+- [Counter](counter/): A simple canister that allows incrementing and decrementing a counter.
+
+Inter Canister Communication:
+
+- [Multi Counter](multi_counter/): A canister that allows incrementing and decrementing a counter
+  that is stored in separate canisters.
+
+Child Canister Creation:
+
+- [Factory Counter](factory_counter/): A canister that allows incrementing and decrementing a counter
+  that is stored in separate canisters that are created on demand.
+
+Inbound HTTP Server:
+
+- [Pastebin](pastebin/): A canister that allows storing and retrieving unencrypted text snippets through http routing.
+  Also features a simple canister generated frontend, that serves plaintext or html depending on the request client.

examples/counter/Cargo.toml

@@ -6,7 +6,9 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-ic-kit = {path="../../ic-kit"}
+# With the `http` feature enabled, and no configured routes, the canister will provide status info at the index path.
+ic-kit = { path = "../../ic-kit" }
+
 
 [[bin]]
 name = "ic_kit_example_counter"

examples/hello/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "ic_kit_example_hello"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+# With the `http` feature enabled, and no configured routes, the canister will provide status info at the index path.
+ic-kit = { path = "../../ic-kit", features = ["http"] }
+
+[[bin]]
+name = "ic_kit_example_hello"
+path = "src/main.rs"

examples/hello/candid.did

@@ -0,0 +1 @@
+service : { hello : () -> (text) query }

examples/hello/src/canister.rs

@@ -0,0 +1,13 @@
+use ic_kit::prelude::*;
+
+#[query]
+fn hello() -> String {
+    "Hello, World!".to_string()
+}
+
+// When the http feature is enabled, the `http_request` function is generated, with a single index route.
+// This index route returns the balance of the canister in cycles, in JSON.
+
+#[derive(KitCanister)]
+#[candid_path("candid.did")]
+struct HelloCanister;

examples/hello/src/lib.rs

@@ -0,0 +1 @@
+pub mod canister;

examples/hello/src/main.rs

@@ -0,0 +1,3 @@
+mod canister;
+
+fn main() {}

examples/pastebin/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "ic_kit_example_pastebin"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+ic-kit = {path="../../ic-kit", features = ["http"]}
+tinytemplate = "1.1"
+serde = { version = "1.0", features = ["derive"] }
+
+[[bin]]
+name = "ic_kit_example_pastebin"
+path = "src/main.rs"

examples/pastebin/README.md

@@ -0,0 +1,23 @@
+# IC Pastebin
+
+This directory contains an example HTTP canister implemented using the IC Kit. It is a simple HTTP pastebin that allows you to store and retrieve text.
+
+## How to use
+
+1. Build and deploy the canister:
+    ```bash
+    dfx deploy pastebin
+    ```
+2. View the canister's HTML UI at `http://rrkah-fqaaa-aaaaa-aaaaq-cai.localhost:8000/`
+3. View the canister's manpage:
+    ```bash
+    curl rrkah-fqaaa-aaaaa-aaaaq-cai.localhost:8000
+    ```
+5. upload some text:
+    ```bash
+    curl -T file.txt rrkah-fqaaa-aaaaa-aaaaq-cai.localhost:8000
+    ```
+5. download some text:
+    ```bash
+    curl rrkah-fqaaa-aaaaa-aaaaq-cai.localhost:8000/file.txt
+    ```

examples/pastebin/candid.did

@@ -0,0 +1 @@
+service : {}

examples/pastebin/src/canister.rs

@@ -0,0 +1,115 @@
+use std::collections::HashMap;
+
+use serde::Serialize;
+use tinytemplate::TinyTemplate;
+
+use ic_kit::prelude::*;
+
+pub type Data = HashMap<String, Vec<u8>>;
+
+#[derive(Serialize)]
+struct HtmlContext {
+    manpage: String,
+}
+
+#[derive(Serialize)]
+struct ManpageContext {
+    url: String,
+}
+
+static HTML_TEMPLATE: &str = r#"
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>IC Pastebin</title>
+        <style>
+            body \{
+                background: #1e1e1e;
+                color: #d4d4d4;
+            \}
+        </style>
+    </head>
+    <body>
+        <pre>
+            <code>
+{manpage}
+            </code>
+        </pre>
+    </body>
+</html>
+"#;
+
+static MANPAGE_TEMPLATE: &str = r#"
+IC PASTEBIN(1)                      IC PASTEBIN                       IC PASTEBIN(1)
+
+NAME
+
+        ic-pastebin - HTTP pastebin canister for the Internet Computer 
+
+DESCRIPTION
+
+        The ic-pastebin canister is a simple pastebin canister that allows users to
+        upload text and get a URL to share it with others.
+
+        The canister is written in Rust and uses the ic-kit library to provide
+        access to the Internet Computer.
+
+USAGE
+
+        curl -T file.txt {url}
+        curl {url}/file.txt
+"#;
+
+/// Index handler
+#[get(route = "/")]
+fn index_handler(r: HttpRequest, _: Params) -> HttpResponse {
+    ic::print(format!("{:?}", r));
+    let url = match r.header("host") {
+        Some(host) => format!("http://{}", host),
+        None => format!("https://{}.raw.ic0.app", id()),
+    };
+
+    let mut tt = TinyTemplate::new();
+
+    tt.add_template("manpage", MANPAGE_TEMPLATE).unwrap();
+    let manpage = tt.render("manpage", &ManpageContext { url }).unwrap();
+
+    // Just return the manpage if client is a terminal (curl or wget)
+    if let Some(ua) = r.header("User-Agent") {
+        if ua.starts_with("curl") || ua.starts_with("wget") {
+            return HttpResponse::ok().body(manpage);
+        }
+    }
+
+    tt.add_template("html", HTML_TEMPLATE).unwrap();
+    let html = tt.render("html", &HtmlContext { manpage }).unwrap();
+
+    HttpResponse::ok().body(html)
+}
+
+/// Get paste handler
+#[get(route = "/:file")]
+fn get_file_handler(data: &Data, _: HttpRequest, p: Params) -> HttpResponse {
+    let file = p.get("file").unwrap();
+    match data.get(file) {
+        Some(content) => HttpResponse::ok().body(content.clone()),
+        None => HttpResponse::new(404).body(format!("file not found `{}`\n", file)),
+    }
+}
+
+/// Upload paste handler
+#[put(route = "/:file", upgrade = true)]
+fn put_file_handler(data: &mut Data, req: HttpRequest, p: Params) -> HttpResponse {
+    let filename = p.get("file").unwrap();
+    let host = req.header("host").unwrap_or("unknown");
+
+    let res = format!("{}/{}", host, filename);
+
+    data.insert(filename.to_string(), req.body);
+
+    HttpResponse::ok().body(res)
+}
+
+#[derive(KitCanister)]
+#[candid_path("candid.did")]
+pub struct PastebinCanister;

examples/pastebin/src/lib.rs

@@ -0,0 +1,2 @@
+pub mod canister;
+pub use canister::PastebinCanister;

examples/pastebin/src/main.rs

@@ -0,0 +1,3 @@
+mod canister;
+
+fn main() {}

ic-kit-certified/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ic-kit-certified"
-version = "0.1.0-alpha.0"
+version = "0.1.0-alpha.1"
 edition = "2018"
 description = "Certified variable friendly data structures for the Internet Computer."
 authors = ["Parsa Ghadimi <i@parsa.ooo>", "Ossian Mapes <oz@fleek.co>"]
@@ -14,11 +14,11 @@ keywords = ["internet-computer", "canister", "fleek", "psychedelic"]
 include = ["src", "Cargo.toml", "README.md"]
 
 [dependencies]
-ic-kit-stable = {path="../ic-kit-stable"}
-ic-types = "0.4.1"
-candid = "0.7"
+ic-kit-stable = { path = "../ic-kit-stable" }
+ic-types = "0.6"
+candid = "0.8"
 sha2 = "0.10.2"
-serde = { version="1.0.116", features = ["derive"] }
+serde = { version = "1.0.116", features = ["derive"] }
 serde_bytes = "0.11.5"
 serde_cbor = "0.11.2"
 hex = "0.4.3"

ic-kit-http/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "ic-kit-http"
+version = "0.1.0-alpha.2"
+edition = "2021"
+authors = ["Ossian Mapes <oz@fleek.co>", "Parsa Ghadimi <i@parsa.ooo>"]
+description = "IC-Kit's macros for canister development"
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/Psychedelic/ic-kit"
+documentation = "https://docs.rs/ic-kit-http"
+homepage = "https://sly.ooo"
+categories = ["api-bindings"]
+keywords = ["internet-computer", "canister", "fleek", "psychedelic"]
+include = ["src", "Cargo.toml", "README.md"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+ic-kit-macros = { path = "../ic-kit-macros", features = ["http"], version = "0.2.0-alpha.0" }
+candid = "0.8"
+serde = "1.0"
+matchit = "0.6.0"
+lazy_static = "1.4"

ic-kit-http/README.md

@@ -0,0 +1,3 @@
+# Ic Kit Http
+
+Types and macro export for canister http routing