boto3-assist 0.32.0__py3-none-any.whl

boto3_assist/s3/s3.py

@@ -0,0 +1,64 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional, cast
+
+from aws_lambda_powertools import Logger
+
+from boto3_assist.s3.s3_connection import S3Connection
+from boto3_assist.s3.s3_object import S3Object
+from boto3_assist.s3.s3_bucket import S3Bucket
+
+logger = Logger(child=True)
+
+
+class S3(S3Connection):
+    """Common S3 Actions"""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        """_summary_
+
+        Args:
+            aws_profile (Optional[str], optional): _description_. Defaults to None.
+            aws_region (Optional[str], optional): _description_. Defaults to None.
+            aws_end_point_url (Optional[str], optional): _description_. Defaults to None.
+            aws_access_key_id (Optional[str], optional): _description_. Defaults to None.
+            aws_secret_access_key (Optional[str], optional): _description_. Defaults to None.
+        """
+        super().__init__(
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_end_point_url=aws_end_point_url,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+        )
+
+        self.__s3_object: S3Object | None = None
+        self.__s3_bucket: S3Bucket | None = None
+
+    @property
+    def object(self) -> S3Object:
+        """s3 object"""
+        if self.__s3_object is None:
+            connection = cast(S3Connection, self)
+            self.__s3_object = S3Object(connection)
+        return self.__s3_object
+
+    @property
+    def bucket(self) -> S3Bucket:
+        """s3 bucket"""
+        if self.__s3_bucket is None:
+            connection = cast(S3Connection, self)
+            self.__s3_bucket = S3Bucket(connection)
+        return self.__s3_bucket

boto3_assist/s3/s3_bucket.py

@@ -0,0 +1,67 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Any, Dict
+
+from aws_lambda_powertools import Logger
+from botocore.exceptions import ClientError
+
+
+from boto3_assist.s3.s3_connection import S3Connection
+
+logger = Logger(child=True)
+
+
+class S3Bucket:
+    """Common S3 Actions"""
+
+    def __init__(self, connection: S3Connection):
+        self.connection = connection or S3Connection()
+
+    def create(self, *, bucket_name: str) -> Dict[str, Any]:
+        """
+        Create an S3 bucket
+        :param bucket_name: Bucket to create
+        :return: True if bucket is created, else False
+        """
+        try:
+            response = self.connection.client.create_bucket(Bucket=bucket_name)
+            logger.info(f"Bucket {bucket_name} created")
+
+            return dict(response)
+        except ClientError as e:
+            logger.exception(e)
+            raise e
+
+    def enable_versioning(self, *, bucket_name: str) -> None:
+        """
+        Enable versioning on an S3 bucket
+        :param bucket_name: Bucket to enable versioning on
+        :return: None
+        """
+        try:
+            self.connection.client.put_bucket_versioning(
+                Bucket=bucket_name, VersioningConfiguration={"Status": "Enabled"}
+            )
+            logger.info(f"Versioning enabled on bucket {bucket_name}")
+        except ClientError as e:
+            logger.exception(e)
+            raise e
+
+    def disable_versioning(self, *, bucket_name: str) -> None:
+        """
+        Disable versioning on an S3 bucket
+        :param bucket_name: Bucket to disable versioning on
+        :return: None
+        """
+        try:
+            self.connection.client.put_bucket_versioning(
+                Bucket=bucket_name, VersioningConfiguration={"Status": "Suspended"}
+            )
+            logger.info(f"Versioning disabled on bucket {bucket_name}")
+        except ClientError as e:
+            logger.exception(e)
+            raise e

boto3_assist/s3/s3_connection.py

@@ -0,0 +1,76 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional
+from typing import TYPE_CHECKING
+
+from aws_lambda_powertools import Logger
+
+from boto3_assist.connection import Connection
+
+if TYPE_CHECKING:
+    from mypy_boto3_s3 import S3Client, S3ServiceResource
+else:
+    S3Client = object
+    S3ServiceResource = object
+
+
+logger = Logger()
+
+
+class S3Connection(Connection):
+    """Connection"""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        super().__init__(
+            service_name="s3",
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            aws_end_point_url=aws_end_point_url,
+        )
+
+        self.__client: S3Client | None = None
+        self.__resource: S3ServiceResource | None = None
+
+    @property
+    def client(self) -> S3Client:
+        """Client Connection"""
+        if self.__client is None:
+            self.__client = self.session.client
+
+        return self.__client
+
+    @client.setter
+    def client(self, value: S3Client):
+        logger.info("Setting Client")
+        self.__client = value
+
+    @property
+    def resource(self) -> S3ServiceResource:
+        """Resource Connection"""
+        if self.__resource is None:
+            logger.info("Creating Resource")
+            self.__resource = self.session.resource
+
+        if self.raise_on_error and self.__resource is None:
+            raise RuntimeError("Resource is not available")
+
+        return self.__resource
+
+    @resource.setter
+    def resource(self, value: S3ServiceResource):
+        logger.info("Setting Resource")
+        self.__resource = value

