upcloud-rs 0.1.4

A pure Rust Upcloud API binding.
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
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
//! Client library for the <https://www.upcloud.com/> API which
//! is documented at <https://developers.upcloud.com/>
//!
//! # Example blocking
//! It needs to have the feature "blocking" enabled.
//! ```toml
//! upcloud_rs = { version = "*", features = ["blocking"] }
//! ```
//! ```ignore
//! use upcloud_rs::{UpcloudApi, UpcloudError};
//!
//! fn main() -> Result<(), UpcloudError> {
//!     let api = UpcloudApi::new("username", "password");
//!     
//!     let account = api.get_account_info()?;
//!     println!("ACCOUNT: {:?}", account);
//!     
//!     let account_list = api.get_account_list()?;
//!     println!("ACCOUNT LIST: {:?}", account_list);
//!     
//!     let prices = api.get_prices()?;
//!     println!("PRICES: {:#?}", prices);
//!     
//!     let zones = api.get_zones()?;
//!     println!("ZONES: {:#?}", zones);
//!     Ok(())
//! }
//! ```
//!
//! # Example async
//! ```toml
//! upcloud_rs = { version = "*" }
//! ```
//! ```no_run
//! use upcloud_rs::{UpcloudApi, UpcloudError};
//!
//! #[async_std::main]
//! async fn main() -> Result<(), UpcloudError> {
//!     let api = UpcloudApi::new("username", "password");
//!     let account = api.get_account_info_async().await?;
//!     println!("ACCOUNT: {:?}", account);
//!     
//!     let account_list = api.get_account_list_async().await?;
//!     println!("ACCOUNT LIST: {:?}", account_list);
//!     
//!     let prices = api.get_prices_async().await?;
//!     println!("PRICES: {:#?}", prices);
//!     Ok(())
//! }
//! ```
//! ## Features
//! * "default" - use nativetls
//! * "default-rustls" - use rusttls
//! * "blocking" - enable blocking api
//! * "rustls" - enable rustls for reqwest
//! * "nativetls" - add support for nativetls DEFAULT
//! * "gzip" - enable gzip in reqwest
//! * "brotli" - enable brotli in reqwest
//! * "deflate" - enable deflate in reqwest

mod api_error;
mod create_instance_builder;
mod data;
mod error;

use api_error::UpcloudApiErrorRoot;
use data::{
    UpcloudAccountRoot, UpcloudAccountsListRoot, UpcloudPlanListRoot, UpcloudPricesListRoot,
    UpcloudServerListRoot, UpcloudServerRoot, UpcloudServerTemplateListRoot, UpcloudZoneListRoot,
};
use serde::Serialize;
use serde_json::json;

pub use create_instance_builder::CreateInstanceBuilder;
pub use data::{
    UpcloudAccount, UpcloudAccountsListItem, UpcloudLabel, UpcloudLabelList, UpcloudPlan,
    UpcloudPrice, UpcloudPricesZone, UpcloudServer, UpcloudServerTemplate, UpcloudTagList,
    UpcloudZone,
};
pub use error::UpcloudError;

#[derive(Clone)]
pub struct UpcloudApi {
    username: String,
    password: String,
}

