feat: add an option for custom api url

Author: hayd1n

Cargo.toml

@@ -7,13 +7,14 @@ repository = "https://github.com/NTUST-Hack/q"
 
 
 [dependencies]
-reqwest = { version = "0.11", features = ["json", "blocking"] }
+reqwest = { version = "0.12.5", features = ["json"] }
 serde = "1.0.196"
 serde-aux = "4.4.0"
 serde_derive = "1.0.196"
 serde_json = "1.0.1"
 serde_with = "3.8.1"
 tokio = { version = "1", features = ["full"] }
+url = "2.5.2"
 
 [dev-dependencies]
 anyhow = "1.0.86"

src/async_impl/mod.rs

@@ -1,18 +1,23 @@
 use std::collections::HashMap;
 
+use url::Url;
+
 use crate::{
     default_reqwest_builder, CourseDetails, CourseInfo, Language, QueryError, SearchOptions,
+    DEFAULT_API_URL,
 };
 
-#[derive(Default, Debug)]
+#[derive(Debug)]
 pub struct ClientBuilder {
     reqwest_client: reqwest::Client,
+    base_url: Url,
 }
 
 impl ClientBuilder {
     pub fn new() -> Self {
         ClientBuilder {
             reqwest_client: default_reqwest_builder().build().unwrap(),
+            base_url: Url::parse(&DEFAULT_API_URL).unwrap(),
         }
     }
 
@@ -21,15 +26,22 @@ impl ClientBuilder {
         self
     }
 
+    pub fn api_url(mut self, url: Url) -> Self {
+        self.base_url = url;
+        self
+    }
+
     pub fn build(self) -> Q {
         Q {
             http_client: self.reqwest_client,
+            base_url: self.base_url,
         }
     }
 }
 
 pub struct Q {
     http_client: reqwest::Client,
+    base_url: Url,
 }
 
 impl Q {
@@ -42,13 +54,9 @@ impl Q {
         options: &SearchOptions,
         merge_courses: bool,
     ) -> Result<Vec<CourseInfo>, QueryError> {
-        let resp = match self
-            .http_client
-            .post("https://querycourse.ntust.edu.tw/querycourse/api/courses")
-            .json(&options)
-            .send()
-            .await
-        {
+        let url = self.base_url.join("courses").unwrap();
+
+        let resp = match self.http_client.post(url).json(&options).send().await {
             Ok(resp) => resp,
             Err(e) => return Err(QueryError::HttpError(format!("{}", e))),
         };
@@ -69,18 +77,16 @@ impl Q {
         course_no: &str,
         language: Language,
     ) -> Result<CourseDetails, QueryError> {
+        // is "coursedetials" not "coursedetails"
+        // looks like an idiotic typo in the API
+        let url = self.base_url.join("coursedetials").unwrap();
+
         let mut params = HashMap::new();
         params.insert("semester", semester);
         params.insert("course_no", course_no);
         params.insert("language", language.as_str());
 
-        let resp = match self
-            .http_client
-            .get("https://querycourse.ntust.edu.tw/querycourse/api/coursedetials")
-            .query(&params)
-            .send()
-            .await
-        {
+        let resp = match self.http_client.get(url).query(&params).send().await {
             Ok(resp) => resp,
             Err(e) => return Err(QueryError::HttpError(format!("{}", e))),
         };
@@ -91,12 +97,10 @@ impl Q {
         };
 
         // # debug
-
         // let text = match String::from_utf8(full.to_vec()) {
         //     Ok(bytes) => bytes,
         //     Err(e) => return Err(QueryError::ParseError(format!("{}", e))),
         // };
-
         // println!("{}", text);
 
         let json = match serde_json::from_slice::<Vec<CourseDetails>>(&full) {

src/blocking/mod.rs

@@ -20,6 +20,11 @@ impl ClientBuilder {
         self
     }
 
+    pub fn api_url(mut self, url: url::Url) -> Self {
+        self.async_builder = self.async_builder.api_url(url);
+        self
+    }
+
     pub fn build(self) -> Q {
         Q {
             async_q: self.async_builder.build(),

src/lib.rs

@@ -8,6 +8,7 @@ use std::{collections::HashMap, fmt, str::FromStr, time::Duration};
 
 pub const DEFAULT_USER_AGENT: &'static str = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36";
 pub const DEFAULT_TIMEOUT: Duration = Duration::from_secs(10);
+pub const DEFAULT_API_URL: &'static str = "https://querycourse.ntust.edu.tw/querycourse/api/";
 
 #[derive(Debug, Copy, Clone, Serialize, Deserialize)]
 #[serde(rename_all = "lowercase")]
@@ -236,6 +237,7 @@ pub fn default_reqwest_builder() -> reqwest::ClientBuilder {
 
 #[derive(Debug, Clone)]
 pub enum QueryError {
+    InputError(String),
     HttpError(String),
     ParseError(String),
 }
@@ -245,6 +247,7 @@ impl std::error::Error for QueryError {}
 impl fmt::Display for QueryError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
+            QueryError::InputError(msg) => write!(f, "Input Error: {}", msg),
             QueryError::HttpError(msg) => write!(f, "HTTP Error: {}", msg),
             QueryError::ParseError(msg) => write!(f, "Parse Error: {}", msg),
         }