digitalocean 0.1.1

A pure Rust DigitalOcean 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

use super::{ApiLinks, ApiMeta};
use super::{HasPagination, HasResponse, HasValue};
use crate::method::{Delete, Get, List};
use crate::request::Request;
use crate::request::SnapshotRequest;
use crate::{ROOT_URL, STATIC_URL_ERROR};
use chrono::{DateTime, Utc};
use getset::{Getters, Setters};
use url::Url;

const SNAPSHOT_SEGMENT: &str = "snapshots";

/// Snapshots are saved instances of a Droplet or a volume, which is reflected
/// in the `resource_type` attribute. In order to avoid problems with
/// compressing filesystems, each defines a `min_disk_size` attribute which is
/// the minimum size of the Droplet or volume disk when creating a new resource
/// from the saved snapshot.
///
/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#snapshots)
#[derive(Deserialize, Serialize, Debug, Clone, Getters, Setters)]
#[get = "pub"]
pub struct Snapshot {
	/// The unique identifier for the snapshot.
	id: String,

	/// A human-readable name for the snapshot.
	name: String,

	/// A time value given in ISO8601 combined date and time format that
    /// represents when the snapshot was created.
	created_at: DateTime<Utc>,

	/// An array of the regions that the image is available in. The regions
    /// are represented by their identifying slug values.
	regions: Vec<String>,

	/// A unique identifier for the resource that the action is associated
    /// with.
	resource_id: String,

	/// The type of resource that the action is associated with.
	resource_type: String,

	/// The minimum size in GB required for a volume or Droplet to use this snapshot.
	min_disk_size: usize,

	/// The billable size of the snapshot in gigabytes.
	size_gigabytes: f64,
}

impl Snapshot {
	/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#list-all-snapshots)
	pub fn list() -> SnapshotRequest<List, Vec<Snapshot>> {
		let mut url = ROOT_URL.clone();
		url.path_segments_mut()
			.expect(STATIC_URL_ERROR)
			.push(SNAPSHOT_SEGMENT);

		Request::new(url)
	}

	/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#list-all-droplet-snapshots)
	pub fn droplets() -> SnapshotRequest<List, Vec<Snapshot>> {
		let mut url = ROOT_URL.clone();
		url.path_segments_mut()
			.expect(STATIC_URL_ERROR)
			.push(SNAPSHOT_SEGMENT);

		url.query_pairs_mut()
			.append_pair("resource_type", "droplet");

		Request::new(url)
	}

	/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#list-all-volume-snapshots)
	pub fn volumes() -> SnapshotRequest<List, Vec<Snapshot>> {
		let mut url = ROOT_URL.clone();
		url.path_segments_mut()
			.expect(STATIC_URL_ERROR)
			.push(SNAPSHOT_SEGMENT);

		url.query_pairs_mut().append_pair("resource_type", "volume");

		Request::new(url)
	}

	/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#retrieve-an-existing-snapshot-by-id)
	pub fn get(id: usize) -> SnapshotRequest<Get, Snapshot> {
		let mut url = ROOT_URL.clone();
		url.path_segments_mut()
			.expect(STATIC_URL_ERROR)
			.push(SNAPSHOT_SEGMENT)
			.push(&id.to_string());

		Request::new(url)
	}

	/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#delete-a-snapshot)
	pub fn delete(id: usize) -> SnapshotRequest<Delete, ()> {
		let mut url = ROOT_URL.clone();
		url.path_segments_mut()
			.expect(STATIC_URL_ERROR)
			.push(SNAPSHOT_SEGMENT)
			.push(&id.to_string());

		Request::new(url)
	}
}

/// Response type returned from Digital Ocean.
#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct SnapshotListResponse {
	snapshots: Vec<Snapshot>,
	links: ApiLinks,
	meta: ApiMeta
}

impl HasResponse for Vec<Snapshot> {
	type Response = SnapshotListResponse;
}

impl HasPagination for SnapshotListResponse {
	fn next_page(&self) -> Option<Url> {
		self.links.next()
	}
}

impl HasValue for SnapshotListResponse {
	type Value = Vec<Snapshot>;

	fn value(self) -> Vec<Snapshot> {
		self.snapshots
	}
}

/// Response type returned from Digital Ocean.
#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct SnapshotResponse {
	snapshot: Snapshot
}

impl HasResponse for Snapshot {
	type Response = SnapshotResponse;
}

impl HasValue for SnapshotResponse {
	type Value = Snapshot;

	fn value(self) -> Snapshot {
		self.snapshot
	}
}