backy_rb 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bb6103213004ae32e66537026b14efb957a6de480b11cc9fe0614eec32ed81
-  data.tar.gz: ef8e5b3e93dfd4da6aead26891631118b6b000fd3ca50f035e5f5975d8033949
+  metadata.gz: 22c60d417618b6d91862bf0de81b3dc88cdd61af8bc5854f498ffc6bad749727
+  data.tar.gz: cbf338342040184c61bcbeffbec63c6a9479e4f370beea2e217cac3b2a1e0c53
 SHA512:
-  metadata.gz: ce262c9c1f830f87a304f3ee2fcee5d34aa68d0180a1397f1bb1c768322f43adefebc1dbf99baab58b4e78a6e047b89838dec865c22eb41593fb448a3a2c1719
-  data.tar.gz: 3910848351967b47731abaabdab28251c5be76d63fe21b8e8c64066cf56dc40d3def935d3266f3a8d71de9901c965b2260c1241b688f80fbc36c56859c59b506
+  metadata.gz: 45ccce1e737f6e34b4e0f4f6b686974dc7341ae1c29e4a0bbe70582ef597502160edb6e5beee657d8df58e82b3f4900f85570a5fe67f37eb974c98641453202d
+  data.tar.gz: 8565246f494bb1302aa947a8ef8623aa4f5d7b2c225931a8342ec46eb24d27e904bcf5183a680baff0299c19ceaf863888260bce8f52caf7f7b73b74cc2cae70

data/.backyrc.example

@@ -0,0 +1,17 @@
+# ~/.backyrc
+defaults:
+  use_parallel: true
+  s3:
+    access_key_id: "YOUR_AWS_ACCESS_KEY_ID"
+    secret_access_key: "YOUR_AWS_SECRET_ACCESS_KEY"
+    region: "eu-central-1"
+    bucket: "your-s3-bucket-name"
+  database:
+    adapter: "postgresql"
+    host: "localhost"
+    port: 5432
+    username: "your-db-username"
+    password: "your-db-password"
+    database_name: "your-database-name"
+  local:
+    backup_path: "/path/to/your/local/backup/directory"

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.1.4] - 2023-12-28
+- Adds CLI
+
 ## [0.1.0] - 2023-03-30
 
 - Initial release

data/Gemfile

@@ -14,3 +14,7 @@ gem "standard", "~> 1.3"
 gem "aws-sdk-s3", "~> 1.117"
 
 gem "pg"
+
+gem "thor", "~> 1.2"
+
+gem "puma"

data/Gemfile.lock

@@ -9,11 +9,66 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.5)
+      actionpack (= 7.0.5)
+      activejob (= 7.0.5)
+      activerecord (= 7.0.5)
+      activestorage (= 7.0.5)
+      activesupport (= 7.0.5)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.5)
+      actionpack (= 7.0.5)
+      actionview (= 7.0.5)
+      activejob (= 7.0.5)
+      activesupport (= 7.0.5)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.5)
+      actionpack (= 7.0.5)
+      activerecord (= 7.0.5)
+      activestorage (= 7.0.5)
+      activesupport (= 7.0.5)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.5)
+      activesupport (= 7.0.5)
+      globalid (>= 0.3.6)
     activemodel (7.0.5)
       activesupport (= 7.0.5)
     activerecord (7.0.5)
       activemodel (= 7.0.5)
       activesupport (= 7.0.5)
+    activestorage (7.0.5)
+      actionpack (= 7.0.5)
+      activejob (= 7.0.5)
+      activerecord (= 7.0.5)
+      activesupport (= 7.0.5)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
     activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -37,18 +92,84 @@ GEM
     aws-sigv4 (1.5.2)
       aws-eventstream (~> 1, >= 1.0.2)
     brakeman (5.4.1)
+    builder (3.2.4)
     concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
     diff-lcs (1.5.0)
-    i18n (1.14.0)
+    erubi (1.12.0)
+    faker (3.2.0)
+      i18n (>= 1.8.11, < 2)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
     minitest (5.18.0)
