io-jmap 0.2.1

//! JMAP `VacationResponse/get` coroutine (RFC 8621 §8.2): wraps the generic
//! [`JmapGet`] for the singleton `JmapVacationResponse` object.
//!
//! # Example
//!
//! ```rust,no_run
//! use std::{
//!     io::{Read, Write},
//!     net::TcpStream,
//! };
//!
//! use io_jmap::{
//!     coroutine::{JmapCoroutine, JmapCoroutineState, JmapYield},
//!     rfc8620::session::JmapSession,
//!     rfc8621::vacation_response::get::JmapVacationResponseGet,
//! };
//! use secrecy::SecretString;
//!
//! // Ready stream needed (TCP-connected, TLS-negociated)
//! let mut stream = TcpStream::connect("api.example.com:443").unwrap();
//! let mut buf = [0u8; 4096];
//!
//! let session: JmapSession = serde_json::from_str(r#"{
//!     "username": "",
//!     "accounts": {},
//!     "primaryAccounts": {"urn:ietf:params:jmap:mail": "a1"},
//!     "capabilities": {},
//!     "apiUrl": "https://api.example.com/jmap/",
//!     "downloadUrl": "",
//!     "uploadUrl": "",
//!     "eventSourceUrl": "",
//!     "state": ""
//! }"#).unwrap();
//! let auth = SecretString::from("Bearer xyz");
//! let mut coroutine = JmapVacationResponseGet::new(&session, &auth).unwrap();
//! let mut arg = None;
//!
//! let out = loop {
//!     match coroutine.resume(arg.take()) {
//!         JmapCoroutineState::Yielded(JmapYield::WantsWrite(bytes)) => {
//!             stream.write_all(&bytes).unwrap();
//!         }
//!         JmapCoroutineState::Yielded(JmapYield::WantsRead) => {
//!             let n = stream.read(&mut buf).unwrap();
//!             arg = Some(&buf[..n]);
//!         }
//!         JmapCoroutineState::Complete(Ok(out)) => break out,
//!         JmapCoroutineState::Complete(Err(err)) => panic!("{err}"),
//!     }
//! };
//!
//! println!("vacation enabled: {:?}", out.vacation_response);
//! ```

use alloc::{
    string::{String, ToString},
    vec,
    vec::Vec,
};

use secrecy::SecretString;
use serde::Serialize;
use thiserror::Error;

use crate::{
    coroutine::*,
    jmap_try,
    rfc8620::{JMAP_CORE_CAPABILITY, get::*, request::JmapBatch, send::*, session::JmapSession},
    rfc8621::{
        JMAP_MAIL_CAPABILITY,
        vacation_response::{JMAP_VACATION_RESPONSE_CAPABILITY, JmapVacationResponse},
    },
};

/// Failure causes during a JMAP `VacationResponse/get` flow.
#[derive(Debug, Error)]
pub enum JmapVacationResponseGetError {
    /// The inner send coroutine failed.
    #[error("JMAP VacationResponse/get failed: {0}")]
    Send(#[from] JmapSendError),
    /// The method arguments could not be serialized.
    #[error("JMAP VacationResponse/get failed: serialize args: {0}")]
    SerializeArgs(#[source] serde_json::Error),
    /// The inner generic get coroutine failed.
    #[error("JMAP VacationResponse/get failed: {0}")]
    Get(#[from] JmapGetError),
}

/// Successful terminal output of [`JmapVacationResponseGet`].
#[derive(Clone, Debug)]
pub struct JmapVacationResponseGetOutput {
    /// The vacation response singleton, when the server returned it.
    pub vacation_response: Option<JmapVacationResponse>,
    /// The new server state after the call.
    pub new_state: String,
    /// Whether the server indicated the connection can be reused.
    pub keep_alive: bool,
}

/// I/O-free coroutine for the JMAP `VacationResponse/get` method.
pub struct JmapVacationResponseGet {
    state: State,
}

impl JmapVacationResponseGet {
    /// Prepares the method call request and builds the coroutine.
    pub fn new(
        session: &JmapSession,
        http_auth: &SecretString,
    ) -> Result<Self, JmapVacationResponseGetError> {
        let account_id = session
            .primary_accounts
            .get(JMAP_VACATION_RESPONSE_CAPABILITY)
            .or_else(|| session.primary_accounts.get(JMAP_MAIL_CAPABILITY))
            .cloned()
            .unwrap_or_default();
        let api_url = &session.api_url;

        let args = serde_json::to_value(VacationResponseGetArgs {
            account_id,
            ids: vec!["singleton".to_string()],
        })
        .map_err(JmapVacationResponseGetError::SerializeArgs)?;

        let mut using = vec![JMAP_CORE_CAPABILITY.into(), JMAP_MAIL_CAPABILITY.into()];
        if session
            .capabilities
            .contains_key(JMAP_VACATION_RESPONSE_CAPABILITY)
        {
            using.push(JMAP_VACATION_RESPONSE_CAPABILITY.into());
        }

        let mut batch = JmapBatch::new();
        batch.add("VacationResponse/get", args);
        let request = batch.into_request(using);

        let send = JmapSend::new(http_auth, api_url, request)?;
        Ok(Self {
            state: State::Get(JmapGet::from_send(send)),
        })
    }
}

impl JmapCoroutine for JmapVacationResponseGet {
    type Yield = JmapYield;
    type Return = Result<JmapVacationResponseGetOutput, JmapVacationResponseGetError>;

    fn resume(&mut self, arg: Option<&[u8]>) -> JmapCoroutineState<Self::Yield, Self::Return> {
        match &mut self.state {
            State::Get(get) => {
                let JmapGetOutput {
                    list,
                    state,
                    keep_alive,
                    ..
                } = jmap_try!(get, arg);
                JmapCoroutineState::Complete(Ok(JmapVacationResponseGetOutput {
                    vacation_response: list.into_iter().next(),
                    new_state: state,
                    keep_alive,
                }))
            }
        }
    }
}

enum State {
    Get(JmapGet<JmapVacationResponse>),
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct VacationResponseGetArgs {
    account_id: String,
    ids: Vec<String>,
}