feat: ✨ password change endpoint

apis/authentication.py

@@ -388,6 +388,74 @@ def post(self):
         return resp
 
 
+@api.route("/auth/password/change")
+class UserPasswordEndpoint(Resource):
+    """
+    Endpoint for updating user password
+    """
+
+    @api.doc(description="Updates User password")
+    @api.response(200, "Success")
+    @api.response(400, "Validation Error")
+    def post(self):
+        """Updates user password"""
+
+        def validate_current_password(instance):
+            received_password = instance
+
+            if not g.user.check_password(received_password):
+                raise ValidationError("Current password is incorrect")
+
+            return True
+
+        def confirm_new_password(instance):
+            data: Union[Any, dict] = request.json
+            new_password = data["new_password"]
+            confirm_password = instance
+
+            if new_password != confirm_password:
+                raise ValidationError("New password and confirm password do not match")
+
+            return True
+
+        # Schema validation
+        schema = {
+            "type": "object",
+            "required": ["old_password", "new_password", "confirm_password"],
+            "additionalProperties": False,
+            "properties": {
+                "old_password": {
+                    "type": "string",
+                    "minLength": 1,
+                    "format": "current password",
+                },
+                "new_password": {"type": "string", "minLength": 1},
+                "confirm_password": {
+                    "type": "string",
+                    "minLength": 1,
+                    "format": "password confirmation",
+                },
+            },
+        }
+
+        format_checker = FormatChecker()
+        format_checker.checks("current password")(validate_current_password)
+        format_checker.checks("password confirmation")(confirm_new_password)
+
+        try:
+            validate(
+                instance=request.json, schema=schema, format_checker=format_checker
+            )
+        except ValidationError as e:
+            return e.message, 400
+
+        data: Union[Any, dict] = request.json
+        user = model.User.query.get(g.user.id)
+        user.set_password(data["new_password"])
+        model.db.session.commit()
+        return "Password updated successfully", 200
+
+
 # @api.route("/auth/current-users")
 # class CurrentUsers(Resource):
 #     """function is used to see all logged users in

tests/functional/test_user.py

@@ -0,0 +1,58 @@
+"""Tests for user settings"""
+
+
+# ------------------- Password Change ------------------- #
+def test_post_password_change(clients):
+    """
+    Given a Flask application configured for testing
+    WHEN the '/auth/password/change' endpoint is requested (PUT)
+    THEN check that the response is valid and the password is changed
+    """
+    _logged_in_client = clients[0]
+
+    response = _logged_in_client.post(
+        "/auth/password/change",
+        json={
+            "confirm_password": "Updatedpassword4testing!",
+            "new_password": "Updatedpassword4testing!",
+            "old_password": "Testingyeshello11!",
+        },
+    )
+
+    assert response.status_code == 200
+
+
+def test_post_password_login_invalid_old_password(clients):
+    """
+    Given a Flask application configured for testing
+    WHEN the '/auth/login' endpoint is requested (POST)
+    THEN check that the response is an error when old password is provided
+    """
+    _logged_in_client = clients[0]
+    response = _logged_in_client.post(
+        "/auth/login",
+        json={
+            "email_address": "[email protected]",
+            "password": "Testingyeshello11!",
+        },
+    )
+
+    assert response.status_code == 401
+
+
+def test_post_login_new_password(clients):
+    """
+    Given a Flask application configured for testing
+    WHEN the '/auth/login' endpoint is requested (POST)
+    THEN check that the response is valid when new password is provided
+    """
+    _logged_in_client = clients[0]
+    response = _logged_in_client.post(
+        "/auth/login",
+        json={
+            "email_address": "[email protected]",
+            "password": "Updatedpassword4testing!",
+        },
+    )
+
+    assert response.status_code == 200