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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
//! crate for working with Connectwise Manage API //! //! In the connectwise api <https://developer.connectwise.com/Products/Manage> some results are //! returned as a single 'object' and most are returned as a list. //! Normally you will be getting a list of results (even a list of one) so you would use [Client.get]. //! In some cases, (/system/info for example) it does not return a list, in this case use [Client.get_single]. //! Consult the api documentation (above) for more details. //! //! # Basic usage //! //! Basic client with default api_uri, codebase, and api version //! ``` //! use cwmanage::Client; //! use dotenv::dotenv; //! dotenv().ok(); //! let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); //! let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); //! let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); //! let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); //! let client = Client::new(company_id, public_key, private_key, client_id).build(); //! let query = [("", "")]; //! let result = client.get_single("/system/info", &query).unwrap(); //! ``` //! Override the api_version //! ``` //! use cwmanage::Client; //! use dotenv::dotenv; //! dotenv().ok(); //! let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); //! let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); //! let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); //! let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); //! //! let client = Client::new(company_id, public_key, private_key, client_id).build(); //! let query = [("", "")]; //! let result = client.get_single("/system/info", &query).unwrap(); //! ``` //! //! Get an endpoint with multiple results //! ``` //! use cwmanage::Client; //! use dotenv::dotenv; //! dotenv().ok(); //! let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); //! let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); //! let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); //! let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); //! let client = Client::new(company_id, public_key, private_key, client_id).build(); //! let query = [("fields", "id,identifier")]; //! let result = client.get("/system/members", &query); //! ``` //! //! # Query examples //! See the connectwise api for further details //! //! - No query - `[("", "")]` //! - Only get the id field `[("fields", "id")]` //! - Also apply some conditions `[("fields", "id"), ("conditions", "name LIKE '%foo%'")]` use serde_json::{Result, Value}; use std::collections::HashMap; use url::Url; /// Default api url. NA for north america. Adjust to your cloud instance or local instance. See [Client] for how to customize pub const DEFAULT_API_URL: &str = "na.myconnectwise.net"; /// This is the release version specified in the documentation. /// There is a way to dynamically look up your api version. This /// might be added in the future. See [Client] for how to customize pub const DEFAULT_API_CODEBASE: &str = "v4_6_release"; /// I cannot find documentation on this , but since it is a number /// it is customizable. See [Client] for how to customize pub const DEFAULT_API_VERSION: &str = "3.0"; /// Connectwise client. Initinitialize with [Client::new]. Use [Client::api_url], /// [Client::api_version] and [Client::codebase] to customize. The finalize with [Client::build] /// * `company_id` is your _short name_ (ie the one you use to login to CW) /// * `public_key` is obtained by creating an api member with keys /// * `private_key` is obtained by creating an api member with keys /// * the `client_id` is generated <https://developer.connectwise.com/ClientID> #[derive(Debug, PartialEq)] pub struct Client { company_id: String, public_key: String, private_key: String, client_id: String, api_url: String, codebase: String, api_version: String, } impl Client { pub fn new( company_id: String, public_key: String, private_key: String, client_id: String, ) -> Client { Client { company_id, public_key, private_key, client_id, api_url: DEFAULT_API_URL.to_string(), codebase: DEFAULT_API_CODEBASE.to_string(), api_version: DEFAULT_API_VERSION.to_string(), } } pub fn build(&self) -> Client { Client { company_id: self.company_id.to_owned(), public_key: self.public_key.to_owned(), private_key: self.private_key.to_owned(), client_id: self.client_id.to_owned(), api_url: self.api_url.to_owned(), codebase: self.codebase.to_owned(), api_version: self.api_version.to_owned(), } } pub fn api_version(mut self, api_version: String) -> Client { self.api_version = api_version; self } pub fn api_url(mut self, api_url: String) -> Client { self.api_url = api_url; self } pub fn codebase(mut self, codebase: String) -> Client { self.codebase = codebase; self } fn gen_basic_auth(&self) -> String { let encoded = base64::encode(format!( "{}+{}:{}", self.company_id, self.public_key, self.private_key )); format!("Basic {}", encoded) } fn gen_api_url(&self, path: &str) -> String { format!( "https://{}/{}/apis/{}{}", self.api_url, self.codebase, self.api_version, path ) } /// GETs a path from the connectwise api. `get_single` is only used on certain api endpoints. /// It is expecting the response from the connectwise api to be a single "object" and not a list /// like it normally returns /// /// # Arguments /// /// - `path` - the api path you want to retrieve (example `/service/info`) /// - `query` - additional query options *must be set*. If non, use [("", "")] /// /// # Known Endpoints /// /// - /system/info /// /// # Example /// /// ## Basic get, returning parsed json /// ``` /// use cwmanage::Client; /// /// // this example is using dotenv to load our settings from /// // the environment, you could also specify this manually /// use dotenv::dotenv; /// dotenv().ok(); /// let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); /// let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); /// let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); /// let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); /// /// let client = Client::new(company_id, public_key, private_key, client_id).build(); /// /// let query = [("", "")]; /// let path = "/system/info"; /// let result = client.get_single(&path, &query).unwrap(); /// /// assert_eq!(&result["isCloud"], true); /// ``` /// ## Basic get, take parsed json and convert to a struct /// ``` /// use cwmanage::Client; /// use serde::{Deserialize}; /// /// #[derive(Debug, Deserialize)] /// #[serde(rename_all = "camelCase")] /// struct SystemInfo { /// version: String, /// is_cloud: bool, /// server_time_zone: String, /// } /// /// // this example is using dotenv to load our settings from /// // the environment, you could also specify this manually /// use dotenv::dotenv; /// dotenv().ok(); /// let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); /// let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); /// let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); /// let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); /// /// let client = Client::new(company_id, public_key, private_key, client_id).build(); /// /// let query = [("", "")]; /// let path = "/system/info"; /// let result = client.get_single(&path, &query).unwrap(); /// /// // got our result, just like before. /// // now convert it into our struct /// let info: SystemInfo = serde_json::from_value(result).unwrap(); /// assert_eq!(info.is_cloud, true); /// assert_eq!(info.server_time_zone, "Eastern Standard Time"); /// ``` pub fn get_single(&self, path: &str, query: &[(&str, &str)]) -> Result<Value> { let res = reqwest::blocking::Client::new() .get(&self.gen_api_url(path)) .header("Authorization", &self.gen_basic_auth()) .header("Content-Type", "application/json") .header("clientid", self.client_id.to_owned()) .header("pagination-type", "forward-only") .query(&query) .send() .unwrap() .text() .unwrap(); let v: Value = serde_json::from_str(&res).unwrap(); Ok(v) } /// GETs a path from the connectwise api. `get` will return *all* results so make sure you /// set your `query` with the appropriate conditions. This follows the api pagination so, again, /// *all* results will be returned For example `/service/tickets` will /// return **every** ticket in the system. The result is a vec of /// [serde_json::value::Value](https://docs.serde.rs/serde_json/value/enum.Value.html) /// /// # Arguments /// /// - `path` - the api path you want to retrieve (example `/service/tickets`) /// - `query` - additional query options *must be set*. If non, use [("", "")] /// # Example /// /// ## Getting all results, returning parsed json /// ``` /// use cwmanage::Client; /// /// // this example is using dotenv to load our settings from /// // the environment, you could also specify this manually /// use dotenv::dotenv; /// dotenv().ok(); /// let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); /// let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); /// let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); /// let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); /// let client = Client::new(company_id, public_key, private_key, client_id).build(); /// /// let query = [("fields", "id")]; /// let path = "/system/members"; /// let result = client.get(&path, &query).unwrap(); /// /// assert!(result.len() > 30); /// ``` /// ## Getting all results, take parsed json and convert to a struct /// ``` /// use cwmanage::Client; /// use serde::{Deserialize}; /// use serde_json::Value::Array; /// /// #[derive(Debug, Deserialize)] /// #[serde(rename_all = "camelCase")] /// struct Member { /// id: i32, /// identifier: String, /// } /// /// // this example is using dotenv to load our settings from /// // the environment, you could also specify this manually /// use dotenv::dotenv; /// dotenv().ok(); /// let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").unwrap(); /// let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").unwrap(); /// let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").unwrap(); /// let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").unwrap(); /// let client = Client::new(company_id, public_key, private_key, client_id).build(); /// /// let query = [("", "")]; /// let path = "/system/members"; /// let result = client.get(&path, &query).unwrap(); /// /// // got our result, just like before. /// // now convert it into our struct /// let members: Vec<Member>= serde_json::from_value(Array(result)).unwrap(); /// assert_eq!(members.len(), 134); /// ``` // pub fn get_single(&self, path: &str, query: &[(&str, &str)]) -> Result<Value> { // let res = reqwest::blocking::Client::new() pub fn get(&self, path: &str, query: &[(&str, &str)]) -> Result<Vec<Value>> { let mut collected_res: Vec<Value> = Vec::new(); let mut page: String = "1".to_string(); let mut next: bool = true; while next { let res = reqwest::blocking::Client::new() .get(&self.gen_api_url(path)) .header("Authorization", self.gen_basic_auth()) .header("Content-Type", "application/json") .header("clientid", self.client_id.to_owned()) .header("pagination-type", "forward-only") .query(&[("pageid", &page)]) .query(&query) .send() .unwrap(); let hdrs = res.headers(); next = match hdrs.get("link") { Some(link) => { if link.is_empty() { false } else { page = get_page_id(hdrs); true } } None => false, }; let body = res.text().unwrap(); let mut v: Vec<Value> = serde_json::from_str(&body).unwrap(); collected_res.append(&mut v); } Ok(collected_res) } } // *** Private Functions *** fn get_page_id(hdrs: &reqwest::header::HeaderMap) -> String { let url = hdrs .get("link") .unwrap() .to_str() .unwrap() .split("link =") .collect::<Vec<&str>>()[0] .split('<') .collect::<Vec<&str>>()[1] .split('>') .collect::<Vec<&str>>()[0]; let parsed_url = Url::parse(url).unwrap(); let hash_query: HashMap<_, _> = parsed_url.query_pairs().into_owned().collect(); match hash_query.contains_key("pageId") { false => "".to_string(), true => hash_query["pageId"].to_string(), } } // *** Tests *** #[cfg(test)] mod tests { use super::*; use dotenv::dotenv; fn testing_client() -> Client { dotenv().ok(); let company_id: String = dotenv::var("CWMANAGE_COMPANY_ID").expect("CWMANAGE_COMPANY_ID needs to be set"); let public_key: String = dotenv::var("CWMANAGE_PUBLIC_KEY").expect("CWMANAGE_PUBLIC_KEY needs to be set"); let private_key: String = dotenv::var("CWMANAGE_PRIVATE_KEY").expect("CWMANAGE_PRIVATE_KEY needs to be set"); let client_id: String = dotenv::var("CWMANAGE_CLIENT_ID").expect("CWMANAGE_CLIENT_ID needs to be set"); Client::new(company_id, public_key, private_key, client_id).build() } #[test] fn test_basic_auth() { let expected: String = "Basic bXljbytwdWI6cHJpdg==".to_string(); let client = Client::new( String::from("myco"), String::from("pub"), String::from("priv"), String::from("something"), ) .build(); let result = client.gen_basic_auth(); assert_eq!(result, expected); } #[test] fn test_gen_url() { let expected = "https://na.myconnectwise.net/v4_6_release/apis/3.0/system/info"; let client = Client::new( String::from("myco"), String::from("pub"), String::from("priv"), String::from("something"), ) .build(); let result = client.gen_api_url("/system/info"); assert_eq!(result, expected); } #[test] #[should_panic] fn test_basic_get_panic() { let query = []; let _result = testing_client() .get_single("/this/is/a/bad/path", &query) .unwrap(); } #[test] fn test_basic_get_single() { let query = []; let result = testing_client().get_single("/system/info", &query).unwrap(); assert_eq!(&result["cloudRegion"], "NA"); assert_eq!(&result["isCloud"], true); assert_eq!(&result["serverTimeZone"], "Eastern Standard Time"); } #[test] fn test_basic_get() { let query = []; let result = testing_client().get("/system/members", &query).unwrap(); assert!(result.len() > 40); let zach = &result[0]; assert_eq!(&zach["adminFlag"], true); assert_eq!(&zach["dailyCapacity"], 8.0); assert_eq!(&zach["identifier"], "ZPeters"); } #[test] fn test_new_client_default() { let input_company_id = "myco".to_string(); let input_public_key = "public".to_string(); let input_private_key = "private".to_string(); let input_client_id = "clientid".to_string(); let expected = Client { company_id: "myco".to_string(), public_key: "public".to_string(), private_key: "private".to_string(), client_id: "clientid".to_string(), api_version: "3.0".to_string(), api_url: "na.myconnectwise.net".to_string(), codebase: "v4_6_release".to_string(), }; let result = Client::new( input_company_id, input_public_key, input_private_key, input_client_id, ) .build(); assert_eq!(result, expected); } #[test] fn test_new_client_api_version() { let input_company_id = "myco".to_string(); let input_public_key = "public".to_string(); let input_private_key = "private".to_string(); let input_client_id = "clientid".to_string(); let input_api_version = "version".to_string(); let expected_api_version = "version"; let result = Client::new( input_company_id, input_public_key, input_private_key, input_client_id, ) .api_version(input_api_version) .build(); assert_eq!(result.api_version, expected_api_version); } #[test] fn test_new_client_codebase() { let input_company_id = "myco".to_string(); let input_public_key = "public".to_string(); let input_private_key = "private".to_string(); let input_client_id = "clientid".to_string(); let input_codebase = "codebase".to_string(); let expected_codebase = "codebase"; let result = Client::new( input_company_id, input_public_key, input_private_key, input_client_id, ) .codebase(input_codebase) .build(); assert_eq!(result.codebase, expected_codebase); } #[test] fn test_new_client_chained_options() { let result = Client::new( "myco".to_string(), "public".to_string(), "private".to_string(), "clientid".to_string(), ) .codebase("codebase".to_string()) .api_url("api".to_string()) .build(); assert_eq!(result.api_url, "api".to_string()); assert_eq!(result.codebase, "codebase".to_string()); } }