config and attr access improvements

archivebox/api/auth.py

@@ -1,6 +1,6 @@
 __package__ = 'archivebox.api'
 
-from typing import Optional
+from typing import Optional, cast
 
 from django.http import HttpRequest
 from django.contrib.auth import login
@@ -18,12 +18,13 @@ def auth_using_token(token, request: Optional[HttpRequest]=None) -> Optional[Abs
 
     submitted_empty_form = token in ('string', '', None)
     if submitted_empty_form:
+        assert request is not None, 'No request provided for API key authentication'
         user = request.user       # see if user is authed via django session and use that as the default
     else:
         try:
             token = APIToken.objects.get(token=token)
             if token.is_valid():
-                user = token.user
+                user = token.created_by
         except APIToken.DoesNotExist:
             pass
 
@@ -38,6 +39,7 @@ def auth_using_password(username, password, request: Optional[HttpRequest]=None)
     
     submitted_empty_form = (username, password) in (('string', 'string'), ('', ''), (None, None))
     if submitted_empty_form:
+        assert request is not None, 'No request provided for API key authentication'
         user = request.user       # see if user is authed via django session and use that as the default
     else:
         user = authenticate(
@@ -47,8 +49,9 @@ def auth_using_password(username, password, request: Optional[HttpRequest]=None)
 
     if not user:
         print('[❌] Failed to authenticate API user using API Key:', request)
+        user = None
 
-    return user
+    return cast(AbstractBaseUser | None, user)
 
 
 ### Base Auth Types

archivebox/api/models.py

@@ -12,7 +12,8 @@ from signal_webhooks.models import WebhookBase
 
 from django_stubs_ext.db.models import TypedModelMeta
 
-from abid_utils.models import ABIDModel, ABIDField
+from abid_utils.models import ABIDModel, ABIDField, get_or_create_system_user_pk
+
 
 
 def generate_secret_token() -> str:
@@ -32,15 +33,13 @@ class APIToken(ABIDModel):
     abid_rand_src = 'self.id'
 
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
-    uuid = models.UUIDField(blank=True, null=True, editable=False, unique=True)
     abid = ABIDField(prefix=abid_prefix)
 
-    created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
-    token = models.CharField(max_length=32, default=generate_secret_token, unique=True)
-    
+    created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, default=get_or_create_system_user_pk)
     created = models.DateTimeField(auto_now_add=True)
+
+    token = models.CharField(max_length=32, default=generate_secret_token, unique=True)
     expires = models.DateTimeField(null=True, blank=True)
-    
 
     class Meta(TypedModelMeta):
         verbose_name = "API Key"
@@ -50,7 +49,7 @@ class APIToken(ABIDModel):
         return self.token
 
     def __repr__(self) -> str:
-        return f'<APIToken user={self.user.username} token=************{self.token[-4:]}>'
+        return f'<APIToken user={self.created_by.username} token=************{self.token[-4:]}>'
 
     def __json__(self) -> dict:
         return {
@@ -63,10 +62,6 @@ class APIToken(ABIDModel):
             "expires":          self.expires_as_iso8601,
         }
 
-    @property
-    def ulid(self):
-        return self.get_abid().ulid
-
     @property
     def expires_as_iso8601(self):
         """Returns the expiry date of the token in ISO 8601 format or a date 100 years in the future if none."""
@@ -100,10 +95,15 @@ class OutboundWebhook(ABIDModel, WebhookBase):
     abid_subtype_src = 'self.ref'
     abid_rand_src = 'self.id'
 
-    id = models.UUIDField(blank=True, null=True, unique=True, editable=True)
-    uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=True)
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     abid = ABIDField(prefix=abid_prefix)
 
+    created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, default=get_or_create_system_user_pk)
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+
+    # More fields here: WebhookBase...
+
     WebhookBase._meta.get_field('name').help_text = (
         'Give your webhook a descriptive name (e.g. Notify ACME Slack channel of any new ArchiveResults).')
     WebhookBase._meta.get_field('signal').help_text = (

archivebox/api/v1_core.py

@@ -309,9 +309,9 @@ def get_snapshot(request, snapshot_id: str, with_archiveresults: bool=True):
 #     snapshot = Snapshot.objects.create(**payload.dict())
 #     return snapshot
 #
-# @router.put("/snapshot/{snapshot_uuid}", response=SnapshotSchema)
-# def update_snapshot(request, snapshot_uuid: str, payload: SnapshotSchema):
-#     snapshot = get_object_or_404(Snapshot, uuid=snapshot_uuid)
+# @router.put("/snapshot/{snapshot_id}", response=SnapshotSchema)
+# def update_snapshot(request, snapshot_id: str, payload: SnapshotSchema):
+#     snapshot = get_object_or_404(Snapshot, uuid=snapshot_id)
 #
 #     for attr, value in payload.dict().items():
 #         setattr(snapshot, attr, value)
@@ -319,9 +319,9 @@ def get_snapshot(request, snapshot_id: str, with_archiveresults: bool=True):
 #
 #     return snapshot
 #
-# @router.delete("/snapshot/{snapshot_uuid}")
-# def delete_snapshot(request, snapshot_uuid: str):
-#     snapshot = get_object_or_404(Snapshot, uuid=snapshot_uuid)
+# @router.delete("/snapshot/{snapshot_id}")
+# def delete_snapshot(request, snapshot_id: str):
+#     snapshot = get_object_or_404(Snapshot, uuid=snapshot_id)
 #     snapshot.delete()
 #     return {"success": True}