ops_backups 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11d46d1083b3b1b45c330e4b74db480d82d80ebd49356a74934dd63409f2c01
-  data.tar.gz: d41344f6c9066beac9ba54ab9e96165fec31b33335b85af0ec26beebf2fba875
+  metadata.gz: e6f1ef117c4c1f91b7ca59eba0f0a27d2387b2f69c7d9f5022d1306c145d19eb
+  data.tar.gz: 1c479131ca94764b617a99cb8ea9896596ceda64aadc7a3281acbbca86286471
 SHA512:
-  metadata.gz: 64d6bb17c0bc7e78cf236d4a2077aa3cbb0cf520576544e8b75c16a9745c19e1b2a4886ad548c8446ac6405f1e366c17873ac540a9ec641e98a45002cf5b4571
-  data.tar.gz: 93ba27887a32e0a361187ef94189c6a574849f65fe5542a0f09fe329c1bfb42121675258ed97a8ce9b85136a9634902028869eb9e945b7c4163307556e3b7150
+  metadata.gz: e8da64fbec202205ff7771d222b26b4c1513467e2001f4d4997bc7f7f18e66390743ade3a68b253e684a67fcb58233d3c58c34e824e1ab528ade2260a0b9c252
+  data.tar.gz: 5246ea35123d5b4aa7748362b1ee89915450d56a433cfa1f62df9089081c62d63a8551ce6361d103d761096eb5564eb053ed8fcb15d9b96a7aa45b283e816fca

data/README.md

@@ -1,117 +1,14 @@
-# Ops
-
-## Description
-Ops is a Ruby gem designed to enhance and to backup your PostgreSQL database.
+# OpsBackups
+Short description and motivation.
 
 ## Usage
-
-### Configuration
-
-To configure the Ops gem, you need to set up the following environment variables:
-- `DATABASE_URL`: The URL of the PostgreSQL database to backup.
-
-Set up Active Storage for backups (e.g., Amazon S3 for production). We expect a service named `:backup_storage` to be configured.
-
-```yaml
-backup_storage:
-  service: S3
-  access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
-  secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
-  region: <%= ENV['AWS_REGION'] %>
-  bucket: backups
-```
-### Backup Method
-
-The `Ops::Backup` class provides a method to perform a PostgreSQL database backup:
-
-- `db_pg_backup(exclude_tables: [], tag: nil)`: This method performs a full backup of the database, optionally excluding specified tables. The backup is tagged and saved as an attachment.
-
-example:
-
-```ruby
-Ops::Backup.new.db_pg_backup(exclude_tables: ["versions"], tag: "db_pg_unveresioned")
-```
-
-### Backup Retention Strategies
-
-Ops gem provides two backup retention strategies:
-
-1. **Tiered Cleanup Policy**:
-    - Keeps all backups from the last day.
-    - Keeps the last backup of each day from the last week (except the last day).
-    - Keeps the last backup of each week from the last month (except the last week).
-    - Keeps the last backup of each month before the last month.
-
-    example:
-    ```ruby
-    Ops::CleanupTiered.new.cleanup("db_pg_unversioned")
-    ```
-
-    This policy can be applied using the `Ops::CleanupTieredJob`.
-
-2. **Limit Cleanup Policy**:
-    - Keeps the last N backups, where N is specified by the `limit` parameter.
-
-    example:
-    ```ruby
-    Ops::CleanupLimit.new.cleanup("db_pg_unversioned", limit: 14)
-    ```
-
-    This policy can be applied using the `Ops::CleanupLimitJob`.
-
-### Using SolidQueue Schedule
-
-1. Schedule the backup job using SolidQueue:
-    ```ruby
-    SolidQueue.schedule(Ops::BackupDbJob.new, cron: '0 0 * * *', args: { tag: "db_pg_full", exclude_tables: [], cleanup: "retain_last_limit" }) # This schedules the backup job to run daily at midnight
-    ```
-
-2. Schedule the cleanup job with a tiered policy:
-    ```ruby
-    SolidQueue.schedule(Ops::CleanupTieredJob.new, cron: '0 1 * * *', args: { tag: "db_pg_full" }) # This schedules the tiered cleanup job to run daily at 1 AM
-    ```
-
-3. Schedule the cleanup job with a limit policy:
-    ```ruby
-    SolidQueue.schedule(Ops::CleanupLimitJob.new, cron: '0 2 * * *', args: { tag: "db_pg_full", limit: 14 }) # This schedules the limit cleanup job to run daily at 2 AM
-    ```
-
-### Using `recurring.yml` from SolidQueue
-
-Alternatively, you can configure recurring tasks using `recurring.yml` in your SolidQueue configuration:
-
-1. Create or update the `recurring.yml` file in your application's config directory:
-    ```yaml
-    # filepath: config/recurring.yml
-    backup_db_job:
-      cron: "0 0 * * *"
-      class: "Ops::BackupDbJob"
-      args:
-        tag: "db_pg_full"
-        exclude_tables: []
-        cleanup: "retain_last_limit"
-
-    cleanup_tiered_job:
-      cron: "0 1 * * *"
-      class: "Ops::CleanupTieredJob"
-      args:
-        tag: "db_pg_full"
-
-    cleanup_limit_job:
-      cron: "0 2 * * *"
-      class: "Ops::CleanupLimitJob"
-      args:
-        tag: "db_pg_full"
-        limit: 14
-    ```
-
-
+How to use my plugin.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "ops"
+gem "ops_backups"
 ```
 
 And then execute:
@@ -121,12 +18,11 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install ops
+$ gem install ops_backups
 ```
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/koenhandekyn/ops.
+Contribution directions go here.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/ops_backups/application_controller.rb

