cloudtoolbox 0.2.1__tar.gz → 0.4.0__tar.gz

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Noverde
+Copyright (c) 2024 Dotz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{cloudtoolbox-0.2.1/cloudtoolbox.egg-info → cloudtoolbox-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudtoolbox
-Version: 0.2.1
+Version: 0.4.0
 Summary: Toolbox for the cloud.
 Author-email: Dotz Developers <devs-dotz@dotz.com>
 Project-URL: Repository, https://github.com/DotzInc/cloud-toolbox

cloudtoolbox-0.4.0/cloud/amazon/s3.py

@@ -0,0 +1,40 @@
+from typing import Any
+
+import boto3
+
+
+class Client:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        self.client = boto3.client("s3", *args, **kwargs)
+
+    def upload(self, bucket_name: str, destination_filename: str, source_filename: str) -> None:
+        self.client.upload_file(source_filename, bucket_name, destination_filename)
+
+    def download(self, bucket_name: str, source_filename: str, destination_filename: str) -> None:
+        self.client.download_file(bucket_name, source_filename, destination_filename)
+
+    def generate_presigned_url(
+        self,
+        bucket_name: str,
+        source_filename: str,
+        expiration: int,
+    ) -> str:
+        url = self.client.generate_presigned_url(
+            ClientMethod="get_object",
+            Params={"Bucket": bucket_name, "Key": source_filename},
+            ExpiresIn=expiration,
+        )
+
+        return url
+
+
+class Uploader(Client):
+    pass
+
+
+class Downloader(Client):
+    pass
+
+
+class URLSigner(Client):
+    pass

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0}/cloud/amazon/sns.py

@@ -7,5 +7,6 @@ class Publisher:
     def __init__(self, *args: Any, **kwargs: Any):
         self.client = boto3.client("sns", *args, **kwargs)
 
-    def publish(self, recipient: str, message: str, **attrs: Any) -> None:
-        self.client.publish(TargetArn=recipient, Message=message, **attrs)
+    def publish(self, recipient: str, message: str, **attrs: Any) -> str:
+        response = self.client.publish(TargetArn=recipient, Message=message, **attrs)
+        return response["MessageId"]

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0}/cloud/amazon/sqs.py

@@ -7,5 +7,6 @@ class Publisher:
     def __init__(self, *args: Any, **kwargs: Any):
         self.client = boto3.client("sqs", *args, **kwargs)
 
-    def publish(self, recipient: str, message: str, **attrs: Any) -> None:
-        self.client.send_message(QueueUrl=recipient, MessageBody=message, **attrs)
+    def publish(self, recipient: str, message: str, **attrs: Any) -> str:
+        response = self.client.send_message(QueueUrl=recipient, MessageBody=message, **attrs)
+        return response["MessageId"]

cloudtoolbox-0.4.0/cloud/factory.py

@@ -0,0 +1,53 @@
+from typing import Any, Callable, Type
+
+from cloud.protocols import MessagePublisher, StorageDownloader, StorageUploader, StorageURLSigner
+
+error_message = "%(class)s does not implement %(protocol)s protocol"
+
+
+def storage_uploader(
+    uploader_class: Type[StorageUploader], *args: Any, **kwargs: Any
+) -> Callable[[], StorageUploader]:
+    error = error_message % {"class": uploader_class.__name__, "protocol": "StorageUploader"}
+    assert issubclass(uploader_class, StorageUploader), error
+
+    def maker() -> StorageUploader:
+        return uploader_class(*args, **kwargs)
+
+    return maker
+
+
+def storage_downloader(
+    downloader_class: Type[StorageDownloader], *args: Any, **kwargs: Any
+) -> Callable[[], StorageDownloader]:
+    error = error_message % {"class": downloader_class.__name__, "protocol": "StorageDownloader"}
+    assert issubclass(downloader_class, StorageDownloader), error
+
+    def maker() -> StorageDownloader:
+        return downloader_class(*args, **kwargs)
+
+    return maker
+
+
+def storage_urlsigner(
+    urlsigner_class: Type[StorageURLSigner], *args: Any, **kwargs: Any
+) -> Callable[[], StorageURLSigner]:
+    error = error_message % {"class": urlsigner_class.__name__, "protocol": "StorageURLSigner"}
+    assert issubclass(urlsigner_class, StorageURLSigner), error
+
+    def maker() -> StorageURLSigner:
+        return urlsigner_class(*args, **kwargs)
+
+    return maker
+
+
+def message_publisher(
+    publisher_class: Type[MessagePublisher], *args: Any, **kwargs: Any
+) -> Callable[[], MessagePublisher]:
+    error = error_message % {"class": publisher_class.__name__, "protocol": "MessagePublisher"}
+    assert issubclass(publisher_class, MessagePublisher), error
+
+    def maker() -> MessagePublisher:
+        return publisher_class(*args, **kwargs)
+
+    return maker

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0}/cloud/google/pubsub.py

