From 007a26974fb1b97c4e23872e1df2e81f8b94fc68 Mon Sep 17 00:00:00 2001 From: askiiart Date: Tue, 26 Nov 2024 23:36:06 -0600 Subject: [PATCH] improve tests and docs --- Cargo.lock | 8 ++++---- src/data.rs | 32 +++++++++++++++++++++++++++----- src/dummy.rs | 25 ++++++++++++++++++------- 3 files changed, 49 insertions(+), 16 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 7effb62..a49fa02 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -520,9 +520,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" [[package]] name = "libc" -version = "0.2.165" +version = "0.2.166" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fcb4d3d38eab6c5239a362fa8bae48c03baf980a6e7079f063942d563ef3533e" +checksum = "c2ccc108bbc0b1331bd061864e7cd823c0cab660bbe6970e66e2c0614decde36" [[package]] name = "linux-raw-sys" @@ -1301,9 +1301,9 @@ dependencies = [ [[package]] name = "tracing-attributes" -version = "0.1.27" +version = "0.1.28" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7" +checksum = "395ae124c09f9e6918a2310af6038fba074bcf474ac352496d5910dd59a2226d" dependencies = [ "proc-macro2", "quote", diff --git a/src/data.rs b/src/data.rs index e145be2..e0bb97c 100644 --- a/src/data.rs +++ b/src/data.rs @@ -9,9 +9,13 @@ pub(crate) type SearchFunc = fn(String, Vec) -> Result; /// These fields are just those listed in the example on [torznab.github.io](https://torznab.github.io), there's no actual specification for thse fields. /// TODO: Update this to have customizable fields instead pub struct ServerInfo { + /// The title of the server pub title: Option, + /// The email for the server info pub email: Option, + /// The URL to the server's image (e.g. logo) pub image: Option, + /// What version the server is - unrelated to torznab-toolkit's version, but may be used by the program pub version: Option, } @@ -25,49 +29,67 @@ pub struct Limits { In fact, I *really* hope you aren't - if you are, you're doing something extremely wrong But hey, it's an option */ + /// The maximum number of entries that can be listed in a search query pub max: u64, + /// The default number of entries to be listed in a search query pub default: u64, } #[derive(Debug, Clone, PartialEq, Eq)] /// A struct holding the info for a type of search -/// - `search_type` must be `search`, `tv-search`, `movie-search`, `audio-search`, or `book-search` -/// - `available` pub struct SearchInfo { + /// What type of search this is - must be `search`, `tv-search`, `movie-search`, `audio-search`, or `book-search` pub search_type: String, + /// Whether this search type is available pub available: bool, + /// The supported parameters for this search type pub supported_params: Vec, } #[derive(Debug, Clone, PartialEq, Eq)] /// Contains subcategories, for use in `Category` pub struct Subcategory { + /// The numeric ID of a subcategory + /// + /// The (de facto?) standard is `xxyy`, xx being the first two digits of the category, and the last two digits specifying the subcategory; see also: Category pub id: String, + /// The name of the subcategory, e.g. "Anime" under the "TV" cateogyr pub name: String, } #[derive(Debug, Clone, PartialEq, Eq)] /// Contains a category, for use in `Caps` and searches as a query parameter pub struct Category { + /// The numeric ID of a category + /// + /// The (de facto?) standard is `xxyy`, xx being the first two digits of the category, and the last two digits specifying the subcategory; see also: Subcategory pub id: String, + /// The name of the category, e.g. "Movies" pub name: String, + /// A vector of all the subcategory in this category pub subcategories: Vec, } #[derive(Debug, Clone, PartialEq, Eq)] /// Contains a genre, for use in `Caps` and searches as a query parameter pub struct Genre { + /// The numeric ID of a genre + /// + /// I'm not aware of any sure standard for this; the specification for Torznab shows an example with an ID of 1. pub id: String, + /// The numeric ID of the category this genre is for. pub category_id: String, + /// The name of the genre pub name: String, } #[derive(Debug, Clone, PartialEq, Eq)] /// Contains a tag, for use in `Caps` and searches as a query parameter pub struct Tag { - pub id: String, - pub category_id: String, + /// The name of a tag for a torrent pub name: String, + /// The description of the tag + pub description: String, } #[derive(Debug, Clone, PartialEq, Eq)] @@ -108,7 +130,7 @@ pub struct Caps { /// A search function (/api?t=search) and capabilities (/api?t=caps - struct Caps) required /// Everything else is optional pub struct Config { - pub search: SearchFunc, // NOTE: This is NOT optional, + pub search: SearchFunc, pub auth: Option, pub caps: Caps, pub tvsearch: Option, diff --git a/src/dummy.rs b/src/dummy.rs index 29e0ba1..adb3065 100644 --- a/src/dummy.rs +++ b/src/dummy.rs @@ -1,11 +1,11 @@ //! Some dummy stuff for testing the API use crate::data::*; -fn dummy_search_func(a: String, b: Vec) -> Result { +fn dummy_search_func(_a: String, _b: Vec) -> Result { return Ok("hi".to_string()); } -fn dummy_auth_func(a: String) -> Result { +fn dummy_auth_func(_a: String) -> Result { return Ok(true); } @@ -40,9 +40,8 @@ pub fn create_empty_config() -> Config { let mut tags = Vec::new(); tags.push(Tag { - id: "a".to_string(), - category_id: "b".to_string(), - name: "c".to_string(), + name: "a".to_string(), + description: "b".to_string(), }); return Config { @@ -73,7 +72,7 @@ pub fn create_empty_config() -> Config { #[cfg(test)] mod tests { - use crate::{dummy::create_empty_config, run}; + use crate::{api, dummy::create_empty_config, run}; #[test] fn caps_test_with_empty_config() { @@ -93,7 +92,19 @@ mod tests { } #[actix_rt::test] - async fn api_with_empty() { + async fn api_with_empty_config() { run(create_empty_config()).await.unwrap(); } + + #[actix_rt::test] + async fn api_with_no_config() { + // copied from lib.rs + // in this case, CONFIG is still None + // can't just use run() because that expects a Config, not an Option + rocket::build() + .mount("/", rocket::routes![api::caps]) + .launch() + .await + .unwrap(); + } }