Remove init method on tenant model (#183)

* Remove init method on tenant model

* Create tests to ensure staffIDs are validated

Author: NickSchimek

data/seedData.py

@@ -11,7 +11,7 @@
 from models.contact_number import ContactNumberModel
 from models.lease import LeaseModel
 from utils.time import time_format
-from schemas import PropertySchema
+from schemas import PropertySchema, TenantSchema
 
 
 def seedData():
@@ -158,24 +158,35 @@ def seedData():
     )
 
 
-    tenant_renty_mcrenter = TenantModel(firstName="Renty",
-                                        lastName="McRenter",
-                                        phone="800-RENT-ALOT",
-                                        staffIDs=[user_1.id, user_2.id]
-                                        )
-    tenant_renty_mcrenter.save_to_db()
-    tenant_soho_muless = TenantModel(firstName="Soho",
-                                     lastName="Muless",
-                                     phone="123-123-0000",
-                                     staffIDs=[]
-                                     )
-    tenant_soho_muless.save_to_db()
-    tenant_starvin_artist = TenantModel(firstName="Starvin",
-                                        lastName="Artist",
-                                        phone="123-123-1111",
-                                        staffIDs=[]
-                                        )
-    tenant_starvin_artist.save_to_db()
+    tenant_renty_mcrenter = TenantModel.create(
+        schema=TenantSchema,
+        payload={
+            'firstName': "Renty",
+            'lastName': "McRenter",
+            'phone': "800-RENT-ALOT",
+            'staffIDs': [user_janice_joinstaff.id, user_hector_chen.id]
+        }
+    )
+
+    tenant_soho_muless = TenantModel.create(
+        schema=TenantSchema,
+        payload={
+            'firstName': "Soho",
+            'lastName': "Muless",
+            'phone': "123-123-0000",
+            'staffIDs': []
+        }
+    )
+
+    tenant_starvin_artist = TenantModel.create(
+        schema=TenantSchema,
+        payload={
+            'firstName': "Starvin",
+            'lastName': "Artist",
+            'phone': "123-123-1111",
+            'staffIDs': []
+        }
+    )
 
     ticket_roof_on_fire = TicketModel(
         issue="The roof, the roof, the roof is on fire.",

models/tenant.py

@@ -18,17 +18,6 @@ class TenantModel(BaseModel):
     leases = db.relationship('LeaseModel',
         backref='tenant', lazy=True, cascade="all, delete-orphan")
 
-    def __init__(self, firstName, lastName, phone, staffIDs):
-        self.firstName = firstName
-        self.lastName = lastName
-        self.phone = phone
-        self.staff = []
-        if not (staffIDs == None):
-            for id in staffIDs:
-                user = UserModel.find_by_id(id)
-                if user: self.staff.append(user)
-
-
     def json(self):
         return {
             'id': self.id,
@@ -40,7 +29,3 @@ def json(self):
             'created_at': Time.format_date(self.created_at),
             'updated_at': Time.format_date(self.updated_at)
         }
-
-    @classmethod
-    def find_by_first_and_last(cls, first, last):
-        return cls.query.filter_by(firstName=first, lastName=last).first()

resources/tenants.py

@@ -1,16 +1,10 @@
-import json
-from flask_restful import Resource, reqparse
+from flask_restful import Resource
 from flask import request
 from utils.authorizations import admin_required
-from db import db
 from models.tenant import TenantModel
-from models.user import UserModel
 from models.lease import LeaseModel
 from schemas.lease import LeaseSchema
-from datetime import datetime
-from utils.time import Time
-from schemas.lease import LeaseSchema
-from datetime import datetime
+from schemas.tenant import TenantSchema
 
 # | method | route                | action                    |
 # | :----- | :------------------- | :------------------------ |
@@ -21,12 +15,6 @@
 # | DELETE | `v1/tenants/:id`     | Deletes a single tenant   |
 
 class Tenants(Resource):
-    parser = reqparse.RequestParser()
-    parser.add_argument('firstName',type=str,required=True,help="This field cannot be blank")
-    parser.add_argument('lastName',type=str,required=True,help="This field cannot be blank")
-    parser.add_argument('phone',type=str,required=True,help="This field cannot be blank")
-    parser.add_argument('staffIDs',action='append',required=False,help="This field can be provided at a later time")
-
     @admin_required
     def get(self, tenant_id=None):
         # GET /tenants
@@ -42,12 +30,7 @@ def get(self, tenant_id=None):
 
     @admin_required
     def post(self):
-        data = Tenants.parser.parse_args()
-        if TenantModel.find_by_first_and_last(data["firstName"], data["lastName"]):
-            return { 'message': 'A tenant with this first and last name already exists'}, 401
-
-        tenantEntry = TenantModel(**data)
-        TenantModel.save_to_db(tenantEntry)
+        tenantEntry = TenantModel.create(schema=TenantSchema, payload=request.json)
 
         returnData = tenantEntry.json()
 
@@ -67,34 +50,7 @@ def post(self):
 
     @admin_required
     def put(self, tenant_id):
-        parser_for_put = Tenants.parser.copy()
-        parser_for_put.replace_argument('firstName',required=False)
-        parser_for_put.replace_argument('lastName',required=False)
-        parser_for_put.replace_argument('phone',required=False)
-        data = parser_for_put.parse_args()
-
-        tenantEntry = TenantModel.find_by_id(tenant_id)
-        if not tenantEntry:
-            return {'message': 'Tenant not found'}, 404
-
-        #variable statements allow for only updated fields to be transmitted
-        if(data.firstName):
-            tenantEntry.firstName = data.firstName
-        if(data.lastName):
-            tenantEntry.lastName = data.lastName
-        if(data.phone):
-            tenantEntry.phone = data.phone
-        if(data.staffIDs and len(data.staffIDs)):
-            tenantEntry.staff[:] = []
-            for id in data.staffIDs:
-                user = UserModel.find_by_id(id)
-                if user: tenantEntry.staff.append(user)
-
-
-        tenantEntry.save_to_db()
-
-        return tenantEntry.json()
-
+        return TenantModel.update(schema=TenantSchema, payload=request.json, id=tenant_id).json()
 
     @admin_required
     def delete(self, tenant_id):

schemas/tenant.py

@@ -1,7 +1,9 @@
 from ma import ma
 from models.tenant import TenantModel
-from marshmallow import fields, validate
+from models.user import UserModel
+from marshmallow import fields, validate, validates, post_load
 from utils.time import time_format
+from schemas.staff_tenants import StaffTenantSchema
 
 
 class TenantSchema(ma.SQLAlchemyAutoSchema):
@@ -11,6 +13,8 @@ class Meta:
     created_at = fields.DateTime(time_format)
     updated_at = fields.DateTime(time_format)
 
+    staffIDs = fields.List(fields.Integer(), required=False)
+
     firstName = fields.Str(
         required=True,
         validate=validate.Length(min=1, max=100),
@@ -25,6 +29,17 @@ class Meta:
 
     phone = fields.Str(
         required=True,
-        validate=validate.Length(min=10, max=20),
+        validate=validate.Length(min=10, max=30),
         error_messages={'required': 'Phone number is required.'},
     )
+
+    @validates("staffIDs")
+    def validate_staff_ids(self, value):
+        StaffTenantSchema().load({'staff': value}, partial=True)
+
+    @post_load
+    def make_tenant_attributes(self, data, **kwargs):
+        if 'staffIDs' in data:
+            data['staff'] = [ UserModel.find(staff) for staff in data['staffIDs'] ]
+            del(data['staffIDs'])
+        return data

tests/factory_fixtures/lease.py

@@ -18,9 +18,8 @@ def _lease_attributes(unitNum, tenant, property):
 @pytest.fixture
 def create_lease(faker, lease_attributes, create_property, create_tenant):
     def _create_lease(unitNum=faker.building_number()):
-        propertyID= create_property()
         tenant = create_tenant()
-        lease = LeaseModel(**lease_attributes(unitNum, tenant, propertyID))
+        lease = LeaseModel(**lease_attributes(unitNum, tenant, create_property()))
         lease.save_to_db()
         return lease
     yield _create_lease

tests/factory_fixtures/tenant.py

@@ -1,15 +1,22 @@
 import pytest
 from models.tenant import TenantModel
+from schemas.tenant import TenantSchema
 
 @pytest.fixture
-def create_tenant(faker):
+def tenant_attributes(faker, create_join_staff):
+    def _tenant_attributes(staff=[create_join_staff().id]):
+        return {
+            'firstName': faker.first_name(),
+            'lastName': faker.last_name(),
+            'phone': faker.phone_number(),
+            'staffIDs': staff
+        }
+
+    yield _tenant_attributes
+
+@pytest.fixture
+def create_tenant(tenant_attributes):
     def _create_tenant():
-        tenant = TenantModel(
-                firstName=faker.first_name(),
-                lastName=faker.last_name(),
-                phone=faker.phone_number(),
-                staffIDs=[]
-            )
-        tenant.save_to_db()
-        return tenant
+        return TenantModel.create(schema=TenantSchema, payload=tenant_attributes(staff=[]))
+
     yield _create_tenant

tests/integration/test_tenants.py

@@ -23,12 +23,14 @@ def test_tenants_GET_one(client, test_database, auth_headers):
     assert response.json == {'message': 'Tenant not found'}
 
 
-def test_tenants_POST(client, test_database, auth_headers, create_property):
+def test_tenants_POST(client, empty_test_db, auth_headers, valid_header, create_property, create_join_staff):
+    staff_1 = create_join_staff()
+    staff_2 = create_join_staff()
     newTenant = {
         "firstName": "Jake",
         "lastName": "The Dog",
         "phone": "111-111-1111",
-        "staffIDs": [1, 2]
+        "staffIDs": [staff_1.id, staff_2.id]
     }
 
     newTenantWithLease = {
@@ -43,25 +45,20 @@ def test_tenants_POST(client, test_database, auth_headers, create_property):
     }
 
     response = client.post(endpoint, json=newTenant,
-                           headers=auth_headers["admin"])
+                           headers=valid_header)
 
     assert is_valid(response, 201)  # CREATED
     assert response.json['firstName'] == 'Jake'
 
     response = client.post(endpoint, json=newTenantWithLease,
-                           headers=auth_headers["admin"])
+                           headers=valid_header)
     assert is_valid(response, 201)
     assert response.json['unitNum'] == '413'
 
 
 
     response = client.post(endpoint, json=newTenant,
-                           headers=auth_headers["admin"])
-    # UNAUTHORIZED - A tenant with this first and last name already exists
-    assert is_valid(response, 401)
-    assert response.json == \
-            {'message':
-             'A tenant with this first and last name already exists'}
+                           headers=valid_header)
 
     response = client.post(endpoint, json=newTenant,
                            headers=auth_headers["pm"])
