From 3970616451ab4336e37a7ddfdc67f51e01e55926 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sun, 24 Mar 2024 14:24:20 +0000 Subject: refactor: module for blocking, default to non-blocking --- Cargo.toml | 4 +- README.md | 19 +++--- examples/async_request.rs | 29 --------- examples/request.rs | 7 +- examples/request_blocking.rs | 26 ++++++++ examples/request_blocking_to_gemtext_from_ast.rs | 32 +++++++++ examples/request_to_gemtext_from_ast.rs | 30 --------- src/request.rs | 52 +++------------ src/request/blocking.rs | 63 ++++++++++++++++++ src/request/non_blocking.rs | 83 ++++++++++++++++++++++++ src/request/sync.rs | 83 ------------------------ 11 files changed, 229 insertions(+), 199 deletions(-) delete mode 100644 examples/async_request.rs create mode 100644 examples/request_blocking.rs create mode 100644 examples/request_blocking_to_gemtext_from_ast.rs delete mode 100644 examples/request_to_gemtext_from_ast.rs create mode 100644 src/request/blocking.rs create mode 100644 src/request/non_blocking.rs delete mode 100644 src/request/sync.rs diff --git a/Cargo.toml b/Cargo.toml index c461e6c..c1f1d6f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -16,13 +16,13 @@ categories = ["encoding"] [features] ast = [] +blocking = ["rustls", "url", "anyhow"] convert = ["ast"] default = ["ast", "convert", "meta", "request"] macros = ["ast", "convert"] meta = [] -request = ["rustls", "url", "anyhow"] +request = ["rustls", "url", "anyhow", "tokio", "tokio-rustls"] quick = [] -sync = ["tokio", "tokio-rustls"] [dependencies] anyhow = { version = "1.0.70", optional = true } # `Result` diff --git a/README.md b/README.md index 26b0e01..7dfc35c 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,16 @@ features = ["ast"] # Enable the features you would like to use! ### Features -| Feature | Description | -| --------- | ---------------------------------------------------------------- | -| `ast` | Construct AST trees from raw Gemtext. | -| `convert` | Convert from Gemtext to markup formats such as HTML or Markdown. | -| `request` | Make Gemini requests and get sane, structured results. | -| `meta` | Structure-ize a Gemini response's meta section | -| `macros` | Macros to aid with various Germ-related functionalities | -| `quick` | Quick functions to create valid Gemtext elements from input | -| `sync` | An asynchronous version of `request` | +| Feature | Description | +| ---------- | ---------------------------------------------------------------- | +| `default` | `ast`, `convert`, `meta`, `request` | +| `ast` | Construct AST trees from raw Gemtext. | +| `blocking` | Blocking equivalent of `request` | +| `convert` | Convert from Gemtext to markup formats such as HTML or Markdown. | +| `request` | Make Gemini requests and get sane, structured results. | +| `meta` | Structure-ize a Gemini response's meta section | +| `macros` | Macros to aid with various Germ-related functionalities | +| `quick` | Quick functions to create valid Gemtext elements from input | ### Examples diff --git a/examples/async_request.rs b/examples/async_request.rs deleted file mode 100644 index 604d6d4..0000000 --- a/examples/async_request.rs +++ /dev/null @@ -1,29 +0,0 @@ -// This file is part of Germ . -// Copyright (C) 2022-2022 Fuwn -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, version 3. -// -// This program is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . -// -// Copyright (C) 2022-2022 Fuwn -// SPDX-License-Identifier: GPL-3.0-only - -#[tokio::main] -async fn main() { - match germ::request::sync::request( - &url::Url::parse("gemini://fuwn.me").unwrap(), - ) - .await - { - Ok(response) => println!("{:?}", response), - Err(_) => {} - } -} diff --git a/examples/request.rs b/examples/request.rs index e33710f..33de2da 100644 --- a/examples/request.rs +++ b/examples/request.rs @@ -16,8 +16,11 @@ // Copyright (C) 2022-2022 Fuwn // SPDX-License-Identifier: GPL-3.0-only -fn main() { - match germ::request::request(&url::Url::parse("gemini://fuwn.me").unwrap()) { +#[tokio::main] +async fn main() { + match germ::request::request(&url::Url::parse("gemini://fuwn.me").unwrap()) + .await + { Ok(response) => println!("{:?}", response), Err(_) => {} } diff --git a/examples/request_blocking.rs b/examples/request_blocking.rs new file mode 100644 index 0000000..fed1c41 --- /dev/null +++ b/examples/request_blocking.rs @@ -0,0 +1,26 @@ +// This file is part of Germ . +// Copyright (C) 2022-2022 Fuwn +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, version 3. +// +// This program is distributed in the hope that it will be useful, but +// WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +// Copyright (C) 2022-2022 Fuwn +// SPDX-License-Identifier: GPL-3.0-only + +fn main() { + match germ::request::blocking::request( + &url::Url::parse("gemini://fuwn.me").unwrap(), + ) { + Ok(response) => println!("{:?}", response), + Err(_) => {} + } +} diff --git a/examples/request_blocking_to_gemtext_from_ast.rs b/examples/request_blocking_to_gemtext_from_ast.rs new file mode 100644 index 0000000..6abfdfb --- /dev/null +++ b/examples/request_blocking_to_gemtext_from_ast.rs @@ -0,0 +1,32 @@ +// This file is part of Germ . +// Copyright (C) 2022-2022 Fuwn +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, version 3. +// +// This program is distributed in the hope that it will be useful, but +// WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +// Copyright (C) 2022-2022 Fuwn +// SPDX-License-Identifier: GPL-3.0-only + +fn main() { + match germ::request::blocking::request( + &url::Url::parse("gemini://fuwn.me/").unwrap(), + ) { + Ok(response) => println!( + "{}", + germ::ast::Ast::from_string( + &*response.content().clone().unwrap_or_else(|| "".to_string()) + ) + .to_gemtext() + ), + Err(_) => {} + } +} diff --git a/examples/request_to_gemtext_from_ast.rs b/examples/request_to_gemtext_from_ast.rs deleted file mode 100644 index 2127433..0000000 --- a/examples/request_to_gemtext_from_ast.rs +++ /dev/null @@ -1,30 +0,0 @@ -// This file is part of Germ . -// Copyright (C) 2022-2022 Fuwn -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, version 3. -// -// This program is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . -// -// Copyright (C) 2022-2022 Fuwn -// SPDX-License-Identifier: GPL-3.0-only - -fn main() { - match germ::request::request(&url::Url::parse("gemini://fuwn.me/").unwrap()) { - Ok(response) => println!( - "{}", - germ::ast::Ast::from_string( - &*response.content().clone().unwrap_or_else(|| "".to_string()) - ) - .to_gemtext() - ), - Err(_) => {} - } -} diff --git a/src/request.rs b/src/request.rs index 97aa954..f1eb005 100644 --- a/src/request.rs +++ b/src/request.rs @@ -1,5 +1,5 @@ // This file is part of Germ . -// Copyright (C) 2022-2022 Fuwn +// Copyright (C) 2022-2023 Fuwn // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -22,50 +22,14 @@ mod response; mod status; mod verifier; -#[cfg(feature = "sync")] pub mod sync; +#[cfg(feature = "blocking")] +pub mod blocking; + +#[cfg(feature = "request")] +pub mod non_blocking; -use std::io::{Read, Write}; +#[cfg(feature = "request")] +pub use non_blocking::request; pub(crate) use verifier::GermVerifier; pub use {response::Response, status::Status}; - -/// Make a request to a Gemini server. The `url` **should** be prefixed with a -/// scheme (e.g. "gemini://"). -/// -/// # Example -/// -/// ```rust -/// match germ::request::request(&url::Url::parse("gemini://fuwn.me").unwrap()) { -/// Ok(response) => println!("{:?}", response), -/// Err(_) => {} -/// } -/// ``` -/// -/// # Errors -/// - May error if the URL is invalid -/// - May error if the TLS write fails -/// - May error if the TLS read fails -pub fn request(url: &url::Url) -> anyhow::Result { - let config = rustls::ClientConfig::builder() - .with_safe_defaults() - .with_custom_certificate_verifier(std::sync::Arc::new(GermVerifier::new())) - .with_no_client_auth(); - let mut connection = rustls::ClientConnection::new( - std::sync::Arc::new(config), - url.domain().unwrap_or("").try_into()?, - )?; - let mut stream = std::net::TcpStream::connect(format!( - "{}:{}", - url.domain().unwrap_or(""), - url.port().unwrap_or(1965) - ))?; - let mut tls = rustls::Stream::new(&mut connection, &mut stream); - - tls.write_all(format!("{url}\r\n").as_bytes())?; - - let mut plain_text = Vec::new(); - - tls.read_to_end(&mut plain_text)?; - - Ok(Response::new(&plain_text, tls.conn.negotiated_cipher_suite())) -} diff --git a/src/request/blocking.rs b/src/request/blocking.rs new file mode 100644 index 0000000..0d78b52 --- /dev/null +++ b/src/request/blocking.rs @@ -0,0 +1,63 @@ +// This file is part of Germ . +// Copyright (C) 2022-2022 Fuwn +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, version 3. +// +// This program is distributed in the hope that it will be useful, but +// WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +// Copyright (C) 2022-2022 Fuwn +// SPDX-License-Identifier: GPL-3.0-only + +use { + crate::request::{GermVerifier, Response}, + std::io::{Read, Write}, +}; + +/// Make a request to a Gemini server. The `url` **should** be prefixed with a +/// scheme (e.g. "gemini://"). +/// +/// # Example +/// +/// ```rust +/// match germ::request::request(&url::Url::parse("gemini://fuwn.me").unwrap()) { +/// Ok(response) => println!("{:?}", response), +/// Err(_) => {} +/// } +/// ``` +/// +/// # Errors +/// - May error if the URL is invalid +/// - May error if the TLS write fails +/// - May error if the TLS read fails +pub fn request(url: &url::Url) -> anyhow::Result { + let config = rustls::ClientConfig::builder() + .with_safe_defaults() + .with_custom_certificate_verifier(std::sync::Arc::new(GermVerifier::new())) + .with_no_client_auth(); + let mut connection = rustls::ClientConnection::new( + std::sync::Arc::new(config), + url.domain().unwrap_or("").try_into()?, + )?; + let mut stream = std::net::TcpStream::connect(format!( + "{}:{}", + url.domain().unwrap_or(""), + url.port().unwrap_or(1965) + ))?; + let mut tls = rustls::Stream::new(&mut connection, &mut stream); + + tls.write_all(format!("{url}\r\n").as_bytes())?; + + let mut plain_text = Vec::new(); + + tls.read_to_end(&mut plain_text)?; + + Ok(Response::new(&plain_text, tls.conn.negotiated_cipher_suite())) +} diff --git a/src/request/non_blocking.rs b/src/request/non_blocking.rs new file mode 100644 index 0000000..c578703 --- /dev/null +++ b/src/request/non_blocking.rs @@ -0,0 +1,83 @@ +// This file is part of Germ . +// Copyright (C) 2022-2024 Fuwn +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, version 3. +// +// This program is distributed in the hope that it will be useful, but +// WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +// Copyright (C) 2022-2022 Fuwn +// SPDX-License-Identifier: GPL-3.0-only + +use { + crate::request::Response, + tokio::io::{AsyncReadExt, AsyncWriteExt}, +}; + +/// Make a request to a Gemini server +/// +/// The `url` **should** be prefixed with a scheme (e.g. "gemini://"). +/// +/// # Example +/// +/// ```rust +/// #[tokio::main] +/// async fn main() { +/// match germ::request::sync::request( +/// &url::Url::parse("gemini://fuwn.me").unwrap(), +/// ) +/// .await +/// { +/// Ok(response) => println!("{:?}", response), +/// Err(_) => {} +/// } +/// } +/// ``` +/// +/// # Errors +/// +/// - May error if the URL is invalid +/// - May error if the server is unreachable +/// - May error if the TLS write fails +/// - May error if the TLS read fails +pub async fn request(url: &url::Url) -> anyhow::Result { + let mut tls = tokio_rustls::TlsConnector::from(std::sync::Arc::new( + rustls::ClientConfig::builder() + .with_safe_defaults() + .with_custom_certificate_verifier(std::sync::Arc::new( + crate::request::GermVerifier::new(), + )) + .with_no_client_auth(), + )) + .connect( + rustls::ServerName::try_from(url.domain().unwrap_or_default())?, + tokio::net::TcpStream::connect(format!( + "{}:{}", + url.domain().unwrap_or(""), + url.port().unwrap_or(1965) + )) + .await?, + ) + .await?; + let cipher_suite = tls.get_mut().1.negotiated_cipher_suite(); + + tls.write_all(format!("{url}\r\n").as_bytes()).await?; + + Ok(Response::new( + &{ + let mut plain_text = Vec::new(); + + tls.read_to_end(&mut plain_text).await?; + + plain_text + }, + cipher_suite, + )) +} diff --git a/src/request/sync.rs b/src/request/sync.rs deleted file mode 100644 index 56950fb..0000000 --- a/src/request/sync.rs +++ /dev/null @@ -1,83 +0,0 @@ -// This file is part of Germ . -// Copyright (C) 2022-2023 Fuwn -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, version 3. -// -// This program is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . -// -// Copyright (C) 2022-2022 Fuwn -// SPDX-License-Identifier: GPL-3.0-only - -use { - crate::request::Response, - tokio::io::{AsyncReadExt, AsyncWriteExt}, -}; - -/// Make a request to a Gemini server -/// -/// The `url` **should** be prefixed with a scheme (e.g. "gemini://"). -/// -/// # Example -/// -/// ```rust -/// #[tokio::main] -/// async fn main() { -/// match germ::request::sync::request( -/// &url::Url::parse("gemini://fuwn.me").unwrap(), -/// ) -/// .await -/// { -/// Ok(response) => println!("{:?}", response), -/// Err(_) => {} -/// } -/// } -/// ``` -/// -/// # Errors -/// -/// - May error if the URL is invalid -/// - May error if the server is unreachable -/// - May error if the TLS write fails -/// - May error if the TLS read fails -pub async fn request(url: &url::Url) -> anyhow::Result { - let mut tls = tokio_rustls::TlsConnector::from(std::sync::Arc::new( - rustls::ClientConfig::builder() - .with_safe_defaults() - .with_custom_certificate_verifier(std::sync::Arc::new( - crate::request::GermVerifier::new(), - )) - .with_no_client_auth(), - )) - .connect( - rustls::ServerName::try_from(url.domain().unwrap_or_default())?, - tokio::net::TcpStream::connect(format!( - "{}:{}", - url.domain().unwrap_or(""), - url.port().unwrap_or(1965) - )) - .await?, - ) - .await?; - let cipher_suite = tls.get_mut().1.negotiated_cipher_suite(); - - tls.write_all(format!("{url}\r\n").as_bytes()).await?; - - Ok(Response::new( - &{ - let mut plain_text = Vec::new(); - - tls.read_to_end(&mut plain_text).await?; - - plain_text - }, - cipher_suite, - )) -} -- cgit v1.2.3