ops_backups 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f1ef117c4c1f91b7ca59eba0f0a27d2387b2f69c7d9f5022d1306c145d19eb
-  data.tar.gz: 1c479131ca94764b617a99cb8ea9896596ceda64aadc7a3281acbbca86286471
+  metadata.gz: 5998e71c3bda4e80392ef2d50e3be95280b5927bb961ab8e3a1d9a614b7788f7
+  data.tar.gz: 8d066ea20d375d5da4156c3f7f1211c67ad6e08604a6e9c5ea1b72c028e3abfc
 SHA512:
-  metadata.gz: e8da64fbec202205ff7771d222b26b4c1513467e2001f4d4997bc7f7f18e66390743ade3a68b253e684a67fcb58233d3c58c34e824e1ab528ade2260a0b9c252
-  data.tar.gz: 5246ea35123d5b4aa7748362b1ee89915450d56a433cfa1f62df9089081c62d63a8551ce6361d103d761096eb5564eb053ed8fcb15d9b96a7aa45b283e816fca
+  metadata.gz: 9b586429bfbba9fbdb3c354743ffb51c2b197afa9ab61367c90cb1d67959bc928ef8b969e8846a43becf58e488e4e999e55dc75fef8a9607e7892ef5b7dd1324
+  data.tar.gz: 20a218a19b9be0a87bdbf5c688c914e1a3083a6e64ec8e94438abe7f174012e15913d23764f3f041d42e0e9bf9c11772d23ed5cacd3157453ecee9cd7ec76ee4

data/README.md

@@ -1,28 +1,35 @@
 # OpsBackups
-Short description and motivation.
+
+A Ruby gem that provides a simple way to backup (self)-hosted postgres databases to
+ActiveStorage services like S3, Google Cloud Storage, etc.
 
 ## Usage
-How to use my plugin.
 
 ## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem "ops_backups"
-```
 
-And then execute:
 ```bash
-$ bundle
+bundle add ops_backups
+# install migrations
+# configure solid queu recurring job for a basic backup
+rails generate ops_backups:install
 ```
 
-Or install it yourself as:
+# ActiveAdmin Integration
+
+If you are using ActiveAdmin, you can manage your backups through the admin interface. The generator rails generate ops_backups:activeadmin will create the necessary example configuration.
+
 ```bash
