2022-02-12 12:25:05 +01:00
|
|
|
//! Service that provides today's weather forecast for air quality, rain and UV metrics.
|
|
|
|
//!
|
|
|
|
//! This is useful if you want to prepare for going outside and need to know what happens in the
|
|
|
|
//! near future or later today.
|
|
|
|
|
|
|
|
#![warn(
|
|
|
|
clippy::all,
|
|
|
|
missing_debug_implementations,
|
|
|
|
rust_2018_idioms,
|
|
|
|
rustdoc::broken_intra_doc_links
|
|
|
|
)]
|
|
|
|
#![deny(missing_docs)]
|
|
|
|
|
|
|
|
use geocoding::{Forward, Openstreetmap, Point};
|
|
|
|
use rocket::serde::json::Json;
|
|
|
|
use rocket::serde::Serialize;
|
|
|
|
use rocket::{get, launch, routes, FromFormField};
|
|
|
|
|
|
|
|
/// The current for a specific location.
|
|
|
|
///
|
|
|
|
/// Only the metrics asked for are included as well as the position and current time.
|
|
|
|
///
|
|
|
|
/// TODO: Fill the metrics with actual data!
|
|
|
|
#[derive(Debug, Default, PartialEq, Serialize)]
|
|
|
|
#[serde(crate = "rocket::serde")]
|
|
|
|
struct Forecast {
|
|
|
|
/// The latitude of the position.
|
|
|
|
lat: f64,
|
2022-02-12 15:01:02 +01:00
|
|
|
|
2022-02-12 12:25:05 +01:00
|
|
|
/// The longitude of the position.
|
|
|
|
lon: f64,
|
2022-02-12 15:01:02 +01:00
|
|
|
|
2022-02-12 12:25:05 +01:00
|
|
|
/// The current time (in seconds since the UNIX epoch).
|
|
|
|
time: i64,
|
2022-02-12 15:01:02 +01:00
|
|
|
|
|
|
|
/// The air quality index (when asked for).
|
|
|
|
#[serde(rename = "AQI", skip_serializing_if = "Option::is_none")]
|
|
|
|
aqi: Option<u8>,
|
|
|
|
|
|
|
|
/// The NO₂ concentration (when asked for).
|
|
|
|
#[serde(rename = "NO2", skip_serializing_if = "Option::is_none")]
|
|
|
|
no2: Option<u8>,
|
|
|
|
|
|
|
|
/// The O₃ concentration (when asked for).
|
|
|
|
#[serde(rename = "O3", skip_serializing_if = "Option::is_none")]
|
|
|
|
o3: Option<u8>,
|
|
|
|
|
|
|
|
/// The FIXME air quality index (when asked for).
|
|
|
|
#[serde(rename = "PAQI", skip_serializing_if = "Option::is_none")]
|
|
|
|
paqi: Option<u8>,
|
|
|
|
|
|
|
|
/// The particulate matter in the air (when asked for).
|
|
|
|
#[serde(rename = "PM10", skip_serializing_if = "Option::is_none")]
|
|
|
|
pm10: Option<u8>,
|
|
|
|
|
|
|
|
/// The pollen in the air (when asked for).
|
|
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
|
|
pollen: Option<u8>,
|
|
|
|
|
|
|
|
/// The precipitation (when asked for).
|
|
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
|
|
precipitation: Option<u8>,
|
|
|
|
|
|
|
|
/// The UV index (when asked for).
|
|
|
|
#[serde(rename = "UVI", skip_serializing_if = "Option::is_none")]
|
|
|
|
uvi: Option<u8>,
|
2022-02-12 12:25:05 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Forecast {
|
|
|
|
fn new(lat: f64, lon: f64) -> Self {
|
|
|
|
let time = chrono::Utc::now().timestamp();
|
|
|
|
|
|
|
|
Self {
|
|
|
|
lat,
|
|
|
|
lon,
|
|
|
|
time,
|
|
|
|
..Default::default()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// The supported metrics.
|
|
|
|
///
|
|
|
|
/// This is used for selecting which metrics should be calculated & returned.
|
|
|
|
#[allow(clippy::upper_case_acronyms)]
|
|
|
|
#[derive(Debug, Eq, PartialEq, FromFormField)]
|
|
|
|
enum Metric {
|
|
|
|
/// All metrics.
|
|
|
|
All,
|
|
|
|
/// The air quality index.
|
|
|
|
AQI,
|
|
|
|
/// The NO₂ concentration.
|
|
|
|
NO2,
|
|
|
|
/// The O₃ concentration.
|
|
|
|
O3,
|
|
|
|
/// The FIXME air quality index.
|
|
|
|
PAQI,
|
|
|
|
/// The particulate matter in the air.
|
|
|
|
PM10,
|
|
|
|
/// The pollen in the air.
|
|
|
|
Pollen,
|
|
|
|
/// The precipitation.
|
|
|
|
Precipitation,
|
|
|
|
/// The UV index.
|
|
|
|
UVI,
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Calculates and returns the forecast.
|
|
|
|
///
|
|
|
|
/// The provided list `metrics` determines what will be included in the forecast.
|
|
|
|
async fn forecast(lat: f64, lon: f64, metrics: Vec<Metric>) -> Forecast {
|
|
|
|
let mut forecast = Forecast::new(lat, lon);
|
|
|
|
|
|
|
|
for metric in metrics {
|
|
|
|
match metric {
|
|
|
|
// TODO: Find a way to handle the "All" case more gracefully!
|
|
|
|
Metric::All => {
|
2022-02-12 15:01:02 +01:00
|
|
|
forecast.aqi = Some(1);
|
|
|
|
forecast.no2 = Some(2);
|
|
|
|
forecast.o3 = Some(3);
|
|
|
|
forecast.paqi = Some(4);
|
|
|
|
forecast.pm10 = Some(5);
|
|
|
|
forecast.pollen = Some(6);
|
|
|
|
forecast.precipitation = Some(7);
|
|
|
|
forecast.uvi = Some(8);
|
2022-02-12 12:25:05 +01:00
|
|
|
}
|
2022-02-12 15:01:02 +01:00
|
|
|
Metric::AQI => forecast.aqi = Some(1),
|
|
|
|
Metric::NO2 => forecast.no2 = Some(2),
|
|
|
|
Metric::O3 => forecast.o3 = Some(3),
|
|
|
|
Metric::PAQI => forecast.paqi = Some(4),
|
|
|
|
Metric::PM10 => forecast.pm10 = Some(5),
|
|
|
|
Metric::Pollen => forecast.pollen = Some(6),
|
|
|
|
Metric::Precipitation => forecast.precipitation = Some(7),
|
|
|
|
Metric::UVI => forecast.uvi = Some(8),
|
2022-02-12 12:25:05 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
forecast
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Retrieves the geocoded position for the given address.
|
|
|
|
async fn address_position(address: &str) -> Option<(f64, f64)> {
|
|
|
|
let osm = Openstreetmap::new();
|
|
|
|
// FIXME: Handle or log the error.
|
|
|
|
let points: Vec<Point<f64>> = osm.forward(address).ok()?;
|
|
|
|
|
|
|
|
points.get(0).map(|point| (point.x(), point.y()))
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Handler for retrieving the forecast for an address.
|
|
|
|
#[get("/forecast?<address>&<metrics>")]
|
|
|
|
async fn forecast_address(address: String, metrics: Vec<Metric>) -> Option<Json<Forecast>> {
|
|
|
|
let (lat, lon) = address_position(&address).await?;
|
|
|
|
let forecast = forecast(lat, lon, metrics).await;
|
|
|
|
|
|
|
|
Some(Json(forecast))
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Handler for retrieving the forecast for a geocoded position.
|
|
|
|
#[get("/forecast?<lat>&<lon>&<metrics>", rank = 2)]
|
|
|
|
async fn forecast_geo(lat: f64, lon: f64, metrics: Vec<Metric>) -> Json<Forecast> {
|
|
|
|
let forecast = forecast(lat, lon, metrics).await;
|
|
|
|
|
|
|
|
Json(forecast)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Launches rocket.
|
|
|
|
#[launch]
|
|
|
|
async fn rocket() -> _ {
|
|
|
|
rocket::build().mount("/", routes![forecast_address, forecast_geo])
|
|
|
|
}
|