oslobike 0.1.0

A rust wrapper for the Oslo City Bike open 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

/*
    oslobike - find free bikes in Oslo.
    Copyright (C) 2019  Harald Eilertsen <haraldei@anduin.net>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

use reqwest::{
    self,
    header::{
        HeaderMap,
        HeaderValue,
    },
    Client,
};
use crate::station::{
    Station,
    StationAvailability,
    StationAvailabilityContainer,
    StationContainer
};
use crate::error::ApiResult;

const API_BASE: &str = "https://oslobysykkel.no/api/v1";

fn url_for(endpoint: &str) -> String {
    [API_BASE, endpoint].join("/")
}

/// The oslobike::Api struct holds the state for the Api.
pub struct Api {
    client: reqwest::Client,
}

impl Api {

    /// Create an instance of the API like this:
    ///
    ///     # let my_api_key = String::from("1234");
    ///     let api = oslobike::Api::new(my_api_key).expect("An error occured");
    ///
    pub fn new(api_key: String) -> ApiResult<Api> {
        let mut hdrs = HeaderMap::new();
        hdrs.insert("client-identifier", HeaderValue::from_str(&api_key)?);

        let client = Client::builder()
            .default_headers(hdrs)
            .build()?;

        Ok(Api { client })
    }

    /// Fetch the list of stations and their basic data from the api.
    pub fn stations(&self) -> ApiResult<Vec<Station>> {
        let response_json = self.get("stations")?;
        let v: StationContainer = serde_json::from_str(&response_json)?;
        Ok(v.stations)
    }

    /// Fetch availability status for all stations
    pub fn station_availability(&self) -> ApiResult<Vec<StationAvailability>> {
        let response_json = self.get("stations/availability")?;
        let v: StationAvailabilityContainer = serde_json::from_str(&response_json)?;
        Ok(v.stations)
    }

    /// A helper method to fetch payloads from the upstream API
    fn get(&self, path: &str) -> ApiResult<String> {
        self.client
            .get(&url_for(path))
            .send()?
            .error_for_status()?
            .text()
            .map_err(crate::error::Error::ReqwestError)
    }
}