+    net-imap (0.3.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
     pg (1.5.3)
+    puma (6.3.0)
+      nio4r (~> 2.0)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.5)
+      actioncable (= 7.0.5)
+      actionmailbox (= 7.0.5)
+      actionmailer (= 7.0.5)
+      actionpack (= 7.0.5)
+      actiontext (= 7.0.5)
+      actionview (= 7.0.5)
+      activejob (= 7.0.5)
+      activemodel (= 7.0.5)
+      activerecord (= 7.0.5)
+      activestorage (= 7.0.5)
+      activesupport (= 7.0.5)
+      bundler (>= 1.15.0)
+      railties (= 7.0.5)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.7.0)
@@ -93,10 +214,17 @@ GEM
       language_server-protocol (~> 3.17.0.2)
       rubocop (~> 1.48.1)
       rubocop-performance (~> 1.16.0)
+    thor (1.2.2)
     timecop (0.9.6)
+    timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.8)
+    zlib (3.0.0)
 
 PLATFORMS
   arm64-darwin-22
@@ -106,7 +234,10 @@ DEPENDENCIES
   aws-sdk-s3 (~> 1.117)
   backy_rb!
   brakeman (~> 5.4)
+  faker (>= 3.1)
   pg
+  puma
+  rails (>= 4.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.44)
@@ -114,7 +245,9 @@ DEPENDENCIES
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.18)
   standard (~> 1.3)
+  thor (~> 1.2)
   timecop (~> 0.9.6)
+  zlib (~> 3.0)
 
 BUNDLED WITH
    2.4.8

data/README.md

@@ -4,26 +4,84 @@
 
 Introducing "Backy" - the ultimate database backup gem for Ruby on Rails applications! Safeguard your valuable data with ease, speed, and reliability. Developed with the Rails community in mind, Backy provides a comprehensive solution for handling your database backups, ensuring your information is safe and sound.
 
-## Installation Rails
+## Features
 
-Add gem to gemfile
+- Database backup and restore.
+- Integration with AWS S3 for storing backups.
+- Support for both standalone usage and as part of a Rails application.
+- Automatic configuration inference when used within a Rails application.
+- Logging with colored output.
+- Command Line Interface (CLI) for easy management.
+
+## Installation Rails
 
-gem 'backy'
 
-Create initializer `config/initializers/backy.rb`
+Add this line to your application's Gemfile:
 
 ```ruby
-Backy.configure do |config|
-  config.s3_access_key = ""
-  config.s3_secret = ""
-  config.s3_bucket = ""
-  config.s3_region = ""
-end
+gem 'backy'
 ```
 
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backy_rb
+
+
 ## Usage
 
-TODO
+### Standalone
+
+To use Backy in a standalone environment, you can utilize the provided CLI.
+
+    $ backy [command] [options]
+
+Available commands include:
+
+* `download`: Download a file from S3
+* `dump`: Dump the database
+* `help [COMMAND]`: Describe available commands or one specific command
+* `list`: List all dumps
+* `push`: Push dump to S3 and delete local file
+* `restore`: Restore a database from a dump
+* `upload`: Upload a specific file to S3
+
+### In a Rails Application
+
+Backy seamlessly integrates with Rails applications. When included in a Rails app, Backy can automatically infer configurations from the Rails environment.
+
+#### Rake Tasks
+Backy provides Rake tasks for easy integration:
+
+```
+bin/rails backy:dump
+bin/rails backy:restore
+```
+
+## Configuration
+
+Backy can be configured through a .backyrc YAML file. Place this file in your home directory or the root of your Rails application.
+
+Example `.backyrc`:
+
+```yaml
+defaults:
+  use_parallel: true
+  s3:
+    access_key_id: YOUR_ACCESS_KEY
+    secret_access_key: YOUR_SECRET_KEY
+    region: YOUR_REGION
+    bucket: YOUR_BUCKET
+  database:
+    host: DB_HOST
+    port: DB_PORT
+    username: DB_USERNAME
+    password: DB_PASSWORD
+    database_name: DB_NAME
+```
 
 ## Development
 