@@ -7,6 +7,6 @@ class Publisher:
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.client = pubsub_v1.PublisherClient(*args, **kwargs)
 
-    def publish(self, recipient: str, message: str, **attrs: Any) -> None:
+    def publish(self, recipient: str, message: str, **attrs: Any) -> str:
         future = self.client.publish(recipient, data=message.encode(), **attrs)
-        future.result()
+        return future.result()

cloudtoolbox-0.4.0/cloud/google/storage.py

@@ -0,0 +1,42 @@
+import datetime
+from typing import Any
+
+from google.cloud import storage
+
+
+class Client:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        self.client = storage.Client(*args, **kwargs)
+
+    def upload(self, bucket_name: str, destination_filename: str, source_filename: str) -> None:
+        blob = self.client.bucket(bucket_name).blob(destination_filename)
+        blob.upload_from_filename(source_filename)
+
+    def download(self, bucket_name: str, source_filename: str, destination_filename: str) -> None:
+        blob = self.client.bucket(bucket_name).blob(source_filename)
+        blob.download_to_filename(destination_filename)
+
+    def generate_presigned_url(
+        self,
+        bucket_name: str,
+        source_filename: str,
+        expiration: int,
+    ) -> str:
+        blob = self.client.bucket(bucket_name).blob(source_filename)
+        url = blob.generate_signed_url(
+            expiration=datetime.timedelta(seconds=expiration),
+            version="v4",
+        )
+        return url
+
+
+class Uploader(Client):
+    pass
+
+
+class Downloader(Client):
+    pass
+
+
+class URLSigner(Client):
+    pass

cloudtoolbox-0.4.0/cloud/protocols.py

@@ -0,0 +1,28 @@
+from typing import Any, Protocol, runtime_checkable
+
+
+@runtime_checkable
+class StorageUploader(Protocol):
+    def upload(self, bucket_name: str, destination_filename: str, source_filename: str) -> None: ...
+
+
+@runtime_checkable
+class StorageDownloader(Protocol):
+    def download(
+        self, bucket_name: str, source_filename: str, destination_filename: str
+    ) -> None: ...
+
+
+@runtime_checkable
+class StorageURLSigner(Protocol):
+    def generate_presigned_url(
+        self,
+        bucket_name: str,
+        source_filename: str,
+        expiration: int,
+    ) -> str: ...
+
+
+@runtime_checkable
+class MessagePublisher(Protocol):
+    def publish(self, recipient: str, message: str, **attrs: Any) -> str: ...

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0/cloudtoolbox.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudtoolbox
-Version: 0.2.1
+Version: 0.4.0
 Summary: Toolbox for the cloud.
 Author-email: Dotz Developers <devs-dotz@dotz.com>
 Project-URL: Repository, https://github.com/DotzInc/cloud-toolbox

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0}/pyproject.toml

@@ -4,12 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cloudtoolbox"
-version = "0.2.1"
+version = "0.4.0"
 description = "Toolbox for the cloud."
-readme = {file = "README.md", content-type = "text/markdown"}
-authors = [
-    {name = "Dotz Developers", email = "devs-dotz@dotz.com"},
-]
+readme = { file = "README.md", content-type = "text/markdown" }
+authors = [{ name = "Dotz Developers", email = "devs-dotz@dotz.com" }]
 keywords = ["cloud", "tools", "utilities", "google", "gcp", "amazon", "aws"]
 classifiers = [
     "Operating System :: OS Independent",
@@ -33,24 +31,16 @@ Repository = "https://github.com/DotzInc/cloud-toolbox"
 [project.optional-dependencies]
 amazon = ["boto3"]
 google = ["google-cloud-pubsub", "google-cloud-storage"]
-all = [
-    "boto3",
-    "google-cloud-pubsub",
-    "google-cloud-storage",
-]
+all = ["boto3", "google-cloud-pubsub", "google-cloud-storage"]
 
 [tool.ruff]
-exclude = [
-    ".git",
-    ".venv",
-    ".ruff_cache",
-]
+exclude = [".git", ".venv", ".ruff_cache"]
 
 line-length = 100
 indent-width = 4
 
 [tool.ruff.lint]
-select = ["E", "W", "F", "I", "B", "C4", "UP","ARG001"]
+select = ["E", "W", "F", "I", "B", "C4", "UP", "ARG001"]
 ignore = ["E402", "E501", "W191", "B904"]
 fixable = ["ALL"]
 unfixable = []

{cloudtoolbox-0.2.1 → cloudtoolbox-0.4.0}/tests/test_factory.py

@@ -4,7 +4,7 @@ from unittest import mock
 from cloud import factory
 from cloud.amazon import s3, sns, sqs
 from cloud.google import pubsub, storage
-from cloud.protocols import MessagePublisher, StorageUploader
+from cloud.protocols import MessagePublisher, StorageDownloader, StorageUploader, StorageURLSigner
 
 
 class NotStorageUploader:
@@ -12,6 +12,26 @@ class NotStorageUploader:
         pass
 
 
+class NotStorageDownloader:
+    def download_file(self):
+        pass
+
+
+class NotStorageURLSigner:
+    def sign_url(self):
+        pass
+
+
+class DummyStorageURLSigner:
+    def generate_presigned_url(
+        self,
+        bucket_name: str,
+        source_filename: str,
+        expiration: int,
+    ) -> str:
+        return ""
+
+
 class NotMessagePublisher:
     def send_message(self):
         pass
@@ -41,6 +61,45 @@ class TestStorageUploaderFactory(unittest.TestCase):
             factory.storage_uploader(NotStorageUploader)  # type: ignore
 
 
+class TestStorageDownloaderFactory(unittest.TestCase):
+    @mock.patch("google.cloud.storage.Client")
+    def test_google_downloader(self, _):
+        Downloader = factory.storage_downloader(storage.Downloader)
+        downloader = Downloader()
+
+        self.assertIsInstance(downloader, StorageDownloader)
+        self.assertIsInstance(downloader, storage.Downloader)
+
+    @mock.patch("boto3.client")
+    def test_amazon_downloader(self, _):
+        Downloader = factory.storage_downloader(s3.Downloader)
+        downloader = Downloader()
+
+        self.assertIsInstance(downloader, StorageDownloader)
+        self.assertIsInstance(downloader, s3.Downloader)
+
+    def test_downloader_protocol_validation(self):
+        error = "NotStorageDownloader does not implement StorageDownloader protocol"
+
+        with self.assertRaisesRegex(AssertionError, error):
+            factory.storage_downloader(NotStorageDownloader)  # type: ignore
+
+
+class TestStorageURLSigner(unittest.TestCase):
+    def test_urlsigner(self):
+        URLSigner = factory.storage_urlsigner(DummyStorageURLSigner)
+        urlsigner = URLSigner()
+
+        self.assertIsInstance(urlsigner, StorageURLSigner)
+        self.assertIsInstance(urlsigner, DummyStorageURLSigner)
+
+    def test_urlsigner_protocol_validation(self):
+        error = "NotStorageURLSigner does not implement StorageURLSigner protocol"
+
+        with self.assertRaisesRegex(AssertionError, error):
+            factory.storage_urlsigner(NotStorageURLSigner)  # type: ignore
+
+
 class TestMessagePublisherFactory(unittest.TestCase):
     @mock.patch("google.cloud.pubsub_v1.PublisherClient")
     def test_google_publisher(self, _):

cloudtoolbox-0.2.1/cloud/amazon/s3.py

@@ -1,11 +0,0 @@
-from typing import Any
-
-import boto3
-
-
-class Uploader:
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        self.client = boto3.client("s3", *args, **kwargs)
-
-    def upload(self, bucket_name: str, destination_filename: str, source_filename: str) -> None:
-        self.client.upload_file(source_filename, bucket_name, destination_filename)

cloudtoolbox-0.2.1/cloud/factory.py

@@ -1,29 +0,0 @@
-from typing import Any, Callable, Type
-
-from cloud.protocols import MessagePublisher, StorageUploader
-
-error_message = "%(class)s does not implement %(protocol)s protocol"
-
-
-def storage_uploader(
-    uploader_class: Type[StorageUploader], *args: Any, **kwargs: Any
-) -> Callable[[], StorageUploader]:
-    error = error_message % {"class": uploader_class.__name__, "protocol": "StorageUploader"}
-    assert issubclass(uploader_class, StorageUploader), error
-
-    def maker() -> StorageUploader:
-        return uploader_class(*args, **kwargs)
-
-    return maker
-
-
-def message_publisher(
-    publisher_class: Type[MessagePublisher], *args: Any, **kwargs: Any
-) -> Callable[[], MessagePublisher]:
-    error = error_message % {"class": publisher_class.__name__, "protocol": "MessagePublisher"}
-    assert issubclass(publisher_class, MessagePublisher), error
-
-    def maker() -> MessagePublisher:
-        return publisher_class(*args, **kwargs)
-
-    return maker

cloudtoolbox-0.2.1/cloud/google/storage.py

@@ -1,13 +0,0 @@
-from typing import Any
-
-from google.cloud import storage
-
-
-class Uploader:
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        self.client = storage.Client(*args, **kwargs)
-
-    def upload(self, bucket_name: str, destination_filename: str, source_filename: str) -> None:
-        bucket = self.client.bucket(bucket_name)
-        blob = bucket.blob(destination_filename)
-        blob.upload_from_filename(source_filename)

cloudtoolbox-0.2.1/cloud/protocols.py

@@ -1,11 +0,0 @@
-from typing import Any, Protocol, runtime_checkable
-
-
-@runtime_checkable
-class StorageUploader(Protocol):
-    def upload(self, bucket_name: str, destination_filename: str, source_filename: str) -> None: ...
-
-
-@runtime_checkable
-class MessagePublisher(Protocol):
-    def publish(self, recipient: str, message: str, **attrs: Any) -> None: ...