mineralfyi 0.1.0

Rust client for the MineralFYI API — https://mineralfyi.com
Documentation
//! Rust client for [MineralFYI](https://mineralfyi.com) REST API.
//!
//! ```rust
//! let client = mineralfyi::Client::new();
//! let result = client.search("query").unwrap();
//! ```

use serde_json::Value;

pub struct Client {
    base_url: String,
    http: reqwest::blocking::Client,
}

impl Client {
    pub fn new() -> Self {
        Self {
            base_url: "https://mineralfyi.com".to_string(),
            http: reqwest::blocking::Client::new(),
        }
    }

    fn get(&self, path: &str) -> Result<Value, Box<dyn std::error::Error>> {
        let url = format!("{}{}", self.base_url, path);
        let resp = self.http.get(&url).send()?.json()?;
        Ok(resp)
    }

    pub fn search(&self, query: &str) -> Result<Value, Box<dyn std::error::Error>> {
        let url = format!("{}/api/v1/search/?q={}", self.base_url, query);
        let resp = self.http.get(&url).send()?.json()?;
        Ok(resp)
    }

    /// List all classes.
    pub fn list_classes(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/classes/")
    }

    /// Get classe by slug.
    pub fn get_classe(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/classes/{}/", slug))
    }
    /// List all comparisons.
    pub fn list_comparisons(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/comparisons/")
    }

    /// Get comparison by slug.
    pub fn get_comparison(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/comparisons/{}/", slug))
    }
    /// List all countries.
    pub fn list_countries(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/countries/")
    }

    /// Get country by slug.
    pub fn get_country(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/countries/{}/", slug))
    }
    /// List all crystal systems.
    pub fn list_crystal_systems(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/crystal-systems/")
    }

    /// Get crystal system by slug.
    pub fn get_crystal_system(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/crystal-systems/{}/", slug))
    }
    /// List all faqs.
    pub fn list_faqs(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/faqs/")
    }

    /// Get faq by slug.
    pub fn get_faq(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/faqs/{}/", slug))
    }
    /// List all glossary.
    pub fn list_glossary(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/glossary/")
    }

    /// Get term by slug.
    pub fn get_term(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/glossary/{}/", slug))
    }
    /// List all glossary categories.
    pub fn list_glossary_categories(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/glossary-categories/")
    }

    /// Get glossary category by slug.
    pub fn get_glossary_category(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/glossary-categories/{}/", slug))
    }
    /// List all guide series.
    pub fn list_guide_series(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/guide-series/")
    }

    /// Get guide sery by slug.
    pub fn get_guide_sery(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/guide-series/{}/", slug))
    }
    /// List all guides.
    pub fn list_guides(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/guides/")
    }

    /// Get guide by slug.
    pub fn get_guide(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/guides/{}/", slug))
    }
    /// List all localities.
    pub fn list_localities(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/localities/")
    }

    /// Get locality by slug.
    pub fn get_locality(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/localities/{}/", slug))
    }
    /// List all minerals.
    pub fn list_minerals(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/minerals/")
    }

    /// Get mineral by slug.
    pub fn get_mineral(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/minerals/{}/", slug))
    }
    /// List all rock types.
    pub fn list_rock_types(&self) -> Result<Value, Box<dyn std::error::Error>> {
        self.get("/api/v1/rock-types/")
    }

    /// Get rock type by slug.
    pub fn get_rock_type(&self, slug: &str) -> Result<Value, Box<dyn std::error::Error>> {
        self.get(&format!("/api/v1/rock-types/{}/", slug))
    }
}

impl Default for Client {
    fn default() -> Self { Self::new() }
}