Merge pull request #6 from Jim-Hodapp-Coaching/basic_command_line_interface

Author: jhodapp

Cargo.toml

@@ -10,6 +10,11 @@ rand = "0.8.4"
 reqwest = { version = "0.11.9", features = ["blocking"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0.74"
+clap = { version = "3.1.7", features = ["derive"] }
 
 [dev-dependencies]
 regex = "1.5.4"
+
+[lib]
+name = "ambi_mock_client"
+path = "src/lib.rs"

src/lib.rs

@@ -0,0 +1,29 @@
+//! # Provides a mock Ambi client that emulates real sensor hardware such as like
+//! an Edge client.
+//!
+//! This file provides for a separation of concerns from main.rs for application
+//! logic, per the standard Rust pattern.
+//! 
+//! See `main.rs` for more details about what this application does.
+//!
+//! See the `LICENSE` file for Copyright and license details.
+//! 
+//! 
+use clap::{Parser};
+
+/// Defines the Ambi Mock Client command line interface as a struct
+#[derive(Parser, Debug)]
+#[clap(name = "Ambi Mock Client")]
+#[clap(author = "Rust Never Sleeps community (https://github.com/Jim-Hodapp-Coaching/)")]
+#[clap(version = "0.1.0")]
+#[clap(about = "Provides a mock Ambi client that emulates real sensor hardware such as an Edge client.")]
+#[clap(long_about = "This application emulates a real set of hardware sensors that can report on environmental conditions such as temperature, pressure, humidity, etc.")]
+pub struct Cli {
+    /// Turns verbose console debug output on
+    #[clap(short, long)]
+    pub debug: bool,
+}
+
+pub fn run(cli: &Cli) {
+    println!("\r\ncli: {:?}\r\n", cli);
+}

src/main.rs

@@ -1,8 +1,24 @@
+//! # Provides a mock Ambi client that emulates real sensor hardware such as 
+//! an Edge client.
+//!
+//! This application emulates a real set of hardware sensors that can report on
+//! environmental conditions such as temperature, pressure, humidity, etc.
+//! 
+//! Please see the `ambi` repository for the web backend that this client connects to
+//! and the `edge-rs` repository for what this client is emulating.
+//!
+//! See the `LICENSE` file for Copyright and license details.
+//! 
+
 use rand::{thread_rng, Rng};
 use reqwest::blocking::Client;
 use reqwest::header::CONTENT_TYPE;
 use serde::{Serialize, Deserialize};
 use std::fmt;
+use clap::{Parser};
+
+// Internal library namespace for separation of app logic
+use ambi_mock_client;
 
 #[derive(Serialize, Deserialize)]
 struct Reading {
@@ -76,8 +92,8 @@ fn random_gen_temperature() -> String {
 }
 
 fn random_gen_pressure() -> String {
-  let mut rng = thread_rng();
-  rng.gen_range(900..=1100).to_string()
+    let mut rng = thread_rng();
+    rng.gen_range(900..=1100).to_string()
 }
 
 fn random_gen_dust_concentration() -> String {
@@ -86,29 +102,39 @@ fn random_gen_dust_concentration() -> String {
 }
 
 fn main() {
-   let dust_concentration = random_gen_dust_concentration();
-   let air_purity = AirPurity::from_value(dust_concentration.parse::<u16>().unwrap()).to_string();
-   let reading = Reading::new(
-       random_gen_temperature(),
-       random_gen_humidity(),
-       random_gen_pressure(),
-       dust_concentration,
-       air_purity
-   );
-
-   let json = serde_json::to_string(&reading).unwrap();
-   const URL: &str = "http://localhost:4000/api/readings/add";
-
-   println!("Sending POST request to {} as JSON: {}", URL, json);
-
-   let client = Client::new();
-   let res = client
-    .post(URL)
-    .header(CONTENT_TYPE, "application/json")
-    .body(json)
-    .send();
-
-   println!("Response: {:#?}", res);
+    // Parses the provided command line interface arguments and flags
+    let cli = ambi_mock_client::Cli::parse();
+
+    match cli.debug {
+        true => println!("Debug mode is now *on*"),
+        false => println!("Debug mode is now *off*")
+    }
+    
+    ambi_mock_client::run(&cli);
+
+    let dust_concentration = random_gen_dust_concentration();
+    let air_purity = AirPurity::from_value(dust_concentration.parse::<u16>().unwrap()).to_string();
+    let reading = Reading::new(
+        random_gen_temperature(),
+        random_gen_humidity(),
+        random_gen_pressure(),
+        dust_concentration,
+        air_purity
+    );
+
+    let json = serde_json::to_string(&reading).unwrap();
+    const URL: &str = "http://localhost:4000/api/readings/add";
+
+    println!("Sending POST request to {} as JSON: {}", URL, json);
+
+    let client = Client::new();
+    let res = client
+        .post(URL)
+        .header(CONTENT_TYPE, "application/json")
+        .body(json)
+        .send();
+
+    println!("Response: {:#?}", res);
 }
 
 #[cfg(test)]