questions API:

- /history returns all previous answers + questions
- /reset allows users to reset progress if ALLOW_RESET is set in config
- answers are now lowercased before checked for correctness

models:
- add 'question' relationship on Answer for convenience

tests:
- add tests for /history
- add tests for /reset
- test /hello after each question is answered

Author: usrbinsam

CodeChallenge/api/questions.py

@@ -89,7 +89,7 @@ def answer_next_question():
 
     data = request.get_json()
     text = data["text"]
-    correct = str_cmp(text, q.answer)
+    correct = str_cmp(text.lower(), q.answer.lower())
 
     ans = Answer.query.filter_by(user_id=user.id, question_id=q.id).first()
 
@@ -108,3 +108,46 @@ def answer_next_question():
     db.session.commit()
 
     return jsonify({"status": "success", "correct": correct})
+
+
+@bp.route("/history", methods=["GET"])
+@jwt_required
+def history():
+    """ Returns all past questions and answers for the currrent user"""
+
+    u = get_current_user()
+
+    qna = []
+    for ans in Answer.query.filter_by(user_id=u.id):  # type: Answer
+
+        qna.append(dict(
+            question=dict(
+                id=ans.question_id,
+                title=ans.question.title,
+                rank=ans.question.rank
+            ),
+            answered=ans.text,
+            correct=ans.correct
+        ))
+
+    return jsonify(qna)
+
+
+@bp.route("/reset", methods=["DELETE"])
+@jwt_required
+def reset_all():
+    """ Reset rank for the current user """
+    if current_app.config["ALLOW_RESET"]:
+
+        u = get_current_user()
+        u.rank = 0
+
+        for ans in Answer.query.filter_by(user_id= u.id):  # type: Answer
+            db.session.delete(ans)
+
+        db.session.commit()
+
+        return jsonify(status="success", message="all answers and rank reset")
+
+    return jsonify(status="error",
+                   message="resetting not allowed at this time"), 403

CodeChallenge/config.py

@@ -28,6 +28,8 @@ class DefaultConfig:
     MAIL_DEFAULT_SENDER = "CodeWizardsHQ <no-reply@codewizardshq.com>"
     MAIL_SUPPRESS_SEND = True
 
+    ALLOW_RESET = False
+
     @property
     def ROOT_DIR(self):
         return os.path.dirname(self.APP_DIR)
@@ -48,6 +50,7 @@ class ProductionConfig(DefaultConfig):
     MAIL_USERNAME = os.getenv("MAIL_USERNAME")
     MAIL_PASSWORD = os.getenv("MAIL_PASSWORD")
     JWT_ACCESS_TOKEN_EXPIRES = 604800
+    ALLOW_RESET = os.getenv("ALLOW_RESET")
 
 
 class DevelopmentConfig(ProductionConfig):
@@ -59,6 +62,7 @@ class DevelopmentConfig(ProductionConfig):
     JWT_SECRET_KEY = "SuperSecret"
     SECRET_KEY = "flaskSecretKey"
     JWT_COOKIE_CSRF_PROTECT = False
+    ALLOW_RESET = True
 
     @property
     def DIST_DIR(self):

CodeChallenge/models.py

@@ -33,3 +33,4 @@ class Answer(db.Model):
                         db.ForeignKey("users.id", ondelete="cascade"))
     text = db.Column(db.String(2000))
     correct = db.Column(db.Boolean)
+    question = db.relationship("Question", lazy=True, uselist=False)

tests/test_question.py

@@ -14,6 +14,7 @@ def client_challenge_today():
     app.config["TESTING"] = True
     app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
     app.config["CODE_CHALLENGE_START"] = time.time()
+    app.config["ALLOW_RESET"] = True
 
     with app.test_client() as client:
         with app.app_context():
@@ -142,6 +143,12 @@ def test_get_rank1(client_challenge_past):
     assert retval.get_json()["question"] == "What is 2+2?"
     assert retval.get_json()["rank"] == 1
 
+    retval = client_challenge_past.get("/api/v1/users/hello")
+    data = retval.get_json()
+
+    assert retval.status_code == 200
+    assert data["rank"] == 0
+
 
 def test_answer_rank1_correctly(client_challenge_past):
     retval = client_challenge_past.post("/api/v1/questions/answer", json=dict(
@@ -151,6 +158,22 @@ def test_answer_rank1_correctly(client_challenge_past):
     assert retval.status_code == 200
     assert retval.get_json()["correct"] is True
 
+    # check history
+    retval = client_challenge_past.get("/api/v1/questions/history")
+    history = retval.get_json()
+
+    assert len(history) == 1
+    assert "question" in history[0]
+    assert history[0]["answered"] == "4"
+    assert history[0]["correct"]
+
+    # check rank
+    retval = client_challenge_past.get("/api/v1/users/hello")
+    data = retval.get_json()
+
+    assert retval.status_code == 200
+    assert data["rank"] == 1
+
 
 def test_get_rank2(client_challenge_past):
     retval = client_challenge_past.get("/api/v1/questions/next")
@@ -168,6 +191,12 @@ def test_answer_rank2_incorrectly(client_challenge_past):
     assert retval.status_code == 200
     assert retval.get_json()["correct"] is False
 
+    retval = client_challenge_past.get("/api/v1/users/hello")
+    data = retval.get_json()
+
+    assert retval.status_code == 200
+    assert data["rank"] == 1
+
 
 def test_answer_rank2_correctly(client_challenge_past):
     retval = client_challenge_past.post("/api/v1/questions/answer", json=dict(
@@ -177,6 +206,12 @@ def test_answer_rank2_correctly(client_challenge_past):
     assert retval.status_code == 200
     assert retval.get_json()["correct"] is True
 
+    retval = client_challenge_past.get("/api/v1/users/hello")
+    data = retval.get_json()
+
+    assert retval.status_code == 200
+    assert data["rank"] == 2
+
 
 def test_get_rank3_404(client_challenge_past):
     retval = client_challenge_past.get("/api/v1/questions/next")
@@ -208,3 +243,16 @@ def test_answer_exceed_attempts(client_challenge_past):
         else:
             assert retval.status_code == 404
             assert "X-RateLimit-Remaining" in retval.headers
+
+
+def test_reset_all(client_challenge_past):
+
+    retval = client_challenge_past.delete("/api/v1/questions/reset")
+
+    assert retval.status_code == 200
+
+    retval = client_challenge_past.get("/api/v1/users/hello")
+    data = retval.get_json()
+
+    assert retval.status_code == 200
+    assert data["rank"] == 0