openweathermap_client 0.7.0

A client for querying the weather from the free OpenWeatherMap 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use core::fmt;

use super::models::{City, CityId, Coord};

pub type QueryParameter = (&'static str, String);
pub type QueryParameters = Vec<QueryParameter>;

/// Abstraction of a query against the `OpenWeatherMap` API.
pub trait Query: fmt::Debug + fmt::Display + Send + Sync {
    /// Used in logging and included as a label in metrics published by `openweathermap_exporter`
    fn get_display_name(&self) -> &Option<String>;
    /// Query parameters and values that must be added to API call URL.
    fn query_params(&self) -> QueryParameters;
}

/// Queries weather at a geographic location using `lat={lat},lon={lon}` as described [here](https://openweathermap.org/current#geo).
impl Query for Coord {
    fn get_display_name(&self) -> &Option<String> {
        &self.display_name
    }

    fn query_params(&self) -> QueryParameters {
        vec![("lat", self.lat.to_string()), ("lon", self.lon.to_string())]
    }
}

/// Queries weather at a city using `q={city},{country_code}` as described [here](https://openweathermap.org/current#name).
impl Query for City {
    fn get_display_name(&self) -> &Option<String> {
        &self.display_name
    }

    fn query_params(&self) -> QueryParameters {
        vec![("q", format!("{},{}", self.name, self.country_code))]
    }
}

/// Queries weather at a city by it's openweathermap id as described [here](https://openweathermap.org/current#cityid).
impl Query for CityId {
    fn get_display_name(&self) -> &Option<String> {
        &self.display_name
    }

    fn query_params(&self) -> QueryParameters {
        vec![("id", self.id.to_string())]
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        models::{City, CityId, Coord},
        query::QueryParameter,
        Query,
    };

    fn coord_query() -> (Coord, Vec<QueryParameter>) {
        (
            Coord {
                lat: 1.2345,
                lon: 5.6789,
                display_name: None,
            },
            vec![("lat", "1.2345".to_owned()), ("lon", "5.6789".to_owned())],
        )
    }

    fn city_query1() -> (City, Vec<QueryParameter>) {
        (
            City {
                name: "Aripuanã".to_owned(),
                country_code: "BR".to_owned(),
                display_name: None,
            },
            vec![("q", "Aripuanã,BR".to_owned())],
        )
    }

    fn city_query2() -> (City, Vec<QueryParameter>) {
        (
            City {
                name: "Springfield,IL".to_owned(),
                country_code: "US".to_owned(),
                display_name: None,
            },
            vec![("q", "Springfield,IL,US".to_owned())],
        )
    }
    fn city_id_query() -> (CityId, Vec<QueryParameter>) {
        (
            CityId {
                id: 3_665_202,
                display_name: None,
            },
            vec![("id", "3665202".to_owned())],
        )
    }

    #[test]
    fn test_query_params() {
        let (query, expected) = coord_query();
        assert_eq!(query.query_params(), expected);

        let (query, expected) = city_query1();
        assert_eq!(query.query_params(), expected);

        let (query, expected) = city_query2();
        assert_eq!(query.query_params(), expected);

        let (query, expected) = city_id_query();
        assert_eq!(query.query_params(), expected);
    }

    fn is_sync<T: Sync>(_: &T) -> bool {
        true
    }
    fn is_send<T: Send>(_: &T) -> bool {
        true
    }

    #[test]
    fn ensure_query_stays_send_plus_sync() {
        let (query, _) = coord_query();
        assert!(is_sync(&query));
        assert!(is_send(&query));

        let (query, _) = city_query1();
        assert!(is_sync(&query));
        assert!(is_send(&query));

        let (query, _) = city_query2();
        assert!(is_sync(&query));
        assert!(is_send(&query));

        let (query, _) = city_id_query();
        assert!(is_sync(&query));
        assert!(is_send(&query));
    }
}