userapi: add email validation with Mailgun

Author: usrbinsam

CodeChallenge/api/users.py

@@ -14,7 +14,7 @@
  reset_password_from_token)
 from ..limiter import limiter
 from ..mail import mail
-from ..mailgun import mg_list_add
+from ..mailgun import mg_list_add, mg_validate
 from ..models import db
 
 bp = Blueprint("userapi", __name__, url_prefix="/api/v1/users")
@@ -264,3 +264,15 @@ def username_exists(username):
  return jsonify(status="success",
  exists=exists,
  username=username)
+
+
+@bp.route("/validate", methods=["POST"])
+def email_validation():
+
+ if "email" not in request.json:
+ return jsonify(status="error", reason="missing 'email' field"), 400
+
+ mg_res = mg_validate(request.json["email"])
+
+ return mg_res.json(), mg_res.status_code
+

CodeChallenge/mailgun.py

@@ -29,3 +29,13 @@ def mg_list_add(email_address, name, data=None):
  r.raise_for_status()
  return r
 
+
+def mg_validate(email_address):
+ r = requests.get(
+ "https://api.mailgun.net/v4/address/validate",
+ auth=__auth(),
+ params={"address": email_address})
+
+ r.raise_for_status()
+
+ return r

tests/test_auth.py

@@ -1,8 +1,11 @@
+import os
+
+import pytest
+
 import CodeChallenge
 
 
 def register(client, email, username, password, firstname, lastname):
-
  return client.post("/api/v1/users/register", json=dict(
  username=username, parentEmail=email, password=password,
  parentFirstName=firstname, parentLastName=lastname, DOB="1994-04-13",
@@ -82,7 +85,6 @@ def test_logout(client):
 
 
 def test_forgot_password(client, app):
-
  with CodeChallenge.mail.record_messages() as outbox:
  retval = client.post("/api/v1/users/forgot", json=dict(
  email="sam@codewizardshq.com"
@@ -104,7 +106,6 @@ def test_forgot_password(client, app):
 
 
 def test_user_exists(client):
-
  rv = client.get("/api/v1/users/cwhqsam/exists")
  assert rv.status_code == 200
  assert rv.json["exists"] is True
@@ -114,3 +115,19 @@ def test_user_exists(client):
  assert rv2.status_code == 200
  assert rv2.json["username"] == "foobar"
  assert rv2.json["exists"] is False
+
+
+@pytest.mark.skipif(not os.getenv("VALIDATION_TEST_EMAIL"), reason="envvar VALIDATION_TEST_EMAIL not set")
+def test_validation(client):
+
+ rv = client.post("/api/v1/users/validate", json=dict(email=os.getenv("VALIDATION_TEST_EMAIL")))
+
+ assert rv.status_code >= 200
+
+ data = rv.json
+
+ assert "address" in data
+ assert "result" in data
+ assert "reason" in data
+ assert "risk" in data
+