core: separate expiry logic from tokens and make re-usable

passbook/core/models.py

@@ -198,6 +198,31 @@ class UserSourceConnection(CreatedUpdatedModel):
         unique_together = (("user", "source"),)
 
 
+class ExpiringModel(models.Model):
+    """Base Model which can expire, and is automatically cleaned up."""
+
+    expires = models.DateTimeField(default=default_token_duration)
+    expiring = models.BooleanField(default=True)
+
+    @classmethod
+    def filter_not_expired(cls, **kwargs) -> QuerySet:
+        """Filer for tokens which are not expired yet or are not expiring,
+        and match filters in `kwargs`"""
+        query = Q(**kwargs)
+        query_not_expired_yet = Q(expires__lt=now(), expiring=True)
+        query_not_expiring = Q(expiring=False)
+        return cls.objects.filter(query & (query_not_expired_yet | query_not_expiring))
+
+    @property
+    def is_expired(self) -> bool:
+        """Check if token is expired yet."""
+        return now() > self.expires
+
+    class Meta:
+
+        abstract = True
+
+
 class TokenIntents(models.TextChoices):
     """Intents a Token can be created for."""
 
@@ -208,34 +233,16 @@ class TokenIntents(models.TextChoices):
     INTENT_API = "api"
 
 
-class Token(models.Model):
+class Token(ExpiringModel):
     """Token used to authenticate the User for API Access or confirm another Stage like Email."""
 
     token_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
     intent = models.TextField(
         choices=TokenIntents.choices, default=TokenIntents.INTENT_VERIFICATION
     )
-    expires = models.DateTimeField(default=default_token_duration)
     user = models.ForeignKey("User", on_delete=models.CASCADE, related_name="+")
-    expiring = models.BooleanField(default=True)
     description = models.TextField(default="", blank=True)
 
-    @staticmethod
-    def filter_not_expired(**kwargs) -> QuerySet:
-        """Filer for tokens which are not expired yet or are not expiring,
-        and match filters in `kwargs`"""
-        query = Q(**kwargs)
-        query_not_expired_yet = Q(expires__lt=now(), expiring=True)
-        query_not_expiring = Q(expiring=False)
-        return Token.objects.filter(
-            query & (query_not_expired_yet | query_not_expiring)
-        )
-
-    @property
-    def is_expired(self) -> bool:
-        """Check if token is expired yet."""
-        return now() > self.expires
-
     def __str__(self):
         return (
             f"Token {self.token_uuid.hex} {self.description} (expires={self.expires})"