boring-backup 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 520f4d8e05984b490027c72e0922660b93f73ed22f6d48671ba87b6c4922883e
+  data.tar.gz: 698eeeb6840e35554551cf2d87a2c2a567f8d5b58678a6d0eaed517781dff7db
+SHA512:
+  metadata.gz: c6f7efdd9f7ab1a12a53f84cb3bd539f1d2003f61098dee77a48b48a23bbb9e40814293ff6622477e1397a4857242a19775f2ca6d375df3f026208ef301f4600
+  data.tar.gz: d0351b5626ffbc7b17d88b60682a8d4e3b30bfa12d390d47cff858ca0cb741879f8182d2bace733f5e31f8e3a43e653e9e1ddf43be6f73206c87171c57aaf293

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+## [Unreleased]
+
+## [0.4.0] - 2026-07-13
+
+- **Renamed the gem from `noop-backup` to `boring-backup`.** Breaking, with no shims:
+  - `NoopBackup` namespace is now `BoringBackup`
+  - executable `nbu` is now `bb`
+  - `require "noop_backup"` is now `require "boring_backup"`
+  - env vars are prefixed `BB_` instead of `NBU_` (`BB_PREFIX`, `BB_MIN_SIZE`,
+    `BB_IGNORE_TABLES`, `BB_SENTINEL_KEY`, `BB_SENTINEL_HOST`, `BB_S3_PART_SIZE`,
+    `BB_S3_THREAD_COUNT`, `BB_S3_STORAGE_CLASS`)
+- Configurable storage classes for s3
+
+## [0.3.0] - 2026-07-13
+
+- Make s3 upload stream part size and thread count configurable
+- Sentinel integration
+- Option to ignore tables
+
+## [0.2.0] - 2026-07-04
+
+- Support multiple destination stores in a single backup run
+- Delete partial uploads and fail the job safely when a dump fails
+- Validate configuration before running, with clearer errors
+- A lot of undocumented API and configuration changes
+
+## [0.1.3] - 2026-07-02
+
+- Pass `access_key_id` and `secret_access_key` in config block
+
+## [0.1.2] - 2026-07-02
+
+- Only `exit 1` when running the CLI, not the backup service
+- Automatically load BackupJob in Rails if using ActiveJob
+
+## [0.1.1] - 2026-07-01
+
+- Better S3 backup naming scheme - <prefix>/<database>/<YYYY>/<MM>/<dd-HHMMSS>.dump
+- Fix bundler autoloading in projects
+
+## [0.1.0] - 2026-07-01
+
+- Initial release
+- Only supports PostrgreSQL and AWS S3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Georgi Mitrev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# BoringBackup
+
+Ruby gem for backing up PostgreSQL databases with minimum effort.
+
+This gem is very much __unstable__. Expect APIs to change a lot before v1.0.0 is released.
+
+## Installation
+
+If using bundler, add the gem to your `Gemfile`:
+
+```bash
+bundle add boring-backup
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install boring-backup
+```
+
+The gem requires `pg_dump` to be installed on the machine that is running it.
+
+## Usage
+
+### Automatic
+
+#### Rails 8 with Solid Queue
+
+Add the BoringBackup job to the `config/recurring.yml` file:
+
+```yaml
+production:
+  # other jobs
+  boring_backup:
+    class: BoringBackup::BackupJob
+    schedule: at 3am every day
+```
+
+The job will run on the `:default` queue on your desired schedule.
+If you wish to customize the job, create a new one and make sure to invoke
+`BoringBackup::Commands::Backup.execute` in the `perform` method.
+
+
+#### Sidekiq, Good Job, whenever
+
+Create a new recurring job and have it invoke `BoringBackup::Commands::Backup.execute`
+
+### Manually
+
+```sh
+bundle exec bb backup
+```
+
+This command will dump the database and stream it to your configured destinations without writing
+anything to disk. Use any scheduler or even cron to run it periodically.
+
+## Configuration
+
+All configuration options can be edited in the initializer:
+
+```rb
+# config/initializers/boring-backup.rb
+
+BoringBackup.configure do |config|
+  config.register(:s3) do |store|
+    store.bucket = Settings.aws.bucket
+    store.region = Settings.aws.region
+    store.access_key_id = Settings.aws.access_key_id
+    store.secret_access_key = Settings.aws.secret_access_key
+  end
+
+  config.notifier :slack do |slack|
+    slack.webhook_url = 'https://hooks.slack.com/services/whatever'
+  end
+end
+```
+
+### Ignoring tables
+
+To skip the rows of tables you don't need backed up, such as audit trails or job history:
+
+```rb
+BoringBackup.configure do |config|
+  config.ignore_tables = %w[versions logs]
+end
+```
+
+Or set `BB_IGNORE_TABLES=versions,logs`.
+
+A restore still creates these tables empty.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gmitrev/boring-backup.
+
+## Wishlist
+
+- [ ] S3-compatible backends
+- [ ] file backend
+- [ ] email notifier
+- [ ] SMS notifier
+- [ ] restore command
+- [ ] test command
+- [ ] encryption
+- [ ] delete stale
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/bb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "boring_backup"
+require "boring_backup/cli"
+
+BoringBackup::CLI.start(ARGV)

