feat(readarr): delete a book and expose the command on the CLI
The delete flags travel as query parameters rather than a request body, and Readarr spells the exclusion key addImportListExclusion, not the addImportExclusion that Radarr uses.
This commit is contained in:
6 files changed
+228
-3
No files matched your search
@@ -27,6 +27,15 @@ pub enum ReadarrDeleteCommand {
|
|||||||
#[arg(long, help = "Add a list exclusion for this author")]
|
#[arg(long, help = "Add a list exclusion for this author")]
|
||||||
add_list_exclusion: bool,
|
add_list_exclusion: bool,
|
||||||
},
|
},
|
||||||
|
#[command(about = "Delete a book from your Readarr library")]
|
||||||
|
Book {
|
||||||
|
#[arg(long, help = "The ID of the book to delete", required = true)]
|
||||||
|
book_id: i64,
|
||||||
|
#[arg(long, help = "Delete the book files from disk as well")]
|
||||||
|
delete_files_from_disk: bool,
|
||||||
|
#[arg(long, help = "Add a list exclusion for this book")]
|
||||||
|
add_list_exclusion: bool,
|
||||||
|
},
|
||||||
#[command(about = "Delete the root folder with the given ID")]
|
#[command(about = "Delete the root folder with the given ID")]
|
||||||
RootFolder {
|
RootFolder {
|
||||||
#[arg(long, help = "The ID of the root folder to delete", required = true)]
|
#[arg(long, help = "The ID of the root folder to delete", required = true)]
|
||||||
@@ -84,6 +93,22 @@ impl<'a, 'b> CliCommandHandler<'a, 'b, ReadarrDeleteCommand>
|
|||||||
.await?;
|
.await?;
|
||||||
serde_json::to_string_pretty(&resp)?
|
serde_json::to_string_pretty(&resp)?
|
||||||
}
|
}
|
||||||
|
ReadarrDeleteCommand::Book {
|
||||||
|
book_id,
|
||||||
|
delete_files_from_disk,
|
||||||
|
add_list_exclusion,
|
||||||
|
} => {
|
||||||
|
let delete_book_params = DeleteParams {
|
||||||
|
id: book_id,
|
||||||
|
delete_files: delete_files_from_disk,
|
||||||
|
add_import_list_exclusion: add_list_exclusion,
|
||||||
|
};
|
||||||
|
let resp = self
|
||||||
|
.network
|
||||||
|
.handle_network_event(ReadarrEvent::DeleteBook(delete_book_params).into())
|
||||||
|
.await?;
|
||||||
|
serde_json::to_string_pretty(&resp)?
|
||||||
|
}
|
||||||
ReadarrDeleteCommand::RootFolder { root_folder_id } => {
|
ReadarrDeleteCommand::RootFolder { root_folder_id } => {
|
||||||
let resp = self
|
let resp = self
|
||||||
.network
|
.network
|
||||||
|
|||||||
@@ -104,6 +104,79 @@ mod tests {
|
|||||||
assert_eq!(delete_command, expected_args);
|
assert_eq!(delete_command, expected_args);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_delete_book_requires_arguments() {
|
||||||
|
let result = Cli::command().try_get_matches_from(["managarr", "readarr", "delete", "book"]);
|
||||||
|
|
||||||
|
assert_err!(&result);
|
||||||
|
assert_eq!(
|
||||||
|
result.unwrap_err().kind(),
|
||||||
|
ErrorKind::MissingRequiredArgument
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_delete_book_book_id_requires_a_number() {
|
||||||
|
let result = Cli::command().try_get_matches_from([
|
||||||
|
"managarr",
|
||||||
|
"readarr",
|
||||||
|
"delete",
|
||||||
|
"book",
|
||||||
|
"--book-id",
|
||||||
|
"not_a_number",
|
||||||
|
]);
|
||||||
|
|
||||||
|
assert_err!(&result);
|
||||||
|
assert_eq!(result.unwrap_err().kind(), ErrorKind::ValueValidation);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_delete_book_defaults() {
|
||||||
|
let expected_args = ReadarrDeleteCommand::Book {
|
||||||
|
book_id: 1,
|
||||||
|
delete_files_from_disk: false,
|
||||||
|
add_list_exclusion: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
let result = Cli::try_parse_from(["managarr", "readarr", "delete", "book", "--book-id", "1"]);
|
||||||
|
|
||||||
|
assert_ok!(&result);
|
||||||
|
|
||||||
|
let Some(Command::Readarr(ReadarrCommand::Delete(delete_command))) = result.unwrap().command
|
||||||
|
else {
|
||||||
|
panic!("Unexpected command type");
|
||||||
|
};
|
||||||
|
assert_eq!(delete_command, expected_args);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_delete_book_all_args_defined() {
|
||||||
|
let expected_args = ReadarrDeleteCommand::Book {
|
||||||
|
book_id: 1,
|
||||||
|
delete_files_from_disk: true,
|
||||||
|
add_list_exclusion: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let result = Cli::try_parse_from([
|
||||||
|
"managarr",
|
||||||
|
"readarr",
|
||||||
|
"delete",
|
||||||
|
"book",
|
||||||
|
"--book-id",
|
||||||
|
"1",
|
||||||
|
"--delete-files-from-disk",
|
||||||
|
"--add-list-exclusion",
|
||||||
|
]);
|
||||||
|
|
||||||
|
assert_ok!(&result);
|
||||||
|
|
||||||
|
let Some(Command::Readarr(ReadarrCommand::Delete(delete_command))) = result.unwrap().command
|
||||||
|
else {
|
||||||
|
panic!("Unexpected command type");
|
||||||
|
};
|
||||||
|
assert_eq!(delete_command, expected_args);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_delete_root_folder_requires_arguments() {
|
fn test_delete_root_folder_requires_arguments() {
|
||||||
let result =
|
let result =
|
||||||
@@ -248,6 +321,40 @@ mod tests {
|
|||||||
assert_ok!(&result);
|
assert_ok!(&result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_delete_book_command() {
|
||||||
|
let expected_delete_book_params = DeleteParams {
|
||||||
|
id: 1,
|
||||||
|
delete_files: true,
|
||||||
|
add_import_list_exclusion: false,
|
||||||
|
};
|
||||||
|
let mut mock_network = MockNetworkTrait::new();
|
||||||
|
mock_network
|
||||||
|
.expect_handle_network_event()
|
||||||
|
.with(eq::<NetworkEvent>(
|
||||||
|
ReadarrEvent::DeleteBook(expected_delete_book_params).into(),
|
||||||
|
))
|
||||||
|
.times(1)
|
||||||
|
.returning(|_| {
|
||||||
|
Ok(Serdeable::Readarr(ReadarrSerdeable::Value(
|
||||||
|
json!({"testResponse": "response"}),
|
||||||
|
)))
|
||||||
|
});
|
||||||
|
let app_arc = Arc::new(Mutex::new(App::test_default()));
|
||||||
|
let delete_book_command = ReadarrDeleteCommand::Book {
|
||||||
|
book_id: 1,
|
||||||
|
delete_files_from_disk: true,
|
||||||
|
add_list_exclusion: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
let result =
|
||||||
|
ReadarrDeleteCommandHandler::with(&app_arc, delete_book_command, &mut mock_network)
|
||||||
|
.handle()
|
||||||
|
.await;
|
||||||
|
|
||||||
|
assert_ok!(&result);
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn test_handle_delete_root_folder_command() {
|
async fn test_handle_delete_root_folder_command() {
|
||||||
let mut mock_network = MockNetworkTrait::new();
|
let mut mock_network = MockNetworkTrait::new();
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ use serde_json::{Value, json};
|
|||||||
|
|
||||||
use crate::models::Route;
|
use crate::models::Route;
|
||||||
use crate::models::readarr_models::{
|
use crate::models::readarr_models::{
|
||||||
Book, BookFile, Edition, ReadarrCommandBody, ReadarrHistoryItem,
|
Book, BookFile, DeleteParams, Edition, ReadarrCommandBody, ReadarrHistoryItem,
|
||||||
};
|
};
|
||||||
use crate::models::servarr_data::readarr::readarr_data::ActiveReadarrBlock;
|
use crate::models::servarr_data::readarr::readarr_data::ActiveReadarrBlock;
|
||||||
use crate::network::readarr_network::ReadarrEvent;
|
use crate::network::readarr_network::ReadarrEvent;
|
||||||
@@ -15,6 +15,38 @@ use crate::network::{Network, RequestMethod};
|
|||||||
mod readarr_books_network_tests;
|
mod readarr_books_network_tests;
|
||||||
|
|
||||||
impl Network<'_, '_> {
|
impl Network<'_, '_> {
|
||||||
|
pub(in crate::network::readarr_network) async fn delete_book(
|
||||||
|
&mut self,
|
||||||
|
delete_book_params: DeleteParams,
|
||||||
|
) -> Result<()> {
|
||||||
|
let event = ReadarrEvent::DeleteBook(DeleteParams::default());
|
||||||
|
let DeleteParams {
|
||||||
|
id,
|
||||||
|
delete_files,
|
||||||
|
add_import_list_exclusion,
|
||||||
|
} = delete_book_params;
|
||||||
|
|
||||||
|
info!(
|
||||||
|
"Deleting Readarr book with ID: {id} with deleteFiles={delete_files} and addImportListExclusion={add_import_list_exclusion}"
|
||||||
|
);
|
||||||
|
|
||||||
|
let request_props = self
|
||||||
|
.request_props_from(
|
||||||
|
event,
|
||||||
|
RequestMethod::Delete,
|
||||||
|
None::<()>,
|
||||||
|
Some(format!("/{id}")),
|
||||||
|
Some(format!(
|
||||||
|
"deleteFiles={delete_files}&addImportListExclusion={add_import_list_exclusion}"
|
||||||
|
)),
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
self
|
||||||
|
.handle_request::<(), ()>(request_props, |_, _| ())
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
|
||||||
pub(in crate::network::readarr_network) async fn get_book_details(
|
pub(in crate::network::readarr_network) async fn get_book_details(
|
||||||
&mut self,
|
&mut self,
|
||||||
book_id: i64,
|
book_id: i64,
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use crate::models::readarr_models::{
|
use crate::models::readarr_models::{
|
||||||
Book, BookFile, Edition, ReadarrHistoryItem, ReadarrSerdeable,
|
Book, BookFile, DeleteParams, Edition, ReadarrHistoryItem, ReadarrSerdeable,
|
||||||
};
|
};
|
||||||
use crate::models::servarr_data::readarr::modals::BookDetailsModal;
|
use crate::models::servarr_data::readarr::modals::BookDetailsModal;
|
||||||
use crate::models::servarr_data::readarr::readarr_data::ActiveReadarrBlock;
|
use crate::models::servarr_data::readarr::readarr_data::ActiveReadarrBlock;
|
||||||
@@ -18,6 +18,60 @@ mod tests {
|
|||||||
use rstest::rstest;
|
use rstest::rstest;
|
||||||
use serde_json::{Value, json};
|
use serde_json::{Value, json};
|
||||||
|
|
||||||
|
#[rstest]
|
||||||
|
#[case(true, false, "deleteFiles=true&addImportListExclusion=false")]
|
||||||
|
#[case(false, true, "deleteFiles=false&addImportListExclusion=true")]
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_delete_book_event(
|
||||||
|
#[case] delete_files: bool,
|
||||||
|
#[case] add_import_list_exclusion: bool,
|
||||||
|
#[case] expected_query: &str,
|
||||||
|
) {
|
||||||
|
let delete_book_params = DeleteParams {
|
||||||
|
id: 1,
|
||||||
|
delete_files,
|
||||||
|
add_import_list_exclusion,
|
||||||
|
};
|
||||||
|
let (mock, app, _server) = MockServarrApi::delete()
|
||||||
|
.path("/1")
|
||||||
|
.query(expected_query)
|
||||||
|
.build_for(ReadarrEvent::DeleteBook(delete_book_params.clone()))
|
||||||
|
.await;
|
||||||
|
app.lock().await.server_tabs.set_index(3);
|
||||||
|
let mut network = test_network(&app);
|
||||||
|
|
||||||
|
let result = network
|
||||||
|
.handle_readarr_event(ReadarrEvent::DeleteBook(delete_book_params))
|
||||||
|
.await;
|
||||||
|
|
||||||
|
mock.assert_async().await;
|
||||||
|
assert_ok!(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_delete_book_event_failure() {
|
||||||
|
let delete_book_params = DeleteParams {
|
||||||
|
id: 1,
|
||||||
|
delete_files: true,
|
||||||
|
add_import_list_exclusion: false,
|
||||||
|
};
|
||||||
|
let (mock, app, _server) = MockServarrApi::delete()
|
||||||
|
.path("/1")
|
||||||
|
.query("deleteFiles=true&addImportListExclusion=false")
|
||||||
|
.status(500)
|
||||||
|
.build_for(ReadarrEvent::DeleteBook(delete_book_params.clone()))
|
||||||
|
.await;
|
||||||
|
app.lock().await.server_tabs.set_index(3);
|
||||||
|
let mut network = test_network(&app);
|
||||||
|
|
||||||
|
let result = network
|
||||||
|
.handle_readarr_event(ReadarrEvent::DeleteBook(delete_book_params))
|
||||||
|
.await;
|
||||||
|
|
||||||
|
mock.assert_async().await;
|
||||||
|
assert_err!(result);
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn test_handle_get_book_details_event() {
|
async fn test_handle_get_book_details_event() {
|
||||||
let expected_book: Book = serde_json::from_str(BOOK_JSON).unwrap();
|
let expected_book: Book = serde_json::from_str(BOOK_JSON).unwrap();
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ pub enum ReadarrEvent {
|
|||||||
AddRootFolder(AddReadarrRootFolderBody),
|
AddRootFolder(AddReadarrRootFolderBody),
|
||||||
AddTag(String),
|
AddTag(String),
|
||||||
DeleteAuthor(DeleteParams),
|
DeleteAuthor(DeleteParams),
|
||||||
|
DeleteBook(DeleteParams),
|
||||||
DeleteRootFolder(i64),
|
DeleteRootFolder(i64),
|
||||||
DeleteTag(i64),
|
DeleteTag(i64),
|
||||||
EditAuthor(EditAuthorParams),
|
EditAuthor(EditAuthorParams),
|
||||||
@@ -72,7 +73,8 @@ impl NetworkResource for ReadarrEvent {
|
|||||||
| ReadarrEvent::ListAuthors
|
| ReadarrEvent::ListAuthors
|
||||||
| ReadarrEvent::ToggleAuthorMonitoring(_) => "/author",
|
| ReadarrEvent::ToggleAuthorMonitoring(_) => "/author",
|
||||||
ReadarrEvent::SearchNewAuthor(_) => "/author/lookup",
|
ReadarrEvent::SearchNewAuthor(_) => "/author/lookup",
|
||||||
ReadarrEvent::GetBookDetails(_)
|
ReadarrEvent::DeleteBook(_)
|
||||||
|
| ReadarrEvent::GetBookDetails(_)
|
||||||
| ReadarrEvent::GetBooks(_)
|
| ReadarrEvent::GetBooks(_)
|
||||||
| ReadarrEvent::ToggleBookMonitoring(_) => "/book",
|
| ReadarrEvent::ToggleBookMonitoring(_) => "/book",
|
||||||
ReadarrEvent::GetBookFiles(_) => "/bookfile",
|
ReadarrEvent::GetBookFiles(_) => "/bookfile",
|
||||||
@@ -123,6 +125,10 @@ impl Network<'_, '_> {
|
|||||||
.delete_author(delete_author_params)
|
.delete_author(delete_author_params)
|
||||||
.await
|
.await
|
||||||
.map(ReadarrSerdeable::from),
|
.map(ReadarrSerdeable::from),
|
||||||
|
ReadarrEvent::DeleteBook(delete_book_params) => self
|
||||||
|
.delete_book(delete_book_params)
|
||||||
|
.await
|
||||||
|
.map(ReadarrSerdeable::from),
|
||||||
ReadarrEvent::DeleteRootFolder(root_folder_id) => self
|
ReadarrEvent::DeleteRootFolder(root_folder_id) => self
|
||||||
.delete_readarr_root_folder(root_folder_id)
|
.delete_readarr_root_folder(root_folder_id)
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ mod tests {
|
|||||||
#[case(ReadarrEvent::ListAuthors, "/author")]
|
#[case(ReadarrEvent::ListAuthors, "/author")]
|
||||||
#[case(ReadarrEvent::ToggleAuthorMonitoring(1), "/author")]
|
#[case(ReadarrEvent::ToggleAuthorMonitoring(1), "/author")]
|
||||||
#[case(ReadarrEvent::SearchNewAuthor(String::new()), "/author/lookup")]
|
#[case(ReadarrEvent::SearchNewAuthor(String::new()), "/author/lookup")]
|
||||||
|
#[case(ReadarrEvent::DeleteBook(DeleteParams::default()), "/book")]
|
||||||
#[case(ReadarrEvent::GetBookDetails(1), "/book")]
|
#[case(ReadarrEvent::GetBookDetails(1), "/book")]
|
||||||
#[case(ReadarrEvent::GetBooks(1), "/book")]
|
#[case(ReadarrEvent::GetBooks(1), "/book")]
|
||||||
#[case(ReadarrEvent::ToggleBookMonitoring(1), "/book")]
|
#[case(ReadarrEvent::ToggleBookMonitoring(1), "/book")]
|
||||||
|
|||||||
Reference in new issue
Block a user