Add email as an option to be asked on sign up

docs/options.rst

@@ -48,3 +48,14 @@ open signup, where all users that do sign up can already log in the system. To d
 .. code-block:: python
 
     c.Authenticator.open_signup = True
+
+
+Ask for extra information on SignUp
+-----------------------------------
+
+Native Authenticator is based on username and password only. But if you need extra information about the users, you can add them on the sign up. For now, you can ask for email by adding the following line:
+
+
+.. code-block:: python
+
+    c.Authenticator.ask_email_on_signup = True

nativeauthenticator/handlers.py

@@ -30,7 +30,10 @@ class SignUpHandler(LocalBase):
     """Render the sign in page."""
     async def get(self):
         self._register_template_path()
-        html = self.render_template('signup.html')
+        html = self.render_template(
+            'signup.html',
+            ask_email=self.authenticator.ask_email_on_signup,
+        )
         self.finish(html)
 
     def get_result_message(self, user):
@@ -57,6 +60,7 @@ async def post(self):
 
         html = self.render_template(
             'signup.html',
+            ask_email=self.authenticator.ask_email_on_signup,
             result_message=message,
             alert=alert
         )
@@ -68,8 +72,11 @@ class AuthorizationHandler(LocalBase):
     @admin_only
     async def get(self):
         self._register_template_path()
-        html = self.render_template('autorization-area.html',
-                                    users=self.db.query(UserInfo).all())
+        html = self.render_template(
+            'autorization-area.html',
+            ask_email=self.authenticator.ask_email_on_signup,
+            users=self.db.query(UserInfo).all(),
+        )
         self.finish(html)
 
 

nativeauthenticator/nativeauthenticator.py

@@ -45,6 +45,11 @@ class NativeAuthenticator(Authenticator):
         help=("Allows every user that made sign up to automatically log in "
               "the system without needing admin authorization")
     )
+    ask_email_on_signup = Bool(
+        config=True,
+        default=False,
+        help="Asks for email on signup"
+    )
 
     def __init__(self, add_new_table=True, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -128,7 +133,7 @@ def is_password_strong(self, password):
 
         return all(checks)
 
-    def get_or_create_user(self, username, pw):
+    def get_or_create_user(self, username, pw, **kwargs):
         user = UserInfo.find(self.db, username)
         if user:
             return user
@@ -138,6 +143,7 @@ def get_or_create_user(self, username, pw):
 
         encoded_pw = bcrypt.hashpw(pw.encode(), bcrypt.gensalt())
         infos = {'username': username, 'password': encoded_pw}
+        infos.update(kwargs)
         if username in self.admin_users or self.open_signup:
             infos.update({'is_authorized': True})
 

nativeauthenticator/orm.py

@@ -1,9 +1,9 @@
 import bcrypt
+import re
 from jupyterhub.orm import Base
 
-from sqlalchemy import (
-    Boolean, Column, Integer, String
-)
+from sqlalchemy import Boolean, Column, Integer, String
+from sqlalchemy.orm import validates
 
 
 class UserInfo(Base):
@@ -12,6 +12,7 @@ class UserInfo(Base):
     username = Column(String, nullable=False)
     password = Column(String, nullable=False)
     is_authorized = Column(Boolean, default=False)
+    email = Column(String)
 
     @classmethod
     def find(cls, db, username):
@@ -31,3 +32,9 @@ def change_authorization(cls, db, username):
         user.is_authorized = not user.is_authorized
         db.commit()
         return user
+
+    @validates('email')
+    def validate_email(self, key, address):
+        assert re.match(r"^[A-Za-z0-9\.\+_-]+@[A-Za-z0-9\._-]+\.[a-zA-Z]*$",
+                        address)
+        return address

nativeauthenticator/templates/autorization-area.html

@@ -10,6 +10,9 @@ <h1>Authorization Area</h1>
       <thead>
         <tr>
           <th>Username</th>
+          {% if ask_email %}
+            <th>Email</th>
+          {% endif %}
           <th>Is Authorized?</th>
         </tr>
       </thead>
@@ -18,6 +21,9 @@ <h1>Authorization Area</h1>
         {% if user.is_authorized %}
         <tr class="success">
           <td>{{ user.username }}</td>
+          {% if ask_email %}
+            <td>{{ user.email }}</td>
+          {% endif %}
           <td>Yes</td>
           <td>
             <a class="btn btn-default" 
@@ -27,6 +33,9 @@ <h1>Authorization Area</h1>
         {% else %}
         <tr>
           <td>{{ user.username }}</td>
+          {% if ask_email %}
+            <td>{{ user.email }}</td>
+          {% endif %}
           <td>No</td>
           <td>
             <a class="btn btn-jupyter" 

nativeauthenticator/templates/signup.html

@@ -31,7 +31,19 @@ <h2>
           name="username"
           id="username_input"
           tabindex="2"
+          required
           />
+          {% if ask_email %}
+            <label>Email:</label>
+            <input
+            type=""
+            class="form-control"
+            name="email"
+            id="email_input"
+            tabindex="2"
+            required
+            />
+          {% endif %}
           <label for='password_input'>Password:</label>
           <div class="input-group">
             <input
@@ -40,6 +52,7 @@ <h2>
             name="password"
             id="pwd"
             tabindex="2"
+            required
             />
             <span class="input-group-addon">
               <button style="border:0;" type="button" id="eye">

nativeauthenticator/tests/test_orm.py

@@ -0,0 +1,28 @@
+import pytest
+from jupyterhub.tests.mocking import MockHub
+
+from ..orm import UserInfo
+
+
+@pytest.fixture
+def tmpcwd(tmpdir):
+    tmpdir.chdir()
+
+
+@pytest.fixture
+def app():
+    hub = MockHub()
+    hub.init_db()
+    return hub
+
+
+@pytest.mark.parametrize('email', ['john', 'john@john'])
+def test_validate_method_wrong_email(email, tmpdir, app):
+    with pytest.raises(AssertionError):
+        UserInfo(username='john', password='pwd', email=email)
+
+
+def test_validate_method_correct_email(tmpdir, app):
+    user = UserInfo(username='john', password='pwd', email='john@john.com')
+    app.db.add(user)
+    assert UserInfo.find(app.db, 'john')