freedom-api 3.2.0

Freedom API for Rustaceans
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
use freedom_models::task::TaskType;
use serde::Serialize;
use time::OffsetDateTime;

use crate::{api::Api, error::Error};

use super::{Post, UrlResult};

#[derive(Debug, Clone, PartialEq)]
pub struct TaskRequest {
    typ: TaskType,
    site: UrlResult,
    satellite: UrlResult,
    configuration: UrlResult,
    target_bands: Vec<UrlResult>,
    target_date: String,
    duration: u64,
    minimum_duration: Option<u64>,
    hours_of_flex: Option<u8>,
    test_file: Option<String>,
    with_override: Option<UrlResult>,
}

#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
struct TaskRequestInner {
    #[serde(rename(serialize = "type"))]
    typ: TaskType,
    site: String,
    satellite: String,
    configuration: String,
    target_bands: Vec<String>,
    target_date: String,
    duration: u64,
    minimum_duration: Option<u64>,
    hours_of_flex: Option<u8>,
    test_file: Option<String>,
    #[serde(rename(serialize = "override"))]
    with_override: Option<String>,
}

pub struct TaskRequestBuilder<'a, C, S> {
    pub(crate) client: &'a C,
    state: S,
}

pub fn new<C>(client: &C) -> TaskRequestBuilder<'_, C, NoType> {
    TaskRequestBuilder {
        client,
        state: NoType,
    }
}

pub trait TaskInner {
    fn adjust(&mut self, request: &mut TaskRequest);
}

impl TaskInner for TestTask {
    fn adjust(&mut self, request: &mut TaskRequest) {
        request.typ = TaskType::Test;
        request.test_file = Some(std::mem::take(&mut self.test_file));
    }
}

impl TaskInner for FlexTask {
    fn adjust(&mut self, request: &mut TaskRequest) {
        let kind = match self.kind {
            FlexTaskKind::Before => TaskType::Before,
            FlexTaskKind::After => TaskType::After,
            FlexTaskKind::Around => TaskType::Around,
        };

        request.typ = kind;
        request.hours_of_flex = Some(self.hours_of_flex);
    }
}

pub struct NoType;

pub struct TestTask {
    test_file: String,
}

pub enum FlexTaskKind {
    Before,
    After,
    Around,
}

pub struct FlexTask {
    kind: FlexTaskKind,
    hours_of_flex: u8,
}

pub struct ExactTask;

impl TaskInner for ExactTask {
    fn adjust(&mut self, request: &mut TaskRequest) {
        request.typ = TaskType::Exact;
    }
}

impl<'a, C> TaskRequestBuilder<'a, C, NoType> {
    pub fn exact_task(self) -> TaskRequestBuilder<'a, C, NoTime<ExactTask>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoTime { kind: ExactTask },
        }
    }

    pub fn flex_task(
        self,
        kind: FlexTaskKind,
        hours_of_flex: u8,
    ) -> TaskRequestBuilder<'a, C, NoTime<FlexTask>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoTime {
                kind: FlexTask {
                    kind,
                    hours_of_flex,
                },
            },
        }
    }

    pub fn flex_task_after(self, hours_of_flex: u8) -> TaskRequestBuilder<'a, C, NoTime<FlexTask>> {
        self.flex_task(FlexTaskKind::After, hours_of_flex)
    }

    pub fn flex_task_around(
        self,
        hours_of_flex: u8,
    ) -> TaskRequestBuilder<'a, C, NoTime<FlexTask>> {
        self.flex_task(FlexTaskKind::Around, hours_of_flex)
    }

    pub fn flex_task_before(
        self,
        hours_of_flex: u8,
    ) -> TaskRequestBuilder<'a, C, NoTime<FlexTask>> {
        self.flex_task(FlexTaskKind::Before, hours_of_flex)
    }

    pub fn test_task(
        self,
        test_file: impl Into<String>,
    ) -> TaskRequestBuilder<'a, C, NoTime<TestTask>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoTime {
                kind: TestTask {
                    test_file: test_file.into(),
                },
            },
        }
    }
}

