Add resource for inviting property managers (#418)

Author: NickSchimek

config/routes.py

@@ -8,6 +8,7 @@
     Users,
 )
 from resources.user_invite import UserInvite
+from resources.user_invite import PropertyManagerInviteResource
 from resources.users.pending_users import UsersPending
 from resources.reset_password import ResetPassword
 from resources.property import Properties, Property, ArchiveProperties
@@ -25,12 +26,13 @@ class Routes:
     @staticmethod
     def routing(app):
         api = Api(app, prefix="/api/")
+        api.add_resource(UserInvite, "user/invite")
+        api.add_resource(PropertyManagerInviteResource, "user/invite/property_manager")
         api.add_resource(UserRegister, "register")
         api.add_resource(Property, "properties/<int:id>")
         api.add_resource(Properties, "properties")
         api.add_resource(ArchiveProperties, "properties/archive")
         api.add_resource(User, "user/<int:id>")
-        api.add_resource(UserInvite, "user/invite")
         api.add_resource(Users, "user")
         api.add_resource(UsersPending, "users/pending")
         api.add_resource(ArchiveUser, "user/archive/<int:user_id>")

models/users/property_manager.py

@@ -11,7 +11,6 @@ class PropertyManager(UserModel):
         "PropertyModel",
         secondary=PropertyAssignment.tablename(),
         collection_class=NobiruList,
-        viewonly=True,
     )
 
     def has_pm_privs(self):

resources/user_invite.py

@@ -1,11 +1,13 @@
+import string
+import random
 from flask_restful import Resource
 from flask import request
+
 from utils.authorizations import admin_required
 from models.user import UserModel
-from schemas import UserSchema
+from models.users.property_manager import PropertyManager
+from schemas import UserSchema, PropertyManagerSchema
 from resources.email import Email
-import string
-import random
 
 
 class UserInvite(Resource):
@@ -18,3 +20,13 @@ def post(self):
         )
         Email.send_user_invite_msg(user)
         return {"message": "User Invited"}, 201
+
+
+class PropertyManagerInviteResource(Resource):
+    @admin_required
+    def post(self):
+        property_manager = PropertyManager.create(
+            schema=PropertyManagerSchema, payload=request.json
+        )
+        Email.send_user_invite_msg(property_manager)
+        return {"message": "Property Manager Invited"}, 201

schemas/__init__.py

@@ -1,7 +1,7 @@
 from .tenant import TenantSchema
 from .property import PropertySchema
 from .lease import LeaseSchema
-from .property_assignment import PropertyAssignSchema
+from .property_assignment import PropertyAssignmentSchema
 from .user import *
 from .staff_tenants import StaffTenantSchema
 from .ticket import TicketSchema

schemas/property.py

@@ -1,7 +1,7 @@
 from ma import ma
 from models.property import PropertyModel
 from models.users.property_manager import PropertyManager
-from schemas.property_assignment import PropertyAssignSchema
+from schemas.property_assignment import PropertyAssignmentSchema
 from marshmallow import fields, validates, ValidationError, post_load
 from utils.time import time_format
 from tests.helpers.matchers import blank
@@ -20,7 +20,7 @@ def validates_property_manager_ids(self, value):
         payload = [
             {"manager_id": value[manager_id]} for manager_id in range(len(value))
         ]
-        PropertyAssignSchema().load(payload, partial=True, many=True)
+        PropertyAssignmentSchema().load(payload, partial=True, many=True)
 
     @validates("name")
     def validates_uniqueness_of_name(self, value):

schemas/property_assignment.py

@@ -1,24 +1,15 @@
 from ma import ma
+from marshmallow import validates, ValidationError
+
 from models.property_assignment import PropertyAssignment
-from models.user import UserModel
 from models.users.property_manager import PropertyManager
 from models.property import PropertyModel
-from marshmallow import fields, validates, ValidationError
 
 
-class PropertyAssignSchema(ma.SQLAlchemyAutoSchema):
+class PropertyAssignmentSchema(ma.SQLAlchemyAutoSchema):
     class Meta:
         model = PropertyAssignment
         include_fk = True
-        relations = True
-
-        propertyID = fields.Nested("PropertySchema")
-        managerID = fields.Nested("UserSchema", required=True)
-
-    @validates("manager_id")
-    def validate_is_valid_user(self, value):
-        if not UserModel.query.get(value):
-            raise ValidationError("not a valid user id")
 
     @validates("property_id")
     def validate_is_valid_property(self, value):

