geoiplocation 0.3.0

//! Find location given the IP address.
//!
//! Provides abstraction over the fields returned by the JSON response. Returns a `Struct` for the
//! given query.
//!
//! You can set your own env for location api using something like `export SUBCOM_LOCATION_API_URL=<your-url>`
//! The final URL looks something like `your-url/IP?apikey=KEY`.
//!
//! Two methods are provides(more documentation provided):
//!
//! - `async fn get_location(ip: &str, key: &str) -> anyhow::Result<Option<Location>>`
//! - `async fn get_location_fallback(ip: &str, key: &str) -> anyhow::Result<HashMap<String, String>>`
//!
//! **NOTE:** Still in production so a few things might break or change, you can use `cargo doc --open` for better
//! experience or read it [here](https://docs.rs/geoiplocation/latest/geoiplocation/index.html).

use crate::geoiplocation::Location;
use reqwest::Url;

pub mod geoiplocation;
use std::collections::HashMap;
use std::env;

/// `async` function to get the location
///
/// Eg:
/// ```rust
/// use geoiplocation::get_location;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
///     let resp = get_location(
///         "8.8.8.8".parse().unwrap(),
///         "YOUR-KEY",
///     )
///     .await?;
///     println!("{:#?}", resp);
///     // Some(Location { ip: Some("8.8.8.8"), city: Some(""), country: Some("United States"), continent: Some("North America") })
///
///     Ok(())
/// }
/// ```
pub async fn get_location(ip: &str, key: &str) -> anyhow::Result<Option<Location>> {
    let location_api_url = env::var("SUBCOM_LOCATION_API_URL").expect("cannot parse URL");

    let mut url = Url::parse(&*format!("{}/{}", location_api_url, ip))?;
    url.set_query(Some(&*format!("apikey={}", key)));

    Ok(Some(reqwest::get(url).await?.json::<Location>().await?))
}

/// An `async` fallback method to get JSON response
///
/// Instead of holding the values in a Struct he hold the in `HashMap<String, String>`, this should
/// provide a fallback in case the api is ever changing to keep on updating the struct
pub async fn get_location_fallback(ip: &str, key: &str) -> anyhow::Result<HashMap<String, String>> {
    let location_api_url = env::var("SUBCOM_LOCATION_API_URL").expect("cannot parse URL");

    let mut url = Url::parse(&*format!("{}/{}", location_api_url, ip))?;
    url.set_query(Some(&*format!("apikey={}", key)));

    Ok(reqwest::get(url)
        .await?
        .json::<HashMap<String, String>>()
        .await?)
}