boto3_assist/s3/s3_event_data.py

@@ -0,0 +1,168 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Dict, Any, List
+from boto3_assist.utilities.numbers_utility import NumberUtility
+
+
+class EventData:
+    """An Event Data Object"""
+
+    def __init__(self, event: Dict[str, Any]):
+        self.__event = event
+
+    @property
+    def version(self) -> str | None:
+        """Event Version"""
+        return self.__event.get("version")
+
+    @property
+    def id(self) -> str | None:
+        """Event Id"""
+        return self.__event.get("id")
+
+    @property
+    def detail_type(self) -> str | None:
+        """Event Detail Type"""
+        return self.__event.get("detail-type")
+
+    @property
+    def source(self) -> str | None:
+        """Event Source"""
+        return self.__event.get("source")
+
+    @property
+    def account(self) -> str | None:
+        """Event Account"""
+        return self.__event.get("account")
+
+    @property
+    def time(self) -> str | None:
+        """Event Time"""
+        return self.__event.get("time")
+
+    @property
+    def region(self) -> str | None:
+        """Event Region"""
+        return self.__event.get("region")
+
+    @property
+    def resources(self) -> List[str]:
+        """Event Resources"""
+        return self.__event.get("resources", [])
+
+
+class S3BucketData:
+    """S3 Bucket Data"""
+
+    def __init__(self, bucket_event_data: Dict[str, Any]):
+        self.__bucket = bucket_event_data
+
+    @property
+    def name(self) -> str | None:
+        """Bucket Name Key"""
+
+        return self.__bucket.get("name")
+
+
+class S3ObjectData:
+    """S3 Object"""
+
+    def __init__(self, object_data: Dict[str, Any]):
+        self.__s3_object_data = object_data
+
+    @property
+    def key(self) -> str | None:
+        """Object Key"""
+        return self.__s3_object_data.get("key")
+
+    @property
+    def size(self) -> int:
+        """Object size in bytes"""
+        size = NumberUtility.to_number(self.__s3_object_data.get("size"))
+        return size
+
+    @property
+    def etag(self) -> str | None:
+        """Object eTag"""
+        return self.__s3_object_data.get("etag")
+
+    @property
+    def version_id(self) -> str | None:
+        """Object Version Id"""
+        return self.__s3_object_data.get("version-id")
+
+    @property
+    def sequencer(self) -> str | None:
+        """Object eTag"""
+        return self.__s3_object_data.get("sequencer")
+
+
+class S3EventDetail:
+    """The Event Detail"""
+
+    def __init__(self, event: Dict[str, Any]):
+        self.__event = event
+        self.__s3_object_data: S3ObjectData | None = None
+        self.__s3_bucket_data: S3BucketData | None = None
+
+    @property
+    def version(self) -> str | None:
+        """Object Key"""
+
+        return self.__event.get("version")
+
+    @property
+    def bucket(self) -> S3BucketData:
+        """S# Bucket Information"""
+        if not self.__s3_bucket_data:
+            self.__s3_bucket_data = S3BucketData(self.__event.get("bucket", {}))
+        return self.__s3_bucket_data
+
+    @property
+    def object(self) -> S3ObjectData:
+        """S3 Object Information"""
+        if not self.__s3_object_data:
+            self.__s3_object_data = S3ObjectData(self.__event.get("object", {}))
+
+        return self.__s3_object_data
+
+    @property
+    def request_id(self) -> str | None:
+        """Detail Request Id"""
+
+        return self.__event.get("request-id")
+
+    @property
+    def requester(self) -> str | None:
+        """Detail Requestor"""
+
+        return self.__event.get("requester")
+
+    @property
+    def source_ip_address(self) -> str | None:
+        """Source IP Address"""
+
+        return self.__event.get("source-ip-address")
+
+    @property
+    def reason(self) -> str | None:
+        """Reason"""
+
+        return self.__event.get("reason")
+
+
+class S3Event(EventData):
+    """S3 Data Event"""
+
+    def __init__(self, event):
+        super().__init__(event)
+        self.__detail: S3EventDetail = S3EventDetail(event=event.get("detail", {}))
+
+    @property
+    def detail(self) -> S3EventDetail:
+        """S3 Specific Detail"""
+        return self.__detail