pub struct NoTime<T> {
    kind: T,
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoTime<T>> {
    pub fn target_time_utc(self, time: OffsetDateTime) -> TaskRequestBuilder<'a, C, NoDuration<T>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoDuration {
                kind: self.state.kind,
                time,
            },
        }
    }
}

pub struct NoDuration<T> {
    kind: T,
    time: OffsetDateTime,
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoDuration<T>> {
    pub fn task_duration(self, seconds: u64) -> TaskRequestBuilder<'a, C, NoSatellite<T>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoSatellite {
                kind: self.state.kind,
                time: self.state.time,
                duration: seconds,
            },
        }
    }
}

pub struct NoSatellite<T> {
    kind: T,
    time: OffsetDateTime,
    duration: u64,
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoSatellite<T>>
where
    C: Api,
{
    pub fn satellite_id(self, id: impl Into<i32>) -> TaskRequestBuilder<'a, C, NoSite<T>> {
        let satellite = self.client.path_to_url(format!("satellites/{}", id.into()));

        TaskRequestBuilder {
            client: self.client,
            state: NoSite {
                kind: self.state.kind,
                time: self.state.time,
                duration: self.state.duration,
                satellite: UrlResult::Unchecked(satellite),
            },
        }
    }
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoSatellite<T>> {
    pub fn satellite_url(self, url: impl Into<String>) -> TaskRequestBuilder<'a, C, NoSite<T>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoSite {
                kind: self.state.kind,
                time: self.state.time,
                duration: self.state.duration,
                satellite: UrlResult::Checked(url.into()),
            },
        }
    }
}

pub struct NoSite<T> {
    kind: T,
    time: OffsetDateTime,
    duration: u64,
    satellite: UrlResult,
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoSite<T>>
where
    C: Api,
{
    pub fn site_id(self, id: impl Into<i32>) -> TaskRequestBuilder<'a, C, NoConfig<T>> {
        let site = self.client.path_to_url(format!("sites/{}", id.into()));

        TaskRequestBuilder {
            client: self.client,
            state: NoConfig {
                kind: self.state.kind,
                time: self.state.time,
                duration: self.state.duration,
                satellite: self.state.satellite,
                site: UrlResult::Unchecked(site),
            },
        }
    }
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoSite<T>> {
    pub fn site_url(self, url: impl Into<String>) -> TaskRequestBuilder<'a, C, NoConfig<T>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoConfig {
                kind: self.state.kind,
                time: self.state.time,
                duration: self.state.duration,
                satellite: self.state.satellite,
                site: UrlResult::Checked(url.into()),
            },
        }
    }
}

pub struct NoConfig<T> {
    kind: T,
    time: OffsetDateTime,
    duration: u64,
    satellite: UrlResult,
    site: UrlResult,
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoConfig<T>>
where
    C: Api,
{
    pub fn site_configuration_id(self, id: impl Into<i32>) -> TaskRequestBuilder<'a, C, NoBand<T>> {
        let configuration = self
            .client
            .path_to_url(format!("configurations/{}", id.into()));

        TaskRequestBuilder {
            client: self.client,
            state: NoBand {
                kind: self.state.kind,
                time: self.state.time,
                duration: self.state.duration,
                satellite: self.state.satellite,
                site: self.state.site,
                configuration: UrlResult::Unchecked(configuration),
            },
        }
    }
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoConfig<T>> {
    pub fn site_configuration_url(
        self,
        url: impl Into<String>,
    ) -> TaskRequestBuilder<'a, C, NoBand<T>> {
        TaskRequestBuilder {
            client: self.client,
            state: NoBand {
                kind: self.state.kind,
                time: self.state.time,
                duration: self.state.duration,
                satellite: self.state.satellite,
                site: self.state.site,
                configuration: UrlResult::Checked(url.into()),
            },
        }
    }
}

