pushover-rs 0.3.23

A Rust client for Pushover (https://www.pushover.net)
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

use reqwest::multipart::{Form, Part};
use serde::Serialize;
use std::io;

#[derive(Debug, Clone, Serialize)]
/**

 A message containing an attachment, to be used in conjunction with the send_pushover_request_with_attachment function.

 Note: It is preferred to create a Message through the AttachmentMessageBuilder.
 **/
pub struct AttachmentMessage {
    /* Required */
    /// (Required) Your app API token, see https://pushover.net/apps/[your application ID]
    pub app_token: String,
    /// (Required) Your User key, see your dashboard (https://pushover.net/ top-right)
    pub user_key: String,
    /// (Required) Your message
    pub message: String,
    /// (Required) An attachment file path to send with the message. (Max size: 2,5MB)
    pub attachment: String,

    /* Optional */
    /// The title of the message, otherwise your app's name will be used
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// A supplementary URL to show with your message
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    /// A title for your supplementary URL, otherwise just the URL is shown
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url_title: Option<String>,
    /// Send as -2 to generate no notification/alert, -1 to always send as a quiet notification, 1 to display as high-priority and bypass the user's quiet hours, or 2 to also require confirmation from the user
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<String>,
    /// When the priority is set to 2, sets the amount of seconds between each retries. Must be at least 30 seconds.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub retry: Option<String>, // Required if priority is set to 2
    /// When the priority is set to 2, sets the amount of seconds before the notification is expired. The maximum value is 10800 (3 hours).be between 60 and 10800.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expire: Option<String>, // Required if priority is set to 2
    /// The name of one of the sounds supported by device clients to override the user's default sound choice. (See sound list: https://pushover.net/api#sounds)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sound: Option<String>,
    /// A Unix timestamp of your message's date and time to display to the user, rather than the time your message is received by our API
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<String>, // Year 2038 proof :p
    /// A device name to send the push notifications to.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device: Option<String>,
    /// A TTL (Time to Live) in seconds, after which the message will be automatically deleted from the recipient's inbox.
    /// Setting *ttl* to None prevents this auto removal. Setting TTL to 0 will raise an error (ttl must be > 0).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ttl: Option<u32>,
}

impl AttachmentMessage {
    pub fn into_form(self) -> Result<reqwest::blocking::multipart::Form, std::io::Error> {
        let mut form: reqwest::blocking::multipart::Form = reqwest::blocking::multipart::Form::new()
            .text("token", self.app_token.clone())
            .text("user", self.user_key.clone())
            .text("message", self.message.clone())
            .text("title", self.title.clone().unwrap_or(String::from("")))
            .text("url", self.url.clone().unwrap_or(String::from("")))
            .text("url_title", self.url_title.clone().unwrap_or(String::from("")))
            .text("priority", self.priority.unwrap_or(String::from("")))
            .text("retry", self.retry.clone().unwrap_or(String::from("")))
            .text("expire", self.expire.clone().unwrap_or(String::from("")))
            .text("sound", self.sound.clone().unwrap_or(String::from("")))
            .text("timestamp", self.timestamp.unwrap_or(String::from("")))
            .text("device", self.device.clone().unwrap_or(String::from("")));
        // TTL became required if it has a value, 0 doesn't work anymore.
        if self.ttl.is_some() {
            form = form.text("ttl", self.ttl.unwrap_or(999).to_string());
        }
        let attachment_part = reqwest::blocking::multipart::Part::bytes(std::fs::read(&self.attachment)?)
            .file_name(self.attachment.clone());
        Ok(form.part("attachment", attachment_part))
    }

    pub async fn into_form_async(self) -> Result<Form, io::Error> {
        let mut form = Form::new()
            .text("token", self.app_token.clone())
            .text("user", self.user_key.clone())
            .text("message", self.message.clone())
            .text("title", self.title.clone().unwrap_or(String::from("")))
            .text("url", self.url.clone().unwrap_or(String::from("")))
            .text("url_title", self.url_title.clone().unwrap_or(String::from("")))
            .text("priority", self.priority.unwrap_or(String::from("")))
            .text("sound", self.sound.clone().unwrap_or(String::from("")))
            .text("timestamp", self.timestamp.unwrap_or(String::from("")))
            .text("device", self.device.clone().unwrap_or(String::from("")));
        if self.ttl.is_some() {
            form = form.text("ttl", self.ttl.unwrap_or(999).to_string());
        }
        let file_bytes = tokio::fs::read(&self.attachment).await?;
        let part = Part::bytes(file_bytes)
            .file_name(self.attachment.clone());
        Ok(form.part("attachment", part))
    }
}

impl Default for AttachmentMessage {
    fn default() -> Self {
        Self {
            app_token: "".into(),
            user_key: "".into(),
            message: "".into(),
            attachment: "".into(),
            title: None,
            url: None,
            url_title: None,
            priority: None,
            retry: None,
            expire: None,
            sound: None,
            timestamp: None,
            device: None,
            ttl: None,
        }
    }
}