noop-backup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3039d98fa3edb9366c1fe2e41f0f1ddfa999c0ef088d265ac256de69a835b7b
+  data.tar.gz: 352a209a61c3b8dec730308dba8ca43813e3444d9664db7941ef54b08caf3f00
+SHA512:
+  metadata.gz: 5e6912b20074c3a938aebb51b4c55a03b6c0c4134b8b9b4c384d32031eacb73f5a7c9952a7079fbcbb8f2b37745a7450dbe2076f458509794e84dbc973006c47
+  data.tar.gz: 7fc6e19dbc757daf152b9c534274406c2005e25fd489ce5c0dd958185c22619e9842979d8ad35b9a420ef8a038801879061b85c4a9bff4a576363ed5cf2384ee

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [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,94 @@
+# NoopBackup
+
+Ruby gem for backing up PostgreSQL databases with minimum effort.
+
+## Installation
+
+If using bundler, add the gem to your `Gemfile`:
+
+```bash
+bundle add noop-backup
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install noop-backup
+```
+
+The gem requires `pg_dump` to be installed on the machine that is running it.
+
+## Usage
+
+### Automatic
+
+#### Rails 8 with Solid Queue
+
+(soon) NoopBackup will run automatically using the Solid Queue scheduler.
+
+#### Sidekiq, Good Job, whenever
+
+(soon)
+
+### Manually
+
+```sh
+bundle exec nbu backup
+```
+
+This command will dump the database and stream it to S3 without writing anything to disk. Use any
+scheduler or even cron to run it periodically.
+
+## Configuration
+
+The gem needs AWS credentials and a bucket name:
+
+```
+AWS_REGION=region
+AWS_ACCESS_KEY_ID=your-key
+AWS_SECRET_ACCESS_KEY=your-secret-key
+NBU_BUCKET=s3-bucket
+NBU_MIN_SIZE=2048
+```
+
+If your app already has the AWS SDK set up, only the bucket needs to be configured.
+
+Alternatively, the gem can be configured with an initializer:
+
+```rb
+# config/initializers/noop-backup.rb
+
+NoopBackup.configure do |config|
+  config.bucket = 'bucket-name'
+  config.region = 'eu-central-1'
+  config.prefix = Rails.env
+  config.min_size = 2048
+
+  config.notifier :slack do |slack|
+    slack.webhook_url = 'https://hooks.slack.com/services/whatever'
+  end
+end
+```
+
+## 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/noop-backup.
+
+## Wishlist
+
+- [ ] S3-compatible backends
+- [ ] file backends
+- [ ] email notifier
+- [ ] SMS notifier
+- [ ] restore command
+- [ ] test command
+
+## 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/nbu

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

data/lib/noop_backup/cli.rb

@@ -0,0 +1,13 @@
+require "thor"
+
+module NoopBackup
+  class CLI < Thor
+    def self.exit_on_failure? = true
+
+    desc "backup", "Create and store a new backup"
+    def backup
+      NoopBackup.prepare!
+      NoopBackup::Commands::Backup.execute
+    end
+  end
+end

data/lib/noop_backup/commands/backup.rb

@@ -0,0 +1,94 @@
+require "aws-sdk-s3"
+require "open3"
+
+module NoopBackup::Commands
+  class Backup
+    def self.execute
+      new.execute
+    end
+
+    def initialize
+      @key = [config.prefix, Time.now.utc.strftime("%Y%m%dT%H%M%SZ")].join("/")
+      @bytes = 0
+      @started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def execute
+      commands = [
+        [config.pg_env, "pg_dump", "--format=custom", "--no-owner"]
+      ]
+
+      commands << ["pv", "-btra"] if system("which", "pv", out: File::NULL, err: File::NULL)
+
+      Open3.pipeline_r(*commands) do |last_stdout, wait_threads|
+        upload(last_stdout)
+
+        raise "pipeline failed" unless wait_threads.all? { |t| t.value.success? }
+      end
+
+      duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @started
+
+      if config.min_size && @bytes.to_i < config.min_size.to_i
+        raise "backup too small: #{human_size(@bytes)} < min_size (#{human_size(config.min_size)})"
+      end
+
+      config.notify(success_message(duration))
+    rescue => e
+      remove_partial_upload
+
+      config.notify("❌ Backup failed: #{e.message}")
+
+      exit 1
+    end
+
+    private
+
+    def config
+      @config ||= NoopBackup.configuration
+    end
+
+    def s3_client
+      @_s3_client ||= Aws::S3::Client.new(region: config.region)
+    end
+
+    # Prefer Aws::S3::TransferManager for streaming uploads if available.
+    # Aws::S3::Resource.upload_stream is deprecated in newer versions
+    def upload(stdout)
+      if defined?(Aws::S3::TransferManager)
+        manager = Aws::S3::TransferManager.new(client: s3_client)
+
+        manager.upload_stream(bucket: config.bucket, key: @key, part_size: 8 * 1024 * 1024, thread_count: 2) do |s3_stream|
+          @bytes = IO.copy_stream(stdout, s3_stream)
+        end
+      else
+        object = Aws::S3::Resource.new(region: config.region).bucket(config.bucket).object(@key)
+
+        object.upload_stream(part_size: 8 * 1024 * 1024, thread_count: 2) do |s3_stream|
+          @bytes = IO.copy_stream(stdout, s3_stream)
+        end
+      end
+    end
+
+    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
+
+    def success_message(duration)
+      "✅ #{config.pg_env["PGDATABASE"]} backed up successfully — " \
+        "#{human_size(@bytes)} in #{duration.round(1)}s → #{config.bucket}/#{@key}"
+    end
+
+    def remove_partial_upload
+      s3_client.delete_object(bucket: config.bucket, key: @key)
+    rescue => e
+      warn "Failed to clean up partial upload #{@key}: #{e.message}"
+    end
+  end
+end

data/lib/noop_backup/configuration.rb

@@ -0,0 +1,54 @@
+module NoopBackup
+  class Configuration
+    attr_accessor :bucket,
+      :region,
+      :prefix,
+      :pg_host,
+      :pg_port,
+      :pg_user,
+      :pg_password,
+      :pg_database,
+      :min_size
+
+    def initialize
+      @bucket = ENV["NBU_BUCKET"]
+      @region = ENV["AWS_REGION"] || "auto"
+      @prefix = "backups"
+      @notifiers = [NoopBackup::Notifiers::Stdout.new]
+      @min_size = ENV.fetch("NBU_MIN_SIZE", 1024).to_i
+    end
+
+    def notifier(type)
+      case type
+      when :slack
+        notifier = NoopBackup::Notifiers::Slack.new
+
+        yield notifier
+
+        @notifiers << notifier
+      else raise "Unknown notifier: #{type}"
+      end
+    end
+
+    def notify(message)
+      @notifiers.each do |notifier|
+        notifier.notify(message)
+      end
+    end
+
+    def pg_env
+      {
+        "PGHOST" => pg_host || db_config[:host]&.to_s || "localhost",
+        "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/noop_backup/notifiers/slack.rb

@@ -0,0 +1,29 @@
+require "net/http"
+require "uri"
+require "json"
+
+module NoopBackup::Notifiers
+  class Slack
+    attr_accessor :webhook_url
+
+    def notify(text)
+      uri = URI(webhook_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.path, "Content-Type" => "application/json")
+      request.body = {text: text}.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/noop_backup/notifiers/stdout.rb

@@ -0,0 +1,7 @@
+module NoopBackup::Notifiers
+  class Stdout
+    def notify(text)
+      puts text
+    end
+  end
+end

data/lib/noop_backup/version.rb

@@ -0,0 +1,3 @@
+module NoopBackup
+  VERSION = "0.1.0"
+end

data/lib/noop_backup.rb

@@ -0,0 +1,28 @@
+require_relative "noop_backup/version"
+require_relative "noop_backup/configuration"
+require_relative "noop_backup/commands/backup"
+require_relative "noop_backup/notifiers/slack"
+require_relative "noop_backup/notifiers/stdout"
+
+module NoopBackup
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias_method :config, :configuration
+
+    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
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: noop-backup
+version: !ruby/object:Gem::Version
+  version: 0.1.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:
+- nbu
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/nbu
+- lib/noop_backup.rb
+- lib/noop_backup/cli.rb
+- lib/noop_backup/commands/backup.rb
+- lib/noop_backup/configuration.rb
+- lib/noop_backup/notifiers/slack.rb
+- lib/noop_backup/notifiers/stdout.rb
+- lib/noop_backup/version.rb
+homepage: https://github.com/gmitrev/noop-backup
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gmitrev/noop-backup
+  source_code_uri: https://github.com/gmitrev/noop-backup/tree/main
+  changelog_uri: https://github.com/gmitrev/noop-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: []