sprites 0.1.0

Official Rust SDK for Sprites - stateful sandbox environments from Fly.io
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
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
//! Filesystem operations for sprites
//!
//! This module provides file and directory operations on a sprite's filesystem.
//!
//! # Example
//!
//! ```no_run
//! use sprites::SpritesClient;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let client = SpritesClient::new("token");
//!     let sprite = client.sprite("my-sprite");
//!     let fs = sprite.filesystem();
//!
//!     // Write a file
//!     fs.write_file("/tmp/hello.txt", b"Hello, world!").await?;
//!
//!     // Read it back
//!     let data = fs.read_file("/tmp/hello.txt").await?;
//!     println!("{}", String::from_utf8_lossy(&data));
//!
//!     // Create a directory
//!     fs.mkdir("/tmp/mydir").await?;
//!
//!     // List directory contents
//!     let entries = fs.read_dir("/tmp").await?;
//!     for entry in entries {
//!         println!("{}: {} bytes", entry.name, entry.size);
//!     }
//!
//!     Ok(())
//! }
//! ```

use crate::error::{Error, Result};
use crate::sprite::Sprite;
use chrono::{DateTime, Utc};
use serde::Deserialize;

/// Handle for filesystem operations on a sprite
#[derive(Clone)]
pub struct Filesystem {
    sprite: Sprite,
    cwd: Option<String>,
}

/// Information about a file
#[derive(Debug, Clone, Deserialize)]
pub struct FileInfo {
    /// File name
    pub name: String,

    /// File size in bytes
    #[serde(default)]
    pub size: u64,

    /// File mode (permissions)
    #[serde(default)]
    pub mode: u32,

    /// Last modification time
    #[serde(default, alias = "mod_time")]
    pub modified: Option<DateTime<Utc>>,

    /// Whether this is a directory
    #[serde(default)]
    pub is_dir: bool,
}

/// Entry in a directory listing
#[derive(Debug, Clone, Deserialize)]
pub struct DirEntry {
    /// Entry name
    pub name: String,

    /// Whether this is a directory
    #[serde(default)]
    pub is_dir: bool,

    /// Size in bytes (0 for directories)
    #[serde(default)]
    pub size: u64,

    /// File mode (permissions)
    #[serde(default)]
    pub mode: u32,

    /// Last modification time
    #[serde(default, alias = "mod_time")]
    pub modified: Option<DateTime<Utc>>,
}

impl Filesystem {
    /// Create a new filesystem handle for a sprite
    pub(crate) fn new(sprite: Sprite) -> Self {
        Self { sprite, cwd: None }
    }

    /// Create a filesystem handle with a working directory
    pub(crate) fn with_cwd(sprite: Sprite, cwd: String) -> Self {
        Self {
            sprite,
            cwd: Some(cwd),
        }
    }

    /// Change to a new working directory (returns a new Filesystem handle)
    pub fn cd(&self, path: &str) -> Filesystem {
        let new_cwd = if path.starts_with('/') {
            path.to_string()
        } else if let Some(ref cwd) = self.cwd {
            format!("{}/{}", cwd.trim_end_matches('/'), path)
        } else {
            format!("/{path}")
        };

        Filesystem {
            sprite: self.sprite.clone(),
            cwd: Some(new_cwd),
        }
    }

    /// Resolve a path relative to the current working directory
    fn resolve_path(&self, path: &str) -> String {
        if path.starts_with('/') {
            path.to_string()
        } else if let Some(ref cwd) = self.cwd {
            format!("{}/{}", cwd.trim_end_matches('/'), path)
        } else {
            format!("/{path}")
        }
    }

    /// Build URL for filesystem operations
    fn fs_url(&self, path: &str) -> String {
        let resolved = self.resolve_path(path);
        // URL encode the path but preserve forward slashes
        let encoded = resolved
            .split('/')
            .map(|segment| urlencoding::encode(segment).into_owned())
            .collect::<Vec<_>>()
            .join("/");
        self.sprite
            .client()
            .url(&format!("/sprites/{}/fs{}", self.sprite.name(), encoded))
    }

