User Management backend - Base - DB support

Vagrantfile

@@ -1,4 +1,20 @@
+db_file_exists    = "test -f /vagrant/edison/db.sql"
+restore_db        = "sudo -u postgres psql edison < /vagrant/edison/db.sql"
+db_restored_msg   = "echo \"Database restored.\""
+db_not_exists_msg = "echo \"db.sql not exists.\""
+try_restore_db    = "bash -c '#{db_file_exists} && #{restore_db} && #{db_restored_msg} || #{db_not_exists_msg}'"
+save_db_data      = "sudo -u postgres pg_dump edison > /vagrant/edison/db.sql"
+
 Vagrant.configure("2") do |config|
+  config.trigger.before :destroy do |trigger|
+    trigger.info = "Saving database data inside synced folder..."
+    trigger.run_remote = {inline: "#{save_db_data}"}
+  end
+
+  config.trigger.after :up do |trigger|
+    trigger.info = "Trying to restore database from /vagrant/edison/db.sql..."
+    trigger.run_remote = {inline: "#{try_restore_db}"}
+  end
 
   config.vm.box = "ubuntu/bionic64"
   config.vm.provision :shell, path: "setup.sh"

edison/__init__.py

@@ -1,10 +1,12 @@
 import os
 
 from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
 from edison.config import get_config_object
 
 
 # Put app here so the entire app could import it.
 app = Flask(__name__)
 app.config.from_object(get_config_object(app.config["ENV"]))
 basedir = os.path.abspath(os.path.dirname(__file__))
+db = SQLAlchemy(app)

edison/app.py

@@ -4,6 +4,12 @@
 
 
 app = edison.app
+db = edison.db
+
+# Creates all tables defined in the database models and the only ones that are not created yet.
+# If there's any change in the database models you should perform a migration to apply this change in the database itself.
+# More about database migrations can be found in /edison/migrations/README.
+db.create_all()
 
 @app.route("/")
 def index():

edison/config.py

@@ -19,7 +19,11 @@ def get_config_object(env_keyword: str):
 class Config:
     ENV_KEYWORD = ""
     DEBUG = False
+    # Turns off the Flask-SQLAlchemy event system
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    SQLALCHEMY_DATABASE_URI = 'postgresql://postgres:[email protected]/edison'
 
+# PostgreSQL connection string should be updated once an actual production environment is established.
 class ProductionConfig(Config):
     ENV_KEYWORD = "production"
 

edison/models/__init__.py

@@ -0,0 +1,2 @@
+from .token import Token
+from .user import User

edison/models/token.py

@@ -0,0 +1,12 @@
+from edison import db
+
+
+class Token(db.Model):
+    __tablename__ = 'token_blacklist'
+
+    id = db.Column(db.Integer, primary_key=True)
+    jti = db.Column(db.String(150), nullable=False, unique=True)
+    creation_timestamp = db.Column(db.TIMESTAMP(timezone=False), nullable=False)
+
+    def __repr__(self):
+        return f"<Token: jti: {self.jti}, creation time: {self.creation_timestamp}>"

edison/models/user.py

@@ -0,0 +1,25 @@
+from edison import db
+
+
+class User(db.Model):
+    __tablename__ = 'users'
+    __table_args__ = {'extend_existing': True}
+
+    id = db.Column(db.Integer, primary_key=True)
+    username = db.Column(db.String(50), nullable=False, unique=True)
+    password = db.Column(db.String(150), nullable=False)
+    first_name = db.Column(db.String(50), nullable=False)
+    last_name = db.Column(db.String(50), nullable=False)
+    email = db.Column(db.String(150), nullable=False)
+
+    def to_json(self):
+        return {
+            "username": self.username,
+            "first_name": self.first_name,
+            "last_name": self.last_name,
+            "email": self.email
+        }
+
+    def __repr__(self):
+        return f"<User: id = {self.id}, first_name = {self.first_name}, " \
+               f"last_name = {self.last_name}, username = {self.username}, email = {self.email}>"

requirements.txt

@@ -1 +1,3 @@
 Flask==1.1.1
+flask-sqlalchemy==2.4.1
+psycopg2-binary==2.8.5

setup.sh

@@ -17,6 +17,10 @@ sudo apt-get install -y postgresql postgresql-contrib
 echo "install requirements"
 pip3 install -r /vagrant/requirements.txt
 
+echo "configuring database"
+sudo -u postgres createdb edison
+sudo -u postgres psql -c "ALTER ROLE postgres WITH PASSWORD 'edison';"
+
 export FLASK_ENV=development
 
 echo "running app.py"