108f65f928
Currently, we use both Python's built-in datetime library and Pendulum to do datetime operations. For the sake of consistency, we should try to stick to one library for datetimes. We could have used either, but Pendulum has a more ergonomic API, so I decided to go with it when possible. The places where were we didn't / couldn't replace datetime are: - checking instances of datetimes. Pendulum's objects are subclasses of python native datetime objects, so it's still useful to import datetime in those cases of using is_instance() - WTForms date validators expect datetime style string formats -- Pendulum has its own format for formatting/ parsing strings. As such, our custom validator DateRange needs to use datetime.stptime() to account for this format.
140 lines
3.8 KiB
Python
140 lines
3.8 KiB
Python
import pendulum
|
|
from enum import Enum
|
|
import secrets
|
|
|
|
from sqlalchemy import Column, ForeignKey, Enum as SQLAEnum, TIMESTAMP, String
|
|
from sqlalchemy.ext.declarative import declared_attr
|
|
from sqlalchemy.dialects.postgresql import UUID
|
|
from sqlalchemy.orm import relationship
|
|
|
|
from atst.models import types
|
|
|
|
|
|
class Status(Enum):
|
|
ACCEPTED = "accepted"
|
|
REVOKED = "revoked"
|
|
PENDING = "pending"
|
|
REJECTED_WRONG_USER = "rejected_wrong_user"
|
|
REJECTED_EXPIRED = "rejected_expired"
|
|
|
|
|
|
class InvitesMixin(object):
|
|
id = types.Id()
|
|
|
|
@declared_attr
|
|
def user_id(cls):
|
|
return Column(UUID(as_uuid=True), ForeignKey("users.id"), index=True)
|
|
|
|
@declared_attr
|
|
def user(cls):
|
|
return relationship("User", foreign_keys=[cls.user_id])
|
|
|
|
@declared_attr
|
|
def inviter_id(cls):
|
|
return Column(
|
|
UUID(as_uuid=True), ForeignKey("users.id"), index=True, nullable=False
|
|
)
|
|
|
|
@declared_attr
|
|
def inviter(cls):
|
|
return relationship("User", foreign_keys=[cls.inviter_id])
|
|
|
|
status = Column(
|
|
SQLAEnum(Status, native_enum=False, default=Status.PENDING, nullable=False)
|
|
)
|
|
|
|
expiration_time = Column(TIMESTAMP(timezone=True), nullable=False)
|
|
|
|
token = Column(
|
|
String, index=True, default=lambda: secrets.token_urlsafe(), nullable=False
|
|
)
|
|
|
|
email = Column(String, nullable=False)
|
|
|
|
dod_id = Column(String, nullable=False)
|
|
first_name = Column(String, nullable=False)
|
|
last_name = Column(String, nullable=False)
|
|
phone_number = Column(String)
|
|
phone_ext = Column(String)
|
|
|
|
def __repr__(self):
|
|
role_id = self.role.id if self.role else None
|
|
return "<{}(user='{}', role='{}', id='{}', email='{}')>".format(
|
|
self.__class__.__name__, self.user_id, role_id, self.id, self.email
|
|
)
|
|
|
|
@property
|
|
def is_accepted(self):
|
|
return self.status == Status.ACCEPTED
|
|
|
|
@property
|
|
def is_revoked(self):
|
|
return self.status == Status.REVOKED
|
|
|
|
@property
|
|
def is_pending(self):
|
|
return self.status == Status.PENDING
|
|
|
|
@property
|
|
def is_rejected(self):
|
|
return self.status in [Status.REJECTED_WRONG_USER, Status.REJECTED_EXPIRED]
|
|
|
|
@property
|
|
def is_rejected_expired(self):
|
|
return self.status == Status.REJECTED_EXPIRED
|
|
|
|
@property
|
|
def is_rejected_wrong_user(self):
|
|
return self.status == Status.REJECTED_WRONG_USER
|
|
|
|
@property
|
|
def is_expired(self):
|
|
return (
|
|
pendulum.now(tz=self.expiration_time.tzinfo) > self.expiration_time
|
|
and not self.status == Status.ACCEPTED
|
|
)
|
|
|
|
@property
|
|
def is_inactive(self):
|
|
return self.is_expired or self.status in [
|
|
Status.REJECTED_WRONG_USER,
|
|
Status.REJECTED_EXPIRED,
|
|
Status.REVOKED,
|
|
]
|
|
|
|
@property
|
|
def user_name(self):
|
|
return "{} {}".format(self.first_name, self.last_name)
|
|
|
|
@property
|
|
def is_revokable(self):
|
|
return self.is_pending and not self.is_expired
|
|
|
|
@property
|
|
def can_resend(self):
|
|
return self.is_pending or self.is_expired
|
|
|
|
@property
|
|
def user_dod_id(self):
|
|
return self.user.dod_id if self.user is not None else None
|
|
|
|
@property
|
|
def event_details(self):
|
|
"""Overrides the same property in AuditableMixin.
|
|
Provides the event details for an invite that are required for the audit log
|
|
"""
|
|
return {"email": self.email, "dod_id": self.user_dod_id}
|
|
|
|
@property
|
|
def history(self):
|
|
"""Overrides the same property in AuditableMixin
|
|
Determines whether or not invite status has been updated
|
|
"""
|
|
changes = self.get_changes()
|
|
change_set = {}
|
|
|
|
if "status" in changes:
|
|
change_set["status"] = [s.name for s in changes["status"]]
|
|
|
|
return change_set
|