Skip to content

Add view-decorator login_required() to refactor 401 cases #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add view-decorator login_required() to refactor 401 cases #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 53 additions & 69 deletions project/server/auth/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# project/server/auth/views.py


from flask import Blueprint, request, make_response, jsonify
from functools import wraps
from flask import g, Blueprint, request, make_response, jsonify
from flask.views import MethodView

from project.server import bcrypt, db
Expand All @@ -10,6 +10,32 @@
auth_blueprint = Blueprint('auth', __name__)


def login_required(f):
@wraps(f)
def decorated_function(*args, **kwargs):
# get the auth token
auth_header = request.headers.get('Authorization')
auth_token = auth_token = auth_header.split(" ")[1] if auth_header else ''
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplication :)
auth_token = auth_token ...

if auth_token:
resp = User.decode_auth_token(auth_token)
if not isinstance(resp, str):
g.auth_token = auth_token
g.user = User.query.filter_by(id=resp).first()
return f(*args, **kwargs)
response_object = {
'status': 'fail',
'message': resp
}
return make_response(jsonify(response_object)), 401
else:
response_object = {
'status': 'fail',
'message': 'Provide a valid auth token.'
}
return make_response(jsonify(response_object)), 401
return decorated_function


class RegisterAPI(MethodView):
"""
User Registration Resource
Expand Down Expand Up @@ -94,82 +120,40 @@ class UserAPI(MethodView):
User Resource
"""
def get(self):
# get the auth token
auth_header = request.headers.get('Authorization')
if auth_header:
auth_token = auth_header.split(" ")[1]
else:
auth_token = ''
if auth_token:
resp = User.decode_auth_token(auth_token)
if not isinstance(resp, str):
user = User.query.filter_by(id=resp).first()
responseObject = {
'status': 'success',
'data': {
'user_id': user.id,
'email': user.email,
'admin': user.admin,
'registered_on': user.registered_on
}
}
return make_response(jsonify(responseObject)), 200
responseObject = {
'status': 'fail',
'message': resp
responseObject = {
'status': 'success',
'data': {
'user_id': g.user.id,
'email': g.user.email,
'admin': g.user.admin,
'registered_on': g.user.registered_on
}
return make_response(jsonify(responseObject)), 401
else:
responseObject = {
'status': 'fail',
'message': 'Provide a valid auth token.'
}
return make_response(jsonify(responseObject)), 401
}
return make_response(jsonify(responseObject)), 200


class LogoutAPI(MethodView):
"""
Logout Resource
"""
def post(self):
# get auth token
auth_header = request.headers.get('Authorization')
if auth_header:
auth_token = auth_header.split(" ")[1]
else:
auth_token = ''
if auth_token:
resp = User.decode_auth_token(auth_token)
if not isinstance(resp, str):
# mark the token as blacklisted
blacklist_token = BlacklistToken(token=auth_token)
try:
# insert the token
db.session.add(blacklist_token)
db.session.commit()
responseObject = {
'status': 'success',
'message': 'Successfully logged out.'
}
return make_response(jsonify(responseObject)), 200
except Exception as e:
responseObject = {
'status': 'fail',
'message': e
}
return make_response(jsonify(responseObject)), 200
else:
responseObject = {
'status': 'fail',
'message': resp
}
return make_response(jsonify(responseObject)), 401
else:
# mark the token as blacklisted
blacklist_token = BlacklistToken(token=g.auth_token)
try:
# insert the token
db.session.add(blacklist_token)
db.session.commit()
responseObject = {
'status': 'success',
'message': 'Successfully logged out.'
}
return make_response(jsonify(responseObject)), 200
except Exception as e:
responseObject = {
'status': 'fail',
'message': 'Provide a valid auth token.'
'message': e
}
return make_response(jsonify(responseObject)), 403
return make_response(jsonify(responseObject)), 200

# define the API resources
registration_view = RegisterAPI.as_view('register_api')
Expand All @@ -190,11 +174,11 @@ def post(self):
)
auth_blueprint.add_url_rule(
'/auth/status',
view_func=user_view,
view_func=login_required(user_view),
methods=['GET']
)
auth_blueprint.add_url_rule(
'/auth/logout',
view_func=logout_view,
view_func=login_required(logout_view),
methods=['POST']
)