impl<'a> UpcloudApi {
    pub fn new<S1, S2>(username: S1, password: S2) -> UpcloudApi
    where
        S1: Into<String>,
        S2: Into<String>,
    {
        UpcloudApi {
            username: username.into(),
            password: password.into(),
        }
    }

    #[cfg(feature = "blocking")]
    fn get(&self, url: &str) -> Result<reqwest::blocking::Response, UpcloudError> {
        let client = reqwest::blocking::Client::new();
        let resp = client
            .get(url)
            .basic_auth(&self.username, Some(&self.password))
            .send()?;
        let status = resp.status();
        if status.is_client_error() {
            let result: UpcloudApiErrorRoot = resp.json()?;
            Err(UpcloudError::Api(result.error.error_message))
        } else {
            Ok(resp.error_for_status()?)
        }
    }

    async fn get_async(&self, url: &str) -> Result<reqwest::Response, UpcloudError> {
        let client = reqwest::Client::new();
        let resp = client
            .get(url)
            .basic_auth(&self.username, Some(&self.password))
            .send()
            .await?;
        let status = resp.status();
        if status.is_client_error() {
            let result: UpcloudApiErrorRoot = resp.json().await?;
            Err(UpcloudError::Api(result.error.error_message))
        } else {
            Ok(resp.error_for_status()?)
        }
    }

    #[cfg(feature = "blocking")]
    fn post<T>(&self, url: &str, json: T) -> Result<reqwest::blocking::Response, UpcloudError>
    where
        T: Serialize + Sized,
    {
        let client = reqwest::blocking::Client::new();
        let resp = client
            .post(url)
            .basic_auth(&self.username, Some(&self.password))
            .json(&json)
            .send()?;
        let status = resp.status();
        if status.is_client_error() {
            let result: UpcloudApiErrorRoot = resp.json()?;
            Err(UpcloudError::Api(result.error.error_message))
        } else {
            Ok(resp.error_for_status()?)
        }
    }

    async fn post_async<T>(&self, url: &str, json: T) -> Result<reqwest::Response, UpcloudError>
    where
        T: Serialize + Sized,
    {
        let client = reqwest::Client::new();
        let resp = client
            .post(url)
            .basic_auth(&self.username, Some(&self.password))
            .json(&json)
            .send()
            .await?;
        let status = resp.status();
        if status.is_client_error() {
            let result: UpcloudApiErrorRoot = resp.json().await?;
            Err(UpcloudError::Api(result.error.error_message))
        } else {
            Ok(resp.error_for_status()?)
        }
    }

    #[cfg(feature = "blocking")]
    fn delete(&self, url: &str) -> Result<reqwest::blocking::Response, UpcloudError> {
        let client = reqwest::blocking::Client::new();
        let resp = client
            .delete(url)
            .basic_auth(&self.username, Some(&self.password))
            .send()?;
        let status = resp.status();
        if status.is_client_error() {
            let result: UpcloudApiErrorRoot = resp.json()?;
            Err(UpcloudError::Api(result.error.error_message))
        } else {
            Ok(resp.error_for_status()?)
        }
    }

    async fn delete_async(&self, url: &str) -> Result<reqwest::Response, UpcloudError> {
        let client = reqwest::Client::new();
        let resp = client
            .delete(url)
            .basic_auth(&self.username, Some(&self.password))
            .send()
            .await?;
        let status = resp.status();
        if status.is_client_error() {
            let result: UpcloudApiErrorRoot = resp.json().await?;
            Err(UpcloudError::Api(result.error.error_message))
        } else {
            Ok(resp.error_for_status()?)
        }
    }

    #[cfg(feature = "blocking")]
    pub fn get_account_info(&self) -> Result<UpcloudAccount, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/account")?
            .json::<UpcloudAccountRoot>()?
            .account)
    }

    pub async fn get_account_info_async(&self) -> Result<UpcloudAccount, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/account")
            .await?
            .json::<UpcloudAccountRoot>()
            .await?
            .account)
    }

    #[cfg(feature = "blocking")]
    pub fn get_account_list(&self) -> Result<Vec<UpcloudAccountsListItem>, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/account/list")?
            .json::<UpcloudAccountsListRoot>()?
            .accounts
            .account)
    }

    pub async fn get_account_list_async(
        &self,
    ) -> Result<Vec<UpcloudAccountsListItem>, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/account/list")
            .await?
            .json::<UpcloudAccountsListRoot>()
            .await?
            .accounts
            .account)
    }

    #[cfg(feature = "blocking")]
    pub fn get_prices(&self) -> Result<Vec<UpcloudPricesZone>, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/price")?
            .json::<UpcloudPricesListRoot>()?
            .prices
            .zone)
    }

    pub async fn get_prices_async(&self) -> Result<Vec<UpcloudPricesZone>, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/price")
            .await?
            .json::<UpcloudPricesListRoot>()
            .await?
            .prices
            .zone)
    }

    #[cfg(feature = "blocking")]
    pub fn get_zones(&self) -> Result<Vec<UpcloudZone>, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/zone")?
            .json::<UpcloudZoneListRoot>()?
            .zones
            .zone)
    }

    pub async fn get_zones_async(&self) -> Result<Vec<UpcloudZone>, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/zone")
            .await?
            .json::<UpcloudZoneListRoot>()
            .await?
            .zones
            .zone)
    }

    #[cfg(feature = "blocking")]
    pub fn get_plans(&self) -> Result<Vec<UpcloudPlan>, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/plan")?
            .json::<UpcloudPlanListRoot>()?
            .plans
            .plan)
    }

    pub async fn get_plans_async(&self) -> Result<Vec<UpcloudPlan>, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/plan")
            .await?
            .json::<UpcloudPlanListRoot>()
            .await?
            .plans
            .plan)
    }

    #[cfg(feature = "blocking")]
    pub fn get_servers(&self) -> Result<Vec<UpcloudServer>, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/server")?
            .json::<UpcloudServerListRoot>()?
            .servers
            .server)
    }

    pub async fn get_servers_async(&self) -> Result<Vec<UpcloudServer>, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/server")
            .await?
            .json::<UpcloudServerListRoot>()
            .await?
            .servers
            .server)
    }

    #[cfg(feature = "blocking")]
    pub fn get_server_details(&self, machine_id: &str) -> Result<UpcloudServer, UpcloudError> {
        Ok(self
            .get(&format!("https://api.Upcloud.com/1.3/server/{uuid}", uuid = machine_id))?
            .json::<UpcloudServerRoot>()?
            .server)
    }

    pub async fn get_server_details_async(&self, machine_id: &str) -> Result<UpcloudServer, UpcloudError> {
        Ok(self
            .get_async(&format!("https://api.Upcloud.com/1.3/server/{uuid}", uuid = machine_id))
            .await?
            .json::<UpcloudServerRoot>()
            .await?
            .server)
    }

    #[cfg(feature = "blocking")]
    pub fn get_server_templates(&self) -> Result<Vec<UpcloudServerTemplate>, UpcloudError> {
        Ok(self
            .get("https://api.Upcloud.com/1.3/storage/template")?
            .json::<UpcloudServerTemplateListRoot>()?
            .storages
            .storage)
    }

    pub async fn get_server_templates_async(
        &self,
    ) -> Result<Vec<UpcloudServerTemplate>, UpcloudError> {
        Ok(self
            .get_async("https://api.Upcloud.com/1.3/storage/template")
            .await?
            .json::<UpcloudServerTemplateListRoot>()
            .await?
            .storages
            .storage)
    }

    /// More information at <https://developers.upcloud.com/1.3/8-servers/#create-server>
    pub fn create_instance<S1, S2, S3, S4, S5>(
        &self,
        region_id: S1,
        plan_id: S2,
        os_id: S3,
        title: S4,
        hostname: S5,
    ) -> CreateInstanceBuilder
    where
        S1: Into<String> + Serialize,
        S2: Into<String> + Serialize,
        S3: Into<String> + Serialize,
        S4: Into<String> + Serialize,
        S5: Into<String> + Serialize,
    {
        CreateInstanceBuilder::new(self.clone(), region_id, plan_id, os_id, title, hostname)
    }

    #[cfg(feature = "blocking")]
    pub fn delete_instance(&self, machine_uuid: &str) -> Result<(), UpcloudError> {
        self.delete(&format!(
            "https://api.Upcloud.com/1.3/server/{uuid}?storages=true&backups=delete",
            uuid = machine_uuid
        ))?;
        Ok(())
    }

    pub async fn delete_instance_async(&self, machine_uuid: &str) -> Result<(), UpcloudError> {
        self.delete_async(&format!(
            "https://api.Upcloud.com/1.3/server/{uuid}?storages=true&backups=delete",
            uuid = machine_uuid
        ))
        .await?;
        Ok(())
    }

    #[cfg(feature = "blocking")]
    pub fn stop_instance(&self, machine_uuid: &str) -> Result<UpcloudServer, UpcloudError> {
        let server = self
            .post(
                &format!(
                    "https://api.Upcloud.com/1.3/server/{uuid}/stop",
                    uuid = machine_uuid
                ),
                json! ({
                    "stop_server": {
                        "stop_type": "hard"
                      }
                }),
            )?
            .json::<UpcloudServerRoot>()?
            .server;
        Ok(server)
    }

    pub async fn stop_instance_async(
        &self,
        machine_uuid: &str,
    ) -> Result<UpcloudServer, UpcloudError> {
        let server = self
            .post_async(
                &format!(
                    "https://api.Upcloud.com/1.3/server/{uuid}/stop",
                    uuid = machine_uuid
                ),
                json! ({
                    "stop_server": {
                        "stop_type": "hard"
                      }
                }),
            )
            .await?
            .json::<UpcloudServerRoot>()
            .await?
            .server;
        Ok(server)
    }
}