Skip to content

Commit

Permalink
feat: Consider CLI config parameters in HTTP request checks (#827)
Browse files Browse the repository at this point in the history 
* Consider CLI config parameters in HTTP request checks

- switch to derive-based parsing of CLI parameters
- bump up 'clap' to '3.0.0-beta.2' version
- make CLI config accessible globally

* Make Clippy happy
  • Loading branch information
@tyranron
tyranron authored Jan 10, 2021
1 parent 01ccf0d commit 88b751a
Show file tree
Hide file tree
Showing 5 changed files with 139 additions and 122 deletions.
78 changes: 55 additions & 23 deletions Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name = "check-if-email-exists-cli"
version = "0.8.18"
default-run = "check_if_email_exists"
edition = "2018"
description = "Check if an email address exists without sending any email."
authors = ["Amaury Martiny <[email protected]>"]
license = "AGPL-3.0"
publish = false

Expand All @@ -12,9 +14,10 @@ path = "src/main.rs"

[dependencies]
check-if-email-exists = { path = "./core" }
clap = { version = "2.33", features = ["yaml"] }
clap = "3.0.0-beta.2"
env_logger = "0.8"
hyper = { version = "0.13" }
hyper = "0.13"
once_cell = "1.5"
serde = "1.0"
serde_json = "1.0"
tokio = { version = "0.2", features = ["macros", "tcp", "dns", "io-util"] }
Expand Down
44 changes: 0 additions & 44 deletions src/cli.yml
View file

This file was deleted.

27 changes: 18 additions & 9 deletions src/http.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use std::{borrow::Cow, net::SocketAddr};

use check_if_email_exists::{check_email, CheckEmailInput};
use hyper::service::{make_service_fn, service_fn};
use hyper::{Body, Method, Request, Response, Server, StatusCode};
use serde::{Deserialize, Serialize};
use std::net::SocketAddr;

use crate::CONF;

/// JSON Request from POST /
#[derive(Debug, Deserialize, Serialize)]
Expand Down Expand Up @@ -59,11 +62,15 @@ async fn req_handler(req: Request<Body>) -> Result<Response<Body>, hyper::Error>

// Create EmailInput from body
let mut input = CheckEmailInput::new(body.to_emails);
input.from_email(body.from_email.unwrap_or_else(|| "[email protected]".into())).hello_name(body.hello_name.unwrap_or_else(|| "localhost".into()));

// Add proxy if both fields `proxy_host` and `proxy_port` are set.
if let (Some(proxy_host), Some(proxy_port)) = (body.proxy_host, body.proxy_port) {
input.proxy(proxy_host, proxy_port);
input
.from_email(body.from_email.unwrap_or_else(|| CONF.from_email.clone()))
.hello_name(body.hello_name.unwrap_or_else(|| CONF.hello_name.clone()))
.yahoo_use_api(CONF.yahoo_use_api);
if let Some(proxy_host) = body.proxy_host.map(Cow::Owned).or_else(|| CONF.proxy_host.as_ref().map(Cow::Borrowed)) {
input.proxy(
proxy_host.into_owned(),
body.proxy_port.unwrap_or(CONF.proxy_port),
);
}

let body = check_email(&input).await;
Expand Down Expand Up @@ -92,10 +99,12 @@ async fn req_handler(req: Request<Body>) -> Result<Response<Body>, hyper::Error>
}
}

