Remove set_property_managers method (#181)

NickSchimek · web-flow · commit e358b30f8f43 · 2020-12-30T09:56:01.000+09:00
* Remove property init method

* Validate uniqueness of name in Property Schema

* Remove reqparser

* Remove set_managers method

* Use the create method for creating Property seeds

* Add nullable False to archive field
diff --git a/conftest.py b/conftest.py
@@ -9,8 +9,6 @@
 import jwt
 from tests.factory_fixtures import *
 
-newPropertyName = "myNewProperty"
-newPropertyAddress = "123 NE FLanders St"
 plaintext_password = "1234"
 
 # Note: this repo uses the "pytest-flask" plugin which exposes the following fixtures for use in tests:
@@ -93,19 +91,6 @@ def pm_header(create_property_manager):
         ).decode('utf-8')
     return {"Authorization": f"Bearer {token}"}
 
-@pytest.fixture
-def new_property():
-    newProperty = PropertyModel( name=newPropertyName
-                               , address=newPropertyAddress
-                               , city="Portland"
-                               , unit="101"
-                               , state="OR"
-                               , zipcode="97207"
-                               , propertyManagerIDs=[5]
-                               , archived=0
-                               )
-    return newProperty
-
 @pytest.fixture
 def test_database(app, admin_user, new_user, property_manager_user):
     db.create_all()
diff --git a/data/seedData.py b/data/seedData.py
@@ -11,6 +11,8 @@
 from models.contact_number import ContactNumberModel
 from models.lease import LeaseModel
 from utils.time import time_format
+from schemas import PropertySchema
+
 
 def seedData():
     now=datetime.utcnow()
@@ -114,33 +116,47 @@ def seedData():
                                    archived=False)
     user_xander_dander.save_to_db()
 