data/lib/boring-backup.rb

@@ -0,0 +1 @@
+require_relative "boring_backup"

data/lib/boring_backup/cli.rb

@@ -0,0 +1,17 @@
+require "thor"
+
+module BoringBackup
+  class CLI < Thor
+    def self.exit_on_failure? = true
+
+    desc "backup", "Create and store a new backup"
+    def backup
+      BoringBackup.prepare!
+      result = BoringBackup::Commands::Backup.execute
+      exit 1 unless result.success?
+    rescue => e
+      warn e
+      exit 1
+    end
+  end
+end

data/lib/boring_backup/commands/backup.rb

@@ -0,0 +1,135 @@
+require "open3"
+
+module BoringBackup::Commands
+  CommandResult = Struct.new(:error, :store_results, keyword_init: true) do
+    def success?
+      status == :success
+    end
+
+    def status
+      return :error if error
+      return :error if store_results.empty? || store_results.none?(&:success)
+      return :success if store_results.all?(&:success)
+
+      :partial_success
+    end
+
+    def messages
+      return ["❌ Fatal error: #{error.message}"] if error
+
+      store_results.map(&:message)
+    end
+
+    def report
+      BoringBackup.notify(self)
+    end
+  end
+
+  class Backup
+    def self.execute(report: BoringBackup.config.report?)
+      result = new.execute
+
+      result.report if report
+
+      result
+    end
+
+    def initialize
+      @key = generate_key
+      @store_results = []
+      @sinks = []
+    end
+
+    def execute
+      perform_sanity_check!
+
+      commands = [config.dump_command]
+
+      # Pipe pg_dump through pv if installed for a basic progress report
+      commands << ["pv", "-btra"] if config.report? && system("which", "pv", out: File::NULL, err: File::NULL)
+
+      Open3.pipeline_r(*commands) do |last_stdout, wait_threads|
+        @sinks = config.stores.map do |store|
+          reader, writer = IO.pipe(binmode: true)
+
+          thread = Thread.new do
+            store.backup!(@key, reader)
+          rescue => e
+            # *always* return a Result, even if unexpected. Add store name for debugging.
+            BoringBackup::Stores::Result.new(success: false, error: e, store: store.class.name, key: @key)
+          ensure
+            reader.close
+          end
+
+          BoringBackup::Tee::Sink.new(store:, writer:, thread:)
+        end
+
+        sinks_fanout = BoringBackup::Tee.new(@sinks)
+
+        begin
+          IO.copy_stream(last_stdout, sinks_fanout)
+        rescue => e
+          raise BoringBackup::DumpFailedError, "streaming failed: #{e.message}"
+        ensure
+          @sinks.each(&:close)
+        end
+
+        @store_results = @sinks.map(&:collect)
+
+        raise BoringBackup::DumpFailedError, "pipeline failed" unless wait_threads.all? { |t| t.value.success? }
+      end
+
+      CommandResult.new(store_results: @store_results)
+    rescue BoringBackup::DumpFailedError => error
+      # The dump stream itself failed, so uploads that finished are truncated copies of a bad stream — delete them.
+      # Collect the results first: if copy_stream raised, the collection line above never ran. Sinks are already
+      # closed on every DumpFailedError path, so collect can't block.
+      @store_results = @sinks.map(&:collect)
+
+      cleanup_uploaded_stores!
+
+      CommandResult.new(error:, store_results: @store_results)
+    rescue => error
+      CommandResult.new(error:, store_results: @store_results)
+    end
+
+    private
+
+    # 1. Check if any stores are registered.
+    # 2. Make sure **all** stores have a valid configuration
+    def perform_sanity_check!
+      raise BoringBackup::ConfigurationError, "No backup stores registered" if config.stores.empty?
+      raise BoringBackup::ConfigurationError, "Could not resolve PGDATABASE" if config.pg_env["PGDATABASE"].to_s.empty?
+
+      config.stores.each(&:validate!)
+    end
+
+    def cleanup_uploaded_stores!
+      @sinks.each do |sink|
+        sink.store.cleanup!(@key) if sink.collect&.success
+      rescue => e
+        warn "⚠️ Cleanup failed for #{sink.store.class}: #{e.message}"
+      end
+    end
+
+    def config
+      @config ||= BoringBackup.config
+    end
+
+    # File name of the current backup. Example:
+    #
+    #  prefix   db_name            y    m  d  h  m  s  ms
+    # /database/db_name_production/2026/07/03-14-47-23-724.dump
+    def generate_key
+      now = Time.now.utc
+
+      [
+        config.prefix,
+        config.pg_env["PGDATABASE"],
+        now.strftime("%Y"),
+        now.strftime("%m"),
+        "#{now.strftime("%d-%H-%M-%S-%L")}.dump"
+      ].compact.join("/")
+    end
+  end
+end

