io_jmap/rfc9610/address_book/

get.rs

//! JMAP `AddressBook/get` coroutine (RFC 9610 §2.1): wraps the generic
//! [`JmapGet`] with the JMAP-Contacts capability set.
//!
//! # Example
//!
//! ```rust,no_run
//! use std::{
//!     io::{Read, Write},
//!     net::TcpStream,
//! };
//!
//! use io_jmap::{
//!     coroutine::{JmapCoroutine, JmapCoroutineState, JmapYield},
//!     rfc8620::session::JmapSession,
//!     rfc9610::address_book::get::{JmapAddressBookGet, JmapAddressBookGetOptions},
//! };
//! 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:contacts": "a1"},
//!     "capabilities": {},
//!     "apiUrl": "https://api.example.com/jmap/",
//!     "downloadUrl": "",
//!     "uploadUrl": "",
//!     "eventSourceUrl": "",
//!     "state": ""
//! }"#).unwrap();
//! let auth = SecretString::from("Bearer xyz");
//! let mut coroutine =
//!     JmapAddressBookGet::new(&session, &auth, JmapAddressBookGetOptions::default()).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!("{} address books", out.address_books.len());
//! ```

use alloc::{borrow::ToOwned, format, string::String, vec, vec::Vec};

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

use crate::{
    coroutine::*,
    jmap_try,
    rfc8620::{JMAP_CORE_CAPABILITY, get::*, session::JmapSession},
    rfc9610::{JMAP_CONTACTS_CAPABILITY, address_book::JmapAddressBook},
};

/// [`JmapAddressBook`] properties requestable in `AddressBook/get`
/// (RFC 9610 §2).
#[derive(Clone, Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum JmapAddressBookProperty {
    /// The `id` property.
    Id,
    /// The `name` property.
    Name,
    /// The `description` property.
    Description,
    /// The `sortOrder` property.
    SortOrder,
    /// The `isDefault` property.
    IsDefault,
    /// The `isSubscribed` property.
    IsSubscribed,
    /// The `shareWith` property.
    ShareWith,
    /// The `myRights` property.
    MyRights,
}

/// Failure causes during a JMAP `AddressBook/get` flow.
#[derive(Debug, Error)]
pub enum JmapAddressBookGetError {
    /// The inner generic get coroutine failed.
    #[error("JMAP AddressBook/get failed: {0}")]
    Get(#[from] JmapGetError),
}

/// Options for [`JmapAddressBookGet::new`].
#[derive(Clone, Debug, Default)]
pub struct JmapAddressBookGetOptions {
    /// Restrict the fetch to these AddressBook IDs; `None` fetches all.
    pub ids: Option<Vec<String>>,
    /// Restrict the returned properties; `None` returns all.
    pub properties: Option<Vec<JmapAddressBookProperty>>,
}

/// Successful terminal output of [`JmapAddressBookGet`].
#[derive(Clone, Debug)]
pub struct JmapAddressBookGetOutput {
    /// The fetched address books.
    pub address_books: Vec<JmapAddressBook>,
    /// The requested ids the server did not find.
    pub not_found: Vec<String>,
    /// 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 `AddressBook/get` method.
pub struct JmapAddressBookGet {
    state: State,
}

impl JmapAddressBookGet {
    /// Prepares the method call request and builds the coroutine.
    pub fn new(
        session: &JmapSession,
        http_auth: &SecretString,
        opts: JmapAddressBookGetOptions,
    ) -> Result<Self, JmapAddressBookGetError> {
        let account_id = session
            .primary_accounts
            .get(JMAP_CONTACTS_CAPABILITY)
            .cloned()
            .unwrap_or_default();
        let api_url = &session.api_url;

        let props = opts.properties.map(|ps| {
            ps.iter()
                .map(|p| {
                    serde_json::to_value(p)
                        .ok()
                        .and_then(|v| v.as_str().map(str::to_owned))
                        .unwrap_or_else(|| format!("{p:?}"))
                })
                .collect()
        });

        Ok(Self {
            state: State::Get(JmapGet::new(
                account_id,
                http_auth,
                api_url,
                "AddressBook/get",
                vec![JMAP_CORE_CAPABILITY.into(), JMAP_CONTACTS_CAPABILITY.into()],
                JmapGetOptions {
                    ids: opts.ids,
                    properties: props,
                },
            )?),
        })
    }
}

impl JmapCoroutine for JmapAddressBookGet {
    type Yield = JmapYield;
    type Return = Result<JmapAddressBookGetOutput, JmapAddressBookGetError>;

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

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