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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
// MIT License // // Copyright (c) 2019 Ankur Srivastava // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. use hostname::get_hostname; use reqwest; use serde::{Deserialize, Serialize}; /// RocketClient represents a minimal rocketchat client which can be used to send text /// messages to a given webhook. /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .execute(); /// ``` #[derive(Debug, Default, Serialize, Deserialize)] pub struct RocketClient { text: String, webhook: String, emoji: Option<String>, botname: Option<String>, channel: Option<String>, hostname: Option<String>, } impl RocketClient { pub fn new<T>(webhook: T) -> Self where T: Into<String>, { RocketClient { webhook: webhook.into(), ..Default::default() } } /// Define the channel name where this message is to be sent /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .execute(); /// ``` pub fn with_channel<T>(&mut self, channel: T) -> &mut Self where T: Into<String>, { self.channel = Some(channel.into()); self } /// Define the hostname from which this message is being sent /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_hostname("my-machine") /// .execute(); /// ``` pub fn with_hostname<T>(&mut self, hostname: T) -> &mut Self where T: Into<String>, { self.hostname = Some(hostname.into()); self } /// Define text which is to be sent. /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .with_text("Hi world") /// .execute(); /// ``` pub fn with_text<T>(&mut self, text: T) -> &mut Self where T: Into<String>, { self.text = text.into(); self } /// Add default hostname with the message being sent /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .with_default_hostname() /// .execute(); /// ``` pub fn with_default_hostname(&mut self) -> &mut Self { self.hostname = get_hostname(); self } /// Add botname with the message being sent /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .with_botname("some-bot") /// .execute(); /// ``` pub fn with_botname<T>(&mut self, botname: T) -> &mut Self where T: Into<Option<String>>, { self.botname = botname.into(); self } /// Add emoji with the message being sent /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .with_emoji(":sos:") /// .execute(); /// ``` pub fn with_emoji<T>(&mut self, emoji: T) -> &mut Self where T: Into<Option<String>>, { self.emoji = emoji.into(); self } /// Execute the builder pattern finally after constructing the object. /// /// # Examples /// Basic usage: /// /// ```rust ignore /// use crate::client::RocketClient; /// let client = RocketClient::new("www.facebook.com") /// .with_channel("#test-logs") /// .with_text("Hi world") /// .with_default_hostname() /// .execute(); /// ``` pub fn execute(&mut self) -> Result<(), reqwest::Error> { let rocket_client = RocketClient { webhook: self.webhook.clone(), channel: self.channel.clone(), hostname: self.hostname.clone(), emoji: self.emoji.clone(), botname: self.botname.clone(), text: self.text.clone(), }; reqwest::Client::new() .post(&rocket_client.webhook) .json(&rocket_client) .send()? .json()?; Ok(()) } } #[cfg(test)] mod tests { use super::*; #[test] fn test_execute() { let response = RocketClient::new("https://example.com") .with_channel("#test-logs") .with_text("Hi world") .with_default_hostname() .execute(); assert!( response.is_err(), "Should return error in case unable to send text to Rocketchat" ); } }