anki_bridge 0.10.2

/*
* The MIT License (MIT)
*
* Copyright (c) 2025 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::Serialize;

use crate::AnkiRequest;

/// Parameters for the "storeMediaFile" action.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
pub struct StoreMediaFileRequest {
    /// Filename of the media file to store.
    ///
    /// To prevent Anki from removing files not used by any cards (e.g. for configuration files),
    /// prefix the filename with an underscore.
    pub filename: String,
    /// The binary data, Base64 encoded. One of `data`, `path` or `url` must be specified.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<String>,
    /// Path to the file. One of `data`, `path` or `url` must be specified.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub path: Option<String>,
    /// URL to the file. One of `data`, `path` or `url` must be specified.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
}

impl AnkiRequest for StoreMediaFileRequest {
    type Response = String;

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

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

    #[test]
    fn test_serialize_with_data() {
        let request = StoreMediaFileRequest {
            filename: "anki_bridge_test".to_string(),
            data: Some("SGVsbG8sIHdvcmxkIQ==".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "filename": "anki_bridge_test",
  "data": "SGVsbG8sIHdvcmxkIQ=="
}"#
        );
    }

    #[test]
    fn test_serialize_with_path() {
        let request = StoreMediaFileRequest {
            filename: "anki_bridge_test".to_string(),
            path: Some("/tmp/anki_bridge_test".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "filename": "anki_bridge_test",
  "path": "/tmp/anki_bridge_test"
}"#
        );
    }

    #[test]
    fn test_serialize_with_url() {
        let request = StoreMediaFileRequest {
            filename: "black_cat.jpg".to_string(),
            url: Some("https://upload.wikimedia.org/wikipedia/commons/thumb/c/c7/A_black_cat_named_Tilly.jpg/220px-A_black_cat_named_Tilly.jpg".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "filename": "black_cat.jpg",
  "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c7/A_black_cat_named_Tilly.jpg/220px-A_black_cat_named_Tilly.jpg"
}"#
        );
    }

    #[test]
    fn test_deserialize() {
        let response: <StoreMediaFileRequest as AnkiRequest>::Response =
            serde_json::from_str("\"anki_bridge_test\"").unwrap();

        assert_eq!(response, "anki_bridge_test");
    }
}