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
use crate::http::EmptyBody;
use crate::structs::{PteroList, PteroObject};
use reqwest::Method;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::RwLock;
pub use structs::*;
pub mod account;
pub mod backups;
pub mod databases;
pub mod files;
pub mod network;
pub mod schedules;
pub mod settings;
pub mod startup;
mod structs;
pub mod users;
#[cfg(feature = "websocket")]
pub mod websocket;
#[derive(Debug, Copy, Clone)]
pub struct RateLimits {
pub limit: u32,
pub limit_remaining: u32,
}
#[derive(Debug)]
pub struct Client {
pub(crate) url: String,
pub(crate) client: reqwest::Client,
pub(crate) api_key: String,
pub(crate) rate_limits: RwLock<Option<RateLimits>>,
}
impl Client {
pub fn get_rate_limits(&self) -> Option<RateLimits> {
*self.rate_limits.read().unwrap()
}
pub async fn list_servers(&self) -> crate::Result<Vec<ServerStruct>> {
self.request::<PteroList<ServerStruct>>(Method::GET, "")
.await
.map(|servers| servers.data)
}
pub async fn get_permissions(&self) -> crate::Result<HashMap<String, PermissionGroup>> {
#[derive(Deserialize)]
struct Permissions {
permissions: HashMap<String, PermissionGroup>,
}
self.request::<PteroObject<Permissions>>(Method::GET, "permissions")
.await
.map(|permissions| permissions.attributes.permissions)
}
pub fn get_server(&self, id: impl Into<String>) -> Server<'_> {
Server {
id: id.into(),
client: self,
}
}
#[cfg(test)]
pub(crate) fn get_test_server(&self) -> Server {
self.get_server(
std::env::var("TEST_SERVER").expect("Expected TEST_SERVER in environment variables"),
)
}
}
#[derive(Debug)]
pub struct ClientBuilder {
url: String,
client: Option<reqwest::Client>,
api_key: String,
}
impl ClientBuilder {
pub fn new(url: impl Into<String>, api_key: impl Into<String>) -> Self {
let mut url = url.into();
if !url.ends_with('/') {
url.push('/');
}
url.push_str("api/client/");
Self {
url,
client: None,
api_key: api_key.into(),
}
}
pub fn with_client(self, client: reqwest::Client) -> Self {
Self {
client: Some(client),
..self
}
}
pub fn build(self) -> Client {
Client {
url: self.url,
client: self.client.unwrap_or_default(),
api_key: self.api_key,
rate_limits: RwLock::new(None),
}
}
}
#[derive(Debug)]
pub struct Server<'a> {
pub(crate) id: String,
pub(crate) client: &'a Client,
}
impl Server<'_> {
pub async fn get_details(&self) -> crate::Result<ServerStruct> {
self.client
.request::<PteroObject<ServerStruct>>(Method::GET, &format!("servers/{}", self.id))
.await
.map(|server| server.attributes)
}
pub async fn get_resources(&self) -> crate::Result<ServerResources> {
self.client
.request::<PteroObject<ServerResources>>(
Method::GET,
&format!("servers/{}/resources", self.id),
)
.await
.map(|resources| resources.attributes)
}
pub async fn send_command(&self, command: impl Into<String>) -> crate::Result<()> {
#[derive(Serialize)]
struct SendCommandBody {
command: String,
}
self.client
.request_with_body::<EmptyBody, _>(
Method::POST,
&format!("servers/{}/command", self.id),
&SendCommandBody {
command: command.into(),
},
)
.await?;
Ok(())
}
pub async fn send_power_signal(&self, signal: PowerSignal) -> crate::Result<()> {
#[derive(Serialize)]
struct SendPowerSignalBody {
signal: PowerSignal,
}
self.client
.request_with_body::<EmptyBody, _>(
Method::POST,
&format!("servers/{}/power", self.id),
&SendPowerSignalBody { signal },
)
.await?;
Ok(())
}
}
#[cfg(test)]
mod test {
use crate::client::backups::BackupParams;
use crate::client::schedules::ScheduleParams;
use crate::client::websocket::{PteroWebSocketHandle, PteroWebSocketListener};
use crate::client::{Client, ClientBuilder, EmptyBody, ServerState};
use async_trait::async_trait;
fn make_test_client() -> Client {
ClientBuilder::new(
std::env::var("API_URL").expect("Expected API_URL in environment variables"),
std::env::var("API_KEY").expect("Expected API_KEY in environment variables"),
)
.build()
}
#[tokio::test]
async fn test_list_servers() {
println!("{:?}", make_test_client().list_servers().await);
}
#[tokio::test]
async fn test_get_permissions() {
println!("{:?}", make_test_client().get_permissions().await);
}
#[tokio::test]
async fn test_get_account_details() {
println!("{:?}", make_test_client().get_account_details().await)
}
#[tokio::test]
async fn test_get_account_2fa_details() {
println!("{:?}", make_test_client().get_account_2fa_details().await)
}
#[tokio::test]
async fn test_get_api_keys() {
println!("{:?}", make_test_client().get_api_keys().await)
}
#[tokio::test]
async fn test_get_server_details() {
println!(
"{:?}",
make_test_client().get_test_server().get_details().await
)
}
#[tokio::test]
async fn test_get_server_resources() {
println!(
"{:?}",
make_test_client().get_test_server().get_resources().await
)
}
#[tokio::test]
async fn test_list_databases() {
println!(
"{:?}",
make_test_client().get_test_server().list_databases().await
)
}
#[tokio::test]
async fn test_list_files() {
println!(
"{:?}",
make_test_client().get_test_server().list_files("/").await
)
}
#[tokio::test]
async fn test_file_content() {
println!(
"{:?}",
make_test_client()
.get_test_server()
.file_contents_text("eula.txt")
.await
)
}
}