data/{backy.gemspec → backy_rb.gemspec}

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
       (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
     end
   end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+
+  spec.executables = ["backy"]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rspec", "~> 3.0"
@@ -36,6 +36,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-performance", "~> 1.15"
   spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
   spec.add_development_dependency "timecop", "~> 0.9.6"
+  spec.add_development_dependency "zlib", "~> 3.0"
+  spec.add_development_dependency "rails", ">= 4.0"
+  spec.add_development_dependency "faker", ">= 3.1"
 
   spec.add_dependency "activerecord", ">= 4.0"
   spec.add_dependency "activesupport", ">= 4.0"

data/bin/backy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/backy_rb"
+
+Backy::CLI.start(ARGV)

data/dummy/psql/Gemfile

@@ -1,34 +0,0 @@
-source "https://rubygems.org"
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-ruby "3.2.0"
-
-# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
-gem "rails", "~> 7.0.4", ">= 7.0.4.2"
-
-# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
-gem "sprockets-rails"
-
-# Use postgresql as the database for Active Record
-gem "pg", "~> 1.1"
-
-# Use the Puma web server [https://github.com/puma/puma]
-gem "puma", "~> 5.0"
-
-# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem "tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby]
-
-# Backy <3
-gem "backy", path: "../../"
-
-group :development, :test do
-  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
-  gem "debug", platforms: %i[mri mingw x64_mingw]
-end
-
-group :development do
-  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
-  # gem "spring"
-end
-
-gem "faker", "~> 3.1"

data/lib/backy/cli.rb

@@ -0,0 +1,88 @@
+require "thor"
+require "yaml"
+
+module Backy
+  class CLI < Thor
+    def initialize(*args)
+      Logger.log("Initializing Backy CLI...")
+      super
+      Backy.setup
+    end
+
+    desc "dump", "Dump the database"
+    def dump
+      Backy::PgDump.new.call
+      Logger.success("Database dumped successfully.")
+    end
+
+    desc "push", "Push dump to S3 and delete local file"
+    def push
+      file_name = Backy::PgDump.new.call
+      save_to_s3(file_name)
+      File.delete(file_name) if File.exist?(file_name)
+      Logger.sucess("Dump pushed to S3 and local file deleted.")
+    end
+
+    desc "upload", "Upload a specific file to S3"
+    method_option :file, aliases: "-f", desc: "File to upload"
+    def upload
+      file_name = options[:file]
+      validate_file!(file_name)
+      save_to_s3(file_name)
+      Logger.success("File uploaded to S3.")
+    end
+
+    desc "download", "Download a file from S3"
+    method_option :file, aliases: "-f", desc: "File to download"
+    def download
+      file_name = options[:file]
+      validate_file!(file_name, should_exist: false)
+      load_from_s3_if_missing(file_name)
+      Logger.success("File downloaded from S3.")
+    end
+
+    desc "list", "List all dumps"
+    def list
+      list = Backy::List.new.call
+      list.each { |item| say "#{item.local? ? "local" : "     "} #{item.remote? ? "remote" : "      "} : #{item.dump_file}", :yellow }
+      say_instructions_if_any(list)
+    end
+
+    desc "restore", "Restore a database from a dump"
+    method_option :file, aliases: "-f", desc: "File to restore from"
+    def restore
+      file_name = find_file_for_restore(options[:file])
+      pg_restore(load_from_s3_if_missing(file_name)) if file_name
+      Logger.success("Database restored from #{file_name}.")
+    end
+
+    private
+
+    def validate_file!(file_name, should_exist: true)
+      if file_name.nil? || (should_exist ? !File.exist?(file_name) : File.exist?(file_name))
+        Logger.error("Invalid file specified.")
+        exit 1
+      end
+    end
+
+    def find_file_for_restore(template_file_name)
+      file_name = Backy::List.new.call.reverse.find { |item| item.dump_file.starts_with?(template_file_name) }&.dump_file if template_file_name.present?
+      Logger.info "Please set the file to restore from." if file_name.nil?
+      file_name
+    end
+
+    def say_instructions_if_any(list)
+      return unless list.any?
+      Logger.info("\nTo restore a backup, run:")
+      Logger.log("  backy restore --file FILE_NAME")
+    end
+
+    def load_from_s3_if_missing(file_name)
+      Backy::S3Load.new(file_name: file_name).call
+    end
+
+    def save_to_s3(file_name)
+      Backy::S3Save.new(file_name: file_name).call
+    end
+  end
+end

data/lib/backy/configuration.rb

@@ -12,9 +12,19 @@ module Backy
       :s3_bucket,
       :app_name,
       :environment,
+      :use_parallel,
       :log_file
     )
 
