Updated pypi module

- Added Docstrings
- Renamed PypiData to PyPIData
- Added unit tests

src/main.rs

@@ -2,7 +2,7 @@ use anyhow::Result;
 use clap::{AppSettings, Parser};
 
 mod pypi;
-use pypi::{request_package_info, PypiData};
+use pypi::{request_package_info, PyPIData};
 
 /// Python package manager written in Rust
 #[derive(Parser, Debug)]
@@ -48,10 +48,10 @@ enum Opt {
 }
 
 fn download_package(package_name: String, package_index: &String) -> Result<()> {
-    let package_info: PypiData = request_package_info(&package_name, package_index)?;
+    let package_info: PyPIData = request_package_info(&package_name, package_index)?;
 
     // Example of getting data this will be more robust as the
-    // PypiData struct gets expanded (meaning less calls to .get())
+    // PyPIData struct gets expanded (meaning less calls to .get())
     let latest_version = package_info.info.get("version").unwrap();
     println!("Latest Version of {} is {}", package_name, latest_version);
 

src/pypi.rs

@@ -1,23 +1,37 @@
+//! Warehouse PyPI API Implementation
+
 use log::info;
 use serde::{Deserialize, Serialize};
 use std::fmt::Display;
 
-///
-/// TODO: Implement more specific structs
+/// Set of Information describing a Python package hosted on a Warehouse instance
+/// for exact details of what is contained go to https://warehouse.pypa.io/api-reference/json.html#project
 #[derive(Debug, Serialize, Deserialize)]
-pub struct PypiData {
+pub struct PyPIData {
+    /// Contains data such as Package Name, Author,
     pub info: serde_json::value::Value,
     pub last_serial: i32,
+    /// List of releases containing data such as
     pub releases: serde_json::value::Value,
+    /// Link and related data to sdist & bdist_wheel
     pub urls: Vec<serde_json::value::Value>,
+    /// Vector of known vulnerabilities of the package
     pub vulnerabilities: Vec<serde_json::value::Value>,
 }
 
-/// Implements Warehouse Pypi API call & JSON conversion
+/// Implements Warehouse PyPI API call & JSON conversion
+///
+/// # Example
+/// ```
+/// use rust-pip::PyPI::request_package_info;
+///
+/// let data = request_package_info("numpy", "https://pypi.org/").unwrap();
+/// assert_eq!(data.info.get("license").unwrap(), "BSD");
+/// ```
 pub fn request_package_info<T>(
     package_name: T,
     package_index: T,
-) -> Result<PypiData, reqwest::Error>
+) -> Result<PyPIData, reqwest::Error>
 where
     T: ToString + Display,
 {
@@ -26,7 +40,38 @@ where
     info!("Requesting data from {}", path);
     let resp: reqwest::blocking::Response = reqwest::blocking::get(path)?;
 
-    let decoded_json: PypiData = resp.json()?;
+    let decoded_json: PyPIData = resp.json()?;
 
     Ok(decoded_json)
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::pypi::request_package_info;
+
+    #[test]
+    fn check_numpy_licence() {
+        let data = request_package_info("numpy", "https://pypi.org/").unwrap();
+
+        assert_eq!(data.info.get("license").unwrap(), "BSD");
+    }
+
+    #[test]
+    fn check_pytorch_name() {
+        let data = request_package_info("pytorch", "https://pypi.org/").unwrap();
+
+        assert_eq!(data.info.get("name").unwrap(), "pytorch");
+    }
+
+    #[test]
+    fn check_pytorch_download_v1() {
+        let data = request_package_info("numpy", "https://pypi.org/").unwrap();
+
+        assert_eq!(
+            data.releases.get("1.0").unwrap()[0]
+                .get("filename")
+                .unwrap(),
+            "numpy-1.0.1.dev3460.win32-py2.4.exe"
+        );
+    }
+}