Merge pull request #38 from ewang2002/refactor/no-default-term

refactor: add support for multiple tasks situation

.github/workflows/rust.yml

@@ -10,8 +10,8 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
-    name: Compilation/Style/Tests
+  build_default:
+    name: Compilation/Style/Tests (Default)
     runs-on: ubuntu-latest
 
     steps:
@@ -24,3 +24,18 @@ jobs:
       run: cargo clippy
     - name: Format
       run: cargo fmt --check
+
+  build_multi:
+    name: Compilation/Style/Tests (Multi)
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build
+        run: cargo build --features multi --verbose
+      - name: Run All Tests
+        run: cargo test --features multi --verbose
+      - name: Clippy
+        run: cargo clippy --features multi
+      - name: Format
+        run: cargo fmt --check

.gitignore

@@ -1,4 +1,5 @@
 /target
+/examples/**/target
 Cargo.lock
 /.idea
 cookie.txt

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "webweg"
-version = "0.8.0"
+version = "0.9.0"
 edition = "2021"
 description = "An asynchronous API wrapper for UCSD's WebReg course enrollment system."
 readme = "README.md"
@@ -13,8 +13,13 @@ keywords = ["ucsd", "webreg", "enrollment"]
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 reqwest = "0.11.0"
-url = "2.2.2"
+url = "2.4"
 thiserror = "1.0"
+parking_lot = { version = "0.12", optional = true }
 
 [dev-dependencies]
-tokio = { version = "1.17.0", features = ["macros"] }
+tokio = { version = "1.17.0", features = ["macros"] }
+
+[features]
+default = []
+multi = ["parking_lot"]

README.md

@@ -36,6 +36,8 @@ You're also able to do things like:
 
 To see some examples, check out the `examples` folder.
 
