lice 0.1.4

Dead simple, minimal SPDX License generator library written in Rust.
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

use anyhow::Result;

use serde::{Deserialize, Serialize};

/// SPDX API client.
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
pub struct SPDX;

impl SPDX {
    /// The base SPDX License API URL.
    pub const BASE_URL: &'static str = "https://spdx.org/licenses";

    /// Get a list of all SPDX licenses.
    pub async fn licenses() -> Result<crate::types::Licenses> {
        let url = format!("{}/licenses.json", Self::BASE_URL);
        reqwest::get(url)
            .await?
            .json::<crate::types::Licenses>()
            .await
            .map_err(|e| e.into())
    }

    /// Fetch a license by ID, e.g. `MIT`.
    ///
    /// # Example
    ///
    /// ```rust
    /// use anyhow::Result;
    /// use lice::spdx;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<()> {
    ///    let license = spdx::SPDX::license("MIT").await?;
    ///    println!("{:#?}", license);
    ///    Ok(())
    /// }
    /// ```
    pub async fn license(id: &str) -> Result<crate::types::License> {
        let url = format!("{}/{}.json", Self::BASE_URL, id);
        reqwest::get(url)
            .await?
            .json::<crate::types::License>()
            .await
            .map_err(|e| e.into())
    }

    /// Fuzzy search for a license by ID, e.g. `MIT`.
    ///
    /// # Example
    /// ```rust
    /// use anyhow::Result;
    /// use lice::spdx;
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<()> {
    ///   let license = spdx::SPDX::fuzzy_find("mit").await?;
    ///   let license = license.ok_or(anyhow::anyhow!("no license!"))?;
    ///   assert_eq!(license.license_id, "MIT");
    ///   Ok(())
    /// }
    /// ```
    pub async fn fuzzy_find(id: &str) -> Result<Option<crate::types::License>> {
        let licenses = Self::licenses().await?;
        Ok(licenses.match_license(id))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_licenses() -> Result<()> {
        let licenses = SPDX::licenses().await?;
        println!("{:#?}", licenses);
        assert!(licenses.licenses.len() > 0);
        Ok(())
    }

    #[tokio::test]
    async fn test_fetch_single_license() -> Result<()> {
        let license = SPDX::license("MIT").await?;
        println!("{:#?}", license);
        assert_eq!(license.license_id, "MIT");
        Ok(())
    }
}