@@ -0,0 +1,4 @@
+module OpsBackups
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/{ops → ops_backups}/application_helper.rb

@@ -1,4 +1,4 @@
-module Ops
+module OpsBackups
   module ApplicationHelper
   end
 end

data/app/jobs/ops_backups/application_job.rb

@@ -0,0 +1,4 @@
+module OpsBackups
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/{ops/backups → ops_backups}/backup_db_job.rb

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
-class Ops::Backups::BackupDbJob < ApplicationJob
+class OpsBackups::BackupDbJob < ApplicationJob
   queue_as :operations
 
   # perform a full backup of the database

data/app/jobs/{ops/backups → ops_backups}/cleanup_limit_job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Cleanup job for limit backup policy
-class Ops::Backups::CleanupLimitJob < ApplicationJob
+class OpsBackups::CleanupLimitJob < ApplicationJob
   queue_as :operations
 
   # @param [String] tag

data/app/jobs/{ops/backups → ops_backups}/cleanup_tiered_job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Cleanup job for tiered backup policy
-class Ops::Backups::CleanupTieredJob < ApplicationJob
+class OpsBackups::CleanupTieredJob < ApplicationJob
   queue_as :operations
 
   # @param [String] tag

data/app/mailers/ops_backups/application_mailer.rb

@@ -0,0 +1,6 @@
+module OpsBackups
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/ops_backups/application_record.rb

@@ -0,0 +1,5 @@
+module OpsBackups
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/{ops/backups → ops_backups}/backup.rb

@@ -1,9 +1,8 @@
-module Ops
-  puts "Ops module loaded"
-
-  class Ops::Backups::Backup < ApplicationRecord
+module OpsBackups
+  class Backup < ApplicationRecord
     # has_one_attached :backup_file, service: :backup_storage
-    has_one_attached :backup_file
+    has_one_attached :backup_file, service: :backups
+    self.table_name = "ops_backups"
 
     default_scope { order(updated_at: :desc) }
 

data/app/views/layouts/{ops → ops_backups}/application.html.erb

@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Ops</title>
+  <title>Ops backups</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
   <%= yield :head %>
 
-  <%= stylesheet_link_tag "ops/application", media: "all" %>
+  <%= stylesheet_link_tag    "ops_backups/application", media: "all" %>
 </head>
 <body>
 

data/config/routes.rb

@@ -1,2 +1,2 @@
-Ops::Backups::Engine.routes.draw do
+OpsBackups::Engine.routes.draw do
 end

data/lib/generators/ops_backups/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

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

@@ -0,0 +1,51 @@
+class OpsBackups::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  desc "Copies migrations and adds a storage service configuration to storage.yml"
+
+  def copy_migrations
+    rake "railties:install:migrations FROM=ops_backups"
+    say "Migrations copied to your application.", :green
+  end
+
+  def add_storage_service
+    storage_file = Rails.root.join("config", "storage.yml")
+
+    if File.exist?(storage_file)
+      service_config = <<~YAML
+
+        backups:
+          service: Disk
+          root: <%= Rails.root.join("storage") %>
+          # service: S3
+          # access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
+          # secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
+          # region: <%= ENV['AWS_REGION'] %>
+          # bucket: allcrux-backups
+      YAML
+
+      append_to_file storage_file, service_config
+      say "Added 'backups' service to storage.yml.", :green
+    else
+      say "config/storage.yml not found. Please create it and re-run this generator.", :red
+    end
+  end
+
+  def add_recurring_jobs
+    recurring_file = Rails.root.join("config", "recurring.yml")
+
+    if File.exist?(recurring_file)
+      recurring_config = <<~YAML.lines.map { |line| "\t#{line}" }.join
+        backup_db:
+          class: OpsBackups::BackupDbJob
+          args: [tag: "db_pg_backup", cleanup: "retain_tiered_cleanup_policy"]
+          schedule: every hour
+      YAML
+
+      append_to_file recurring_file, recurring_config
+      say "Added 'recurring' jobs to recurring.yml.", :green
+    else
+      say "config/recurring.yml not found. Please create it and re-run this generator.", :red
+    end
+  end
+end

