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::{Deserialize, Deserializer, Serialize};

use crate::AnkiRequest;

/// Parameters for the "retrieveMediaFile" action.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
pub struct RetrieveMediaFileRequest {
    /// Filename of the media file to retrieve.
    pub filename: String,
}

/// Media file contents.
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct RetrieveMediaFileResponse {
    /// The base64-encoded file contents.
    ///
    /// Will be `None` if the file was not found in the media storage.
    pub encoded_bytes: Option<String>,
}

impl<'de> Deserialize<'de> for RetrieveMediaFileResponse {
    fn deserialize<D>(deserializer: D) -> Result<RetrieveMediaFileResponse, D::Error>
    where
        D: Deserializer<'de>,
    {
        let value: serde_json::Value = Deserialize::deserialize(deserializer)?;
        let encoded_bytes = match value {
            serde_json::Value::String(s) => Some(s),
            _ => None,
        };

        Ok(Self { encoded_bytes })
    }
}

impl AnkiRequest for RetrieveMediaFileRequest {
    type Response = RetrieveMediaFileResponse;

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

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

    #[test]
    fn test_serialize() {
        let request = RetrieveMediaFileRequest {
            filename: "_hello.txt".to_string(),
        };

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

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

        assert_eq!(
            response,
            RetrieveMediaFileResponse {
                encoded_bytes: Some("SGVsbG8sIHdvcmxkIQ==".to_string())
            }
        );
    }

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

        assert_eq!(
            response,
            RetrieveMediaFileResponse {
                encoded_bytes: None
            }
        );
    }
}