kernald/reddit-magnet
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat!: distinguish URLs and hosts

Browse source 
BREAKING CHANGE: the configuration for Bitmagnet and Ntfy has changed.
Instead of `host`, they now use `url`.
This commit is contained in:
Marc Plano-Lesay 2025-05-22 21:57:51 +10:00
parent 01fecffc90
commit bb32cfdf97
Signed by: kernald
GPG key ID: 66A41B08CC62A6CF
10 changed files with 59 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -50,13 +50,13 @@ download_dir = "/downloads" # Optional
# BitMagnet configuration
[bitmagnet]
enable = true
host = "http://localhost:3333"
url = "http://localhost:3333"
# Ntfy configuration
[ntfy]
enable = true
topic = "reddit-magnet"
host = "https://ntfy.sh"
url = "https://ntfy.sh"
username = "username" # Optional
password = "password" # Optional

8
src/actions/bitmagnet/client.rs
View file

@ -20,12 +20,12 @@ impl BitmagnetClient {
return Err(eyre!("Bitmagnet action is disabled"));
}
let url_str = &config.host;
let base_url = Url::parse(url_str).wrap_err_with(|| format!("Invalid URL: {}", url_str))?;
let client = Client::new();
Ok(BitmagnetClient { client, base_url })
Ok(BitmagnetClient {
client,
base_url: config.url.clone(),
})
}
/// Submit a magnet link to Bitmagnet

4
src/actions/bitmagnet/config.rs
View file

