improve examples

thewh1teagle · May 6, 2024 · fda07d0 · fda07d0
1 parent 8d04eaf
commit fda07d0
Show file tree

Hide file tree

Showing 24 changed files with 69 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 target/
 Cargo.lock
 __pycache__
-*.pyc
+*.pyc
+node_modules/
diff --git a/BUILDING.md b/BUILDING.md
@@ -25,5 +25,5 @@ python3 -m venv venv
 source venv/bin/activate
 # Install dependencies + build + install
 # May take sometime on first use
-pip3 install . 
-```
+pip3 install .
+```
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,10 +1,4 @@
 [workspace]
-members = [
-  "rookie-rs",
-  "bindings/python",
-  "bindings/node",
-  "cli",
-  "rookie-rs/examples/*",
-]
+members = ["rookie-rs", "bindings/python", "bindings/node", "cli"]
 default-members = ["rookie-rs", "bindings/python"]
 resolver = "2"
diff --git a/README.md b/README.md
@@ -63,16 +63,22 @@ for (const cookie of cookies) {
 
 ## Examples 📋
 
-`Python` [examples](https://github.com/thewh1teagle/rookie/tree/main/examples)
+`Python` [examples/python](examples/python)
 
-`Rust` [rookie-rs/examples](https://github.com/thewh1teagle/rookie/tree/main/rookie-rs/examples)
+`JavaScript` [examples/javascript](examples/python)
+
+`Rust` [examples/rust](examples/rust)
 
 ## Docs 📘
 
 `Python`
 
 - [docs/Python.md](docs/Python.md)
 
+`JavaScript`
+
+- [docs/JavaScript.md][docs/JavaScript.md]
+
 `Rust`
 
 - [docs/Rust.md](docs/Rust.md)

diff --git a/bindings/node/.yarn/releases/yarn-4.2.1.cjs b/bindings/node/.yarn/releases/yarn-4.2.1.cjs
diff --git a/docs/JavaScript.md b/docs/JavaScript.md
@@ -0,0 +1,14 @@
+# Rookie JavaScript Docs
+
+## Install
+
+```typescript
+npm install @rookie/api
+```
+
+## Basic Usage
+
+```js
+import { brave } from "@rookie/api";
+const cookies = brave();
+```
diff --git a/examples/javascript/fetch.js b/examples/javascript/fetch.js
@@ -0,0 +1,25 @@
+import rookie from "@rookie-rs/api";
+
+function createHeaders() {
+  // Get all Github cookies from Brave browser
+  const cookies = rookie.brave(["github.com"]);
+  // Create cookie header
+  const cookie = cookies
+    .map((c) => decodeURIComponent(`${c.name}=${c.value}`))
+    .join(";");
+  const userAgent =
+    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36";
+  return {
+    "User-Agent": userAgent,
+    Cookie: cookie,
+  };
+}
+
+const headers = createHeaders();
+const res = await fetch("https://github.com/settings/profile", { headers });
+const html = await res.text();
+// Parse username from HTML
+const username =
+  html.match(/<a href="\/(.+)" class="btn.+>/)?.[1] ??
+  `Not Logged In. Response URL: ${res.url}`;
+console.log(`Github username: ${username}`);
diff --git a/examples/javascript/package.json b/examples/javascript/package.json
@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "dependencies": {
+    "@rookie-rs/api": "^0.0.1-beta.4"
+  }
+}
diff --git a/examples/javascript/simple.js b/examples/javascript/simple.js
@@ -0,0 +1,5 @@
+import rookie from "@rookie-rs/api";
+
+for (const cookie of rookie.brave()) {
+  console.log(cookie);
+}
diff --git a/examples/all_example.py → examples/python/all_example.py b/examples/all_example.py → examples/python/all_example.py
diff --git a/examples/cookiejar_example.py → examples/python/cookiejar_example.py b/examples/cookiejar_example.py → examples/python/cookiejar_example.py
diff --git a/examples/custom_path.py → examples/python/custom_path.py b/examples/custom_path.py → examples/python/custom_path.py
diff --git a/examples/dict_example.py → examples/python/dict_example.py b/examples/dict_example.py → examples/python/dict_example.py
diff --git a/examples/http_example.py → examples/python/http_example.py b/examples/http_example.py → examples/python/http_example.py
diff --git a/examples/requests_session.py → examples/python/requests_session.py b/examples/requests_session.py → examples/python/requests_session.py
diff --git a/examples/python/requirements.txt b/examples/python/requirements.txt
@@ -0,0 +1 @@
+rookiepy
diff --git a/examples/with_logging.py → examples/python/with_logging.py b/examples/with_logging.py → examples/python/with_logging.py
diff --git a/rookie-rs/examples/http/Cargo.toml → examples/rust/http/Cargo.toml b/rookie-rs/examples/http/Cargo.toml → examples/rust/http/Cargo.toml
diff --git a/rookie-rs/examples/http/src/main.rs → examples/rust/http/src/main.rs b/rookie-rs/examples/http/src/main.rs → examples/rust/http/src/main.rs
diff --git a/rookie-rs/examples/logging/Cargo.toml → examples/rust/logging/Cargo.toml b/rookie-rs/examples/logging/Cargo.toml → examples/rust/logging/Cargo.toml
diff --git a/rookie-rs/examples/logging/README.md → examples/rust/logging/README.md b/rookie-rs/examples/logging/README.md → examples/rust/logging/README.md
diff --git a/rookie-rs/examples/logging/src/main.rs → examples/rust/logging/src/main.rs b/rookie-rs/examples/logging/src/main.rs → examples/rust/logging/src/main.rs
diff --git a/rookie-rs/examples/simple.rs → examples/rust/simple.rs b/rookie-rs/examples/simple.rs → examples/rust/simple.rs
diff --git a/rookie-rs/Cargo.toml b/rookie-rs/Cargo.toml
@@ -59,3 +59,7 @@ windows = { version = "0.51", features = [
     "Win32_System",
     "Win32_System_RestartManager",
 ] }
+
+[[example]]
+name = "simple"
+path = "../examples/rust/simple.rs"