capistrano-ops 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ddd893262d4429b7970dda53b62f8ae613009e3713b81e8498b56b4726ea7a
-  data.tar.gz: d1b64639900679165f62c709b4abd9af51efa22221674370fe084da62b28bc15
+  metadata.gz: d06d07accde331b2e72dc623a092ce83cf4a33760dfaee3526f53ff54e0d31d6
+  data.tar.gz: 333db2173d26102ddab05e8f2f942ad3669be5f4a463814bdf58a68e87e5ff07
 SHA512:
-  metadata.gz: 1c918f70a298064b454f7eae961d7d2ff96aa149329df72ee1f9eefda26bc4bd3d8295845788b8511be7cadbb070bff8d6419466e19219e31f0dd5f11c59feea
-  data.tar.gz: 91acdf541cb7f704320660ee936e8b2261c4172cfb75f10db9d9996c66969aea4ca39b37ab9d1fafa9736ac166b0d6c96c02d8b48e47e20e3d8639fcc5ab72ce
+  metadata.gz: 0465ef4d67b766208461c410ba61282bb09c67902b0c1c6e53f88df9073b89c30f79fbd48954839b758ec32117abf51dfbc3c39adbf841411aecc998024aecff
+  data.tar.gz: 643a104e7f6433399cac617513bfb82326c04717f2a0e623503e9941afa3b6eabd3c582a7081c335be05fcd7a89d1c32ca52629e7ae153721822b48960f9a8be

data/README.md

@@ -1,8 +1,39 @@
-# capistrano-ops
+# capistrano-ops - Comprehensive DevOps Utility for Rails 🛠️
 
-Library of useful scripts for DevOps using capistrano with rails.
+The capistrano-ops gem is a valuable library, tailor-made for Rails DevOps professionals, offering an array of beneficial scripts to streamline and enhance operations with Capistrano. The focus is on seamless integration with Capistrano version 3 and above.
 
-**Only supports Capistrano 3 and above**.
+## Main Features:
+
+🗃️ **Database and Storage Backups:**
+ - Create, pull, and manage backups of your Postgres database and server storage.
+ - Delegation of old backup removal for both Postgres database and server storage.
+
+🛠️ **Configuration Management:**
+ - Compare application.yml files between local and server environments using figaro_yml:compare.
+ - Fetch server environment variables set via Figaro with figaro_yml:get.
+
+📜 **Logging and Task Management:**
+ - Real-time viewing of Rails server logs.
+ - Showcase the server app's crontab generated with the 'whenever' gem.
+ - Ability to invoke server-specific rake tasks.
+
+🔔 **Notification Integrations:**
+ - Set up notifications through Slack or generic Webhooks.
+ - Customize notification levels (info/error).
+
+⚙️ **Backup Settings Customization:**
+ - Define the number of backups retained, both locally and externally.
+ - Toggle backup tasks and external backups.
+ - S3 integration for backup storage, including customization of bucket, region, and endpoint details.
+
+📅 **Schedule Tasks:**
+ - Couple with the 'whenever' gem to schedule daily backup creation and old backup removal.
+
+🔗 **Slack & Webhook Integrations:**
+ - Integrate seamlessly with Slack or use webhooks for notifications, alerting you on essential operations or any potential issues.
+
+☁️ **Backup Providers:**
+ - S3 and other S3-compatible services are supported to ensure your data remains secure and accessible.
 
 ## Requirements
 

data/lib/capistrano/ops/backup/s3.rb

@@ -2,7 +2,9 @@
 
 module Backup
   require 'aws-sdk-s3'
+  require 'capistrano/ops/backup/s3_helper'
   class S3
+    include Backup::S3Helper
     attr_accessor :endpoint, :region, :access_key_id, :secret_access_key, :s3_resource
 
     def initialize(endpoint: ENV['S3_BACKUP_ENDPOINT'], region: ENV['S3_BACKUP_REGION'], access_key_id: ENV['S3_BACKUP_KEY'],
@@ -14,7 +16,9 @@ module Backup
       configuration = {
         region: region,
         access_key_id: access_key_id,
-        secret_access_key: secret_access_key
+        secret_access_key: secret_access_key,
+        force_path_style: true
+
       }
       configuration[:endpoint] = endpoint unless endpoint.nil?
       self.s3_resource = Aws::S3::Resource.new(configuration)
@@ -36,17 +40,30 @@ module Backup
       end
 
       all_items = all_items.sort_by { |hsh| hsh[:last_modified] }.reverse
-
-      count = all_items.count
-
-      if count <= keep
-        puts 'Nothing to remove'
+      months = get_months(all_items)
+      old_months = get_old_months(months)
+      if old_months&.empty? || old_months.nil?
+        puts 'No old months to remove'
+      else
+        old_months.each do |month|
+          items = get_items_by_month(all_items, month)
+          delete_items = get_delete_items(items, 1)
+          puts "Removing #{month} from S3"
+          delete_items.each do |item_obj|
+            puts "Removing #{item_obj[:key]} from S3"
+            s3_resource.bucket(ENV['S3_BACKUP_BUCKET']).object(item_obj[:key]).delete
+          end
+        end
+        puts 'Old months removed from S3'
+      end
+      current_month = get_current_month(all_items)
+      current_month_delete_items = get_delete_items(current_month, keep)
+      if current_month_delete_items&.empty? || current_month_delete_items.nil?
+        puts 'No old backups to remove'
         exit(0)
       end
 
-      delete_items = all_items.slice(keep..-1)
-
-      delete_items.each do |item_obj|
+      current_month_delete_items.each do |item_obj|
         puts "Removing #{item_obj[:key]} from S3"
         s3_resource.bucket(ENV['S3_BACKUP_BUCKET']).object(item_obj[:key]).delete
       end

data/lib/capistrano/ops/backup/s3_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Backup
+  module S3Helper
+    def get_delete_items(items, keep)
+      items.slice(keep..-1)
+    end
+
+    def get_months(all_items)
+      all_items.reverse.map { |m| m[:last_modified].strftime('%Y-%m') }
+    end
+
+    def get_old_months(months)
+      months.uniq.reject { |m| m == Time.now.strftime('%Y-%m') }
+    end
+
+    def get_current_month(all_items)
+      all_items.select { |item| item[:last_modified].strftime('%Y-%m') == Time.now.strftime('%Y-%m') }
+    end
+
+    def get_items_by_month(all_items, month)
+      all_items.select { |item| item[:last_modified].strftime('%Y-%m') == month }
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/backup/backup_helper.rb

@@ -12,7 +12,7 @@ module BackupHelper
 
   def download_backup(backup_file, type)
     puts "Downloading #{type} backup"
-    download! "#{shared_path}/backups/#{backup_file}" , backup_file
+    download! "#{shared_path}/backups/#{backup_file}", backup_file
     puts "Download finished\nDeleting temporary backup..."
     cleanup_backup(backup_file, "Download finished\nDeleting temporary backup...")
   end

data/lib/capistrano/ops/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Ops
-    VERSION = '0.2.8'
+    VERSION = '0.2.9'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ops
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -118,6 +118,7 @@ files:
 - lib/capistrano/ops/backup.rb
 - lib/capistrano/ops/backup/api.rb
 - lib/capistrano/ops/backup/s3.rb
+- lib/capistrano/ops/backup/s3_helper.rb
 - lib/capistrano/ops/capistrano.rb
 - lib/capistrano/ops/capistrano/v3/tasks/backup.rake
 - lib/capistrano/ops/capistrano/v3/tasks/backup/backup_helper.rb
@@ -162,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: devops tasks for rails applications