+## Crate Features
+An optional feature that can be enabled is the `multi` feature. By default, the wrapper will assume an environment with a single thread or task. So, if you want to be able to share an instance of the wrapper across multiple threads or tasks, you would have to use a `Mutex`. The problem with using a `Mutex` is that if a request is taking a long time (which isn't unusual), the entire wrapper is locked until the 
 
 ## Authentication
 

examples/enroll-in-classes/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "enroll-in-classes"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+webweg = { path = "../.." }
+tokio = { version = "1.17.0", features = ["macros"] }

examples/enroll_in_class.rs → examples/enroll-in-classes/src/main.rs

@@ -1,11 +1,10 @@
 use webweg::wrapper::input_types::{AddType, EnrollWaitAdd, GradeOption};
-use webweg::wrapper::wrapper_builder::WebRegWrapperBuilder;
+use webweg::wrapper::WebRegWrapper;
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() {
-    let wrapper = WebRegWrapperBuilder::new()
+    let wrapper = WebRegWrapper::builder()
         .with_cookies("my cookies here")
-        .with_default_term("FA23")
         .try_build_wrapper()
         .unwrap();
 
@@ -19,7 +18,8 @@ async fn main() {
         .unwrap();
 
     let enroll_result = wrapper
-        .default_request()
+        .req("FA23")
+        .parsed()
         .add_section(AddType::DecideForMe, course_to_enroll, true)
         .await;
 

examples/multiple-tasks/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "multiple-tasks"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+tokio = { version = "1.17.0", features = ["macros"] }
+webweg = { path = "../..", features = ["multi"] }
+futures = "0.3"

examples/multiple-tasks/src/main.rs

@@ -0,0 +1,27 @@
+use std::sync::Arc;
+use futures::stream::FuturesUnordered;
+use futures::StreamExt;
+use webweg::wrapper::WebRegWrapper;
+
+#[tokio::main(flavor = "current_thread")]
+async fn main() {
+    let wrapper = Arc::new(WebRegWrapper::builder()
+        .with_cookies("my cookies here")
+        .try_build_wrapper()
+        .unwrap());
+
+    const TERMS: [&str; 3] = ["FA23", "S223", "S323"];
+    let mut tasks = FuturesUnordered::new();
+    for term in TERMS {
+        let cloned = wrapper.clone();
+        tasks.push(tokio::spawn(async move {
+            cloned.set_cookies(format!("pretend I have cookies for {}", term));
+            let data = cloned.req(term).parsed().get_course_info("CSE", "100").await;
+            println!("{data:?}");
+        }));
+    }
+
+    while let Some(_) = tasks.next().await {
+        println!("done!");
+    }
+}

examples/raw-requests/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "raw-requests"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+webweg = { path = "../.." }
+tokio = { version = "1.17.0", features = ["macros"] }

examples/raw_requests.rs → examples/raw-requests/src/main.rs

@@ -1,10 +1,9 @@
-use webweg::wrapper::wrapper_builder::WebRegWrapperBuilder;
+use webweg::wrapper::WebRegWrapper;
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() {
-    let wrapper = WebRegWrapperBuilder::new()
+    let wrapper = WebRegWrapper::builder()
         .with_cookies("my cookies here")
-        .with_default_term("FA23")
         .try_build_wrapper()
         .unwrap();
 
@@ -14,24 +13,16 @@ async fn main() {
     // `default_request` will by default give you a "parsed" response. A parsed response
     // is one that takes the original WebReg response and "cleans" it and then returns
     // the cleaned version.
-    let my_schedule = wrapper.default_request().get_schedule(None).await;
+    let my_schedule = wrapper.req("FA23").parsed().get_schedule(None).await;
     println!("{my_schedule:?}");
 
     // The above few lines are equivalent to...
-    let my_schedule = wrapper
-        .make_request()
-        .build_term_parser()
-        .get_schedule(None)
-        .await;
+    let my_schedule = wrapper.req("FA23").parsed().get_schedule(None).await;
 
     println!("{my_schedule:?}");
 
     // But let's say you want a raw response (not a cleaned one from WebReg)...
-    let my_raw_schedule = wrapper
-        .make_request()
-        .build_term_raw()
-        .get_schedule(None)
-        .await;
+    let my_raw_schedule = wrapper.req("FA23").raw().get_schedule(None).await;
 
     println!("{my_raw_schedule:?}");
 }

examples/search-classes/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "search-classes"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+webweg = { path = "../.." }
+tokio = { version = "1.17.0", features = ["macros"] }
+

examples/search_classes.rs → examples/search-classes/src/main.rs

@@ -1,11 +1,10 @@
 use webweg::wrapper::input_types::{CourseLevelFilter, SearchRequestBuilder, SearchType};
-use webweg::wrapper::wrapper_builder::WebRegWrapperBuilder;
+use webweg::wrapper::WebRegWrapper;
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() {
-    let wrapper = WebRegWrapperBuilder::new()
+    let wrapper = WebRegWrapper::builder()
         .with_cookies("my cookies here")
-        .with_default_term("FA23")
         .try_build_wrapper()
         .unwrap();
 
@@ -24,7 +23,8 @@ async fn main() {
         .only_allow_open();
 
     let search_results = wrapper
-        .default_request()
+        .req("FA23")
+        .parsed()
         .search_courses(SearchType::Advanced(search))
         .await;
 

examples/switch-quarters/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "switch-quarters"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+webweg = { path = "../.." }
+tokio = { version = "1.17.0", features = ["macros"] }

examples/switch_active_quarters.rs → examples/switch-quarters/src/main.rs

@@ -1,19 +1,19 @@
-use webweg::wrapper::wrapper_builder::WebRegWrapperBuilder;
+use webweg::wrapper::WebRegWrapper;
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() {
-    let wrapper = WebRegWrapperBuilder::new()
+    let wrapper = WebRegWrapper::builder()
         .with_cookies("my cookies here")
-        .with_default_term("FA23")
         .try_build_wrapper()
         .unwrap();
 
     // Registers all active terms so we can switch between active quarters.
     _ = wrapper.register_all_terms().await;
 
-    // Using `default_request` defaults to the default term (FA23)
+    // Let's get all CSE 100 courses for FA23
     let cse100_fa23 = wrapper
-        .default_request()
+        .req("FA23")
+        .parsed()
         .get_course_info("CSE", "100")
         .await;
 
@@ -30,9 +30,8 @@ async fn main() {
 
     // But we can also switch to another active quarter
     let cse100_s223 = wrapper
-        .make_request()
-        .override_term("S223")
-        .build_term_parser()
+        .req("S223")
+        .parsed()
         .get_course_info("CSE", "100")
         .await;