@@ -76,30 +73,30 @@ def test_tenants_POST(client, test_database, auth_headers, create_property):
     assert is_valid(response, 401)
     assert response.json == {'message': 'Missing authorization header'}
 
-    newTenant = {}
-    response = client.post(endpoint, json=newTenant,
-                           headers=auth_headers["admin"])
-    # BAD REQUEST - {'firstName': 'This field cannot be blank.'}
-    assert is_valid(response, 400)
-    assert response.json == {'message':
-                             {'firstName': 'This field cannot be blank'}}
-
-def test_tenants_PUT(client, auth_headers):
-    id = 1
+def test_tenants_PUT(client, empty_test_db, valid_header, create_tenant, create_join_staff):
+    tenant = create_tenant()
+    staff_1 = create_join_staff()
+    staff_2 = create_join_staff()
     updatedTenant = {
         "firstName": "Jake",
         "lastName": "The Dog",
         "phone": "111-111-1111",
-        "staffIDs": [1, 2]
+        "staffIDs": [staff_1.id, staff_2.id]
     }
-    response = client.put(f'{endpoint}/{id}',
-                          json=updatedTenant, headers=auth_headers["admin"])
+    response = client.put(
+        f'{endpoint}/{tenant.id}',
+        json=updatedTenant,
+        headers=valid_header
+    )
     assert is_valid(response, 200)  # OK
     assert response.json['firstName'] == 'Jake'
 
     id = 100