@ -1,12 +1,12 @@
use crate::app::Enableable;
use crate::config::types::Host;
use serde::{Deserialize, Serialize};
use url::Url;
/// Configuration for the Bitmagnet action
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BitmagnetConfig {
pub enable: bool,
pub host: Host,
pub url: Url,
}
impl Enableable for BitmagnetConfig {

18
src/actions/bitmagnet/validation.rs
View file

@ -1,14 +1,9 @@
use crate::actions::bitmagnet::BitmagnetConfig;
use crate::config::Validate;
use crate::errors::{self};
use color_eyre::eyre::Result;
use url::Url;
impl Validate for BitmagnetConfig {
fn validate(&self) -> Result<()> {
Url::parse(&self.host.to_string())
.map_err(|e| errors::config_error(e, &format!("Invalid URL format: {}", self.host)))?;
Ok(())
}
}
@ -16,12 +11,12 @@ impl Validate for BitmagnetConfig {
#[cfg(test)]
mod tests {
use super::*;
use crate::config::types::Host;
use url::Url;
fn create_valid_config() -> Result<BitmagnetConfig> {
Ok(BitmagnetConfig {
enable: true,
host: Host::try_new("http://localhost:8080")?,
url: Url::parse("http://localhost:8080")?,
})
}
@ -36,13 +31,8 @@ mod tests {
#[test]
fn test_invalid_url() -> Result<()> {
let config = BitmagnetConfig {
enable: true,
host: Host::try_new("not a url")?,
};
assert!(config.validate().is_err());
// This test is no longer needed as the Url type handles validation
// and will not allow invalid URLs to be created
Ok(())
}
}

4
src/config/fixtures/test_config.toml
View file

@ -1,6 +1,6 @@
[bitmagnet]
enable = true
host = "http://localhost:8080"
url = "http://localhost:8080"
[transmission]
enable = false
@ -13,7 +13,7 @@ download_dir = "/downloads"
[ntfy]
enable = true
topic = "reddit-magnet"
host = "https://ntfy.sh"
url = "https://ntfy.sh"
priority = "default"
[sources.movies]

4
src/config/lib.rs
View file

@ -151,9 +151,9 @@ pub fn get_db_path(args: &Args) -> Result<PathBuf> {
#[cfg(test)]
mod tests {
use super::*;
use crate::config::types::Host;
use insta::assert_debug_snapshot;
use std::path::Path;
use url::Url;
/// Helper function to create a valid configuration for testing
fn create_valid_config() -> Result<Config> {
@ -171,7 +171,7 @@ mod tests {
Ok(Config {
bitmagnet: Some(BitmagnetConfig {
enable: true,
host: Host::try_new("http://localhost:8080")?,
url: Url::parse("http://localhost:8080")?,
}),
transmission: None,
ntfy: None,

35
src/config/snapshots/reddit_magnet__config__lib__tests__config_parsing.snap
View file

@ -1,15 +1,28 @@
---
source: src/config/lib.rs
assertion_line: 247
expression: config
---
Config {
bitmagnet: Some(
BitmagnetConfig {
enable: true,
host: Host(
"http://localhost:8080",
url: Url {
scheme: "http",
cannot_be_a_base: false,
username: "",
password: None,
host: Some(
Domain(
"localhost",
),
),
port: Some(
8080,
),
path: "/",
query: None,
fragment: None,
},
},
),
transmission: Some(
@ -35,9 +48,21 @@ Config {
ntfy: Some(
NtfyConfig {
enable: true,
host: Host(
"https://ntfy.sh",
url: Url {
scheme: "https",
cannot_be_a_base: false,
username: "",
password: None,
host: Some(
Domain(
"ntfy.sh",
),
),
port: None,
path: "/",
query: None,
fragment: None,
},
username: None,
password: None,
topic: Topic(

7
src/notifications/ntfy/config.rs
View file

@ -1,6 +1,7 @@
use crate::app::Enableable;
use crate::config::types::{Host, Password, Topic, Username};
use crate::config::types::{Password, Topic, Username};
use serde::{Deserialize, Serialize};
use url::Url;
/// Configuration for the ntfy notification service
#[derive(Debug, Clone, Serialize, Deserialize)]
@ -9,8 +10,8 @@ pub struct NtfyConfig {
#[serde(default)]
pub enable: bool,
/// The host URL of the ntfy server
pub host: Host,
/// The URL of the ntfy server
pub url: Url,
/// The username for authentication (optional)
#[serde(default)]

2
src/notifications/ntfy/notification.rs
View file

@ -17,7 +17,7 @@ pub struct NtfyNotification {
impl NtfyNotification {
/// Create a new NtfyNotification instance
pub fn new(config: NtfyConfig) -> Result<Self> {
let mut builder = dispatcher::builder(config.host.as_str());
let mut builder = dispatcher::builder(config.url.as_str());
// Add authentication if provided
if let (Some(username), Some(password)) = (&config.username, &config.password) {

17
src/notifications/ntfy/validation.rs
View file

@ -2,14 +2,9 @@ use crate::config::Validate;
use crate::errors::{self};
use crate::notifications::ntfy::NtfyConfig;
use color_eyre::eyre::Result;
use url::Url;
impl Validate for NtfyConfig {
fn validate(&self) -> Result<()> {
// Validate URL format
Url::parse(&self.host.to_string())
.map_err(|e| errors::config_error(e, &format!("Invalid URL format: {}", self.host)))?;
match (self.username.as_ref(), self.password.as_ref()) {
(Some(_), None) => {
return Err(errors::config_error(
@ -33,12 +28,13 @@ impl Validate for NtfyConfig {
#[cfg(test)]
mod tests {
use super::*;
use crate::config::types::{Host, Password, Topic, Username};
use crate::config::types::{Password, Topic, Username};
use url::Url;
fn create_valid_config() -> Result<NtfyConfig> {
Ok(NtfyConfig {
enable: true,
host: Host::try_new("https://ntfy.sh")?,
url: Url::parse("https://ntfy.sh")?,
username: None,
password: None,
topic: Topic::try_new("my-topic")?,
@ -56,11 +52,8 @@ mod tests {
#[test]
fn test_invalid_url() -> Result<()> {
let mut invalid_config = create_valid_config()?;
invalid_config.host = Host::try_new("not a url")?;
assert!(invalid_config.validate().is_err());
// This test is no longer needed as the Url type handles validation
// and will not allow invalid URLs to be created
Ok(())
}