pub async fn run(host: &str, port: u16) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
// This is our socket address
let addr = SocketAddr::new(host.parse()?, port);
pub async fn run<A: Into<SocketAddr>>(
addr: A,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
let service = make_service_fn(|_| async { Ok::<_, hyper::Error>(service_fn(req_handler)) });

let addr = addr.into();
let server = Server::bind(&addr).serve(service);

println!("Listening on http://{}", addr);
Expand Down
105 changes: 61 additions & 44 deletions src/main.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,47 +14,74 @@
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

extern crate clap;
extern crate env_logger;
extern crate hyper;
extern crate serde;
extern crate tokio;

mod http;

use std::net::IpAddr;

use check_if_email_exists::{check_email, CheckEmailInput};
use clap::{crate_version, value_t, App};
use std::env;
use clap::Clap;
use once_cell::sync::Lazy;

/// CLI options of this binary.
#[derive(Clap, Debug)]
#[clap(author, version, about)]
pub struct Cli {
/// The email to use in the `MAIL FROM:` SMTP command.
#[clap(long, env, default_value = "[email protected]")]
pub from_email: String,

/// The name to use in the `EHLO:` SMTP command.
#[clap(long, env, default_value = "localhost")]
pub hello_name: String,

/// Use the specified SOCKS5 proxy host to perform email verification.
#[clap(long, env)]
pub proxy_host: Option<String>,

/// Use the specified SOCKS5 proxy port to perform email verification.
/// Only used when `--proxy-host` flag is set.
#[clap(long, env, default_value = "1080")]
pub proxy_port: u16,

/// For Yahoo email addresses, use Yahoo's API instead of connecting
/// directly to their SMTP servers.
#[clap(long, env, default_value = "true", parse(try_from_str))]
pub yahoo_use_api: bool,

/// The email to check.
pub to_email: Option<String>,

/// Runs a HTTP server.
#[clap(long)]
pub http: bool,

/// Sets the host IP address on which the HTTP server should bind.
/// Only used when `--http` flag is on.
#[clap(long, env = "HOST", default_value = "127.0.0.1")]
pub http_host: IpAddr,

/// Sets the port on which the HTTP server should bind.
/// Only used when `--http` flag is on.
/// If not set, then it will use $PORT, or default to 3000.
#[clap(long, env = "PORT", default_value = "3000")]
pub http_port: u16,
}

/// Global config of this application.
pub(crate) static CONF: Lazy<Cli> = Lazy::new(Cli::parse);

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
env_logger::init();

// The YAML file is found relative to the current file, similar to how modules are found
let yaml = clap::load_yaml!("cli.yml");
let matches = App::from_yaml(yaml).version(crate_version!()).get_matches();

if let Some(to_email) = matches.value_of("TO_EMAIL") {
let from_email = matches
.value_of("FROM_EMAIL")
.expect("FROM_EMAIL has a default value. qed.");
let hello_name = matches
.value_of("HELLO_NAME")
.expect("HELLO_NAME has a default value. qed.");

let mut input = CheckEmailInput::new(vec![to_email.into()]);
if let Some(to_email) = &CONF.to_email {
let mut input = CheckEmailInput::new(vec![to_email.clone()]);
input
.from_email(from_email.into())
.hello_name(hello_name.into());

if let Some(proxy_host) = matches.value_of("PROXY_HOST") {
let proxy_port = value_t!(matches.value_of("PROXY_PORT"), u16)
.expect("PROXY_PORT has a default value of type u16. qed.");
input.proxy(proxy_host.into(), proxy_port);
}

if let Ok(yahoo_use_api) = value_t!(matches.value_of("YAHOO_USE_API"), bool) {
input.yahoo_use_api(yahoo_use_api);
.from_email(CONF.from_email.clone())
.hello_name(CONF.hello_name.clone())
.yahoo_use_api(CONF.yahoo_use_api);
if let Some(proxy_host) = &CONF.proxy_host {
input.proxy(proxy_host.clone(), CONF.proxy_port);
}

let result = check_email(&input).await;
Expand All @@ -70,18 +97,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
}

// Run the web server if flag is on
if matches.is_present("HTTP") {
let http_host = matches
.value_of("HTTP_HOST")
.expect("HTTP_HOST has a default value. qed.");
// http_port is, in this order:
// - the value of `--http-port` flag
// - if not set, then the $PORT env varialbe
// - if not set, then 3000
let env_port = env::var("PORT").unwrap_or_else(|_| "3000".into());
let http_port = matches.value_of("HTTP_PORT").unwrap_or(&env_port);

http::run(http_host, http_port.parse::<u16>().unwrap()).await?
if CONF.http {
http::run((CONF.http_host, CONF.http_port)).await?;
}

Ok(())
Expand Down

0 comments on commit 88b751a

Please sign in to comment.