-    response = client.put(f'{endpoint}/{id}',
-                          json=updatedTenant, headers=auth_headers["admin"])
+    response = client.put(
+        f'{endpoint}/{id}',
+        json=updatedTenant,
+        headers=valid_header
+    )
     assert is_valid(response, 404)  # NOT FOUND
     assert response.json == {'message': 'Tenant not found'}
 

tests/schemas/test_tenant_schema.py

@@ -1,4 +1,6 @@
+import pytest
 from datetime import datetime
+from models.tenant import TenantModel
 from schemas import TenantSchema
 from utils.time import Time
 
@@ -48,13 +50,13 @@ def test_lastName_max_100(self):
 
         assert 'lastName' in validation_errors
 
-    def test_phone_min_10(self):
+    def test_min_length_phone_number_validation(self):
         validation_errors = TenantSchema().validate({'phone': '1234'})
 
         assert 'phone' in validation_errors
 
-    def test_phone_max_20(self):
-        long_phone_number = '8' * 21
+    def test_max_length_phone_number_validation(self):
+        long_phone_number = '8' * 41
         validation_errors = TenantSchema().validate({'phone': long_phone_number})
 
         assert 'phone' in validation_errors
@@ -72,3 +74,22 @@ def test_updated_at_is_dump_only(self):
         )
 
         assert 'updated_at' in validation_errors
+
+    def test_staffIDs_are_validated(self, empty_test_db, create_property_manager):
+        pm = create_property_manager()
+        validation_error = TenantSchema().validate({"staffIDs": [pm.id]})
+
+        assert "staffIDs" in validation_error
+
+@pytest.mark.usefixtures('empty_test_db')
+class TestPostLoadDeserialization:
+    def test_tenant_creation(self, tenant_attributes, create_property, create_join_staff):
+        staff_1 = create_join_staff()
+        staff_2 = create_join_staff()
+
+        tenant_attrs = tenant_attributes(staff=[staff_1.id, staff_2.id])
+
+        tenant = TenantModel.create(schema=TenantSchema, payload=tenant_attrs)
+
+        assert tenant
+        assert tenant.staff == [staff_1, staff_2]