pub struct NoBand<T> {
    kind: T,
    time: OffsetDateTime,
    duration: u64,
    satellite: UrlResult,
    site: UrlResult,
    configuration: UrlResult,
}

impl<'a, C, T> TaskRequestBuilder<'a, C, NoBand<T>>
where
    T: TaskInner,
{
    pub fn band_ids(
        self,
        ids: impl IntoIterator<Item = i32>,
    ) -> TaskRequestBuilder<'a, C, TaskRequest>
    where
        C: Api,
    {
        let client = self.client;
        let bands = ids
            .into_iter()
            .map(|id| UrlResult::Unchecked(client.path_to_url(format!("satellite_bands/{}", id))));

        self.band_results(bands)
    }

    pub fn band_urls(
        self,
        urls: impl IntoIterator<Item = String>,
    ) -> TaskRequestBuilder<'a, C, TaskRequest> {
        let target_bands: Vec<_> = urls.into_iter().map(UrlResult::Checked).collect();
        self.band_results(target_bands)
    }

    fn band_results(
        mut self,
        urls: impl IntoIterator<Item = UrlResult>,
    ) -> TaskRequestBuilder<'a, C, TaskRequest> {
        use time::macros::format_description;
        let item = format_description!("[year]-[month]-[day]T[hour]:[minute]:[second]Z");

        let target_date = self.state.time.format(item).unwrap();
        let target_bands: Vec<_> = urls.into_iter().collect();

        let mut state = TaskRequest {
            typ: TaskType::After, // This is overwritten in `adjust`
            site: self.state.site,
            satellite: self.state.satellite,
            configuration: self.state.configuration,
            target_bands,
            target_date,
            duration: self.state.duration,
            minimum_duration: Some(self.state.duration),
            hours_of_flex: None,
            test_file: None,
            with_override: None,
        };

        self.state.kind.adjust(&mut state);

        TaskRequestBuilder {
            client: self.client,
            state,
        }
    }
}

impl<C> TaskRequestBuilder<'_, C, TaskRequest> {
    pub fn task_minimum_duration(mut self, duration: u64) -> Self {
        self.state.minimum_duration = Some(duration);
        self
    }

    fn override_result(mut self, url: UrlResult) -> Self {
        self.state.with_override = Some(url);
        self
    }

    pub fn override_url(self, url: impl Into<String>) -> Self {
        self.override_result(UrlResult::Checked(url.into()))
    }
}

impl<C> TaskRequestBuilder<'_, C, TaskRequest>
where
    C: Api,
{
    pub fn override_id(self, id: impl Into<i32>) -> Self {
        let override_url = self.client.path_to_url(format!("overrides/{}", id.into()));

        self.override_result(UrlResult::Unchecked(override_url))
    }
}

impl<C> Post for TaskRequestBuilder<'_, C, TaskRequest>
where
    C: Api,
{
    type Response = freedom_models::task::TaskRequest;

    async fn send(self) -> Result<Self::Response, Error> {
        let client = self.client;

        let url = client.path_to_url("requests")?;

        let mut target_bands = Vec::new();
        for result in self.state.target_bands {
            let url = result.try_convert()?;
            target_bands.push(url);
        }
        let with_override = match self.state.with_override {
            Some(url) => Some(url.try_convert()?),
            None => None,
        };

        let dto = TaskRequestInner {
            typ: self.state.typ,
            site: self.state.site.try_convert()?,
            satellite: self.state.satellite.try_convert()?,
            configuration: self.state.configuration.try_convert()?,
            target_bands,
            target_date: self.state.target_date,
            duration: self.state.duration,
            minimum_duration: self.state.minimum_duration,
            hours_of_flex: self.state.hours_of_flex,
            test_file: self.state.test_file,
            with_override,
        };

        client.post_json_map(url, dto).await
    }
}