bbm 0.1.0

Async Rust client library for the German Breitbandmessung (broadband measurement) API
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

// Copyright (c) 2023-2026 Tim Oliver Rabl
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use serde::{Deserialize, Serialize};

use crate::compare::{ComparisonResult, ThresholdResult};
use crate::intstr::InconsistentIntegerString;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Plan {
    pub plan_id: InconsistentIntegerString,
    pub plan_db_version: InconsistentIntegerString,
    pub mindownload: InconsistentIntegerString,
    pub normdownload: InconsistentIntegerString,
    pub maxdownload: InconsistentIntegerString,
    pub maxdownloadpub: InconsistentIntegerString,
    pub minupload: InconsistentIntegerString,
    pub normupload: InconsistentIntegerString,
    pub maxupload: InconsistentIntegerString,
    pub product_highlighted: InconsistentIntegerString,
}

impl Plan {
    fn parse_speed(field: &InconsistentIntegerString) -> Option<f64> {
        field.0.parse::<f64>().ok()
    }

    /// Minimum contractual download speed in kbit/s.
    pub fn min_download_kbps(&self) -> Option<f64> {
        Self::parse_speed(&self.mindownload)
    }

    /// Normal (typically available) download speed in kbit/s.
    pub fn norm_download_kbps(&self) -> Option<f64> {
        Self::parse_speed(&self.normdownload)
    }

    /// Maximum contractual download speed in kbit/s.
    pub fn max_download_kbps(&self) -> Option<f64> {
        Self::parse_speed(&self.maxdownload)
    }

    /// Minimum contractual upload speed in kbit/s.
    pub fn min_upload_kbps(&self) -> Option<f64> {
        Self::parse_speed(&self.minupload)
    }

    /// Normal (typically available) upload speed in kbit/s.
    pub fn norm_upload_kbps(&self) -> Option<f64> {
        Self::parse_speed(&self.normupload)
    }

    /// Maximum contractual upload speed in kbit/s.
    pub fn max_upload_kbps(&self) -> Option<f64> {
        Self::parse_speed(&self.maxupload)
    }

    /// Compare measured speeds against this plan's contractual thresholds.
    pub fn compare(&self, download_kbps: f64, upload_kbps: f64) -> ComparisonResult {
        let results = vec![
            ThresholdResult::check("download >= min", download_kbps, self.min_download_kbps()),
            ThresholdResult::check(
                "download >= normal",
                download_kbps,
                self.norm_download_kbps(),
            ),
            ThresholdResult::check("download >= max", download_kbps, self.max_download_kbps()),
            ThresholdResult::check("upload >= min", upload_kbps, self.min_upload_kbps()),
            ThresholdResult::check("upload >= normal", upload_kbps, self.norm_upload_kbps()),
            ThresholdResult::check("upload >= max", upload_kbps, self.max_upload_kbps()),
        ];

        let all_met = results.iter().all(|r| r.met);

        ComparisonResult {
            plan_id: self.plan_id.0.clone(),
            results,
            all_met,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::client::BbmClient;

    const TESTING_PROVIDER_IDS: &[i64] = &[1, 7, 10, 11, 244, 251, 330, 416, 709];

    #[tokio::test]
    #[ignore] // hits live API
    async fn test_get_plans_by_provider_id() {
        let client = BbmClient::new();
        for &id in TESTING_PROVIDER_IDS {
            let plans = client.get_plans_by_provider_id(id).await.unwrap();
            for plan in &plans {
                assert!(!plan.plan_id.0.is_empty());
            }
        }
    }
}