    /// Read a file's contents
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use sprites::SpritesClient;
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = SpritesClient::new("token");
    /// let sprite = client.sprite("my-sprite");
    ///
    /// let data = sprite.filesystem().read_file("/etc/hostname").await?;
    /// println!("Hostname: {}", String::from_utf8_lossy(&data));
    /// # Ok(())
    /// # }
    /// ```
    pub async fn read_file(&self, path: &str) -> Result<Vec<u8>> {
        let url = self.fs_url(path);

        let response = self
            .sprite
            .client()
            .http()
            .get(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if status == reqwest::StatusCode::NOT_FOUND {
            return Err(Error::not_found(path));
        }
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        let bytes = response.bytes().await?;
        Ok(bytes.to_vec())
    }

    /// Read a file as a string
    pub async fn read_to_string(&self, path: &str) -> Result<String> {
        let data = self.read_file(path).await?;
        Ok(String::from_utf8_lossy(&data).to_string())
    }

    /// Write data to a file
    ///
    /// Creates the file if it doesn't exist, overwrites if it does.
    pub async fn write_file(&self, path: &str, data: &[u8]) -> Result<()> {
        let url = self.fs_url(path);

        let response = self
            .sprite
            .client()
            .http()
            .put(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .header("Content-Type", "application/octet-stream")
            .body(data.to_vec())
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Write data to a file with specific permissions
    pub async fn write_file_with_mode(&self, path: &str, data: &[u8], mode: u32) -> Result<()> {
        // First write the file
        self.write_file(path, data).await?;
        // Then set permissions
        self.chmod(path, mode).await
    }

    /// Read directory contents
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use sprites::SpritesClient;
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = SpritesClient::new("token");
    /// let sprite = client.sprite("my-sprite");
    ///
    /// let entries = sprite.filesystem().read_dir("/home").await?;
    /// for entry in entries {
    ///     let kind = if entry.is_dir { "dir" } else { "file" };
    ///     println!("{} ({})", entry.name, kind);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn read_dir(&self, path: &str) -> Result<Vec<DirEntry>> {
        let url = format!("{}?list=true", self.fs_url(path));

        let response = self
            .sprite
            .client()
            .http()
            .get(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if status == reqwest::StatusCode::NOT_FOUND {
            return Err(Error::not_found(path));
        }
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        let entries: Vec<DirEntry> = response.json().await?;
        Ok(entries)
    }

    /// Create a directory
    pub async fn mkdir(&self, path: &str) -> Result<()> {
        let url = format!("{}?mkdir=true", self.fs_url(path));

        let response = self
            .sprite
            .client()
            .http()
            .post(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Create a directory and all parent directories
    pub async fn mkdir_all(&self, path: &str) -> Result<()> {
        let url = format!("{}?mkdir=true&parents=true", self.fs_url(path));

        let response = self
            .sprite
            .client()
            .http()
            .post(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Remove a file or empty directory
    pub async fn remove(&self, path: &str) -> Result<()> {
        let url = self.fs_url(path);

        let response = self
            .sprite
            .client()
            .http()
            .delete(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if status == reqwest::StatusCode::NOT_FOUND {
            return Err(Error::not_found(path));
        }
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Remove a file or directory recursively
    pub async fn remove_all(&self, path: &str) -> Result<()> {
        let url = format!("{}?recursive=true", self.fs_url(path));

        let response = self
            .sprite
            .client()
            .http()
            .delete(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if status == reqwest::StatusCode::NOT_FOUND {
            return Err(Error::not_found(path));
        }
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Rename/move a file or directory
    pub async fn rename(&self, from: &str, to: &str) -> Result<()> {
        let from_path = self.resolve_path(from);
        let to_path = self.resolve_path(to);

        let url = self.sprite.client().url(&format!(
            "/sprites/{}/fs?rename={}&to={}",
            self.sprite.name(),
            urlencoding::encode(&from_path),
            urlencoding::encode(&to_path)
        ));

        let response = self
            .sprite
            .client()
            .http()
            .post(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Copy a file
    pub async fn copy(&self, from: &str, to: &str) -> Result<()> {
        let from_path = self.resolve_path(from);
        let to_path = self.resolve_path(to);

        let url = self.sprite.client().url(&format!(
            "/sprites/{}/fs?copy={}&to={}",
            self.sprite.name(),
            urlencoding::encode(&from_path),
            urlencoding::encode(&to_path)
        ));

        let response = self
            .sprite
            .client()
            .http()
            .post(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Change file permissions
    pub async fn chmod(&self, path: &str, mode: u32) -> Result<()> {
        let url = format!("{}?chmod={:o}", self.fs_url(path), mode);

        let response = self
            .sprite
            .client()
            .http()
            .post(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        Ok(())
    }

    /// Get file information (stat)
    pub async fn stat(&self, path: &str) -> Result<FileInfo> {
        let url = format!("{}?stat=true", self.fs_url(path));

        let response = self
            .sprite
            .client()
            .http()
            .get(&url)
            .header("Authorization", self.sprite.client().auth_header())
            .send()
            .await?;

        let status = response.status();
        if status == reqwest::StatusCode::NOT_FOUND {
            return Err(Error::not_found(path));
        }
        if !status.is_success() {
            let message = response.text().await.unwrap_or_default();
            return Err(Error::api(status.as_u16(), message));
        }

        let info: FileInfo = response.json().await?;
        Ok(info)
    }

    /// Check if a file or directory exists
    pub async fn exists(&self, path: &str) -> Result<bool> {
        match self.stat(path).await {
            Ok(_) => Ok(true),
            Err(Error::NotFound(_)) => Ok(false),
            Err(e) => Err(e),
        }
    }
}

// URL encoding helper
mod urlencoding {
    pub fn encode(s: &str) -> std::borrow::Cow<'_, str> {
        let mut needs_encoding = false;
        for c in s.chars() {
            match c {
                'a'..='z' | 'A'..='Z' | '0'..='9' | '-' | '_' | '.' | '~' => {}
                _ => {
                    needs_encoding = true;
                    break;
                }
            }
        }

        if !needs_encoding {
            return std::borrow::Cow::Borrowed(s);
        }

        let mut result = String::new();
        for c in s.chars() {
            match c {
                'a'..='z' | 'A'..='Z' | '0'..='9' | '-' | '_' | '.' | '~' => result.push(c),
                _ => {
                    for byte in c.to_string().as_bytes() {
                        result.push_str(&format!("%{byte:02X}"));
                    }
                }
            }
        }
        std::borrow::Cow::Owned(result)
    }
}