wekan-cli 0.3.0

Agent-first, human-friendly command-line client for Wekan
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use reqwest::header::ACCEPT;
use secrecy::{ExposeSecret, SecretString};
use serde::Deserialize;

use super::{
    ClientError, WekanClient, decode_success, protocol_error, require_non_empty, validate_date_time,
};

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ArchiveCardResult {
    pub card_id: String,
    pub archived: bool,
    pub archived_at: String,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RestoreCardResult {
    pub card_id: String,
    pub archived: bool,
}

#[derive(Deserialize)]
#[serde(deny_unknown_fields, rename_all = "camelCase")]
struct ArchiveResponse {
    #[serde(rename = "_id")]
    card_id: String,
    archived: bool,
    archived_at: String,
}

#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct RestoreResponse {
    #[serde(rename = "_id")]
    card_id: String,
    archived: bool,
}

impl WekanClient {
    pub async fn archive_card(
        &self,
        board_id: &str,
        list_id: &str,
        card_id: &str,
        token: &SecretString,
    ) -> Result<ArchiveCardResult, ClientError> {
        let body = self
            .execute_success_request(
                self.http
                    .post(self.card_action_endpoint(board_id, list_id, card_id, "archive")?)
                    .header(ACCEPT, "application/json")
                    .bearer_auth(token.expose_secret()),
            )
            .await?;
        let response: ArchiveResponse = decode_success(&body, "card archive", true)?;
        validate_state_response(
            &response.card_id,
            card_id,
            response.archived,
            true,
            "card archive",
        )?;
        validate_date_time(&response.archived_at, "archivedAt", "card archive")?;
        Ok(ArchiveCardResult {
            card_id: response.card_id,
            archived: response.archived,
            archived_at: response.archived_at,
        })
    }

    pub async fn restore_card(
        &self,
        board_id: &str,
        list_id: &str,
        card_id: &str,
        token: &SecretString,
    ) -> Result<RestoreCardResult, ClientError> {
        let body = self
            .execute_success_request(
                self.http
                    .post(self.card_action_endpoint(board_id, list_id, card_id, "unarchive")?)
                    .header(ACCEPT, "application/json")
                    .bearer_auth(token.expose_secret()),
            )
            .await?;
        let response: RestoreResponse = decode_success(&body, "card restore", true)?;
        validate_state_response(
            &response.card_id,
            card_id,
            response.archived,
            false,
            "card restore",
        )?;
        Ok(RestoreCardResult {
            card_id: response.card_id,
            archived: response.archived,
        })
    }

    fn card_action_endpoint(
        &self,
        board_id: &str,
        list_id: &str,
        card_id: &str,
        action: &str,
    ) -> Result<reqwest::Url, ClientError> {
        let mut endpoint = self.card_endpoint(board_id, list_id, Some(card_id))?;
        endpoint
            .path_segments_mut()
            .map_err(|()| ClientError::Protocol {
                diagnostic: None,
                message: "could not add the action to the card endpoint".to_owned(),
                success_status_received: false,
            })?
            .push(action);
        Ok(endpoint)
    }
}

fn validate_state_response(
    actual_id: &str,
    requested_id: &str,
    archived: bool,
    expected_archived: bool,
    operation: &str,
) -> Result<(), ClientError> {
    require_non_empty(actual_id, operation, "card id")?;
    if actual_id != requested_id {
        return Err(protocol_error(format!(
            "the {operation} response reported a different card ID than requested"
        )));
    }
    if archived != expected_archived {
        return Err(protocol_error(format!(
            "the {operation} response contained an unexpected archived state"
        )));
    }
    Ok(())
}