forecast 3.0.0

A Rust client for the Dark Sky 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
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

/*Copyright 2016 Jesse C. Grillo

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.*/

use std::fs::File;
use std::path::{PathBuf, Path};
use std::time::Duration;

use reqwest::{Client, StatusCode};

use forecast::{ApiResponse, ApiClient, ForecastRequestBuilder,
               TimeMachineRequestBuilder, ExcludeBlock, ExtendBy,
               Lang, Units};

// constants

const LAT: f64 = 42.3736;
const LONG: f64 = -71.1097;
const TIME: u64 = 1505899999;

const TIMEOUT_SECS: u64 = 60;

// tests for serde models

fn test_response_serde(path: &Path) {
    let file = match File::open(&path) {
        Err(reason) => panic!("couldn't open {}: {}", path.display(), reason),
        Ok(file) => file
    };

    let deserialized_response: ApiResponse = serde_json::from_reader(file).unwrap();

    let serialized_response: String = serde_json::to_string(&deserialized_response).unwrap();

    let deserialized_again: ApiResponse = serde_json::from_str(&serialized_response).unwrap();

    assert_eq!(deserialized_response, deserialized_again);
}

#[test]
fn test_response_serde_10_23_2016() {
    let mut path_buf = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    path_buf.push("resources/tests/forecast_response_10-23-2016.json");

    let path = path_buf.as_path();

    test_response_serde(path);
}

#[test]
fn test_response_serde_01_21_2018() {
    let mut path_buf = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    path_buf.push("resources/tests/forecast_response_01-21-2018.json");

    let path = path_buf.as_path();

    test_response_serde(path);
}

// tests which perform network calls.
//
// To execute these tests, run the following command in the project
// root:
//
// FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration

#[tokio::test]
#[cfg(feature = "integration")]
async fn test_get_forecast_request_default() {
    let api_key = env!("FORECAST_API_KEY");

    let reqwest_client = Client::builder()
        .timeout(Duration::from_secs(TIMEOUT_SECS))
        .build()
        .unwrap();

    let api_client = ApiClient::new(&reqwest_client);

    let forecast_request = ForecastRequestBuilder::new(api_key, LAT, LONG).build();

    let response = api_client.get_forecast(forecast_request).await.unwrap();
    let status = response.status();

    assert_eq!(status, StatusCode::OK);

    let api_response: ApiResponse = serde_json::from_str(&response.text().await.unwrap()).unwrap();

    assert_eq!(api_response.latitude, LAT);
    assert_eq!(api_response.longitude, LONG);

    // Use the following invocation to display the JSON response:
    // FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration -- --nocapture
    println!("{}", serde_json::to_string_pretty(&api_response).unwrap());
}

#[tokio::test]
#[cfg(feature = "integration")]
async fn test_get_forecast_request_full() {
    let api_key = env!("FORECAST_API_KEY");

    let reqwest_client = Client::builder()
        .timeout(Duration::from_secs(TIMEOUT_SECS))
        .build()
        .unwrap();

    let api_client = ApiClient::new(&reqwest_client);

    let mut blocks = vec![ExcludeBlock::Alerts];

    let forecast_request = ForecastRequestBuilder::new(api_key, LAT, LONG)
        .exclude_block(ExcludeBlock::Flags)
        .exclude_blocks(&mut blocks)
        .extend(ExtendBy::Hourly)
        .lang(Lang::Swedish)
        .units(Units::SI)
        .build();

    let response = api_client.get_forecast(forecast_request).await.unwrap();
    response.headers();
    let status = response.status();

    assert_eq!(status, StatusCode::OK);

    let api_response: ApiResponse = serde_json::from_str(&response.text().await.unwrap()).unwrap();

    assert_eq!(api_response.latitude, LAT);
    assert_eq!(api_response.longitude, LONG);

    // Use the following invocation to display the JSON response:
    // FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration -- --nocapture
    println!("{}", serde_json::to_string_pretty(&api_response).unwrap());
}