+    def load
+      local_config_file = File.join(Dir.pwd, '.backyrc')
+      global_config_file = File.join(Dir.home, '.backyrc')
+
+      config_file = File.exist?(local_config_file) ? local_config_file : global_config_file
+      Logger.log("Loading configuration from #{config_file}...") if File.exist?(config_file)
+      load_from_file(config_file) if File.exist?(config_file)
+    end
+
     def pg_host
       @pg_host ||= ENV["PG_HOST"]
     end
@@ -51,8 +61,29 @@ module Backy
       @s3_bucket ||= ENV["S3_BUCKET"]
     end
 
+    def use_parallel
+      @use_parallel ||= ENV["BACKY_USE_PARALLEL"] == "true"
+    end
+
+    def use_parallel?
+      use_parallel && pigz_installed && multicore
+    end
+
+    # Detect if pigz binary is available
+    # If it is, use it to speed up the dump
+    # pigz is a parallel gzip implementation
+    # https://zlib.net/pigz/
+    def pigz_installed
+      @pigz_installed ||= system("which pigz > /dev/null 2>&1")
+    end
+
+    # Determine if the system is multicore
+    def multicore
+      @multicore ||= Etc.nprocessors > 1
+    end
+
     def app_name
-      @app_name ||= "backy"
+      @app_name ||= ENV["APP_NAME"].presence || "backy"
     end
 
     def environment
@@ -60,7 +91,39 @@ module Backy
     end
 
     def log_file
-      @log_file ||= "log/backy.log"
+      @log_file ||= default_log_file
+    end
+
+    private
+
+    def default_log_file
+      if Gem.win_platform?
+        # Windows default path
+        File.join(Dir.home, "AppData", "Local", "#{app_name}", "log", "#{app_name}.log")
+      else
+        # Unix-like systems default path
+        File.join(Dir.home, ".local", "share", "#{app_name}", "log", "#{app_name}.log")
+      end
+    end
+
+    def load_from_file(file_path)
+      configuration = YAML.load_file(file_path)
+
+      @s3_access_key = configuration.dig("defaults", "s3", "access_key_id")
+      @s3_secret = configuration.dig("defaults", "s3", "secret_access_key")
+      @s3_region = configuration.dig("defaults", "s3", "region")
+      @s3_bucket = configuration.dig("defaults", "s3", "bucket")
+
+      @pg_host = configuration.dig("defaults", "database", "host")
+      @pg_port = configuration.dig("defaults", "database", "port")
+      @pg_username = configuration.dig("defaults", "database", "username")
+      @pg_password = configuration.dig("defaults", "database", "password")
+      @pg_database = configuration.dig("defaults", "database", "database_name")
+
+      @app_name = configuration.dig("defaults", "app_name") || "backy"
+      @environment = configuration.dig("defaults", "environment") || "development"
+      @log_file = configuration.dig("defaults", "log", "file") || default_log_file
+      @use_parallel = configuration.dig("defaults", "use_parallel") || false
     end
   end
 end

data/lib/backy/db.rb

@@ -11,6 +11,7 @@ module Backy
     def_delegator "Backy.configuration", :pg_database, :database
     def_delegator "Backy.configuration", :pg_username, :username
     def_delegator "Backy.configuration", :pg_password, :password
+    def_delegator "Backy.configuration", :use_parallel?, :use_parallel?
 
     def pg_password_env
       password.present? ? "PGPASSWORD='#{password}' " : ""

data/lib/backy/list.rb

@@ -5,7 +5,7 @@ module Backy
       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)
+        OpenStruct.new(local?: locals.include?(dump_file), remote?: remotes.include?(dump_file), dump_file: dump_file)
       end
     end
 

data/lib/backy/logger.rb

@@ -0,0 +1,27 @@
+require 'thor'
+
+module Backy
+  class Logger
+    # Logs a message with the specified color using Thor's shell
+    def self.log(message, color = nil)
+      thor_shell = Thor::Base.shell.new
+      thor_shell.say("[#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}] #{message}", color)
+    end
+
+    def self.success(message)
+      log(message, :green)
+    end
+
+    def self.info(message)
+      log(message, :blue)
+    end
+
+    def self.warn(message)
+      log(message, :yellow)
+    end
+
+    def self.error(message)
+      log(message, :red)
+    end
+  end
+end