response structure fix, name->username bug fix

Author: ksh7

api/models.py

@@ -13,13 +13,13 @@
 
 class Users(db.Model):
     id = db.Column(db.Integer(), primary_key=True)
-    name = db.Column(db.String(32), nullable=False)
+    username = db.Column(db.String(32), nullable=False)
     email = db.Column(db.String(64), nullable=False)
     password = db.Column(db.Text())
     date_joined = db.Column(db.DateTime(), default=datetime.utcnow)
 
     def __repr__(self):
-        return f"User {self.name}"
+        return f"User {self.username}"
 
     def save(self):
         db.session.add(self)
@@ -31,8 +31,8 @@ def set_password(self, password):
     def check_password(self, password):
         return check_password_hash(self.password, password)
 
-    def update_name(self, new_name):
-        self.name = new_name
+    def update_username(self, new_username):
+        self.username = new_username
 
     def update_email(self, new_email):
         self.email = new_email

api/routes.py

@@ -30,7 +30,7 @@ def check_if_token_revoked(jwt_header, jwt_payload):
     Flask-Restx models for api request and response data
 """
 
-signup_model = rest_api.model('SignUpModel', {"name": fields.String(required=True, min_length=2, max_length=32),
+signup_model = rest_api.model('SignUpModel', {"username": fields.String(required=True, min_length=2, max_length=32),
                                               "email": fields.String(required=True, min_length=4, max_length=64),
                                               "password": fields.String(required=True, min_length=4, max_length=16)
                                               })
@@ -39,7 +39,7 @@ def check_if_token_revoked(jwt_header, jwt_payload):
                                             "password": fields.String(required=True, min_length=4, max_length=16)
                                             })
 
-user_edit_model = rest_api.model('UserEditModel', {"name": fields.String(required=True, min_length=2, max_length=32),
+user_edit_model = rest_api.model('UserEditModel', {"username": fields.String(required=True, min_length=2, max_length=32),
                                                    "password": fields.String(required=True, min_length=4, max_length=16)
                                                    })
 
@@ -59,20 +59,22 @@ def post(self):
 
         req_data = request.get_json()
 
-        _name = req_data.get("name")
+        _username = req_data.get("username")
         _email = req_data.get("email")
         _password = req_data.get("password")
 
         user_exists = Users.get_by_email(_email)
         if user_exists:
-            abort(400, "Sorry. This email already exists.")
+            return {"success": False,
+                    "msg": "Sorry. This email already exists."}, 400
 
-        new_user = Users(name=_name, email=_email)
+        new_user = Users(username=_username, email=_email)
 
         new_user.set_password(_password)
         new_user.save()
 
-        return {'message': 'User with (%s, %s) created successfully!' % (_name, _email)}, 201
+        return {"success": True,
+                "msg": "User with (%s, %s) created successfully!" % (_username, _email)}, 201
 
 
 @rest_api.route('/api/users/login')
@@ -92,10 +94,12 @@ def post(self):
         user_exists = Users.get_by_email(_email)
 
         if not user_exists:
-            abort(400, "Sorry. This email does not exist.")
+            return {"success": False,
+                    "msg": "Sorry. This email does not exist."}, 400
 
         if not user_exists.check_password(_password):
-            abort(400, "Sorry. Wrong credentials.")
+            return {"success": False,
+                    "msg": "Sorry. Wrong credentials."}, 400
 
         # create access token uwing JWT
         access_token = create_access_token(identity=_email)
@@ -106,7 +110,7 @@ def post(self):
 @rest_api.route('/api/users/edit')
 class EditUser(Resource):
     """
