backy_rb 0.1.3

data/dummy/psql/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t "hello"
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t("hello") %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   "true": "foo"
+#
+# To learn more, please read the Rails Internationalization guide
+# available at https://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/dummy/psql/config/master.key

@@ -0,0 +1 @@
+15729cca85c03e01e7b263643b18dfd7

data/dummy/psql/config/puma.rb

@@ -0,0 +1,43 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart

data/dummy/psql/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  resources :posts
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Defines the root path route ("/")
+  root "posts#index"
+end

data/dummy/psql/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/dummy/psql/db/migrate/20230330203226_create_posts.rb

@@ -0,0 +1,10 @@
+class CreatePosts < ActiveRecord::Migration[7.0]
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

data/dummy/psql/db/schema.rb

@@ -0,0 +1,23 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.0].define(version: 2023_03_30_203226) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "posts", force: :cascade do |t|
+    t.string "title"
+    t.text "body"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+end

data/dummy/psql/db/seeds.rb

@@ -0,0 +1,8 @@
+require "faker"
+
+100.times do
+  Post.create(
+    title: Faker::Lorem.sentence,
+    body: Faker::Lorem.paragraph
+  )
+end

data/dummy/psql/public/404.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/dummy/psql/public/422.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/dummy/psql/public/500.html

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/dummy/psql/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/lib/backy/app_config.rb

@@ -0,0 +1,11 @@
+require 'forwardable'
+
+module Backy
+  module AppConfig
+    extend Forwardable
+
+    private
+
+    def_delegators "Backy.configuration", :app_name, :environment, :log_file
+  end
+end

data/lib/backy/configuration.rb

@@ -0,0 +1,66 @@
+module Backy
+  class Configuration
+    attr_writer(
+      :pg_host,
+      :pg_port,
+      :pg_database,
+      :pg_username,
+      :pg_password,
+      :s3_region,
+      :s3_access_key,
+      :s3_secret,
+      :s3_bucket,
+      :app_name,
+      :environment,
+      :log_file
+    )
+
+    def pg_host
+      @pg_host ||= ENV["PG_HOST"]
+    end
+
+    def pg_port
+      @pg_port ||= ENV["PG_PORT"]
+    end
+
+    def pg_database
+      @pg_database ||= ENV["PG_DATABASE"]
+    end
+
+    def pg_username
+      @pg_username ||= ENV["PG_USERNAME"]
+    end
+
+    def pg_password
+      @pg_password ||= ENV["PG_PASSWORD"]
+    end
+
+    def s3_region
+      @s3_region ||= ENV["S3_REGION"]
+    end
+
+    def s3_access_key
+      @s3_access_key ||= ENV["S3_ACCESS_KEY"]
+    end
+
+    def s3_secret
+      @s3_secret ||= ENV["S3_SECRET"]
+    end
+
+    def s3_bucket
+      @s3_bucket ||= ENV["S3_BUCKET"]
+    end
+
+    def app_name
+      @app_name ||= "backy"
+    end
+
+    def environment
+      @environment ||= "development"
+    end
+
+    def log_file
+      @log_file ||= "log/backy.log"
+    end
+  end
+end

data/lib/backy/db.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+
+module Backy
+  module Db
+    extend Forwardable
+
+    private
+
+    def_delegator "Backy.configuration", :pg_host, :host
+    def_delegator "Backy.configuration", :pg_port, :port
+    def_delegator "Backy.configuration", :pg_database, :database
+    def_delegator "Backy.configuration", :pg_username, :username
+    def_delegator "Backy.configuration", :pg_password, :password
+
+    def pg_password_env
+      password.present? ? "PGPASSWORD='#{password}' " : ""
+    end
+
+    def pg_credentials
+      args_string = ""
+
+      args_string << " -U #{username}" if username.present?
+      args_string << " -h #{host}" if host.present?
+      args_string << " -p #{port}" if port.present?
+
+      args_string
+    end
+  end
+end

data/lib/backy/list.rb

@@ -0,0 +1,18 @@
+module Backy
+  class List
+    def call
+      locals = Set.new(Dir.glob(dump_wildcard))
+      remotes = Set.new(S3List.new.call)
+
+      (locals + remotes).sort.map do |dump_file|
+        OpenStruct.new(local?: dump_file.in?(locals), remote?: dump_file.in?(remotes), dump_file: dump_file)
+      end
+    end
+
+    private
+
+    def dump_wildcard
+      PgDump::DUMP_DIR + "/*"
+    end
+  end
+end

data/lib/backy/pg_dump.rb