schemas/user.py

@@ -1,7 +1,9 @@
 from ma import ma
-from marshmallow import fields, validates, ValidationError
+from marshmallow import fields, validates, ValidationError, post_load
 
 from models.user import UserModel, RoleEnum
+from models.property import PropertyModel
+from schemas.property_assignment import PropertyAssignmentSchema
 
 
 class UserSchema(ma.SQLAlchemyAutoSchema):
@@ -37,3 +39,19 @@ def user_cannot_register_a_role(self, _):
     @validates("type")
     def user_cannot_register_a_type(self, _):
         raise ValidationError("Type is not allowed")
+
+
+class PropertyManagerSchema(UserSchema):
+    property_ids = fields.List(fields.Integer(), required=False)
+
+    @validates("property_ids")
+    def validate_property_ids(self, ids):
+        for id in ids:
+            PropertyAssignmentSchema().load({"property_id": id}, partial=True)
+
+    @post_load
+    def make_property_attributes(self, data, **kwargs):
+        if "property_ids" in data:
+            data["properties"] = [PropertyModel.find(id) for id in data["property_ids"]]
+            del data["property_ids"]
+        return data

tests/integration/test_user_invite.py

@@ -1,7 +1,10 @@
 import pytest
-from models.user import RoleEnum
 from unittest.mock import patch
+
+from models.user import RoleEnum
 from resources.email import Email
+from models.users.property_manager import PropertyManager
+from schemas.user import PropertyManagerSchema
 
 
 @pytest.mark.usefixtures("client_class")
@@ -20,3 +23,30 @@ def test_invite_user(self, send_user_invite_msg, valid_header, user_attributes):
         send_user_invite_msg.assert_called()
         assert response.status_code == 201
         assert response.json == {"message": "User Invited"}
+
+
+@pytest.mark.usefixtures("client_class")
+class TestPropertyManagerInvite:
+    def setup(self):
+        self.endpoint = "/api/user/invite/property_manager"
+
+    @patch.object(Email, "send_user_invite_msg")
+    def test_invite_property_manager(
+        self, send_user_invite_msg, user_attributes, valid_header
+    ):
+        payload = user_attributes()
+
+        with patch.object(PropertyManager, "create") as mock_create_pm:
+            response = self.client.post(
+                self.endpoint,
+                headers=valid_header,
+                json=payload,
+            )
+
+        send_user_invite_msg.assert_called()
+        mock_create_pm.assert_called_once_with(
+            schema=PropertyManagerSchema, payload=payload
+        )
+
+        assert response.status_code == 201
+        assert response.json == {"message": "Property Manager Invited"}

tests/schemas/test_property_assign_schema.py renamed to tests/schemas/test_property_assignment_schema.py

@@ -1,14 +1,14 @@
-from schemas.property_assignment import PropertyAssignSchema
+from schemas.property_assignment import PropertyAssignmentSchema
 
 
-class TestPropertyAssignSchemaValidation:
+class TestPropertyAssignmentSchemaValidation:
     def test_foreign_key_constraints(self):
-        validation = PropertyAssignSchema().validate(
+        validation = PropertyAssignmentSchema().validate(
             {"manager_id": 23, "property_id": 22}
         )
         assert "manager_id", "property_id" in validation
 
     def test_manager_id_is_property_manager_pk(self, create_join_staff):
         invalid_data = {"manager_id": create_join_staff().id, "property_id": 3}
-        validation_error = PropertyAssignSchema().validate(invalid_data)
+        validation_error = PropertyAssignmentSchema().validate(invalid_data)
         assert "manager_id", "property_id" in validation_error

tests/schemas/test_user_schema.py

@@ -1,4 +1,4 @@
-from schemas.user import UserSchema, UserRegisterSchema
+from schemas.user import UserSchema, UserRegisterSchema, PropertyManagerSchema
 from models.user import RoleEnum, UserType
 
 
@@ -86,3 +86,8 @@ def test_password_is_required(self):
         validation_errors = UserRegisterSchema().validate({})
 
         assert "password" in validation_errors
+
+
+class TestInheritedPropertyManagerSchemaValidations(UserSchemaValidations):
+    def setup(self):
+        self.schema = PropertyManagerSchema