anki_bridge 0.10.2

AnkiBridge is a Rust library that provides a bridge between your Rust code and the Anki application, enabling HTTP communication and seamless data transmission.
Documentation
/*
* The MIT License (MIT)
*
* Copyright (c) 2023 DaniƩl Kerkmann <daniel@kerkmann.dev>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

use serde::{Deserialize, Deserializer, Serialize};

use crate::AnkiRequest;
use crate::entities::DeckConfigId;

/// Parameters for cloning a deck configuration by ID.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CloneDeckConfigIdRequest {
    /// Name of the new configuration group.
    pub name: String,
    /// ID of the configuration group to clone from.
    pub clone_from: DeckConfigId,
}

/// Result of the deck configuration cloning.
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct CloneDeckConfigIdResponse {
    /// ID of the newly created deck configuration.
    ///
    /// Will be `None` if the deck configuration in the request does not exist.
    pub new_deck_config_id: Option<DeckConfigId>,
}

impl<'de> Deserialize<'de> for CloneDeckConfigIdResponse {
    fn deserialize<D>(deserializer: D) -> Result<CloneDeckConfigIdResponse, D::Error>
    where
        D: Deserializer<'de>,
    {
        let value: serde_json::Value = Deserialize::deserialize(deserializer)?;
        let new_deck_config_id = match value {
            serde_json::Value::Number(num) => num.as_i64(),
            _ => None,
        };

        Ok(Self { new_deck_config_id })
    }
}

impl AnkiRequest for CloneDeckConfigIdRequest {
    type Response = CloneDeckConfigIdResponse;

    const ACTION: &'static str = "cloneDeckConfigId";
    const VERSION: u8 = 6;
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_serialize() {
        let request = CloneDeckConfigIdRequest {
            name: "Copy of Default".to_string(),
            clone_from: 1,
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "name": "Copy of Default",
  "cloneFrom": 1
}"#
        );
    }

    #[test]
    fn test_deserialize_success() {
        let json = "1502972374573";
        let response: <CloneDeckConfigIdRequest as AnkiRequest>::Response =
            serde_json::from_str(json).unwrap();

        assert_eq!(
            response,
            CloneDeckConfigIdResponse {
                new_deck_config_id: Some(1502972374573)
            }
        );
    }

    #[test]
    fn test_deserialize_missing_config() {
        let json = "false";
        let response: <CloneDeckConfigIdRequest as AnkiRequest>::Response =
            serde_json::from_str(json).unwrap();

        assert_eq!(
            response,
            CloneDeckConfigIdResponse {
                new_deck_config_id: None
            }
        );
    }
}