@@ -0,0 +1,39 @@
+module Backy
+  class PgDump
+    include Db
+    include AppConfig
+
+    DUMP_DIR = "db/dump"
+    DUMP_CMD_OPTS = "--no-acl --no-owner --no-subscriptions --no-publications --exclude-table=awsdms_ddl_audit"
+
+    def call
+      FileUtils.mkdir_p(DUMP_DIR)
+
+      dump_file = "#{DUMP_DIR}/#{database}_#{whoami}@#{hostname}_#{Time.zone.now.strftime("%Y%m%d_%H%M%S")}.sql.gz"
+
+      cmd = "(#{pg_password_env}pg_dump #{pg_credentials} #{database} #{DUMP_CMD_OPTS} | gzip -9 > #{dump_file}) 2>&1 >> #{log_file}"
+
+      print "Saving to #{dump_file} ... "
+
+      if system(cmd)
+        puts "done"
+      else
+        puts "error. See #{log_file}"
+
+        return
+      end
+
+      dump_file
+    end
+
+    private
+
+    def hostname
+      @hostname ||= `hostname`.strip
+    end
+
+    def whoami
+      @whoami ||= `whoami`.strip
+    end
+  end
+end

data/lib/backy/pg_restore.rb

@@ -0,0 +1,27 @@
+module Backy
+  class PgRestore
+    include Db
+    include AppConfig
+
+    def initialize(file_name:)
+      @file_name = file_name
+    end
+
+    def call
+      terminate_connection_sql = "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '#{database}' AND pid <> pg_backend_pid();"
+      cmd = "(#{pg_password_env}psql -c \"#{terminate_connection_sql};\" #{pg_credentials} #{database}; #{pg_password_env}dropdb #{pg_credentials} #{database}; #{pg_password_env}createdb #{pg_credentials} #{database}; gunzip -c #{file_name} | #{pg_password_env}psql #{pg_credentials} -q -d #{database}) 2>&1 >> #{log_file}"
+
+      print "Restoring #{database} from #{file_name} ... "
+
+      if system(cmd)
+        puts "done"
+      else
+        puts "error. See #{log_file}"
+      end
+    end
+
+    private
+
+    attr_reader :file_name
+  end
+end

data/lib/backy/railtie.rb

@@ -0,0 +1,19 @@
+module Backy
+  class Railtie < Rails::Railtie
+    initializer "railtie.configure_rails_initialization" do
+      Backy.configure do |config|
+        config.pg_host = ActiveRecord::Base.connection_db_config.configuration_hash[:host]
+        config.pg_port = ActiveRecord::Base.connection_db_config.configuration_hash[:port]
+        config.pg_database = ActiveRecord::Base.connection_db_config.configuration_hash[:database]
+        config.pg_username = ActiveRecord::Base.connection_db_config.configuration_hash[:username]
+        config.pg_password = ActiveRecord::Base.connection_db_config.configuration_hash[:password]
+        config.app_name = Rails.application.class.name.split("::").first.underscore
+        config.environment = Rails.env
+      end
+    end
+
+    rake_tasks do
+      load "tasks/backy_tasks.rake"
+    end
+  end
+end

data/lib/backy/s3.rb

@@ -0,0 +1,27 @@
+require "aws-sdk-s3"
+require 'forwardable'
+
+module Backy
+  module S3
+    extend Forwardable
+
+    private
+
+    def_delegator "Backy.configuration", :s3_region, :region
+    def_delegator "Backy.configuration", :s3_secret, :secret
+    def_delegator "Backy.configuration", :s3_bucket, :bucket
+    def_delegator "Backy.configuration", :s3_access_key, :access_key
+
+    def s3
+      @s3 ||= Aws::S3::Client.new(region: region, credentials: s3_credentials)
+    end
+
+    def s3_configured?
+      [region, access_key, secret, bucket].all?(&:present?)
+    end
+
+    def s3_credentials
+      @credentials ||= Aws::Credentials.new(access_key, secret)
+    end
+  end
+end

data/lib/backy/s3_list.rb

@@ -0,0 +1,31 @@
+module Backy
+  class S3List
+    include S3
+
+    DEFAULT_PREFIX = "db/dump/"
+
+    def initialize(prefix: nil)
+      @prefix = prefix || DEFAULT_PREFIX
+    end
+
+    def call
+      return [] unless s3_configured?
+
+      response = s3.list_objects(prefix: prefix, bucket: bucket)
+
+      result = response.contents.map(&:key)
+
+      while response.next_page?
+        response = response.next_page
+
+        result += response.contents.map(&:key)
+      end
+
+      result.sort
+    end
+
+    private
+
+    attr_reader :prefix
+  end
+end

data/lib/backy/s3_load.rb

@@ -0,0 +1,41 @@
+module Backy
+  class S3Load
+    include S3
+
+    def initialize(file_name:, key: nil)
+      @file_name = file_name
+      @key = key || file_name
+    end
+
+    def call
+      return file_name if File.exist?(file_name)
+
+      print "Loading #{key} from S3 ... "
+
+      Tempfile.create(file_name) do |tempfile|
+        response_target = tempfile.path
+
+        begin
+          s3.get_object(response_target: response_target, key: key, bucket: bucket)
+          FileUtils.mkdir_p(File.dirname(file_name))
+          FileUtils.mv(response_target, file_name)
+        rescue Aws::S3::Errors::NoSuchKey
+          puts "error. No such key #{key}"
+        ensure
+          if File.exist?(tempfile.path)
+            tempfile.close
+            File.delete(tempfile.path)
+          end
+        end
+      end
+
+      puts "done"
+
+      file_name
+    end
+
+    private
+
+    attr_reader :key, :file_name
+  end
+end