data/lib/boring_backup/configuration.rb

@@ -0,0 +1,105 @@
+module BoringBackup
+  class Configuration
+    DEFAULT_SENTINEL_HOST = "https://boringbackup.com"
+
+    attr_accessor :prefix,
+      :min_size,
+      :pg_host,
+      :pg_port,
+      :pg_user,
+      :pg_password,
+      :pg_database,
+      :sentinel_key
+
+    attr_reader :stores
+    attr_writer :report, :dump_command, :ignore_tables, :sentinel_host
+
+    def initialize
+      @prefix = ENV.fetch("BB_PREFIX", "database")
+      @stores = []
+      @min_size = ENV.fetch("BB_MIN_SIZE", 2048).to_i
+      @notifiers = [BoringBackup::Notifiers::Stdout.new]
+      @report = true
+      @ignore_tables = ENV.fetch("BB_IGNORE_TABLES", "").split(",")
+      @sentinel_key = ENV["BB_SENTINEL_KEY"]
+      @sentinel_host = ENV.fetch("BB_SENTINEL_HOST", DEFAULT_SENTINEL_HOST)
+    end
+
+    def report?
+      @report
+    end
+
+    def sentinel_host
+      @sentinel_host || DEFAULT_SENTINEL_HOST
+    end
+
+    def sentinel?
+      !sentinel_key.to_s.empty?
+    end
+
+    def sentinel
+      return unless sentinel?
+
+      @sentinel ||= BoringBackup::Notifiers::Sentinel.new(key: sentinel_key, host: sentinel_host)
+    end
+
+    def notifiers
+      [*@notifiers, sentinel].compact
+    end
+
+    def ignore_tables
+      Array(@ignore_tables).map { |table| table.to_s.strip }.reject(&:empty?).uniq
+    end
+
+    def dump_command
+      @dump_command || [
+        pg_env,
+        "pg_dump",
+        "--format=custom",
+        "--no-owner",
+        *ignore_tables.map { |table| "--exclude-table-data=#{table}" }
+      ]
+    end
+
+    def register(store_type)
+      raise BoringBackup::ConfigurationError, "`config.register` requires a block" unless block_given?
+
+      store =
+        case store_type.to_sym
+        when :s3 then BoringBackup::Stores::S3.new
+        else raise BoringBackup::ConfigurationError, "unknown store type: #{store_type}"
+        end
+
+      @stores << store
+
+      yield store
+    end
+
+    def notifier(type)
+      case type
+      when :slack
+        notifier = BoringBackup::Notifiers::Slack.new
+
+        yield notifier
+
+        @notifiers << notifier
+      else raise "Unknown notifier: #{type}"
+      end
+    end
+
+    def pg_env
+      {
+        "PGHOST" => (pg_host || db_config[:host])&.to_s,
+        "PGPORT" => (pg_port || db_config[:port])&.to_s,
+        "PGUSER" => (pg_user || db_config[:username])&.to_s,
+        "PGPASSWORD" => (pg_password || db_config[:password])&.to_s,
+        "PGDATABASE" => (pg_database || db_config[:database])&.to_s
+      }.compact
+    end
+
+    def db_config
+      @db_config ||= defined?(::ActiveRecord) ?
+        ::ActiveRecord::Base.connection_db_config.configuration_hash : {}
+    end
+  end
+end

