feat: add SIGNED capability

Author: smotornyuk

pyproject.toml

@@ -39,11 +39,12 @@ test = [ "pytest-cov", "pytest-faker", "responses", "werkzeug" ]
 docs = [ "mkdocs", "mkdocs-material", "pymdown-extensions", "mkdocstrings[python]",]
 dev = [ "pytest-cov", "pytest-faker", "responses", "mkdocs", "mkdocs-material", "pymdown-extensions", "mkdocstrings[python]",]
 
-redis = [ "redis",]
-s3 = [ "boto3", "boto3-stubs[essential]"]
+azure = ["azure-storage-blob",]
 gcs = [ "google-cloud-storage",]
-opendal = [ "opendal",]
 libcloud = [ "apache-libcloud", "cryptography",]
+opendal = [ "opendal",]
+redis = [ "redis",]
+s3 = [ "boto3", "boto3-stubs[essential]"]
 sqlalchemy = ["sqlalchemy"]
 
 [project.entry-points."file_keeper_ext"]

src/file_keeper/core/storage.py

@@ -213,6 +213,16 @@ def analyze(
         """Return all details about filename."""
         raise NotImplementedError
 
+    def signed(
+        self,
+        action: types.SignedAction,
+        duration: int,
+        location: types.Location,
+        extras: dict[str, Any],
+    ) -> str:
+        """Make an URL for signed action."""
+        raise NotImplementedError
+
 
 class Reader(StorageService):
     """Service responsible for reading data from the storage.
@@ -558,6 +568,17 @@ def analyze(self, location: types.Location, /, **kwargs: Any) -> data.FileData:
         """Return file details for the given location."""
         return self.manager.analyze(location, kwargs)
 
+    @requires_capability(Capability.SIGNED)
+    def signed(
+        self,
+        action: types.SignedAction,
+        duration: int,
+        location: types.Location,
+        **kwargs: Any,
+    ) -> str:
+        """Make an URL for signed action."""
+        return self.manager.signed(action, duration, location, kwargs)
+
     @requires_capability(Capability.STREAM)
     def stream(self, data: data.FileData, /, **kwargs: Any) -> Iterable[bytes]:
         """Return the stream of file's content."""

src/file_keeper/core/types.py

@@ -3,7 +3,7 @@
 from collections.abc import Callable, Iterator
 from typing import TYPE_CHECKING, Any, NewType, Protocol
 
-from typing_extensions import TypeAlias
+from typing_extensions import Literal, TypeAlias
 
 if TYPE_CHECKING:
     from .data import BaseData
@@ -15,6 +15,8 @@
     [str, "Upload | BaseData | None", "dict[str, Any]"], str
 ]
 
+SignedAction = Literal["upload", "download", "delete"]
+
 
 class PReadable(Protocol):
     def read(self, size: Any = ..., /) -> bytes: ...

src/file_keeper/default/adapters/azure.py

@@ -0,0 +1,19 @@
+# from azure.storage.blob import generate_blob_sas, BlobSasPermissions
+
+# def azure_signed_action(action, duration, location):
+#     container, blob = location.split('/', 1)
+#     perms = BlobSasPermissions()
+#     if action == 'download': perms.read = True
+#     elif action == 'upload': perms.write = True; perms.create = True
+#     elif action == 'delete': perms.delete = True
+#     else: raise ValueError('Unsupported action')
+
+#     sas = generate_blob_sas(
+#         account_name=...,
+#         account_key=...,
+#         container_name=container,
+#         blob_name=blob,
+#         permission=perms,
+#         expiry=datetime.utcnow() + timedelta(seconds=duration)
+#     )
+#     return f"https://{account}.blob.core.windows.net/{container}/{blob}?{sas}"

src/file_keeper/default/adapters/gcs.py

@@ -4,6 +4,7 @@
 import dataclasses
 import os
 import re
+from datetime import timedelta
 from typing import Any, cast
 
 import requests
@@ -251,7 +252,27 @@ def multipart_complete(
 
 class Manager(fk.Manager):
     storage: GoogleCloudStorage
-    capabilities: fk.Capability = fk.Capability.REMOVE
+    capabilities: fk.Capability = fk.Capability.REMOVE | fk.Capability.SIGNED
+
+    @override
+    def signed(
+        self,
+        action: fk.types.SignedAction,
+        duration: int,
+        location: fk.Location,
+        extras: dict[str, Any],
+    ) -> str:
+        name = self.storage.full_path(location)
+
+        client = self.storage.settings.client
+        bucket = client.bucket(self.storage.settings.bucket)
+        blob = bucket.blob(name)
+
+        method = {"download": "GET", "upload": "PUT", "delete": "DELETE"}[action]
+
+        return blob.generate_signed_url(
+            version="v4", expiration=timedelta(seconds=duration), method=method
+        )
 
     @override
     def remove(

src/file_keeper/default/adapters/null.py

@@ -151,7 +151,12 @@ def permanent_link(self, data: fk.FileData, extras: dict[str, Any]) -> str:
         return data.location
 
     @override
-    def temporal_link(self, data: fk.FileData, extras: dict[str, Any]) -> str:
+    def temporal_link(
+        self,
+        data: fk.FileData,
+        duration: int,
+        extras: dict[str, Any],
+    ) -> str:
         return data.location
 
     @override

src/file_keeper/default/adapters/proxy.py

@@ -4,4 +4,5 @@
 
 
 @fk.Storage.register
-class ProxyStorage: ...
+class ProxyStorage:
+    hidden = True

src/file_keeper/default/adapters/redis.py

@@ -11,7 +11,7 @@
 
 import file_keeper as fk
 
-pools = fk.Registry[redis.ConnectionPool]()
+pool = fk.Registry[redis.ConnectionPool]()
 
 
 @dataclasses.dataclass
@@ -34,15 +34,15 @@ def __post_init__(self, url: str, **kwargs: Any):
         super().__post_init__(**kwargs)
 
         if self.redis is None:  # pyright: ignore[reportUnnecessaryComparison]
-            if url not in pools:
-                pools.register(
-                    url,
+            if url not in pool:
+                conn = (
                     redis.ConnectionPool.from_url(url)
                     if url
-                    else redis.ConnectionPool(),
+                    else redis.ConnectionPool()
                 )
+                pool.register(url, conn)
 
-            self.redis = redis.Redis(connection_pool=pools[url])
+            self.redis = redis.Redis(connection_pool=pool[url])
 
 
 class Uploader(fk.Uploader):

src/file_keeper/default/adapters/s3.py

@@ -259,8 +259,32 @@ class Manager(fk.Manager):
         | fk.Capability.SCAN
         | fk.Capability.MOVE
         | fk.Capability.COPY
+        | fk.Capability.SIGNED
     )
 
+    @override
+    def signed(
+        self,
+        action: fk.types.SignedAction,
+        duration: int,
+        location: fk.Location,
+        extras: dict[str, Any],
+    ) -> str:
+        client = self.storage.settings.client
+        method = {
+            "download": "get_object",
+            "upload": "put_object",
+            "delete": "delete_object",
+        }[action]
+
+        key = self.storage.full_path(location)
+
+        return client.generate_presigned_url(
+            ClientMethod=method,
+            Params={"Bucket": self.storage.settings.bucket, "Key": key},
+            ExpiresIn=duration,
+        )
+
     @override
     def copy(
         self,