data/lib/ops_backups/engine.rb

@@ -0,0 +1,11 @@
+module OpsBackups
+  class Engine < ::Rails::Engine
+    isolate_namespace OpsBackups
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match? root.to_s
+        app.config.paths["db/migrate"].concat(config.paths["db/migrate"].expanded)
+      end
+    end
+  end
+end

data/lib/ops_backups/version.rb

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

data/lib/ops_backups.rb

@@ -0,0 +1,6 @@
+require "ops_backups/version"
+require "ops_backups/engine"
+
+module OpsBackups
+  # Your code goes here...
+end

data/lib/tasks/{ops_tasks.rake → ops_backups_tasks.rake}

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
-# task :ops do
+# task :ops_backups do
 #   # Task goes here
 # end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_backups
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Koen Handekyn
@@ -35,22 +35,25 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/stylesheets/ops/application.css
-- app/controllers/ops/backups/application_controller.rb
-- app/helpers/ops/application_helper.rb
-- app/jobs/ops/backups/application_job.rb
-- app/jobs/ops/backups/backup_db_job.rb
-- app/jobs/ops/backups/cleanup_limit_job.rb
-- app/jobs/ops/backups/cleanup_tiered_job.rb
-- app/models/ops/backups/application_record.rb
-- app/models/ops/backups/backup.rb
-- app/views/layouts/ops/application.html.erb
+- app/assets/stylesheets/ops_backups/application.css
+- app/controllers/ops_backups/application_controller.rb
+- app/helpers/ops_backups/application_helper.rb
+- app/jobs/ops_backups/application_job.rb
+- app/jobs/ops_backups/backup_db_job.rb
+- app/jobs/ops_backups/cleanup_limit_job.rb
+- app/jobs/ops_backups/cleanup_tiered_job.rb
+- app/mailers/ops_backups/application_mailer.rb
+- app/models/ops_backups/application_record.rb
+- app/models/ops_backups/backup.rb
+- app/views/layouts/ops_backups/application.html.erb
 - config/routes.rb
 - db/migrate/20241114173612_create_ops_backups.rb
-- lib/ops/backups/backups.rb
-- lib/ops/backups/engine.rb
-- lib/ops/backups/version.rb
-- lib/tasks/ops_tasks.rake
+- lib/generators/ops_backups/install/USAGE
+- lib/generators/ops_backups/install/install_generator.rb
+- lib/ops_backups.rb
+- lib/ops_backups/engine.rb
+- lib/ops_backups/version.rb
+- lib/tasks/ops_backups_tasks.rake
 homepage: https://github.com/koenhandekyn/ops-backups
 licenses:
 - MIT

data/app/controllers/ops/backups/application_controller.rb

@@ -1,6 +0,0 @@
-module Ops
-  module Backups
-    class ApplicationController < ActionController::Base
-    end
-  end
-end

data/app/jobs/ops/backups/application_job.rb

@@ -1,6 +0,0 @@
-module Ops
-  module Backups
-    class ApplicationJob < ActiveJob::Base
-    end
-  end
-end

data/app/models/ops/backups/application_record.rb

@@ -1,8 +0,0 @@
-module Ops
-  module Backups
-    class ApplicationRecord < ActiveRecord::Base
-      self.abstract_class = true
-      self.table_name_prefix = "ops_"
-    end
-  end
-end

data/lib/ops/backups/backups.rb

@@ -1,8 +0,0 @@
-require "ops/backups/version"
-require "ops/backups/engine"
-
-module Ops
-  module Backups
-    # Your code goes here...
-  end
-end

data/lib/ops/backups/engine.rb

@@ -1,7 +0,0 @@
-module Ops
-  module Backups
-    class Engine < ::Rails::Engine
-      isolate_namespace Ops::Backups
-    end
-  end
-end

data/lib/ops/backups/version.rb

@@ -1,5 +0,0 @@
-module Ops
-  module Backups
-    VERSION = "0.1.0"
-  end
-end