Auth and update Readme

Author: AlexandreDewilde

README.md

@@ -1,6 +1,7 @@
 # Simple-quiz-api
 Simple flask app wich run a server with an api implemented
 ## Features
+* JWT authentification 
 * Multiple choice question
 * Simple Choice Question
 ## Requirements
@@ -16,10 +17,10 @@ In the repository open bash and run:
 go in app folder and run in a cmd 
 ```python run.py```
 ## Usage
-### To show a question with the id provided 
+### To show a question with the id provided (Require no auth) 
 ```http://<your_url>/show-question/<id>``` 
 return json 
 ### To create a new question
-```http://<your_url>/create-question/``` and argument (POST method) question, answer, category, level (int between 1 and 3), it returns json 
+```$ curl -X POST http://localhost:5000/create-question/ -H "Authorization: JWT <your token> -d "question=<question>" -d "answer=<answer>" -d "level=<>" -d "category=<>"``` and argument (POST method) question, answer, category, level (int between 1 and 3), it returns json 
 ## In the next releases
 authentification, update question, exception ... 

app/__pycache__/run.cpython-37.pyc

@@ -28,15 +28,27 @@ def show_question(self, question_id):
 }
 
 def create_question(self):
+"""create a question and add it in the json file specified in config_mutiplechoice.txt"""
 parser = reqparse.RequestParser()
 parser.add_argument('question', type=str, help="the question", required=True)
 parser.add_argument('choice', action='append', help="choice for the question", required=True)
 parser.add_argument('answer', type=str, required=True, help="the answer")
+
 #category of the questions
 parser.add_argument('category', type=str)
-#int between 1 and 3 to define args
+
+#int between 1 and 3
 parser.add_argument('level', type=int, help="int between 1 and 3 to define level")
 args = parser.parse_args()
+
+#check if arg level is between 1 and 3
+try:
+if args['level'] != None: assert args['level'] < 3, "Level must be between 1 and 3"
+except AssertionError as error:
+return {
+"error" : str(error)
+}
+
 #converts args object to a dict 
 keys = ['question', 'choice', 'answer', 'category', 'level']
 dict_element = {}

app/api/MultipleChoiceQuestion.py

@@ -1,7 +1,8 @@
 from flask_restful import Resource
 from . Question import Question
 from . MultipleChoiceQuestion import MultipleChoiceQuestion
-
+from flask_jwt import JWT, jwt_required
+from . User import *
 
 class ShowQuestion(Resource):
 def get(self, question_id):
@@ -12,9 +13,11 @@ def get(self, question_id):
 return MultipleChoiceQuestion().show_question(question_id)
 
 class CreateQuestion(Resource):
+@jwt_required()
 def post(self):
 return Question().create_question()
 class CreateMultipleChoiceQuestion(Resource):
+@jwt_required()
 def post(self):
 return MultipleChoiceQuestion().create_question()
 

app/api/OperationQuestion.py

@@ -6,26 +6,26 @@
 class Question:
 
 def path_to_file_question(self):
-#find the path where is located the questions file
+"""find the path where is located the questions file"""
 with open('config.txt', 'r') as file:
 path_to_file = file.read()
 return path_to_file
 
 def read_question_file(self):
-#open and copy the questions file
+"""open and copy the questions file"""
 path_to_file = self.path_to_file_question()
 with open(path_to_file, 'r') as json_file:
 questions_json_file = json.load(json_file)
 return questions_json_file
 
 def write_questions_json_file(self, questions_json_file):
-#write question json file with the object provided
+"""write question json file with the list provided"""
 path_to_file = self.path_to_file_question()
 with open(path_to_file, 'w') as file_question:
 json.dump(questions_json_file, file_question)
 
 def show_question(self, question_id):
-#return the question according to the question_id provided
+"""return the question according to the question_id provided"""
 question_file = self.read_question_file()
 for dic_quest in question_file:
 if dic_quest['id'] == question_id:
@@ -43,28 +43,44 @@ def show_question(self, question_id):
 }
 
 def create_question(self):
+"""create a question and add it in the json file specified in config.txt"""
 parser = reqparse.RequestParser()
 parser.add_argument('question', type=str, help="the question", required=True)
 parser.add_argument('answer', type=str, required=True, help="the answer")
+
 #category of the questions
 parser.add_argument('category', type=str)
-#int between 1 and 3 to define args
+
+#int between 1 and 3
 parser.add_argument('level', type=int, help="int between 1 and 3 to define level")
 args = parser.parse_args()
-#converts args object to a dict 
+
+#check if arg level is between 1 and 3
+try:
+if args['level'] != None: assert args['level'] < 3, "Level must be between 1 and 3"
+except AssertionError as error:
+return {
+"error" : str(error)
+}
+
+#create dict_element with the args provided in POST and add random id
 keys = ['question', 'answer', 'category', 'level']
 dict_element = {}
 for key in keys:
 dict_element[key] = args[key]
 dict_element['id'] = int(uuid.uuid4())
+
+#rewrite file with the added question"
 questions_json_file = self.read_question_file()
 questions_json_file.append(dict_element)
 self.write_questions_json_file(questions_json_file)
+
 return {
 'status' : '200 question added'
 }
 
 def delete_question(self):
+"""Delete question with the id provided"""
 parser = reqparse.RequestParser()
 parser.add_argument('id', type=int, required=True)
 args = parser.parse_args()
@@ -79,5 +95,6 @@ def delete_question(self):
 }
 
 def update_question(self, dic_change):
+"""Update question, answer, ..."""
 pass
 

app/api/Question.py

@@ -0,0 +1,23 @@
+import json
+from flask_jwt import JWT, jwt_required
+import sys
+
+USER_DATA = {"admin": "admin"}
+
+class User:
+ def __init__(self, id):
+ self.id = id
+ 
+ def __str__(self):
+ return f"User(id={self.id})"
+
+def verify(username, password):
+ if not (username and password):
+ return False
+ if USER_DATA.get(username) == password:
+ return User(id=1)
+ 
+def identity(payload):
+ user_id = payload['identity']
+ return {"user_id": user_id}
+