-    property_test1 = PropertyModel(name="test1",
-                                   address="123 NE FLanders St",
-                                   unit="5",
-                                   city="Portland",
-                                   state="OR",
-                                   zipcode="97207",
-                                   propertyManagerIDs=[user_gray_pouponn.id],
-                                   archived=False)
-    property_test1.save_to_db()
-    property_meerkat_manor = PropertyModel(name="Meerkat Manor",
-                                           address="Privet Drive",
-                                           unit="2",
-                                           city="Portland",
-                                           state="OR",
-                                           zipcode="97207",
-                                           propertyManagerIDs=[user_mister_sir.id],
-                                           archived=False)
-    property_meerkat_manor.save_to_db()
-    property_the_reginald = PropertyModel(name="The Reginald",
-                                          address="Aristocrat Avenue",
-                                          unit="3",
-                                          city="Portland",
-                                          state="OR",
-                                          zipcode="97207",
-                                          propertyManagerIDs=[user_gray_pouponn.id, user_mister_sir.id],
-                                          archived=False)
-    property_the_reginald.save_to_db()
+
+    property_test1 = PropertyModel.create(
+        payload= {
+            'name': "test1",
+            'address': "123 NE FLanders St",
+            'unit': "5",
+            'city': "Portland",
+            'state': "OR",
+            'zipcode': "97207",
+            'propertyManagerIDs': [user_gray_pouponn.id]
+        },
+        schema=PropertySchema
+    )
+
+
+    property_meerkat_manor = PropertyModel.create(
+        payload = {
+            'name': "Meerkat Manor",
+            'address': "Privet Drive",
+            'unit': "2",
+            'city': "Portland",
+            'state': "OR",
+            'zipcode': "97207",
+            'propertyManagerIDs': [user_mister_sir.id]
+        },
+        schema = PropertySchema
+    )
+
+    property_the_reginald = PropertyModel.create(
+        payload = {
+            'name': "The Reginald",
+            'address': "Aristocrat Avenue",
+            'unit': "3",
+            'city': "Portland",
+            'state': "OR",
+            'zipcode': "97207",
+            'propertyManagerIDs': [user_gray_pouponn.id, user_mister_sir.id]
+        },
+        schema = PropertySchema
+    )
+
 
     tenant_renty_mcrenter = TenantModel(firstName="Renty",
                                         lastName="McRenter",
diff --git a/models/base_model.py b/models/base_model.py
@@ -66,3 +66,7 @@ def __repr__(self):
     @classmethod
     def _name(cls):
         return cls.__name__.replace('Model', '')
+
+    @classmethod
+    def tablename(cls):
+        return cls.__tablename__
diff --git a/models/property.py b/models/property.py
@@ -1,10 +1,9 @@
 from db import db
 from utils.time import Time
-from marshmallow import ValidationError
 
 from models.tenant import TenantModel
 from models.base_model import BaseModel
-from models.user import UserModel, RoleEnum
+from models.user import UserModel
 from models.property_assignment import PropertyAssignment
 
 
@@ -18,20 +17,10 @@ class PropertyModel(BaseModel):
     city = db.Column(db.String(50))
     state = db.Column(db.String(50))
     zipcode = db.Column(db.String(20))
-    archived = db.Column(db.Boolean)
+    archived = db.Column(db.Boolean, default=False, nullable=False)
 
     leases = db.relationship('LeaseModel', backref='property', lazy=True, cascade="all, delete-orphan")
-    managers = db.relationship(UserModel, secondary='property_assignments', backref='properties')
-
-    def __init__(self, name, address, unit, city, state, zipcode, propertyManagerIDs, archived):
-        self.name = name
-        self.address = address
-        self.unit = unit
-        self.city = city
-        self.state = state
-        self.zipcode = zipcode
-        self.managers = self.set_property_managers(propertyManagerIDs)
-        self.archived = False
+    managers = db.relationship(UserModel, secondary=PropertyAssignment.tablename(), backref='properties')
 
     def json(self):
 
@@ -59,20 +48,3 @@ def find_by_name(cls, name):
     @classmethod
     def find_by_manager(cls, manager_id):
         return cls.query.filter(cls.managers.any(UserModel.id == manager_id)).all()
-
-    @classmethod
-    def set_property_managers(cls, ids):
-        managers = []
-        if ids:
-            for id in ids:
-                user = UserModel.find_by_id(id)
-                if user and user.role == RoleEnum.PROPERTY_MANAGER:
-
-                    managers.append(user)
-
-                elif user and user.role != RoleEnum.PROPERTY_MANAGER:
-                    raise ValidationError(f'{user.full_name()} is not a property manager')
-                else:
-                    raise ValidationError(f'{id} is not a valid user id')
-
-        return managers
diff --git a/resources/property.py b/resources/property.py
@@ -1,8 +1,9 @@
-import json
 from flask_restful import Resource, reqparse
+from flask import request
 from utils.authorizations import admin_required
 from db import db
 from models.property import PropertyModel
+from schemas.property import PropertySchema
 
 # | method | route                | action                     |
 # | :----- | :------------------- | :------------------------- |
@@ -12,35 +13,15 @@
 # | PUT    | `v1/property/:id`    | Updates a single property  |
 # | DELETE | `v1/property/:id`    | Deletes a single property  |
 
-#TODO Add Id based identifiers.
 #TODO Incorporate JWT Claims for Admin
 
 class Properties(Resource):
-    parser = reqparse.RequestParser()
-    parser.add_argument('name')
-    parser.add_argument('address')
-    parser.add_argument('unit')
-    parser.add_argument('city')
-    parser.add_argument('zipcode')
-    parser.add_argument('state')
-    parser.add_argument('propertyManagerIDs')
-    parser.add_argument('archived')
-
     def get(self):
         return {'properties': [property.json() for property in db.session.query(PropertyModel).all()]}
 
     @admin_required
     def post(self):
-        data = Properties.parser.parse_args()
-
-        if PropertyModel.find_by_name(data["name"]):
-            return { 'message': 'A property with this name already exists'}, 401
-
-        rentalproperty = PropertyModel(**data)
-
-        PropertyModel.save_to_db(rentalproperty)
-
-        return rentalproperty.json(), 201
+        return PropertyModel.create(schema=PropertySchema, payload=request.json).json(), 201
 
 class ArchiveProperty(Resource):
 
@@ -81,17 +62,6 @@ def patch(self):
 
 # single property/name
 class Property(Resource):
-    parser = reqparse.RequestParser()
-    parser.add_argument('name')
-    parser.add_argument('address')
-    parser.add_argument('unit')
-    parser.add_argument('city')
-    parser.add_argument('zipcode')
-    parser.add_argument('state')
-    parser.add_argument('propertyManagerIDs')
-    parser.add_argument('tenants')
-    parser.add_argument('archived')
-
     @admin_required
     def get(self, id):
         rentalProperty = PropertyModel.find_by_id(id)
@@ -110,37 +80,4 @@ def delete(self, id):
 
     @admin_required
     def put(self, id):
-        data = Properties.parser.parse_args()
-        rentalProperty = PropertyModel.find_by_id(id)
-
-        #variable statements allow for only updated fields to be transmitted
-        if(data.address):
-            rentalProperty.address = data.address
-
-        if(data.city):
-            rentalProperty.city = data.city
-
-        if(data.name):
-            rentalProperty.name = data.name
-
-        if(data.zipcode):
-            rentalProperty.zipcode = data.zipcode
-
-        if(data.state):
-            rentalProperty.state = data.state
-
-        if (data.unit):
-            rentalProperty.unit = data.unit
-
-        if data.propertyManagerIDs:
-            rentalProperty.managers = PropertyModel.set_property_managers(data.propertyManagerIDs)
-
-        #the reported purpose of this route is toggling the "archived" status
-        #but an explicit value of "archive" in the request body will override
-        rentalProperty.archived = not rentalProperty.archived
-        if(data.archived == True or data.archived == False):
-            rentalProperty.archived = data.archived
-
-        rentalProperty.save_to_db()
-
-        return rentalProperty.json()
+        return PropertyModel.update(schema=PropertySchema, id=id, payload=request.json).json()
diff --git a/schemas/property.py b/schemas/property.py
@@ -1,6 +1,8 @@
 from ma import ma
 from models.property import PropertyModel
-from marshmallow import fields, validates, ValidationError
+from models.user import UserModel
+from schemas.property_assignment import PropertyAssignSchema
+from marshmallow import fields, validates, ValidationError, post_load
 from utils.time import time_format
 
 
@@ -13,6 +15,21 @@ class Meta:
     propertyManagerIDs = fields.List(fields.Integer(), required=True)
 
     @validates("propertyManagerIDs")
-    def validates_manager_assigned(self, value):
+    def validates_property_manager_ids(self, value):
         if len(value) < 1:
             raise ValidationError('manager must be assigned')
+
+        payload = [ {'manager_id': value[manager_id]} for manager_id in range(len(value)) ]
+        PropertyAssignSchema().load(payload, partial=True, many=True)
+
+    @validates("name")
+    def validates_uniqueness_of_name(self, value):
+        if PropertyModel.find_by_name(value):
+            raise ValidationError('A property with this name already exists')
+
+    @post_load
+    def make_property_attributes(self, data, **kwargs):
+        if 'propertyManagerIDs' in data:
+            data['managers'] = [ UserModel.find(manager) for manager in data['propertyManagerIDs'] ]
+            del(data['propertyManagerIDs'])
+        return data
diff --git a/tests/factory_fixtures/property.py b/tests/factory_fixtures/property.py
@@ -1,29 +1,25 @@
 import pytest
 from models.property import PropertyModel
+from schemas.property import PropertySchema
 
 @pytest.fixture
-def property_attributes(faker):
-    def _property_attributes(archived=False, pm=None):
+def property_attributes(faker, create_property_manager):
+    def _property_attributes(archived=False, manager_ids=[create_property_manager().id]):
         return {
             'name': faker.unique.name(),
             'address': faker.address(),
             'city': faker.city(),
             'unit': faker.building_number(),
-            'state': faker.state() ,
+            'state': faker.state(),
             'zipcode': faker.postcode(),
-            'propertyManagerIDs': [pm.id] if pm and pm.id else [],
             'archived': archived,
+            'propertyManagerIDs': manager_ids
         }
     yield _property_attributes
 
 @pytest.fixture
-def create_property(property_attributes, create_property_manager):
+def create_property(property_attributes):
     def _create_property():
-        property = PropertyModel(**property_attributes(
-            pm=create_property_manager(),
-            archived=False,
-        ))
-        property.save_to_db()
+        property = PropertyModel.create(payload=property_attributes(), schema=PropertySchema)
         return property
     yield _create_property
-
diff --git a/tests/integration/test_properties.py b/tests/integration/test_properties.py
diff --git a/tests/schemas/test_property_schema.py b/tests/schemas/test_property_schema.py
diff --git a/tests/unit/test_property.py b/tests/unit/test_property.py