data/lib/boring_backup/jobs/backup_job.rb

@@ -0,0 +1,11 @@
+module BoringBackup
+  class BackupJob < ActiveJob::Base
+    queue_as :default
+
+    def perform
+      result = BoringBackup::Commands::Backup.execute
+
+      raise BoringBackup::BackupFailedError.new(result) unless result.success?
+    end
+  end
+end

data/lib/boring_backup/notifiers/sentinel.rb

@@ -0,0 +1,103 @@
+require "net/http"
+require "uri"
+require "json"
+
+module BoringBackup::Notifiers
+  class Sentinel
+    PAYLOAD_VERSION = 1
+
+    OPEN_TIMEOUT = 5
+    READ_TIMEOUT = 10
+    MAX_ATTEMPTS = 3
+
+    LOCAL_HOSTS = %w[localhost 127.0.0.1 0.0.0.0]
+
+    attr_accessor :key, :host
+
+    def initialize(key:, host:)
+      @key = key
+      @host = host
+    end
+
+    def ping_url
+      URI.join(normalized_host, "/ping/#{key}")
+    end
+
+    def notify(result)
+      body = payload(result).to_json
+      attempt = 0
+
+      begin
+        attempt += 1
+        response = post(body)
+
+        return true if response.is_a?(Net::HTTPSuccess)
+        raise BoringBackup::Error, "#{response.code} #{response.body}" if retryable?(response)
+
+        warn "Sentinel ping failed: #{response.code} #{response.body}"
+
+        false
+      rescue => e
+        if attempt < MAX_ATTEMPTS
+          sleep(2**(attempt - 1))
+          retry
+        end
+
+        warn "Sentinel ping error after #{attempt} attempts: #{e.message}"
+
+        false
+      end
+    end
+
+    private
+
+    def normalized_host
+      uri = URI.parse(host)
+
+      return host if uri.is_a?(URI::HTTP)
+
+      "#{LOCAL_HOSTS.include?(uri.scheme) ? "http" : "https"}://#{host}"
+    end
+
+    def post(body)
+      uri = ping_url
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = OPEN_TIMEOUT
+      http.read_timeout = READ_TIMEOUT
+
+      request = Net::HTTP::Post.new(uri.request_uri, "Content-Type" => "application/json")
+      request.body = body
+
+      http.request(request)
+    end
+
+    def retryable?(response)
+      response.is_a?(Net::HTTPServerError) || response.is_a?(Net::HTTPTooManyRequests)
+    end
+
+    def payload(result)
+      store_results = result.store_results
+
+      {
+        version: PAYLOAD_VERSION,
+        status: result.status,
+        error: result.error&.message,
+        database: BoringBackup.config.pg_env["PGDATABASE"],
+        bytes: store_results.filter_map(&:bytes).max,
+        duration: store_results.filter_map(&:duration).max&.round(3),
+        stores: store_results.map do |store_result|
+          {
+            store: store_result.store,
+            success: store_result.success,
+            key: store_result.key,
+            bytes: store_result.bytes,
+            duration: store_result.duration&.round(3),
+            error: store_result.error&.message
+          }
+        end
+      }
+    end
+  end
+end