#[tokio::test]
#[cfg(feature = "integration")]
async fn test_get_forecast_request_full_asref() {
    let api_key = env!("FORECAST_API_KEY");

    let reqwest_client = Client::builder()
        .timeout(Duration::from_secs(TIMEOUT_SECS))
        .build()
        .unwrap();

    let api_client = ApiClient::new(&reqwest_client);

    let mut blocks = vec![ExcludeBlock::Alerts];

    let forecast_request = ForecastRequestBuilder::new(api_key, LAT, LONG)
        .exclude_block(ExcludeBlock::Flags)
        .exclude_blocks(&mut blocks)
        .extend(ExtendBy::Hourly)
        .lang(Lang::Swedish)
        .units(Units::SI)
        .build();

    let response = api_client.get_forecast(&forecast_request).await.unwrap();
    response.headers();
    let status = response.status();

    assert_eq!(status, StatusCode::OK);

    let api_response: ApiResponse = serde_json::from_str(&response.text().await.unwrap()).unwrap();

    assert_eq!(api_response.latitude, LAT);
    assert_eq!(api_response.longitude, LONG);

    // Use the following invocation to display the JSON response:
    // FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration -- --nocapture
    println!("{}", serde_json::to_string_pretty(&api_response).unwrap());
}

#[tokio::test]
#[cfg(feature = "integration")]
async fn test_get_time_machine_request_default() {
    let api_key = env!("FORECAST_API_KEY");

    let reqwest_client = Client::builder()
        .timeout(Duration::from_secs(TIMEOUT_SECS))
        .build()
        .unwrap();

    let api_client = ApiClient::new(&reqwest_client);

    let time_machine_request = TimeMachineRequestBuilder::new(
        api_key, LAT, LONG, TIME
    ).build();

    let response = api_client.get_time_machine(time_machine_request).await.unwrap();
    let status = response.status();

    assert_eq!(status, StatusCode::OK);

    let api_response: ApiResponse = serde_json::from_str(&response.text().await.unwrap()).unwrap();

    assert_eq!(api_response.latitude, LAT);
    assert_eq!(api_response.longitude, LONG);

    // Use the following invocation to display the JSON response:
    // FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration -- --nocapture
    println!("{}", serde_json::to_string_pretty(&api_response).unwrap());
}

#[tokio::test]
#[cfg(feature = "integration")]
async fn test_get_time_machine_request_full() {
    let api_key = env!("FORECAST_API_KEY");

    let reqwest_client = Client::builder()
        .timeout(Duration::from_secs(TIMEOUT_SECS))
        .build()
        .unwrap();

    let api_client = ApiClient::new(&reqwest_client);

    let mut blocks = vec![ExcludeBlock::Daily];

    let time_machine_request = TimeMachineRequestBuilder::new(
        api_key, LAT, LONG, TIME
    )
        .exclude_block(ExcludeBlock::Alerts)
        .exclude_blocks(&mut blocks)
        .lang(Lang::Arabic)
        .units(Units::SI)
        .build();

    let response = api_client.get_time_machine(time_machine_request).await.unwrap();
    let status = response.status();

    assert_eq!(status, StatusCode::OK);

    let api_response: ApiResponse = serde_json::from_str(&response.text().await.unwrap()).unwrap();

    assert_eq!(api_response.latitude, LAT);
    assert_eq!(api_response.longitude, LONG);

    // Use the following invocation to display the JSON response:
    // FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration -- --nocapture
    println!("{}", serde_json::to_string_pretty(&api_response).unwrap());
}

#[tokio::test]
#[cfg(feature = "integration")]
async fn test_get_time_machine_request_default_asref() {
    let api_key = env!("FORECAST_API_KEY");

    let reqwest_client = Client::builder()
        .timeout(Duration::from_secs(TIMEOUT_SECS))
        .build()
        .unwrap();

    let api_client = ApiClient::new(&reqwest_client);

    let time_machine_request = TimeMachineRequestBuilder::new(
        api_key, LAT, LONG, TIME
    ).build();

    let response = api_client.get_time_machine(&time_machine_request).await.unwrap();
    let status = response.status();

    assert_eq!(status, StatusCode::OK);

    let api_response: ApiResponse = serde_json::from_str(&response.text().await.unwrap()).unwrap();

    assert_eq!(api_response.latitude, LAT);
    assert_eq!(api_response.longitude, LONG);

    // Use the following invocation to display the JSON response:
    // FORECAST_API_KEY=$YOUR_FORECAST_API_KEY cargo test --features integration -- --nocapture
    println!("{}", serde_json::to_string_pretty(&api_response).unwrap());
}