heroku_s3_backups 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30af0c9bc6a1781af32673bd76b0c09b13f557e8036bd2e1adde45b4a740bc6d
-  data.tar.gz: 5a7044c7662fa60119f4ec3cbc0093041ed107ba7752723fc781746b2c756dcb
+  metadata.gz: 578895ea7218009155fa1a62a6e3ff32831216daeb1e9257f08376e5c1d70806
+  data.tar.gz: e40f81575e440ee42392aa1ee6eb188b846af8f1412b62c17c1969057ba73a54
 SHA512:
-  metadata.gz: 4647e5deba4cabe9c4cb29415e2411fbf0502282ba6d910ffda663ed226d1f6c508b68a45a949405221d962cbaabd6a8af142c18a2cd220fefe9e40a52c7c532
-  data.tar.gz: 6940c24f0149ec6f799228df2f1c89ea02d19a8daaf54f5cfd7316ebb273a3f72503565f0b829abd303eb1f7094901e9d73da325b8265d0294d508030fdd8a9d
+  metadata.gz: cd5a6302f00153dbc489363f1215b042ee636b61e6ffde429ee5b40928bc7869eb9485f4c494c99ecb665f8a668f7e75fd3b8133107cf8fecc252516715b3067
+  data.tar.gz: 3e78db9b20ca4dfad706d72b8f7dfaa1df60bb9de6a36e95990e4fdee96cb9674af4d7b8d1a0259754832b476c1306fbffbfc70ac721cc32f54c410b1578f513

data/README.md

@@ -46,7 +46,7 @@ HEROKU_API_KEY="1234-abcd"
 ```
 
 To run:
-`HerokuS3Backups::Heroku.new("name-of-application").backup("path/to/backup/folder")`
+`HerokuS3Backups::Heroku.new("name-of-application").backup_to_s3("path/to/backup/folder")`
 
 If you're running this in a Heroku application, ensure that you have the [Heroku Buildpack CLI](https://github.com/heroku/heroku-buildpack-cli) installed.
 

data/lib/heroku_s3_backups.rb

@@ -10,47 +10,77 @@ module HerokuS3Backups
     # @return nil
     def initialize(app_name)
       @app_name = app_name
+      @backup_filename = nil
     end
 
+    # Backup Heroku DB to S3
+    # Valid options:
+    # => {boolean} capture - If true, capture a new backup at the current point in
+    #    time. Otherwise, we'll just download the latest backup
     # @param {hash} options
     # @return nil
     def backup_to_s3(backup_location, options = { capture: true })
 
       # Capture backups if toggled
-      HerokuCLI.cmd("pg:backups:capture", @app_name) if options[:capture]
+      capture if options[:capture]
 
-      # Generate the filename for the backup
-      backup_filename = generate_backup_name
+      # Download the latest backup from Heroku and store it on S3
+      generate_backup_filename
+      download(@backup_filename)
+      store_on_s3(backup_location)
 
-      # Download the latest backup
-      # TODO: Be more explicit about which DB to download
-      HerokuCLI.cmd("pg:backups:download --output #{backup_filename}", @app_name)
+      # Remove the backup from the local system
+      remove_backup(@backup_filename)
+    end
+
+    # Creates a new Heroku backup for a particular moment in time
+    # Valid options:
+    # => {boolean} maintenance_mode - If true, set the application to go into
+    #    maintenance mode to prevent further interaction until the capture is
+    #    complete
+    # @param {hash} options
+    # @return nil
+    def capture(options = { maintenance_mode: false })
+      # Enable maintenance mode if set
+      HerokuCLI.cmd("maintenance:on", @app_name) if options[:maintenance_mode]
 
-      store_on_s3(backup_location, backup_filename)
+      HerokuCLI.cmd("pg:backups:capture", @app_name)
 
-      # Remove the backup from the system
-      system("rm #{backup_filename}")
+      # Turn off maintenance mode once capture is complete
+      HerokuCLI.cmd("maintenance:off", @app_name) if options[:maintenance_mode]
+    end
+
+    # Download the latest backup
+    # TODO: Be more explicit about which DB to download
+    # @param {string} output_filename
+    def download(output_filename)
+      raise "Please specify a filename" if output_filename.length.eql?(0)
+      HerokuCLI.cmd("pg:backups:download --output #{output_filename}", @app_name)
     end
 
     private
 
+    def remove_backup
+      system("rm #{@backup_filename}")
+      @backup_filename = nil
+    end
+
     # Stores the recently backed up file in a specified S3 bucket
     # @param {string} backup_location
-    # @param {string} backup_filename
     def store_on_s3(backup_location, backup_filename)
       prod_backup_folder = AWS_S3().buckets.find(ENV["S3_PRODUCTION_BACKUP_BUCKET"]).objects(prefix: backup_location)
 
       backup_obj = prod_backup_folder.build("#{backup_location}/#{backup_filename}")
 
       # Need to do this to set content length for some reason
-      backup_obj.content = open(backup_filename)
+      backup_obj.content = open(@backup_filename)
 
       backup_obj.save
     end
 
-    def generate_backup_name
+    def generate_backup_filename
       curr_time = Time.now.strftime("%Y-%m-%d_%H%M%S")
-      "backup_#{curr_time}.dump"
+      @backup_filename = "backup_#{curr_time}.dump"
     end
 
     # Instantiates a new S3 service using the provided credentials

data/lib/heroku_s3_backups/version.rb

@@ -1,3 +1,3 @@
 module HerokuS3Backups
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_s3_backups
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - joerodrig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler