dsc-rs 0.10.15

Discourse CLI tool for managing multiple Discourse forums: track installs, run upgrades over SSH, manage emojis, sync topics and categories as Markdown, and more.
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

use super::client::DiscourseClient;
use super::error::http_error;
use anyhow::{Context, Result};
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// One row from /admin/api/keys.json.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct ApiKeySummary {
    pub id: u64,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default, alias = "user_username")]
    pub username: Option<String>,
    #[serde(default)]
    pub last_used_at: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
    #[serde(default)]
    pub revoked_at: Option<String>,
    #[serde(default)]
    pub truncated_key: Option<String>,
}

/// Response from POST /admin/api/keys.json — includes the full secret `key`.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct CreatedApiKey {
    pub id: u64,
    pub key: String,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default, alias = "user_username")]
    pub username: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
}

impl DiscourseClient {
    pub fn list_api_keys(&self) -> Result<Vec<ApiKeySummary>> {
        let response = self.get("/admin/api/keys.json")?;
        let status = response.status();
        let text = response.text().context("reading api keys response")?;
        if !status.is_success() {
            return Err(http_error("api keys list request", status, &text));
        }
        let value: Value =
            serde_json::from_str(&text).context("parsing api keys response json")?;
        let keys_value = value
            .get("keys")
            .cloned()
            .unwrap_or(Value::Array(Vec::new()));
        let keys: Vec<ApiKeySummary> =
            serde_json::from_value(keys_value).context("deserialising api keys")?;
        Ok(keys)
    }

    /// Create a new API key. `username` of `None` makes a global all-users key.
    pub fn create_api_key(&self, description: &str, username: Option<&str>) -> Result<CreatedApiKey> {
        let mut payload: Vec<(&str, &str)> = vec![("key[description]", description)];
        if let Some(u) = username {
            payload.push(("key[username]", u));
        }
        let response = self
            .send_retrying(|| Ok(self.post("/admin/api/keys.json")?.form(&payload)))?;
        let status = response.status();
        let text = response.text().context("reading api key create response")?;
        if !status.is_success() {
            return Err(http_error("api key create request", status, &text));
        }
        let value: Value =
            serde_json::from_str(&text).context("parsing api key create response")?;
        let key_obj = value.get("key").unwrap_or(&value);
        let created: CreatedApiKey =
            serde_json::from_value(key_obj.clone()).context("deserialising created api key")?;
        Ok(created)
    }

    pub fn revoke_api_key(&self, key_id: u64) -> Result<()> {
        let path = format!("/admin/api/keys/{}.json", key_id);
        let response = self.send_retrying(|| Ok(self.delete_builder(&path)?))?;
        let status = response.status();
        if !status.is_success() {
            let text = response
                .text()
                .unwrap_or_else(|_| "<failed to read response body>".to_string());
            return Err(http_error("api key revoke request", status, &text));
        }
        Ok(())
    }
}