-$ gem install ops_backups
+# add an active admin resource
+rails generate ops_backups:activeadmin
 ```
 
-## Contributing
-Contribution directions go here.
+## Available Actions
+
+- Download Backup: Download the backup file.
+- Create Versioned Backup: Create a new versioned backup.
+- Create Unversioned Backup: Create a new unversioned backup, excluding specific tables.
+
+
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/jobs/ops_backups/backup_db_job.rb

@@ -8,8 +8,11 @@ class OpsBackups::BackupDbJob < ApplicationJob
   # @param tag [String] the tag to assign to the backup
   # @param exclude_tables [Array<String>] the list of tables to exclude from the backup
   # @param cleanup_policy [String] the cleanup policy to apply to the backup, one of "retain_tiered_cleanup_policy" or "retain_last_limit_cleanup_policy"
-  def perform(tag: "db_pg_full", exclude_tables: [], cleanup: nil)
-    Ops::Backup.new.db_pg_backup(tag:, exclude_tables:)
-    Ops::Backup.send("#{cleanup}_cleanup_policy", tag: tag) if cleanup.present?
+  def perform(options = {})
+    exclude_tables = options[:exclude_tables] || []
+    tag = options[:tag] || (exclude_tables.empty? ? "db_pg_full" : "db_pg_partial")
+    cleanup = options[:cleanup]
+    OpsBackups::Backup.new.db_pg_backup(exclude_tables:, tag:)
+    OpsBackups::Backup.send("#{cleanup}_cleanup_policy", tag: tag) if cleanup.present?
   end
 end

data/app/jobs/ops_backups/cleanup_limit_job.rb

@@ -10,6 +10,6 @@ class OpsBackups::CleanupLimitJob < ApplicationJob
   #
   # @example Tasks::CleanupLimit.perform_now(tag: "db_pg_full", limit: 14)
   def perform(tag: "db_pg_full", limit: 14)
-    Ops::Backup.retain_last_limit_cleanup_policy(tag: tag, limit: limit)
+    OpsBackups::Backup.retain_last_limit_cleanup_policy(tag: tag, limit: limit)
   end
 end

data/app/jobs/ops_backups/cleanup_tiered_job.rb

@@ -9,6 +9,6 @@ class OpsBackups::CleanupTieredJob < ApplicationJob
   #
   # @example Tasks::CleanupTiered.perform_now(tag: "db_pg_full")
   def perform(tag: "db_pg_full")
-    Ops::Backup.retain_tiered_cleanup_policy(tag: tag)
+    OpsBackups::Backup.retain_tiered_cleanup_policy(tag: tag)
   end
 end

data/app/models/ops_backups/backup.rb

@@ -1,23 +1,36 @@
 module OpsBackups
-  class Backup < ApplicationRecord
+  class Backup < ActiveRecord::Base
     # has_one_attached :backup_file, service: :backup_storage
     has_one_attached :backup_file, service: :backups
     self.table_name = "ops_backups"
 
     default_scope { order(updated_at: :desc) }
 
-    def db_pg_backup(exclude_tables: [], tag: nil)
-      tag ||= exclude_tables.empty? ? "db_pg_full" : "db_pg_partial"
-      Rails.logger.info("Backing up database, skipping tables: \#{exclude_tables.join(", ")}")
+    def self.ransackable_attributes(auth_object = nil)
+      [ "created_at", "id", "name", "new_id", "tag", "updated_at" ]
+    end
+
+    def self.test
+      "self.test"
+    end
+
+    def hoho
+      "hihi"
+    end
+
+    def db_pg_backup(tag: nil, exclude_tables: [])
       db_url = ENV["DATABASE_URL"]
+      tag ||= exclude_tables.empty? ? "db_pg_full" : "db_pg_partial" # if tag.empty?
       self.tag = tag
-      self.name = filename = "pg_\#{db_url.split('/').last}_backup_\#{Time.now.to_i}.dump"
+      self.name = "pg_#{db_url.split('/').last}_backup_#{Time.now.to_i}.dump"
       save!
-
-      Tempfile.new("pgbackup") do |tempfile|
+      Rails.logger.info("Backing up database")
+      # exclude_tables = []
+      filename = self.name
+      Tempfile.open("pgbackup") do |tempfile|
         begin
           excluded_tables_param = exclude_tables.map { |table| "--exclude-table-data=\#{table}" }.join(" ")
-          command = ["pg_dump", "--no-owner", excluded_tables_param, "-v", "-Fc", "-f", tempfile.path, db_url]
+          command = [ "pg_dump", "--no-owner", excluded_tables_param, "-v", "-Fc", "-f", tempfile.path, db_url ].reject(&:empty?)
 
           stdout, stderr, status = Open3.capture3(*command)
 

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+---
+en:
+  admin:
+    ops:
+      backup: "Backup"
+      backup_scheduled: "Backup scheduled"
+      backup_db: "Backup database"

data/lib/generators/ops_backups/activeadmin/activeadmin_generator.rb

@@ -0,0 +1,10 @@
+class OpsBackups::ActiveadminGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  desc "Copies the ActiveAdmin backup configuration to your application."
+
+  def copy_admin_backup
+    copy_file "backup.rb", Rails.root.join("app", "admin", "ops_backups", "backup.rb")
+    say "Copied admin/backup.rb to app/admin/ops_backups/backup.rb.", :green
+  end
+end

data/lib/generators/ops_backups/activeadmin/templates/backup.rb

@@ -0,0 +1,42 @@
+ActiveAdmin.register OpsBackups::Backup do
+  menu parent: "Ops", label: I18n.t("admin.ops.backup")
+
+  # Set the default sort order
+  config.sort_order = "updated_at DESC"
+
+  actions :index, :destroy
+
+  filter :name
+  filter :tag
+
+  index title: I18n.t("admin.ops.backup") do
+    selectable_column
+    column :name do |backup|
+      link_to(backup.name, download_backup_admin_ops_backups_backup_path(backup), class: "member_link")
+    end
+    column :tag
+    column :size do |backup|
+      backup.backup_file.attached? ? number_to_human_size(backup.backup_file.byte_size) : "N/A"
+    end
+    column :updated_at
+    column :duration do |backup|
+      Time.at((backup.updated_at - backup.created_at)).utc.strftime("%H:%M:%S")
+    end
+    actions
+  end
+
+  member_action :download_backup, method: :get do
+    redirect_to resource.backup_file.url(disposition: :attachment), allow_other_host: true
+  end
+
+  # an action that creates a new backup
+  collection_action :backup_db, method: :post do
+    OpsBackups::BackupDbJob.perform_later(tag: "db_pg_full")
+    redirect_to admin_ops_backups_backups_path, notice: I18n.t("admin.ops.backup_scheduled")
+  end
+
+  # add a button to the top of the index page
+  action_item :backup_db, only: :index do
+    link_to(I18n.t("admin.ops.backup_db"), backup_db_admin_ops_backups_backups_path, method: :post, class: "action-item-button")
+  end
+end

data/lib/generators/ops_backups/install/install_generator.rb

@@ -35,7 +35,7 @@ class OpsBackups::InstallGenerator < Rails::Generators::Base
     recurring_file = Rails.root.join("config", "recurring.yml")
 
     if File.exist?(recurring_file)
-      recurring_config = <<~YAML.lines.map { |line| "\t#{line}" }.join
+      recurring_config = <<~YAML.lines.map { |line| "  #{line}" }.join
         backup_db:
           class: OpsBackups::BackupDbJob
           args: [tag: "db_pg_backup", cleanup: "retain_tiered_cleanup_policy"]
@@ -47,5 +47,11 @@ class OpsBackups::InstallGenerator < Rails::Generators::Base
     else
       say "config/recurring.yml not found. Please create it and re-run this generator.", :red
     end
+
+    # # copy the admin/backup.rb file to app/admin/ops_backups/backup.rb
+    # def copy_admin_backup
+    #   copy_file "admin/backup.rb", Rails.root.join("app", "admin", "ops_backups", "backup.rb")
+    #   say "Copied admin/backup.rb to app/admin/ops_backups/backup.rb.", :green
+    # end
   end
 end

data/lib/ops_backups/engine.rb

@@ -7,5 +7,9 @@ module OpsBackups
         app.config.paths["db/migrate"].concat(config.paths["db/migrate"].expanded)
       end
     end
+
+    initializer :i18n do |app|
+      app.config.i18n.load_path += Dir[root.join("config", "locales", "**", "*.{rb,yml}")]
+    end
   end
 end

data/lib/ops_backups/version.rb

@@ -1,3 +1,3 @@
 module OpsBackups
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ops_backups
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Koen Handekyn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-17 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,8 +46,11 @@ files:
 - app/models/ops_backups/application_record.rb
 - app/models/ops_backups/backup.rb
 - app/views/layouts/ops_backups/application.html.erb
+- config/locales/en.yml
 - config/routes.rb
 - db/migrate/20241114173612_create_ops_backups.rb
+- lib/generators/ops_backups/activeadmin/activeadmin_generator.rb
+- lib/generators/ops_backups/activeadmin/templates/backup.rb
 - lib/generators/ops_backups/install/USAGE
 - lib/generators/ops_backups/install/install_generator.rb
 - lib/ops_backups.rb