QRouland/M2OLA
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

TG-59 : Ajout de l'API UserAPI + passage du role en VARCHAR

Browse Source
This commit is contained in:
Clément ARNAUDEAU 2017-03-14 10:14:11 +01:00
parent c7ac46ee5a
commit b6ca3dbdc8
6 changed files with 106 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
API_Interfaces.txt
View File

@ -18,10 +18,40 @@ UserInfoAPI (api/userInfo)
#######################
GET -> Get the current logged user, return None if no one is connected
Out:
200 -> USER = <USER_OBJECT>|None : Dictionary containing user infos or None
200 -> USER = <USER_OBJECT>|null : Dictionary containing user infos or null
########################
Redirect to cas auth (/login)
########################
Redirect to cas auth
########################
UserAPI (api/user)
########################
POST -> Create a user if it not already exists
In:
CASid = Login of the user caught from the CAS authentication
role = Role of the user (can be concatenated with -) 1=secrétaire, 2=resp_formation, 3=tuteur_univ, 4=étudiant
Out:
200 -> UID = <USER_ID> : The user already exists with the id USER_ID
201 -> UID = <USER_ID> : The user has been successfully created with the id USER_ID
400 -> ERROR = "One or more parameters are missing" : Bad request
PUT -> Modify an existing user
In: (Suffix = /byuid/<USER_ID>)
CASid = Login of the user caught from the CAS authentication
role = Role of the user (can be concatenated with -) 1=secrétaire, 2=resp_formation, 3=tuteur_univ, 4=étudiant
phone = Phone number of the user (00.00.00.00.00)
email = Email of the user
Out:
200 -> UID = <USER_ID> : The user has been modified sucessfully with the id USER_ID
400 -> ERROR = "One or more parameters are missing !" : Bad request
405 -> ERROR = "This user doesn't exists !" : Bad USER_ID provided
GET -> Getting specified user infos
In: (Suffixes = /byuid/<USER_ID> | /bylogin/<USER_LOGIN> | /byemail/<USER_EMAIL>)
Out:
200 -> USER = <USER_OBJECT>|null : Dictionary containing user infos or null

10
backend/OLA.mysql
View File

@ -37,11 +37,11 @@ CREATE TABLE IF NOT EXISTS `GROUP`
CREATE TABLE IF NOT EXISTS `USER`
(
id BIGINT NOT NULL AUTO_INCREMENT,
`login` VARCHAR(128) NOT NULL,
`role` INT NOT NULL,
email VARCHAR(256) NOT NULL,
phone VARCHAR(15),
id BIGINT NOT NULL AUTO_INCREMENT,
`login` VARCHAR(128) NOT NULL,
`role` VARCHAR(10) NOT NULL,
email VARCHAR(256) NOT NULL,
phone VARCHAR(15),
PRIMARY KEY(id)
) ENGINE = INNODB;

55
backend/app/api/UserAPI.py Normal file
View File

@ -0,0 +1,55 @@
from flask_restful import Resource, request
from app.model import *
from app.utils import checkParams
class UserAPI(Resource):
"""
User Api Resource
"""
def post(self):
args = request.get_json(cache=False, force=True)
if not checkParams(['CASid', 'role'], args):
return {"ERROR": "One or more parameters are missing !"}, 400
CASid = args['CASid']
role = args['role']
email = self.getEmailFromCAS(CASid)
phone = None
user = getUser(login=CASid)
if user is not None:
return {"UID": user["id"]}, 200
query = USER.insert().values(login=CASid, email=email, role=role, phone=phone)
res = query.execute()
return {"UID": res.lastrowid}, 201
def put(self, uid):
args = request.get_json(cache=False, force=True)
if not checkParams(['CASid', 'role', 'email', 'phone'], args):
return {"ERROR": "One or more parameters are missing !"}, 400
if getUser(uid=uid) is None:
return {"ERROR": "This user doesn't exists !"}, 405
CASid = args['CASid']
role = args['role']
email = args['email']
phone = args['phone']
query = USER.update().values(login=CASid, email=email, role=role, phone=phone).where(USER.c.id == uid)
query.execute()
return {"UID": uid}, 200
def get(self, uid=0, login="", email=""):
if uid > 0:
return {'USER': getUser(uid=uid)}, 200
elif login != "":
return {'USER': getUser(login=login)}, 200
elif email != "":
return {'USER': getUser(email=email)}, 200
@staticmethod
def getEmailFromCAS(CASid):
return ""

8
backend/app/model.py
View File

@ -20,14 +20,14 @@ period_class = Base.classes.PERIOD
livret_class = Base.classes.LIVRET
def getUser(id=0, login="", email=""):
def getUser(uid=0, login="", email=""):
res = None
if id == 0 and login == "" and email == "":
if uid == 0 and login == "" and email == "":
raise Exception("getUser must be called with one argument !")
else:
if id != 0:
res = db.session.query(user_class).get(id)
if uid != 0:
res = db.session.query(user_class).get(uid)
elif login != "":
query = USER.select(USER.c.login == login)

4
backend/app/urls.py
View File

@ -1,3 +1,4 @@
from app.api.UserAPI import UserAPI
from app.api.UserInfoAPI import UserInfoAPI
from app.api.exampleapi import SomeApi
from app.api.loginAPI import LoginAPI
@ -6,3 +7,6 @@ from app.core import api
# Some Api resource
api.add_resource(SomeApi, '/api/someapi', '/api/someapi/<int:id>')
api.add_resource(LoginAPI, '/api/login')
api.add_resource(UserAPI, '/api/user', '/api/user/byuid/<int:uid>', '/api/user/bylogin/<string:login>',
'/api/user/byemail/<string:email>')
api.add_resource(UserInfoAPI, '/api/userInfo')

8
backend/app/utils.py
View File

@ -37,7 +37,8 @@ def new_alchemy_encoder(revisit_self=False, fields_to_expand=[]):
# is this field another SQLalchemy object, or a list of SQLalchemy objects?
if isinstance(val.__class__, DeclarativeMeta) or (
isinstance(val, list) and len(val) > 0 and isinstance(val[0].__class__, DeclarativeMeta)):
isinstance(val, list) and len(val) > 0 and isinstance(val[0].__class__,
DeclarativeMeta)):
# unless we're expanding this field, stop here
if field not in fields_to_expand:
# not expanding this field: set it to None and continue
@ -51,3 +52,8 @@ def new_alchemy_encoder(revisit_self=False, fields_to_expand=[]):
return json.JSONEncoder.default(self, obj)
return AlchemyEncoder
def checkParams(wanted, args):
inter = [elt for elt in wanted if elt in args]
return len(inter) == len(wanted)