Merge pull request #7 from py-package/feature/s3

Added S3 Feature

Author: yubarajshrestha

CONTRIBUTING.md

@@ -14,7 +14,7 @@
   <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 </p>
 
-# Masonite Backup (WIP)
+# Masonite Backup
 
 Backup solution for Masonite.
 
@@ -24,7 +24,7 @@ Backup solution for Masonite.
 - [x] Backup Files
 - [x] Store Backup Locally in the filesystem
 - [x] Email Backup
-- [ ] Store Backup in other Masonite Supported Storage Drivers [s3]
+- [x] Store Backup in other Masonite Supported Storage Drivers [s3]
 
 
 ### Installation
@@ -78,11 +78,12 @@ SOURCE = {
     ],
 }
 
+S3_BACKUP = False # Whether or not to backup to S3.
 EMAIL_BACKUP = False  # Whether or not to email the backup.
 EMAIL_BACKUP_TO = ""  # The email address to send the backup to.
 EMAIL_SUBJECT = "System Backup"  # The email subject.
 ```
-> Note: Make sure you have `EMAIL_BACKUP` set to `True` and `EMAIL_BACKUP_TO` set to a valid email address, to send the backup via email. Also don't forget to setup SMTP in `config/mail.py` configuration file or in `.env` file.
+> Note: Make sure you have `EMAIL_BACKUP` set to `True` and `EMAIL_BACKUP_TO` set to a valid email address, to send the backup via email. Also don't forget to setup SMTP in `config/mail.py` configuration file or in `.env` file. In case you want to backup to S3, then make sure you have `S3_BACKUP` set to `True` and S3 storage configuration.
 
 ```sh
 MAIL_DRIVER=smtp
@@ -91,6 +92,11 @@ MAIL_HOST=
 MAIL_PORT=
 MAIL_USERNAME=
 MAIL_PASSWORD=
+
+AWS_CLIENT=
+AWS_SECRET=
+AWS_BUCKET=
+AWS_REGION=
 ```
 
 **Backup Database and Files**
@@ -111,17 +117,7 @@ python craft backup:run --only-db
 python craft backup:run --only-files
 ```
 
-
-## Contributing
-
-Please read the [Contributing Documentation](CONTRIBUTING.md) here.
-
-## Maintainers
-
-- [x] [Yubaraj Shrestha](https://www.github.com/py-package)
-
 ## License
 
-
 Backup is open-sourced software licensed under the [MIT license](LICENSE).
 

README.md

@@ -8,7 +8,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version="0.0.3",
+    version="0.0.4",
     packages=[
         "backup",
         "backup.commands",

setup.py

@@ -101,14 +101,15 @@ def files(self):
 
         return f"{self.archive_file_path}.zip"
 
-    def email(self):
+    def email(self, info):
         """
         Email the backup.
         """
 
         if not self.backup_config.get("email_backup", False):
             return
 
+        info("Sending backup to email")
         if self.archive_file_path != None and pathlib.Path(f"{self.archive_file_path}.zip").exists():
             Mail.mailable(
                 BackupMailable().attach(f"System Backup.zip", f"{self.archive_file_path}.zip")
@@ -120,7 +121,24 @@ def email(self):
                 BackupMailable().attach(f"Database Backup.{ext}", self.db_file_path)
             ).send()
 
-        self.cleanup()
+    def s3(self, info):
+        """
+        Upload the backup to S3.
+        """
+        if not self.backup_config.get("s3_backup", False):
+            return
+
+        info("Uploading backup to S3")
+        if self.archive_file_path != None and pathlib.Path(f"{self.archive_file_path}.zip").exists():
+            self.app.make("storage").disk("s3").put(
+                f"System Backup.zip", f"{self.archive_file_path}.zip"
+            )
+
+        if self.db_file_path != None and pathlib.Path(self.db_file_path).exists():
+            ext = self.db_file_path.split(".")[-1]
+            self.app.make("storage").disk("s3").put(
+                f"Database Backup.{ext}", self.db_file_path
+            )
 
     def cleanup(self):
         """

src/backup/Backup.py

@@ -40,7 +40,10 @@ def handle(self):
             os.remove(self.database_file_path)
             self.database_file_path = None
 
-        backup.email()
+        backup.email(self.info)
+        backup.s3(self.info)
+        backup.cleanup()
+
         self.info("============ Backup complete ============")
 
     def validate_options(self):

src/backup/commands/BackupRunCommand.py

@@ -24,6 +24,7 @@
         "__pycache__",
     ],
 }
+S3_BACKUP = False  # Whether or not to backup in S3.
 EMAIL_BACKUP = False  # Whether or not to email the backup.
 EMAIL_BACKUP_TO = ""  # The email address to send the backup to.
 EMAIL_SUBJECT = "System Backup"  # The email subject.