-       Edits User's name or password or both using 'user_edit_model' input
+       Edits User's username or password or both using 'user_edit_model' input
     """
 
     @rest_api.expect(user_edit_model)
@@ -117,28 +121,30 @@ def post(self):
         current_user = Users.get_by_email(user_email)
 
         if not current_user:
-            abort(400, "Sorry. Wrong auth token. This user does not exist.")
+            return {"success": False,
+                    "msg": "Sorry. Wrong auth token. This user does not exist."}, 400
 
         req_data = request.get_json()
 
-        _new_name = req_data.get("name")
+        _new_username = req_data.get("username")
         _new_password = req_data.get("password")
 
-        if _new_name:
-            current_user.update_name(_new_name)
+        if _new_username:
+            current_user.update_username(_new_username)
 
         if _new_password:
             current_user.set_password(_new_password)
 
         current_user.save()
 
-        return {"message": 'User details updated successfully!'}, 200
+        return {"success": True,
+                "msg": "User details updated successfully!"}, 200
 
 
 @rest_api.route('/api/users/logout')
 class LogoutUser(Resource):
     """
-       Edits User's name or password or both using 'user_edit_model' input
+       Edits User's username or password or both using 'user_edit_model' input
     """
 
     @rest_api.expect(user_edit_model)
@@ -149,9 +155,11 @@ def delete(self):
         current_user = Users.get_by_email(user_email)
 
         if not current_user:
-            abort(400, "Sorry. Wrong auth token")
+            return {"success": False,
+                    "msg": "Sorry. Wrong auth token"}, 400
 
         jwt_block = JWTTokenBlocklist(jti=get_jwt()["jti"], created_at=datetime.now(timezone.utc))
         jwt_block.save()
 
-        return {"message": "JWT Token revoked successfully!"}, 200
+        return {"success": True,
+                "msg": "JWT Token revoked successfully!"}, 200

tests.py

@@ -14,7 +14,7 @@
    Sample test data
 """
 
-DUMMY_NAME = "apple"
+DUMMY_USERNAME = "apple"
 DUMMY_EMAIL = "[email protected]"
 DUMMY_PASS = "newpassword"
 
@@ -30,10 +30,10 @@ def test_user_signup(client):
        Tests /users/signup API
     """
     response = client.post(
-        "/users/signup",
+        "api/users/signup",
         data=json.dumps(
             {
-                "name": DUMMY_NAME,
+                "username": DUMMY_USERNAME,
                 "email": DUMMY_EMAIL,
                 "password": DUMMY_PASS
             }
@@ -42,18 +42,18 @@ def test_user_signup(client):
 
     data = json.loads(response.data.decode())
     assert response.status_code == 201
-    assert "User with (%s, %s) created successfully!" % (DUMMY_NAME, DUMMY_EMAIL) in data["message"]
+    assert "User with (%s, %s) created successfully!" % (DUMMY_USERNAME, DUMMY_EMAIL) in data["msg"]
 
 
 def test_user_signup_invalid_data(client):
     """
        Tests /users/signup API: invalid data like email field empty
     """
     response = client.post(
-        "/users/signup",
+        "api/users/signup",
         data=json.dumps(
             {
-                "name": DUMMY_NAME,
+                "username": DUMMY_USERNAME,
                 "email": "",
                 "password": DUMMY_PASS
             }
@@ -62,15 +62,15 @@ def test_user_signup_invalid_data(client):
 
     data = json.loads(response.data.decode())
     assert response.status_code == 400
-    assert "Input payload validation failed" in data["message"]
+    assert "'' is too short" in data["msg"]
 
 
 def test_user_login_correct(client):
     """
        Tests /users/signup API: Correct credentials
     """
     response = client.post(
-        "/users/login",
+        "api/users/login",
         data=json.dumps(
             {
                 "email": DUMMY_EMAIL,
@@ -89,7 +89,7 @@ def test_user_login_error(client):
        Tests /users/signup API: Wrong credentials
     """
     response = client.post(
-        "/users/login",
+        "api/users/login",
         data=json.dumps(
             {
                 "email": DUMMY_EMAIL,
@@ -100,4 +100,4 @@ def test_user_login_error(client):
 
     data = json.loads(response.data.decode())
     assert response.status_code == 400
-    assert "Sorry. Wrong credentials." in data["message"]
+    assert "Sorry. Wrong credentials." in data["msg"]