-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update location persistence for new registrations. (#957)
Signed-off-by: Doug Lovett <[email protected]> Signed-off-by: Doug Lovett <[email protected]>
- Loading branch information
1 parent
ca744b7
commit 6ed1915
Showing
15 changed files
with
503 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| # Copyright © 2019 Province of British Columbia | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| """This module holds data for MHR locations.""" | ||
|
|
||
| # from flask import current_app | ||
| from sqlalchemy.dialects.postgresql import ENUM as PG_ENUM | ||
|
|
||
| from mhr_api.models import utils as model_utils | ||
|
|
||
| from .db import db | ||
| from .address import Address # noqa: F401 pylint: disable=unused-import | ||
| from .type_tables import MhrLocationTypes, MhrStatusTypes | ||
|
|
||
|
|
||
| class MhrLocation(db.Model): # pylint: disable=too-many-instance-attributes | ||
| """This class manages all of the MHR location information.""" | ||
|
|
||
| __tablename__ = 'mhr_locations' | ||
|
|
||
| id = db.Column('id', db.Integer, db.Sequence('mhr_location_id_seq'), primary_key=True) | ||
| ltsa_description = db.Column('ltsa_description', db.String(1000), nullable=True) | ||
| additional_description = db.Column('additional_description', db.String(250), nullable=True) | ||
| dealer_name = db.Column('dealer_name', db.String(150), nullable=True) | ||
| exception_plan = db.Column('exception_plan', db.String(150), index=True, nullable=True) | ||
| leave_province = db.Column('leave_province', db.String(1), nullable=True) | ||
| tax_certification = db.Column('tax_certification', db.String(1), nullable=True) | ||
| tax_certification_date = db.Column('tax_certification_date', db.DateTime, nullable=True) | ||
| # LTSA specific properties. | ||
| park_name = db.Column('park_name', db.String(100), nullable=True) | ||
| park_pad = db.Column('park_pad', db.String(10), nullable=True) | ||
| pid_number = db.Column('pid_number', db.String(9), nullable=True) | ||
| lot = db.Column('lot', db.String(10), nullable=True) | ||
| parcel = db.Column('parcel', db.String(10), nullable=True) | ||
| block = db.Column('block', db.String(10), nullable=True) | ||
| district_lot = db.Column('district_lot', db.String(20), nullable=True) | ||
| part_of = db.Column('part_of', db.String(10), nullable=True) | ||
| section = db.Column('section', db.String(10), nullable=True) | ||
| township = db.Column('township', db.String(10), nullable=True) | ||
| range = db.Column('range', db.String(10), nullable=True) | ||
| meridian = db.Column('meridian', db.String(10), nullable=True) | ||
| land_district = db.Column('land_district', db.String(30), nullable=True) | ||
| plan = db.Column('plan', db.String(20), nullable=True) | ||
|
|
||
| # parent keys | ||
| address_id = db.Column('address_id', db.Integer, db.ForeignKey('addresses.id'), nullable=True, index=True) | ||
| registration_id = db.Column('registration_id', db.Integer, db.ForeignKey('mhr_registrations.id'), nullable=False, | ||
| index=True) | ||
| change_registration_id = db.Column('change_registration_id', db.Integer, nullable=False, index=True) | ||
| location_type = db.Column('location_type', PG_ENUM(MhrLocationTypes), | ||
| db.ForeignKey('mhr_location_types.location_type'), nullable=False) | ||
| status_type = db.Column('status_type', PG_ENUM(MhrStatusTypes), | ||
| db.ForeignKey('mhr_status_types.status_type'), nullable=False) | ||
|
|
||
| # Relationships - Address | ||
| address = db.relationship('Address', foreign_keys=[address_id], uselist=False, | ||
| back_populates='mhr_location', cascade='all, delete') | ||
| # Relationships - MhrRegistration | ||
| registration = db.relationship('MhrRegistration', foreign_keys=[registration_id], | ||
| back_populates='locations', cascade='all, delete', uselist=False) | ||
|
|
||
| @property | ||
| def json(self) -> dict: # pylint: disable=too-many-branches | ||
| """Return the location as a json object.""" | ||
| location = { | ||
| 'locationId': self.id, | ||
| 'status': self.status_type, | ||
| 'locationType': self.location_type | ||
| } | ||
| if self.ltsa_description: | ||
| location['legalDescription'] = self.ltsa_description | ||
| if self.address: | ||
| location['address'] = self.address.json | ||
| if self.park_name: | ||
| location['parkName'] = self.park_name | ||
| if self.park_pad: | ||
| location['pad'] = self.park_pad | ||
| if self.pid_number: | ||
| location['pidNumber'] = self.pid_number | ||
| if self.lot: | ||
| location['lot'] = self.lot | ||
| if self.parcel: | ||
| location['parcel'] = self.parcel | ||
| if self.block: | ||
| location['block'] = self.block | ||
| if self.district_lot: | ||
| location['districtLot'] = self.district_lot | ||
| if self.part_of: | ||
| location['partOf'] = self.part_of | ||
| if self.section: | ||
| location['section'] = self.section | ||
| if self.township: | ||
| location['township'] = self.township | ||
| if self.range: | ||
| location['range'] = self.range | ||
| if self.meridian: | ||
| location['meridian'] = self.meridian | ||
| if self.land_district: | ||
| location['landDistrict'] = self.land_district | ||
| if self.plan: | ||
| location['plan'] = self.plan | ||
| if self.leave_province and self.leave_province == 'Y': | ||
| location['leaveProvince'] = True | ||
| else: | ||
| location['leaveProvince'] = False | ||
| if self.tax_certification and self.tax_certification == 'Y': | ||
| location['taxCertificate'] = True | ||
| else: | ||
| location['taxCertificate'] = False | ||
| if self.tax_certification_date: | ||
| location['taxCertificateDate'] = model_utils.format_ts(self.tax_certification_date) | ||
| if self.exception_plan: | ||
| location['exceptionPlan'] = self.exception_plan | ||
| if self.dealer_name: | ||
| location['dealerName'] = self.dealer_name | ||
| if self.additional_description: | ||
| location['additionalDescription'] = self.additional_description | ||
| return location | ||
|
|
||
| @classmethod | ||
| def find_by_id(cls, location_id: int = None): | ||
| """Return a location object by location ID.""" | ||
| location = None | ||
| if location_id: | ||
| location = cls.query.get(location_id) | ||
|
|
||
| return location | ||
|
|
||
| @classmethod | ||
| def find_by_registration_id(cls, registration_id: int = None): | ||
| """Return a list of location objects by registration id.""" | ||
| locations = None | ||
| if registration_id: | ||
| locations = cls.query.filter(MhrLocation.registration_id == registration_id) \ | ||
| .order_by(MhrLocation.id).all() | ||
|
|
||
| return locations | ||
|
|
||
| @classmethod | ||
| def find_by_change_registration_id(cls, registration_id: int = None): | ||
| """Return a list of location objects by change registration id.""" | ||
| locations = None | ||
| if registration_id: | ||
| locations = cls.query.filter(MhrLocation.change_registration_id == registration_id) \ | ||
| .order_by(MhrLocation.id).all() | ||
|
|
||
| return locations | ||
|
|
||
| @staticmethod | ||
| def create_from_json(json_data, # pylint: disable=too-many-statements, too-many-branches | ||
| registration_id: int = None): | ||
| """Create a location object from a json schema object: map json to db.""" | ||
| # current_app.logger.info(json_data) | ||
| location: MhrLocation = MhrLocation() | ||
| location.location_type = json_data.get('locationType', MhrLocationTypes.OTHER) | ||
| location.status_type = MhrStatusTypes.ACTIVE | ||
| location.address = Address.create_from_json(json_data['address']) | ||
| if registration_id: | ||
| location.registration_id = registration_id | ||
| location.change_registration_id = registration_id | ||
| if 'legalDescription' in json_data: | ||
| location.ltsa_description = json_data['legalDescription'].strip() | ||
| if 'parkName' in json_data: | ||
| location.park_name = json_data['parkName'].strip() | ||
| if 'pad' in json_data: | ||
| location.park_pad = json_data['pad'].strip() | ||
| if 'pidNumber' in json_data: | ||
| location.pid_number = json_data['pidNumber'].strip() | ||
| if 'parcel' in json_data: | ||
| location.parcel = json_data['parcel'].strip() | ||
| if 'block' in json_data: | ||
| location.block = json_data['block'].strip() | ||
| if 'districtLot' in json_data: | ||
| location.district_lot = json_data['districtLot'].strip() | ||
| if 'partOf' in json_data: | ||
| location.part_of = json_data['partOf'].strip() | ||
| if 'section' in json_data: | ||
| location.section = json_data['section'].strip() | ||
| if 'township' in json_data: | ||
| location.township = json_data['township'].strip() | ||
| if 'range' in json_data: | ||
| location.range = json_data['range'].strip() | ||
| if 'meridian' in json_data: | ||
| location.meridian = json_data['meridian'].strip() | ||
| if 'landDistrict' in json_data: | ||
| location.land_district = json_data['landDistrict'].strip() | ||
| if 'plan' in json_data: | ||
| location.plan = json_data['plan'].strip() | ||
| if 'exceptionPlan' in json_data: | ||
| location.exception_plan = json_data['exceptionPlan'].strip() | ||
| if 'dealerName' in json_data: | ||
| location.dealer_name = json_data['dealerName'].strip() | ||
| if 'additionalDescription' in json_data: | ||
| location.additional_description = json_data['additionalDescription'].strip() | ||
| if json_data.get('leaveProvince'): | ||
| location.leave_province = 'Y' | ||
| else: | ||
| location.leave_province = 'N' | ||
| if json_data.get('taxCertificate'): | ||
| location.tax_certification = 'Y' | ||
| else: | ||
| location.tax_certification = 'N' | ||
|
|
||
| if json_data.get('taxCertificateDate', None): | ||
| location.tax_certification_date = model_utils.ts_from_iso_format(json_data.get('taxCertificateDate')) | ||
|
|
||
| return location |
Oops, something went wrong.