snapshot_archive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4da07dc7efc8fc705adf5c30458fc478990ce8becbb21341929532726bfcf866
+  data.tar.gz: 55ab36863f972707168fd6a9f4066dae5f63502a29f88d8ab7e0fc3ca14eb905
+SHA512:
+  metadata.gz: 8758443c01473fa6111e37cba9cc4963e9e68470d4b8a352c9df11a4d0e36254cd65ec7b6fe3415ba471b2554da9384211734096fb704d27a25095714bd4611f
+  data.tar.gz: 79aca3b6538fe7e57ff2147fbcb0bd734d28ff3bb1b2e4f879c11e8e532f62cf3d8bdc7ac5f3d3f299dc8bd6a7de4c7fff5abd4c1878c9d475ead5cab227c824

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at pete.kinnecom@appfolio.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snapshot_archive.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    snapshot_archive (0.1.0)
+      commander (~> 4.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    commander (4.6.0)
+      highline (~> 2.0.0)
+    highline (2.0.3)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  snapshot_archive!
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Pete Kinnecom
+
+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,156 @@
+# SnapshotArchive
+
+Save and restore snapshots of stateful services to a central archive. Have a
+development database that you want to restore to a prior state? Just take a
+snapshot and restore it later! Build your own snapshotting behavior in a
+configuration file so that you can snapshot any stateful service you use during
+development.
+
+## Installation
+
+```
+gem install snapshot_archive
+```
+
+## Example
+
+Snapshot and restore mysql databases named `db_1` and `db_2`:
+
+```bash
+$ snap backup mysql:db_1,db_2 -m "snapshot description"
+#=> Saved snapshot: a4758dbe-6f26-4365-9d3a-6962a96557b5
+
+$ snap show a4758dbe-6f26-4365-9d3a-6962a96557b5
+#=> id: a4758dbe-6f26-4365-9d3a-6962a96557b5
+#=> time: 2022-04-15 22:30
+#=> ----------------------
+#=> snapshot description
+
+$ snap restore a4758dbe-6f26-4365-9d3a-6962a96557b5
+#=> Restored snapshot: a4758dbe-6f26-4365-9d3a-6962a96557b5
+```
+
+## Backup
+
+Save a snapshot that can be restored later.
+
+By default, will use the active stores that have been configured. The
+stores used for the snapshot can be overridden by passing them as args
+to the command. Each store can also be passed arguments for
+snapshotting from the CLI. Examples below:
+
+See the "Configure" section for how add a custom store.
+
+```bash
+# Uses your EDITOR to add details for the snapshot.
+# Uses the default configured "stores" for creating the snapshot
+snap backup
+
+# Add a message from the command line:
+snap backup --message "Add message from command line"
+snap backup -m "Add message from command line"
+
+# Override which stores are used for the snapshot
+snap backup store_1 store_2
+
+# Pass arguments to a store
+snap backup mysql:db_1,db_2
+```
+## Show
+
+```bash
+# Show the full details for a given snapshot
+snap show {id}
+```
+
+## Restore
+
+```bash
+# Restore the given snapshot
+snap restore {id}
+```
+
+## List
+
+```bash
+# list all snapshots (pipe to `less` if you like)
+snap list
+```
+
+## Delete
+
+```bash
+# Delete the given snapshot
+snap rm {id}
+```
+
+## Configure
+
+A custom configuration can be written at the location `$HOME/.config/snapshot_archive.rb`. It is written in ruby. Here is an example config:
+
+```ruby
+
+SnapshotArchive.configure do |config|
+
+  # Configure where the snapshots are stored. Defaults to `$HOME/.snapshot_archive`
+  config.storage_path = "/path/to/snapshot_dir"
+
+  # Configure which stores are active by default (can be overridden with --store
+  # option on command line). The default store is "mysql_rails" which saves a
+  # snapshot of all databases for the Rails app found in the CWD.
+  config.active_stores = ["store_1", "store_2"]
+
+  # Creating a custom store:
+  #
+  # Stores must implement two methods:
+  #
+  #   backup: accepts a directory for data and returns a JSON hash (with string
+  #     keys) for use in restoring.
+  #
+  #  restore: accepts the metadata JSON data created when making the backup. No
+  #    return value.
+  #
+  # Stores can either be defined as objects/classes/modules or a builtin store
+  # builder can be used.
+
+  # Using an object:
+
+  class MyCustomStore
+    def backup(dir, args=[])
+      path = File.join(dir, "my_custom_store.txt")
+      File.write(path, "received args: #{args}")
+
+      { "path" => path }
+    end
+
+    def restore(metadata)
+      puts(File.read(metadata.fetch("path")))
+    end
+  end
+
+  config.register_store("my_custom_store", MyCustomStore.new)
+
+
+  # Using the store builder:
+
+  config.register_store("my_customer_store") do |store|
+    store.backup do |dir, args=[]|
+      path = File.join(dir, "my_custom_store.txt")
+      File.write(path, "received args: #{args}")
+
+      { "path" => path }
+    end
+
+    store.restore do |metadata|
+      puts(File.read(metadata.fetch("path")))
+    end
+  end
+
+  # Making an alias for a store with arguments. This makes the following
+  # invocations the same:
+  #   snap backup my_backup
+  #   snap backup mysql:db_1,db_2
+
+  config.register_store("my_backup", "mysql:db_1,db_2")
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "snapshot_archive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/snap

@@ -0,0 +1,131 @@
+#! /usr/bin/env ruby
+
+# frozen_string_literal: true
+
+if $PROGRAM_NAME == __FILE__
+  require "bundler/setup"
+end
+
+require "commander"
+require "snapshot_archive"
+
+module SnapshotArchive
+  class CommanderCli
+    include Commander::Methods
+
+    def run
+      SnapshotArchive::Cfg.load
+
+      program(:name, "SnapshotArchive")
+      program(:version, SnapshotArchive::VERSION)
+      program(:description, SnapshotArchive::DESCRIPTION)
+      global_option('--verbose') { Cfg.instance.shell = Shell.new(verbose: true) }
+
+      command(:backup) do |c|
+        c.syntax = "snap backup [store(s)]"
+        c.description = <<~TXT
+          Save a snapshot that can be restored later.
+
+          By default, will use the active stores that have been configured. The
+          stores used for the snapshot can be overridden by passing them as args
+          to the command. Each store can also be passed arguments for
+          snapshotting from the CLI. Examples below:
+
+          # Uses your EDITOR to add details for the snapshot.
+          # Uses the default configured "stores" for creating the snapshot
+          snap backup
+
+          # Add a message from the command line:
+          snap backup --message "Add message from command line"
+          snap backup -m "Add message from command line"
+
+          # Override which stores are used for the snapshot
+          snap backup store_1 store_2
+
+          # Pass arguments to a store
+          snap backup mysql:db_1,db_2
+        TXT
+
+        c.option "-m MESSAGE", "--message MESSAGE", String, "Description"
+
+        c.action do |args, options|
+          message = (
+            if options.message
+              options.message.strip
+            else
+              ask_editor(File.read(File.join(__dir__, "../lib/template.txt")))
+                .split("\n")
+                .reject { |l| l.match(/\A#|\A\n/) }
+                .join("\n")
+                .strip
+            end
+          )
+
+          stores = (
+            if args.count > 0
+              args.map { |arg| SnapshotArchive::Cfg.parse_store(arg) }.to_h
+            else
+              SnapshotArchive::Cfg.stores
+            end
+          )
+
+          SnapshotArchive::Cli.backup(
+            msg: message,
+            stores: stores
+          )
+        end
+
+      end
+
+      command(:restore) do |c|
+        c.syntax = "snap restore ID"
+        c.description = "Restore the state of the databases."
+
+        c.action do |args, _options|
+          raise "exactly one ID required" unless args.count == 1
+
+          SnapshotArchive::Cli.restore(
+            id: args.first
+          )
+        end
+      end
+
+      command(:list) do |c|
+        c.syntax = "snap list"
+        c.description = "List available snapshots"
+
+        c.action do |_args, options|
+          SnapshotArchive::Cli.list
+        end
+      end
+
+      command(:show) do |c|
+        c.syntax = "snap show"
+        c.description = "Show full message for snapshot"
+
+        c.action do |args, options|
+          raise "exactly one id is required" unless args.length == 1
+
+          SnapshotArchive::Cli.show(args.first)
+        end
+      end
+
+      command(:rm) do |c|
+        c.syntax = "snap rm"
+        c.description = "Delete an snapshot"
+
+        c.action do |args, options|
+          raise "exactly one id is required" unless args.length == 1
+
+          SnapshotArchive::Cli.delete(args.first)
+        end
+      end
+
+      default_command(:list)
+
+      run!
+    end
+  end
+end
+
+SnapshotArchive::CommanderCli.new.run

data/lib/snapshot_archive/archives.rb

@@ -0,0 +1,56 @@
+module SnapshotArchive
+  module Archives
+    class Builder
+      def self.call(dir:, stores:)
+        new(dir, stores).call
+      end
+
+      attr_reader :dir, :stores
+      def initialize(dir, stores)
+        @dir = dir
+        @stores = stores
+      end
+
+      def call
+        stores_metadata = (
+          stores
+            .map { |name, store| store.backup(dir)&.merge(type: name) }
+            .compact
+        )
+
+        {
+          stores: stores_metadata
+        }
+      end
+    end
+
+    class Restore
+      def self.call(metadata)
+        new(metadata).call
+      end
+
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def call
+        metadata.fetch("stores").each do |store_metadata|
+          store = Cfg.instance.store(store_metadata.fetch("type"))
+          store.restore(store_metadata)
+        end
+      end
+    end
+
+    class Presenter
+      def self.call(metadata)
+        new(metadata).call
+      end
+
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+    end
+  end
+end

data/lib/snapshot_archive/cfg.rb

@@ -0,0 +1,134 @@
+require "snapshot_archive/shell"
+require "snapshot_archive/repositories"
+
+module SnapshotArchive
+  class StoreBuilder
+    class CustomStore
+      def initialize(backup:, restore:)
+        @backup = backup
+        @restore = restore
+      end
+
+      def backup(dir)
+        @backup.call(dir)
+      end
+
+      def restore(metadata)
+        @restore.call(metadata)
+      end
+    end
+
+    def backup(&block)
+      @backup = block
+    end
+
+    def restore(&block)
+      @restore = block
+    end
+
+    def to_store
+      CustomStore.new(backup: @backup, restore: @restore)
+    end
+  end
+
+  class Cfg
+    class << self
+      def instance
+        @instance ||= Cfg.new
+      end
+
+      [
+        :bind_backup,
+        :load,
+        :parse_store,
+        :pwd,
+        :repository,
+        :shell,
+        :stores,
+      ].each do |meth|
+        define_method(meth) do |*args|
+          instance.public_send(meth, *args)
+        end
+      end
+    end
+
+    attr_accessor :pwd, :storage_path, :active_stores, :shell
+    def initialize
+      self.active_stores = []
+    end
+
+    def load(path = ".config/snapshot_archive.rb")
+      config_path = File.join(ENV["HOME"], path)
+
+      require("snapshot_archive/default_configuration")
+      Kernel.load(config_path) if File.exist?(config_path)
+    end
+
+    def register_store(name, klass_or_alias=nil, active_by_default: true, &block)
+      store = (
+        if klass_or_alias.is_a?(String)
+          parse_store(klass_or_alias)[1]
+        elsif klass_or_alias
+          klass_or_alias
+        else
+          builder = StoreBuilder.new
+          yield(builder)
+          builder.to_store
+        end
+      )
+
+      store_registry[name] = store
+      if active_by_default
+        active_stores << name
+      end
+    end
+
+    def repository
+      Repositories::FileSystem.new(path: storage_path)
+    end
+
+    def parse_store(str)
+      name, *store_args = str.split(/[:,]/)
+
+      store = (
+        if store_args.count > 0
+          bind_backup(name, store_args)
+        else
+          store_registry.fetch(name)
+        end
+      )
+
+      [name, store]
+    rescue KeyError
+      raise "Store not found: '#{str}'"
+    end
+
+    def bind_backup(name, args)
+      SnapshotArchive::Stores::BoundBackup.new(store_registry.fetch(name), args)
+    end
+
+    def store(name)
+      store_registry.fetch(name)
+    end
+
+    def stores
+      unknown_keys = active_stores - store_registry.keys
+
+      if !unknown_keys.empty?
+        raise ArgumentError.new("invalid store(s): #{unknown_keys.join(",")}")
+      end
+
+      store_registry.slice(*active_stores)
+    end
+
+    def shell
+      @shell ||= Shell.new
+    end
+
+    private
+
+    def store_registry
+      @store_registry ||= {}
+    end
+  end
+end

data/lib/snapshot_archive/cli.rb

@@ -0,0 +1,38 @@
+require "ostruct"
+require "time"
+require "json"
+require "securerandom"
+
+require "snapshot_archive/stores"
+require "snapshot_archive/archives"
+require "snapshot_archive/formatters"
+
+module SnapshotArchive
+  class Cli
+    class << self
+      def backup(msg:, stores:)
+        if msg.empty?
+          Cfg.shell.warn("aborting due to empty message")
+        else
+          Cfg.repository.add(msg: msg, stores: stores)
+        end
+      end
+
+      def restore(id:)
+        Cfg.repository.restore(id)
+      end
+
+      def list
+        Cfg.repository.list
+      end
+
+      def show(id)
+        Cfg.repository.show(id)
+      end
+
+      def delete(id)
+        Cfg.repository.delete(id)
+      end
+    end
+  end
+end

data/lib/snapshot_archive/default_configuration.rb

@@ -0,0 +1,38 @@
+SnapshotArchive.configure do |config|
+  config.register_store(
+    "mysql",
+    SnapshotArchive::Stores::Mysql,
+    active_by_default: false
+  )
+
+  config.register_store("mysql_rails") do |store|
+    store.backup do |dir, _args|
+      existing_databases = (
+        config
+          .shell
+          .run("mysql --execute 'show databases' --silent --skip-column-names")
+      )
+
+      db_names = (
+        config
+          .shell
+          .run("sh -c 'cd $(git rev-parse --show-toplevel) && git grep database:.*_development *database.yml || exit 0'")
+          .map { |line| line.match(/database:\s+(.*_development)\s*$/) }
+          .compact
+          .map { |match| match[1] }
+          .select { |db| existing_databases.include?(db) }
+          .reject { |db| db.match(/_tmp_/)}
+      )
+
+      next if db_names.empty?
+
+      Cfg.bind_backup("mysql", db_names).backup(dir)
+    end
+
+    store.restore do |metadata|
+      Cfg.store("mysql").restore(metadata)
+    end
+  end
+
+  config.storage_path = File.join(ENV["HOME"], ".snapshot_archive")
+end

data/lib/snapshot_archive/formatters.rb

@@ -0,0 +1,49 @@
+module SnapshotArchive
+  module Formatters
+    class List
+      def self.call(metadata)
+        new(metadata).call
+      end
+
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def call
+        id = metadata.fetch("id")
+        timestamp = Time.parse(metadata.fetch("timestamp")).strftime("%F %H:%M")
+        message = metadata.fetch("message")
+
+        short_message = message.split("\n").first
+        Cfg.shell.puts([id, timestamp, short_message].join(" : "))
+      end
+    end
+
+    class Show
+      def self.call(metadata)
+        new(metadata).call
+      end
+
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def call
+        id = metadata.fetch("id")
+        timestamp = Time.parse(metadata.fetch("timestamp")).strftime("%F %H:%M")
+        message = metadata.fetch("message")
+        dir = metadata.fetch("dir")
+
+        Cfg.shell.puts(<<~TXT)
+          id: #{id}
+          time: #{timestamp}
+          path: #{dir}
+          ----------------------
+          #{message}
+        TXT
+      end
+    end
+  end
+end

data/lib/snapshot_archive/repositories.rb

@@ -0,0 +1,90 @@
+module SnapshotArchive
+  module Repositories
+    class FileSystem
+      SCHEMA = "0"
+      attr_reader :path
+      def initialize(path:)
+        @path = path
+      end
+
+      def add(msg:, stores:)
+        id = SecureRandom.uuid
+        timestamp = Time.now
+        dir = mkdir(id)
+
+        archive_metadata = Archives::Builder.call(dir: dir, stores: stores)
+
+        Cfg.shell.debug("Using stores: #{stores.keys.join(", ")}")
+
+        if archive_metadata.fetch(:stores).empty?
+          Cfg.shell.warn("no data to save")
+        else
+          metadata = {
+            __schema__: SCHEMA,
+            id: id,
+            message: msg,
+            timestamp: timestamp.utc.iso8601,
+            dir: dir,
+            archive: archive_metadata
+          }
+
+          Cfg.shell.debug("writing metadata: #{metadata.to_json}")
+          Cfg.shell.info("Saved snapshot: #{id}")
+          File.write(File.join(dir, "metadata.json"), JSON.pretty_generate(metadata))
+        end
+      end
+
+      def restore(id)
+        metadata = JSON.parse(File.read(File.join(path, id, "metadata.json")))
+
+        Archives::Restore.call(metadata.dig("archive"))
+        Cfg.shell.info("Restored snapshot: #{id}")
+      end
+
+      def list
+        snapshots = (
+          Dir
+            .glob(File.join(path, "**/metadata.json"))
+            .map { |metadata| JSON.parse(File.read(metadata)) }
+            .sort_by { |metadata| metadata.fetch("timestamp") }
+            .reverse
+        )
+
+        if snapshots.count > 0
+          snapshots.each do |metadata|
+            Formatters::List.call(metadata)
+          end
+        else
+          Cfg.shell.info("No snapshots in archive")
+        end
+      end
+
+      def show(id)
+        Formatters::Show.call(
+          JSON.parse(File.read(File.join(path, id, "metadata.json")))
+        )
+      end
+
+      def delete(id)
+        dir = File.join(path, id)
+
+        raise ArgumentError.new("unknown snapshot: #{id}") unless File.exist?(dir)
+
+        FileUtils.rm_rf(dir)
+        Cfg.shell.info("Removed snapshot: #{id}")
+      end
+
+      private
+
+      def timestamp
+        @timestamp ||= Time.now
+      end
+
+      def mkdir(id)
+        dir = File.join(path, id)
+        FileUtils.mkdir_p(dir)
+        dir
+      end
+    end
+  end
+end

data/lib/snapshot_archive/shell.rb

@@ -0,0 +1,53 @@
+module SnapshotArchive
+  class Shell
+    CODES = {
+      red: 31,
+      green: 32,
+      yellow: 33,
+      pink: 35,
+    }.freeze
+
+    CommandFailureError = Class.new(StandardError)
+
+    def initialize(verbose: false)
+      @verbose = verbose
+    end
+
+    def run(cmd)
+      debug(cmd)
+
+      `#{cmd}`
+        .split("\n")
+        .tap { raise CommandFailureError.new(cmd) unless $? == 0 }
+    end
+
+    def warn(msg)
+      print "#{colorize(msg, :red)}\n"
+    end
+
+    def notify(msg)
+      print "#{colorize(msg, :yellow)}\n"
+    end
+
+    def puts(msg)
+      print "#{msg}\n"
+    end
+
+    def info(msg)
+      puts(msg)
+    end
+
+    def debug(msg)
+      puts(msg) if @verbose
+    end
+
+    private
+
+    # colorization
+    def colorize(msg, color)
+      color_code = CODES.fetch(color)
+
+      "\e[#{color_code}m#{msg}\e[0m"
+    end
+  end
+end

data/lib/snapshot_archive/stores.rb

@@ -0,0 +1,81 @@
+module SnapshotArchive
+  module Stores
+    class BoundBackup
+      attr_reader :store, :args
+      def initialize(store, args)
+        raise ArgumentError.new("double bound backup") if store.is_a?(BoundBackup)
+
+        @store = store
+        @args = args
+      end
+
+      def backup(dir)
+        store.backup(dir, args)
+      end
+
+      def restore(metadata)
+        store.restore(metadata)
+      end
+    end
+
+    module Mysql
+      class << self
+        def backup(dir, args)
+          Backup.call(dir, args)
+        end
+
+        def restore(metadata)
+          Restore.call(metadata)
+        end
+      end
+
+      class Backup
+        def self.call(dir, names)
+          new(dir, names).call
+        end
+
+        attr_reader :dir, :names
+        def initialize(dir, names)
+          @dir = dir
+          @names = names
+        end
+
+        def call
+          Cfg.shell.debug("backing up #{names} into #{dir}")
+
+          path = File.join(dir, "mysql.sql.gz")
+
+          Cfg.shell.run(<<~SH)
+            mysqldump \
+              --add-drop-database \
+              --databases #{names.join(" ")} \
+              | gzip > #{path}
+          SH
+
+          {
+            type: "mysql",
+            path: path,
+            databases: names
+          }
+        end
+      end
+
+      class Restore
+        def self.call(metadata)
+          new(metadata).call
+        end
+
+        attr_reader :metadata
+        def initialize(metadata)
+          @metadata = metadata
+        end
+
+        def call
+          dump_path = metadata.dig("path")
+          Cfg.shell.debug("restoring #{metadata.to_json}")
+          Cfg.shell.run("bash -ec 'zcat < #{dump_path} | mysql -uroot'")
+        end
+      end
+    end
+  end
+end

data/lib/snapshot_archive/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SnapshotArchive
+  VERSION = "0.1.0"
+end

data/lib/snapshot_archive.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "snapshot_archive/version"
+require_relative "snapshot_archive/cfg"
+
+module SnapshotArchive
+  class Error < StandardError; end
+
+  DESCRIPTION = <<~TEXT.chomp
+    Save and restore snapshots of stateful services to a central archive. The
+    default action is to backup all databases for the current rails apps,
+    however, custom actions can easily be configured.
+
+    See https://github.com/petekinnecom/snapshot_archive for the full README.
+  TEXT
+
+  class << self
+    def configure
+      yield(Cfg.instance)
+    end
+  end
+end
+
+require_relative "snapshot_archive/cli"

data/lib/template.txt

@@ -0,0 +1,5 @@
+
+
+# Follows same rules as a git commit message. First line is summary, followed by
+# more detailed info. Set `export EDITOR="..."` to use a different editor for
+# this message. (eg. `export EDITOR="code --wait"` to use VSCode)

data/script/install

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -ex
+
+gemname='snapshot_archive'
+
+gem uninstall -Ix ${gemname}
+gem build ${gemname}.gemspec
+gemfile=${gemname}-"$(grep -oEi '\d+\.\d+\.\d+' lib/${gemname}/version.rb)".gem
+gem install "${gemfile}"
+rm "${gemfile}"

data/snapshot_archive.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/snapshot_archive/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "snapshot_archive"
+  spec.version       = SnapshotArchive::VERSION
+  spec.authors       = ["Pete Kinnecom"]
+  spec.email         = ["git@k7u7.com"]
+
+  spec.summary       = <<~TEXT.chomp
+    Save and restore snapshots of stateful services to a central archive. The
+    default action is to backup all databases for the current rails apps,
+    however, custom actions can easily be configured.
+  TEXT
+
+  spec.homepage      = "https://github.com/petekinnecom/snapshot_archive"
+  spec.license       = "WTFPL"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("commander", "~> 4.5")
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: snapshot_archive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Kinnecom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+description: 
+email:
+- git@k7u7.com
+executables:
+- snap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/snap
+- lib/snapshot_archive.rb
+- lib/snapshot_archive/archives.rb
+- lib/snapshot_archive/cfg.rb
+- lib/snapshot_archive/cli.rb
+- lib/snapshot_archive/default_configuration.rb
+- lib/snapshot_archive/formatters.rb
+- lib/snapshot_archive/repositories.rb
+- lib/snapshot_archive/shell.rb
+- lib/snapshot_archive/stores.rb
+- lib/snapshot_archive/version.rb
+- lib/template.txt
+- script/install
+- snapshot_archive.gemspec
+homepage: https://github.com/petekinnecom/snapshot_archive
+licenses:
+- WTFPL
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/petekinnecom/snapshot_archive
+  source_code_uri: https://github.com/petekinnecom/snapshot_archive
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key: 
+specification_version: 4
+summary: Save and restore snapshots of stateful services to a central archive. The
+  default action is to backup all databases for the current rails apps, however, custom
+  actions can easily be configured.
+test_files: []