data/lib/boring_backup/notifiers/slack.rb

@@ -0,0 +1,34 @@
+require "net/http"
+require "uri"
+require "json"
+
+module BoringBackup::Notifiers
+  class Slack
+    OPEN_TIMEOUT = 5
+    READ_TIMEOUT = 10
+
+    attr_accessor :webhook_url
+
+    def notify(result)
+      uri = URI(webhook_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.open_timeout = OPEN_TIMEOUT
+      http.read_timeout = READ_TIMEOUT
+
+      request = Net::HTTP::Post.new(uri.request_uri, "Content-Type" => "application/json")
+      request.body = {text: result.messages.join("\n")}.to_json
+
+      response = http.request(request)
+
+      success = response.is_a?(Net::HTTPSuccess)
+
+      warn "Slack notify failed: #{response.code} #{response.body}" unless success
+
+      success
+    rescue => e
+      # Never fail a backup because of a notification error
+      warn "Slack notify error: #{e.message}"
+    end
+  end
+end

data/lib/boring_backup/notifiers/stdout.rb

@@ -0,0 +1,7 @@
+module BoringBackup::Notifiers
+  class Stdout
+    def notify(result)
+      result.messages.each { |message| puts message }
+    end
+  end
+end

data/lib/boring_backup/plugins/rails.rb

@@ -0,0 +1,9 @@
+module BoringBackup
+  class Railtie < Rails::Railtie
+    initializer "boring_backup.job" do |app|
+      ActiveSupport.on_load(:active_job) do
+        require "boring_backup/jobs/backup_job"
+      end
+    end
+  end
+end

data/lib/boring_backup/stores/result.rb

@@ -0,0 +1,11 @@
+module BoringBackup::Stores
+  Result = Struct.new(:success, :error, :store, :key, :bytes, :duration, keyword_init: true) do
+    def message
+      if success
+        "✅ [#{store}] Backup successful — #{BoringBackup.utils.human_size(bytes)} in #{duration.round(1)}s → /#{key}"
+      else
+        "❌ [#{store}] Backup failed: #{error.message}"
+      end
+    end
+  end
+end

data/lib/boring_backup/stores/s3.rb

@@ -0,0 +1,119 @@
+require "aws-sdk-s3"
+
+module BoringBackup::Stores
+  class S3 < Store
+    DEFAULT_STORAGE_CLASS = :standard_ia
+
+    STORAGE_CLASSES = %i[
+      standard
+      standard_ia
+      onezone_ia
+      intelligent_tiering
+      glacier_ir
+      glacier
+      deep_archive
+      reduced_redundancy
+      express_onezone
+      outposts
+      snow
+    ].freeze
+
+    attr_accessor :bucket, :region, :access_key_id, :secret_access_key, :part_size, :thread_count
+    attr_writer :storage_class
+
+    def initialize
+      @bucket = ENV["AWS_S3_BUCKET"]
+      @region = ENV["AWS_REGION"]
+      @access_key_id = ENV["AWS_ACCESS_KEY_ID"]
+      @secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+      @part_size = ENV.fetch("BB_S3_PART_SIZE", 8 * 1024 * 1024).to_i
+      @thread_count = ENV.fetch("BB_S3_THREAD_COUNT", 2).to_i
+      @storage_class = ENV.fetch("BB_S3_STORAGE_CLASS", DEFAULT_STORAGE_CLASS)
+    end
+
+    def storage_class
+      value = @storage_class.to_s.strip.downcase
+
+      value.empty? ? nil : value.to_sym
+    end
+
+    # Prefer Aws::S3::TransferManager for streaming uploads if available.
+    # Aws::S3::Resource.upload_stream is deprecated in newer versions
+    def backup!(key, stream)
+      started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      bytes = 0
+
+      validate!
+
+      upload_attempted = true
+
+      if defined?(Aws::S3::TransferManager)
+        manager = Aws::S3::TransferManager.new(client: s3_client)
+
+        manager.upload_stream(bucket:, key: key, **upload_options) do |s3_stream|
+          bytes = IO.copy_stream(stream, s3_stream)
+        end
+      else
+        object = Aws::S3::Resource.new(client: s3_client).bucket(bucket).object(key)
+
+        object.upload_stream(**upload_options) do |s3_stream|
+          bytes = IO.copy_stream(stream, s3_stream)
+        end
+      end
+
+      duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
+
+      if config.min_size && bytes < config.min_size.to_i
+        raise BoringBackup::DumpTooSmallError, "backup too small: #{BoringBackup.utils.human_size(bytes)} < min_size (#{BoringBackup.utils.human_size(config.min_size)})"
+      end
+
+      Result.new(success: true, store: :s3, bytes:, key:, duration:)
+    rescue => e
+      duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
+
+      cleanup!(key) if upload_attempted
+
+      Result.new(success: false, error: e, store: :s3, bytes:, key:, duration:)
+    end
+
+    def validate!
+      raise BoringBackup::ConfigurationError, "bucket is not configured" if bucket.to_s.empty?
+
+      if access_key_id.to_s.empty? != secret_access_key.to_s.empty?
+        raise BoringBackup::ConfigurationError,
+          "access_key_id and secret_access_key must both be set, or both left blank to use the default AWS credential chain"
+      end
+
+      if storage_class && !STORAGE_CLASSES.include?(storage_class)
+        raise BoringBackup::ConfigurationError,
+          "unknown storage class: #{storage_class.inspect} (expected one of: #{STORAGE_CLASSES.map(&:inspect).join(", ")}, or nil to use the bucket default)"
+      end
+    end
+
+    def cleanup!(key)
+      s3_client.delete_object(bucket:, key:)
+    rescue => e
+      warn "Failed to clean up partial upload #{key}: #{e.message}"
+    end
+
+    private
+
+    def upload_options
+      options = {part_size:, thread_count:}
+      options[:storage_class] = storage_class.to_s.upcase if storage_class
+      options
+    end
+
+    def s3_client
+      @_s3_client ||= Aws::S3::Client.new(**s3_config)
+    end
+
+    def s3_config
+      {
+        region: region,
+        access_key_id: access_key_id,
+        secret_access_key: secret_access_key
+      }.compact
+    end
+  end
+end

data/lib/boring_backup/stores/store.rb

@@ -0,0 +1,9 @@
+module BoringBackup::Stores
+  class Store
+    private
+
+    def config
+      @config ||= BoringBackup.config
+    end
+  end
+end

data/lib/boring_backup/stores.rb

@@ -0,0 +1,3 @@
+require_relative "stores/store"
+require_relative "stores/result"
+require_relative "stores/s3" # TODO: load conditionally

data/lib/boring_backup/tee.rb

@@ -0,0 +1,33 @@
+module BoringBackup
+  class Tee
+    Sink = Struct.new(:store, :writer, :thread, keyword_init: true) do
+      def write(chunk)
+        return if @error
+
+        writer.write(chunk)
+      rescue Errno::EPIPE, IOError => e
+        @error = e
+
+        close unless writer.closed?
+      end
+
+      def close
+        writer.close
+      end
+
+      def collect
+        thread.value
+      rescue
+        nil
+      end
+    end
+
+    def initialize(sinks) = @sinks = sinks
+
+    def write(chunk)
+      @sinks.each { |sink| sink.write(chunk) }
+
+      chunk.bytesize
+    end
+  end
+end

data/lib/boring_backup/utils.rb

@@ -0,0 +1,14 @@
+module BoringBackup::Utils
+  extend self
+
+  def human_size(bytes)
+    units = %w[B KB MB GB TB]
+    size = bytes.to_f
+    i = 0
+    while size >= 1024 && i < units.size - 1
+      size /= 1024
+      i += 1
+    end
+    format("%.1f %s", size, units[i])
+  end
+end

data/lib/boring_backup/version.rb

@@ -0,0 +1,3 @@
+module BoringBackup
+  VERSION = "0.4.0"
+end

data/lib/boring_backup.rb

@@ -0,0 +1,68 @@
+require_relative "boring_backup/version"
+require_relative "boring_backup/configuration"
+require_relative "boring_backup/tee"
+require_relative "boring_backup/utils"
+require_relative "boring_backup/stores"
+require_relative "boring_backup/commands/backup"
+require_relative "boring_backup/notifiers/slack"
+require_relative "boring_backup/notifiers/stdout"
+require_relative "boring_backup/notifiers/sentinel"
+
+module BoringBackup
+  class Error < StandardError; end
+
+  class DumpTooSmallError < Error; end
+  class DumpFailedError < Error; end
+  class ConfigurationError < Error; end
+
+  class BackupFailedError < Error
+    attr_reader :result
+
+    def initialize(result)
+      @result = result
+
+      super("Backup failed (#{result.status}): #{result.error&.message || failed_stores(result)}")
+    end
+
+    private
+
+    def failed_stores(result)
+      result.store_results.reject(&:success).map(&:store).join(", ")
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias_method :config, :configuration
+
+    def reset!
+      @configuration = nil
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    # Attempt to boot host app. Booting it should trigger the configuration process.
+    def prepare!
+      env_file = File.expand_path("config/environment.rb")
+
+      require env_file if File.exist?(env_file)
+    end
+
+    def notify(result)
+      config.notifiers.each do |notifier|
+        notifier.notify(result)
+      end
+    end
+
+    def utils
+      BoringBackup::Utils
+    end
+  end
+end
+
+require_relative "boring_backup/plugins/rails" if defined? Rails::Railtie

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: boring-backup
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Georgi Mitrev
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: The simplest way to add recurring database backups to your project with
+  minimal setup required.
+email:
+- gvmitrev@gmail.com
+executables:
+- bb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/bb
+- lib/boring-backup.rb
+- lib/boring_backup.rb
+- lib/boring_backup/cli.rb
+- lib/boring_backup/commands/backup.rb
+- lib/boring_backup/configuration.rb
+- lib/boring_backup/jobs/backup_job.rb
+- lib/boring_backup/notifiers/sentinel.rb
+- lib/boring_backup/notifiers/slack.rb
+- lib/boring_backup/notifiers/stdout.rb
+- lib/boring_backup/plugins/rails.rb
+- lib/boring_backup/stores.rb
+- lib/boring_backup/stores/result.rb
+- lib/boring_backup/stores/s3.rb
+- lib/boring_backup/stores/store.rb
+- lib/boring_backup/tee.rb
+- lib/boring_backup/utils.rb
+- lib/boring_backup/version.rb
+homepage: https://github.com/gmitrev/boring-backup
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gmitrev/boring-backup
+  source_code_uri: https://github.com/gmitrev/boring-backup/tree/main
+  changelog_uri: https://github.com/gmitrev/boring-backup/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Hassle-free database backups
+test_files: []