Added openid, implemented 'login' and 'logout',and db migrationns

juliuskrah · juliuskrah · commit 7197d9f9ed29 · 2016-08-07T22:52:28.000Z
diff --git a/.gitignore b/.gitignore
@@ -89,3 +89,6 @@ ENV/
 .ropeproject
 
 .idea/
+app.db
+db_repository/
+tmp/
diff --git a/README.md b/README.md
@@ -1,3 +1,22 @@
-[![Build Status](https://travis-ci.org/juliuskrah/flask-blog.svg?branch=master)](https://travis-ci.org/juliuskrah/flask-blog)
 # Flask Blog
+
+[![Build Status](https://travis-ci.org/juliuskrah/flask-blog.svg?branch=master)](https://travis-ci.org/juliuskrah/flask-blog)
 This blog is built using the [Flask](http://flask.pocoo.org/ "Flask Framework") Python microframework.
+
+## Database migration
+```shell
+$ python db_create.py
+```
+Creates the database `app.db` and the repository folder structure `db_repository`
+```shell
+$ pyhton db_migrate.py
+```
+Migrates database changes and keeps track in `db_repository/versions`
+```shell
+$ python db_upgrade.py
+```
+This upgrades your database to the current revision
+```shell
+$ python db_downgrade.py
+```
+This downgrades your database to the previous version. This is uncommon in most scenarios
diff --git a/app/__init__.py b/app/__init__.py
@@ -1,9 +1,18 @@
+import os
 from flask import Flask
-
+from flask_login import LoginManager
+from flask_openid import OpenID
+from flask_sqlalchemy import SQLAlchemy
+from config import basedir
 
 app = Flask(__name__)
 app.config.from_object('config')
+db = SQLAlchemy(app)
+lm = LoginManager()
+lm.init_app(app)
+lm.login_view = 'login'
+oid = OpenID(app, os.path.join(basedir, 'tmp'))
 
-
-from app import views  # avoids circular import errors when put at the end 'cos the `views` also import `app`
+""" avoids circular import errors when put at the end 'cos the `views` also import `app` """
+from app import views, models
 
diff --git a/app/models.py b/app/models.py
@@ -0,0 +1,39 @@
+from app import db
+
+
+class User(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    nickname = db.Column(db.String(64), index=True, unique=True)
+    email = db.Column(db.String(120), index=True, unique=True)
+
+    @property
+    def is_authenticated(self):
+        return True
+
+    @property
+    def is_active(self):
+        return True
+
+    @property
+    def is_anonymous(self):
+        return False
+
+    def get_id(self):
+        try:
+            return unicode(self.id)  # python 2
+        except NameError:
+            return str(self.id)  # python 3
+
+    def __repr__(self):
+        return '<User %r>' % self.nickname
+
+
+class Post(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    body = db.Column(db.String(140))
+    timestamp = db.Column(db.DateTime)
+    user_id = db.Column(db.Integer, db.ForeignKey('user.id'))
+    author = db.relationship('User', backref=db.backref('posts', lazy='dynamic'))
+
+    def __repr__(self):
+        return '<Post %r>' % self.body
diff --git a/app/templates/base.html b/app/templates/base.html
@@ -9,7 +9,13 @@
     {% endif %}
 </head>
 <body>
-    <div>J's blog: <a href="/index">Home</a> <a href="/login">Login</a></div>
+    <div>J's blog:
+        <a href="{{ url_for('index') }}">Home</a>
+        {% if g.user.is_authenticated %}
+        | <a href="{{ url_for('logout') }}">Logout</a></div>
+        {% else %}
+        | <a href="{{ url_for('login') }}">Login</a></div>
+        {% endif %}
     <hr>
     {% with messages = get_flashed_messages() %}
         {% if messages %}
diff --git a/app/views.py b/app/views.py
@@ -1,12 +1,46 @@
-from app import app
-from flask import render_template, flash, redirect
+from app import app, db, lm, oid
+from flask import render_template, flash, redirect, g, url_for, session, request
+from flask_login import login_user, logout_user, current_user, login_required
 from .forms import LoginForm
+from .models import User
+
+
+@lm.user_loader
+def load_user(id):
+    return User.query.get(int(id))
+
+
+@app.before_request
+def before_request():
+    g.user = current_user
+
+
+@oid.after_login
+def after_login(resp):
+    if resp.email is None or resp.email == "":
+        flash('Invalid login. Please try again.')
+        return redirect(url_for('login'))
+    user = User.query.filter_by(email=resp.email).first()
+    if user is None:
+        nickname = resp.nickname
+        if nickname is None or nickname == "":
+            nickname = resp.email.split('@')[0]
+        user = User(nickname=nickname, email=resp.email)
+        db.session.add(user)
+        db.session.commit()
+    remember_me = False
+    if 'remember_me' in session:
+        remember_me = session['remember_me']
+        session.pop('remember_me', None)
+    login_user(user, remember=remember_me)
+    return redirect(request.args.get('next') or url_for('index'))
 
 
 @app.route('/')
 @app.route('/index')
+@login_required
 def index():
-    user = {'nickname': 'Julius'}  # username
+    user = g.user  # username
     posts = [
         {
             'author': {'nickname': 'John'},
@@ -24,15 +58,24 @@ def index():
 
 
 @app.route('/login', methods=['GET', 'POST'])
+@oid.loginhandler
 def login():
+    if g.user is not None and g.user.is_authenticated:
+        return redirect(url_for('index'))
+
     form = LoginForm()
 
     if form.validate_on_submit():
-        flash('Login requested for OpenID="%s", remember_me=%s' %
-              (form.openid.data, str(form.remember_me.data)))
-        return redirect('/index')
+        session['remember_me'] = form.remember_me.data
+        return oid.try_login(form.openid.data, ask_for=['nickname', 'email'])
 
     return render_template('login.html',
                            title='Sign In',
                            form=form,
                            providers=app.config['OPENID_PROVIDERS'])
+
+
+@app.route('/logout')
+def logout():
+    logout_user()
+    return redirect(url_for('index'))
diff --git a/config.py b/config.py
@@ -1,3 +1,11 @@
+import os
+
+basedir = os.path.abspath(os.path.dirname(__file__))
+
+SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'app.db')
+SQLALCHEMY_MIGRATE_REPO = os.path.join(basedir, 'db_repository')
+SQLALCHEMY_TRACK_MODIFICATIONS = True
+
 WTF_CSRF_ENABLED = True
 SECRET_KEY = '1qaz@WSX'
 
diff --git a/db_create.py b/db_create.py
@@ -0,0 +1,12 @@
+from migrate.versioning import api
+from config import SQLALCHEMY_DATABASE_URI
+from config import SQLALCHEMY_MIGRATE_REPO
+from app import db
+import os.path
+
+db.create_all()
+if not os.path.exists(SQLALCHEMY_MIGRATE_REPO):
+    api.create(SQLALCHEMY_MIGRATE_REPO, 'database repository')
+    api.version_control(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+else:
+    api.version_control(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO, api.version(SQLALCHEMY_MIGRATE_REPO))
diff --git a/db_downgrade.py b/db_downgrade.py
@@ -0,0 +1,8 @@
+from migrate.versioning import api
+from config import SQLALCHEMY_DATABASE_URI
+from config import SQLALCHEMY_MIGRATE_REPO
+
+v = api.db_version(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+api.downgrade(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO, v - 1)
+v = api.db_version(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+print('Current database version: ' + str(v))
diff --git a/db_migrate.py b/db_migrate.py
@@ -0,0 +1,18 @@
+import types
+from migrate.versioning import api
+from app import db
+from config import SQLALCHEMY_DATABASE_URI
+from config import SQLALCHEMY_MIGRATE_REPO
+
+v = api.db_version(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+migration = SQLALCHEMY_MIGRATE_REPO + ('/versions/%03d_migration.py' % (v+1))
+tmp_module = types.ModuleType('old_model')
+old_module = api.create_model(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+exec(old_module, tmp_module.__dict__)
+script = api.make_update_script_for_model(SQLALCHEMY_DATABASE_URI,
+                                          SQLALCHEMY_MIGRATE_REPO, tmp_module.meta, db.metadata)
+open(migration, "wt").write(script)
+api.upgrade(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+v = api.db_version(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+print('New migration saved as ' + migration)
+print('Current database version: ' + str(v))
diff --git a/db_upgrade.py b/db_upgrade.py
@@ -0,0 +1,7 @@
+from migrate.versioning import api
+from config import SQLALCHEMY_DATABASE_URI
+from config import SQLALCHEMY_MIGRATE_REPO
+
+api.upgrade(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+v = api.db_version(SQLALCHEMY_DATABASE_URI, SQLALCHEMY_MIGRATE_REPO)
+print('Current database version: ' + str(v))
