WIP: feat!: fluent api for net

Cargo.toml

@@ -14,35 +14,24 @@ unexpected_cfgs = { level = "warn", check-cfg = ['cfg(tarpaulin_include)'] }
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-# logging
-tracing = "0.1"
-
-# network
 async-trait = "0.1"
+derive_more = { version = "1.0", features = [ "from", "display", "constructor" ] }
 http = "1.1"
+path-clean = "1.0"
 reqwest = "0.12"
 secrecy = "0.10"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde-xml-rs = "0.6"
-thiserror = "2.0"
-
-# fs
 tempfile = "3.10"
-path-clean = "1.0"
+thiserror = "2.0"
-
+tracing = "0.1"
-# boilerplate
-derive_more = { version = "1.0.0-beta", features = [
-  "from",
-  "display",
-  "constructor",
-] }
 
 [dev-dependencies]
-# testing
 assert2 = "0.3"
 pretty_assertions = "1.4"
 test-log = "0.2"
+tokio = { version = "1.41", features = ["macros"] }
 tokio-test = "0.4"
 
 [package.metadata.bin]

src/lib.rs

@@ -1,3 +1,6 @@
 //
 pub mod fs;
+pub mod net;
+
+#[deprecated]
 pub mod network;

src/net/mock.rs

@@ -0,0 +1,76 @@
+//
+use super::{Error, Net, Result};
+
+struct Plan {
+    request: reqwest::Request,
+    response: reqwest::Response,
+}
+
+#[derive(Default)]
+pub struct MockNet {
+    plans: Vec<Plan>,
+}
+impl MockNet {
+    pub(crate) fn new() -> Self {
+        Self::default()
+    }
+
+    pub fn as_net(&self) -> Net<'_> {
+        Net::mock(self)
+    }
+
+    pub fn client(&self) -> reqwest::Client {
+        Net::client()
+    }
+
+    pub fn response(&self) -> http::response::Builder {
+        http::Response::builder()
+    }
+
+    pub fn on(&mut self, request: reqwest::RequestBuilder) -> Result<OnRequest<'_>> {
+        Ok(OnRequest {
+            mock: self,
+            request: request.build()?,
+        })
+    }
+
+    fn _on(&mut self, request: reqwest::Request, response: reqwest::Response) {
+        self.plans.push(Plan { request, response })
+    }
+
+    pub(crate) async fn send(
+        &mut self,
+        request: reqwest::RequestBuilder,
+    ) -> Result<reqwest::Response> {
+        let request = request.build()?;
+        let index = self.plans.iter().position(|plan| {
+            // TODO: add support or ony matching on selected criteria
+            plan.request.method() == request.method()
+                && plan.request.url() == request.url()
+                && match (plan.request.body(), request.body()) {
+                    (None, None) => true,
+                    (Some(plan), Some(request)) => plan.as_bytes() == request.as_bytes(),
+                    _ => false,
+                }
+                && plan.request.headers() == request.headers()
+        });
+        match index {
+            Some(i) => Ok(self.plans.remove(i).response),
+            None => Err(Error::UnexpectedMockRequest(request)),
+        }
+    }
+
+    pub fn assert(&self) -> Result<()> {
+        todo!()
+    }
+}
+
+pub struct OnRequest<'mock> {
+    mock: &'mock mut MockNet,
+    request: reqwest::Request,
+}
+impl<'mock> OnRequest<'mock> {
+    pub fn response(self, response: reqwest::Response) {
+        self.mock._on(self.request, response)
+    }
+}

src/net/mod.rs

@@ -0,0 +1,22 @@
+//! Provides a generic interface for network operations.
+//! 
+//! 
+
+mod mock;
+mod system;
+mod result;
+
+pub use result::{Error, Result};
+
+pub use system::Net;
+
+
+/// Creates a new `Net`.
+pub const fn new() -> Net<'static> {
+    Net::new()
+}
+
+/// Creates a new `MockNet` for use in tests.
+pub fn mock() -> mock::MockNet {
+    mock::MockNet::new()
+}

src/net/result.rs

@@ -0,0 +1,27 @@
+//
+
+use derive_more::derive::From;
+
+/// Represents a error accessing the network.
+#[derive(Debug, From, derive_more::Display)]
+pub enum Error {
+    Reqwest(reqwest::Error),
+    Request(String),
+    UnexpectedMockRequest(reqwest::Request),
+}
+impl std::error::Error for Error {}
+impl Clone for Error {
+    fn clone(&self) -> Self {
+        match self {
+            Self::Reqwest(req) => Self::Request(req.to_string()),
+            Self::Request(req) => Self::Request(req.clone()),
+        }
+    }
+}
+
+/// Represents a success or a failure.
+///
+/// Any failure is related to `std::io`, a Path Traversal
+/// (i.e. trying to escape the base of the `FileSystem`),
+/// or attempting to use a file as a directory or /vise versa/.
+pub type Result<T> = core::result::Result<T, Error>;

src/net/system.rs

@@ -0,0 +1,30 @@
+//
+use super::{mock::MockNet, Error};
+
+pub struct Net<'mock> {
+    mock: Option<&'mock MockNet>,
+}
+impl<'mock> Net<'mock> {
+    pub(crate) const fn mock(mock: &'mock MockNet) -> Self {
+        Self { mock: Some(mock) }
+    }
+
+}
+
+impl Net<'_> {
+
+    pub(crate) const fn new() -> Self {
+        Self { mock: None }
+    }
+
+    pub fn client() -> reqwest::Client {
+        reqwest::Client::new()
+    }
+
+    pub async fn send(&self, request: reqwest::RequestBuilder) -> Result<reqwest::Response, Error> {
+        match self.mock {
+            Some(mock) => mock.send(request).await,
+            None => request.send().await.map_err(Error::from),
+        }
+    }
+}

tests/net.rs

@@ -0,0 +1,36 @@
+//
+use kxio::net::Error;
+
+type TestResult = Result<(), Error>;
+
+mod get {
+
+    use kxio::net::Net;
+
+    use super::*;
+
+    #[tokio::test]
+    async fn test() -> TestResult {
+        let mut net_mock = kxio::net::mock();
+
+        let url = "https://www.example.com";
+        let request = net_mock.client().get(url);
+        let my_response = net_mock.response().status(200).body("OK").unwrap();
+
+        net_mock.on(request).response(my_response.clone().into());
+
+        let net = net_mock.as_net();
+        let client = Net::client();
+
+        let response = net.send(client.get(url)).await?;
+
+        assert_eq!(response.status(), my_response.status());
+
+        net_mock.assert()?;
+
+        // let my_net = net::new();
+        // my_net.send(request).await?;
+
+        Ok(())
+    }
+}