brillo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b684f9b150cde1eded3db5ae684ca02853e6ae37
+  data.tar.gz: 1a052b7afc30957c7b87b04506be442c511b65ea
+SHA512:
+  metadata.gz: b1726eac1715f1fda25a19e35f77e82bdfe528378c83736ca194ff86c0a1d6bd57eb2d203d4583d8e0cef9e758209200b3d818d167e3533f13d013b1ca0f8fb9
+  data.tar.gz: 2e9857f15ea8486806208bf64954b35eec1371fceb183b27803e828baf1d6726a718f350f50f91ffe6f23e230f80270d8529820db706dfd9a4f5f7ed62055fed

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+
+## 1.0.0
+First public Brillo version!
+
+## 0.3.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in brillo.gemspec
+gemspec
+
+gem 'rails', "~> 4.2.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Matt Bessey
+
+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,104 @@
+[![Build Status](https://travis-ci.com/bessey/brillo.svg?token=z16y9ppDyNfaLAvjjHbK&branch=master)](https://travis-ci.com/bessey/brillo)
+
+# Brillo
+
+Brillo is a Rails database scrubber and loader, useful for making lightweight copies of your production database for development machines, with sensitive information obfuscated. Most configuration is done through YAML: Specify the models that you want to back up, what associations you want with them, and what fields should be obfuscated (and how).
+
+Once that is done, dropping your local DB and replacing it with the latest scrubbed copy is as easy as `rake db:load`.
+
+Under the hood we use [Polo](https://github.com/IFTTT/polo) to explore the classes and associations you specify in brillo.yml, obfuscated fields as configured.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brillo'
+# We currently rely on an unreleased version of Polo
+gem 'polo',   github: 'IFTTT/polo'
+```
+
+Generate a starter `brillo.yml` file and `config/initializers/brillo.rb` with
+
+```bash
+$ rails g brillo_config
+```
+
+If you're using Capistrano, add Brillo's tasks to your Capfile:
+
+```ruby
+# Capfile
+require 'capistrano/brillo'
+```
+
+Lastly, since the scrubber is pretty resource intensive you may wish to ensure it runs on separate hardware from your app servers:
+
+```ruby
+# config/deploy.rb
+set :brillo_role, :my_batch_role
+```
+
+## Usage
+
+Here's an example `brillo.yml` for IMDB:
+
+```yaml
+name: imdb            # Namespace the scrubbed file will occupy in S3
+explore:
+  user:               # Name of ActiveRecord class in snake_case
+    tactic: all       # Scrubbing tactic to use (see Brillo:TACTICS for choices)
+    associations:     # Associations to include in the scrub (ALL associated records included)
+      - comments
+  movie:
+    tactic: latest    # The latest tactic explores the most recent 1,000 records
+    associations:
+      - actors
+      - ratings
+  admin/note:         # Corresponds to the Admin::Note class
+    tactic: all
+obfuscations:         #
+  user.name: name     # Scrub user.name with the "name" scrubber (see Brillo::SCRUBBERS for choices)
+  user.phone: phone
+  user.email: email
+```
+
+In order to communicate with S3, Brillo expects `AWS_ACCESS_KEY` and `AWS_SECRET_KEY` to be set in the environment. It uses [Tim Kay's AWS cli](http://timkay.com/aws/) to communicate with AWS.
+
+### Loading a database in development
+
+```bash
+$ rake db:load
+```
+
+### Loading a database on a stage
+
+```bash
+$ cap staging db:load
+```
+
+### Adding scrub tactics and obfuscations
+
+If the built in record selection tactics aren't enough for you, or you need a custom obfuscation strategy, you can add them via the initializer. They are available in the YAML config like any other strategy.
+
+```ruby
+# config/initializers/brillo.rb
+
+Brillo.configure do |config|
+  config.add_tactic :oldest, -> (klass) { klass.order(created_at: :desc).limit(1000) }
+
+  config.add_obfuscation :remove_ls, -> (field) {
+    field.gsub(/l/, "X")
+  }
+
+  # If you need the context of the entire record being obfuscated, it is available in the second argument
+  config.add_obfuscation :phone_with_id, -> (field, instance) {
+    (555_000_0000 + instance.id).to_s
+  }
+end
+
+```
+
+## To Do
+
+- Support S3 transfer via the usual AWS CLI
+- Support alternative transfer mechanisms

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails"
+require "brillo"
+
+# 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

data/bin/setup

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

data/brillo.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brillo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brillo"
+  spec.version       = Brillo::VERSION
+  spec.authors       = ["Matt Bessey"]
+  spec.email         = ["mbessey@caring.com"]
+
+  spec.summary       = %q{Rails database scrubber and loader, great for seeding your dev db with real but sanitized data}
+  spec.homepage      = "https://github.com/bessey/brillo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|dummy)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "capistrano", "~> 3.0"
+  spec.add_runtime_dependency "polo", "~> 0.3"
+
+  spec.add_development_dependency "rails", ">= 3.2"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "geminabox"
+end

data/config/brillo-example.yml

@@ -0,0 +1,13 @@
+name: my-app          # Namespace the scrubbed file will occupy
+## Optional configuration (with defaults shown)
+# compress: true        # Enables gzip on scrub and ungzip on load
+# send_to_s3: true      # Disable to skip sending to S3, useful for debugging
+# fetch_from_s3: true   # Disable to skip fetching from S3, useful when you have an existing scrub in tmp/
+#
+# obfuscations:
+#   user.name: name     # Scrub table.field with scrubber (see Brillo::SCRUBBERS for choices)
+explore:
+  user:               # Name of ActiveRecord class in snake_case
+    tactic: all       # Scrubbing tactic to use (see Brillo:TACTICS for choices)
+    associations:     # Associations to include in the scrub (ALL associated records included)
+      - comments

data/config/brillo-initializer.rb

@@ -0,0 +1,14 @@
+Brillo.configure do |config|
+  ## Add extra tactics for selecting records as you need them
+  # config.add_tactic :oldest, -> (klass) { klass.order(created_at: :desc).limit(1000) }
+
+  ## Custom obfuscations can also be added
+  # config.add_obfuscation :remove_ls, -> (field) {
+  #   field.gsub(/l/, "X")
+  # }
+
+  ## If you need the context of the entire record being obfuscated, it is available in the second argument
+  # config.add_obfuscation :phone_with_id, -> (field, instance) {
+  #   (555_000_0000 + instance.id).to_s
+  # }
+end

data/lib/brillo/adapter/README.md

@@ -0,0 +1,3 @@
+## Brillo::Adapter
+
+Adapter allow database specific setup and teardown to be added to the Scrubber's dumped SQL.

data/lib/brillo/adapter/base.rb

@@ -0,0 +1,27 @@
+module Brillo
+  module Adapter
+    class Base
+      attr_reader :config
+      def initialize(db_config)
+        @config = db_config
+      end
+      def header
+        ActiveRecord::Base.connection.dump_schema_information
+      end
+
+      def footer
+        ""
+      end
+
+      def dump_structure_and_migrations(config)
+        # Overrides the path the structure is dumped to in Rails >= 3.2
+        ENV['SCHEMA'] = ENV['DB_STRUCTURE'] = config.dump_path.to_s
+        Rake::Task["db:structure:dump"].invoke
+      end
+
+      def load_command
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/brillo/adapter/mysql.rb

@@ -0,0 +1,32 @@
+module Brillo
+  module Adapter
+    class MySQL < Base
+      def header
+        super + <<-SQL
+        -- Disable autocommit, uniquechecks, and foreign key checks, for performance on InnoDB
+        -- http://dev.mysql.com/doc/refman/5.5/en/optimizing-innodb-bulk-data-loading.html
+        SET @OLD_AUTOCOMMIT=@@AUTOCOMMIT, AUTOCOMMIT = 0;
+        SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS = 0;
+        SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS = 0;
+        SQL
+      end
+
+      def footer
+        super + <<-SQL
+        SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS;
+        SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS;
+        SET AUTOCOMMIT = @OLD_AUTOCOMMIT;
+        COMMIT;
+        SQL
+      end
+
+      def dump_structure_and_migrations(config)
+        Dumper::MysqlDumper.new(config).dump
+      end
+
+      def load_command
+        "mysql --host #{config[:host]} -u #{config[:username]} #{config[:password] ? "-p#{config[:password]}" : ""} #{config[:database]}"
+      end
+    end
+  end
+end

data/lib/brillo/adapter/postgres.rb

@@ -0,0 +1,9 @@
+module Brillo
+  module Adapter
+    class Postgres < Base
+      def load_command
+        "psql --host #{config[:host]} -U #{config[:username]} #{config[:password] ? "-W#{config[:password]}" : ""} #{config[:database]}"
+      end
+    end
+  end
+end

data/lib/brillo/config.rb

@@ -0,0 +1,92 @@
+module Brillo
+  class Config
+    AWS_KEY_PATH = '/etc/ec2_secure_env.yml'
+    S3_BUCKET = 'scrubbed_databases2'
+    attr_reader :app_name, :compress, :obfuscations, :klass_association_map, :db, :send_to_s3, :fetch_from_s3,
+      :aws_key_path, :s3_bucket
+
+    def initialize(options = {})
+      @app_name =               options.fetch("name")
+      @klass_association_map =  options["explore"] || {}
+      @compress =               options.fetch("compress",  true)
+      @fetch_from_s3 =          options.fetch("fetch_from_s3", true)
+      @send_to_s3 =             options.fetch("send_to_s3", true)
+      @aws_key_path =           options.fetch("aws_key_path", AWS_KEY_PATH)
+      @s3_bucket =              options.fetch("s3_bucket", S3_BUCKET)
+      @obfuscations =           parse_obfuscations(options["obfuscations"] || {})
+    rescue KeyError => e
+      raise ConfigParseError, e
+    end
+
+    def verify!
+      @obfuscations.each do |field, strategy|
+        next if Scrubber::SCRUBBERS[strategy]
+        raise ConfigParseError, "Scrub strategy '#{strategy}' not found, but required by '#{field}'"
+      end
+      @klass_association_map.each do |klass, _|
+        next if klass.camelize.safe_constantize
+        raise ConfigParseError, "Class #{klass} not found"
+      end
+      self
+    end
+
+    def add_obfuscation(name, scrubber)
+      Scrubber::SCRUBBERS[name] = scrubber
+    end
+
+    def add_tactic(name, tactic)
+      Scrubber::TACTICS[name] = tactic
+    end
+
+    def app_tmp
+      Rails.root.join "tmp"
+    end
+
+    def dump_filename
+      "#{app_name}-scrubbed.dmp"
+    end
+
+    def remote_filename
+      compress ? "#{dump_filename}.gz" : dump_filename
+    end
+
+    def dump_path
+      app_tmp + dump_filename
+    end
+
+    def remote_path
+      app_tmp + remote_filename
+    end
+
+    def db
+      @db_config ||= ActiveRecord::Base.connection.instance_variable_get(:@config).dup
+    end
+
+    # TODO support other tranfer systems
+    def transferrer
+      Transferrer::S3.new(self)
+    end
+
+    def adapter
+      case db[:adapter].to_sym
+      when :mysql2
+        Adapter::MySQL.new(db)
+      when :postgres
+        Adapter::Postgres.new(db)
+      else
+        raise ConfigParseError, "Unsupported DB adapter #{db[:adapter]}"
+      end
+    end
+
+    # Convert generic cross table obfuscations to symbols so Polo parses them correctly
+    # "my_table.field" => "my_table.field"
+    # "my_field"       => :my_field
+    def parse_obfuscations(obfuscations)
+      obfuscations.each_pair.with_object({}) do |field_and_strategy, hash|
+        field, strategy = field_and_strategy
+        strategy = strategy.to_sym
+        field.match(/\./) ? hash[field] = strategy : hash[field.to_sym] = strategy
+      end
+    end
+  end
+end

data/lib/brillo/dumper/mysql_dumper.rb

@@ -0,0 +1,44 @@
+module Brillo
+  module Dumper
+    class MysqlDumper
+      include Helpers::ExecHelper
+      include Logger
+      attr_reader :config
+      def initialize(config)
+        @config = config
+      end
+
+      def dump
+        db = config.db
+        execute!(
+          "mysqldump",
+          host_arg,
+          "-u #{db[:username]}",
+          password_arg,
+          "--no-data",
+          "--single-transaction", # InnoDB only. Prevent MySQL locking the whole database during dump.
+          "#{db[:database]}",
+          "> #{config.dump_path}"
+        )
+      end
+
+      private
+
+      def password_arg
+        if password = config.db[:password].presence
+          "--password=#{password}"
+        else
+          ""
+        end
+      end
+
+      def host_arg
+        if (host = config.db[:host].presence) && host != 'localhost'
+          "-h #{host}"
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/brillo/errors.rb

@@ -0,0 +1,4 @@
+module Brillo
+  ConfigParseError    = Class.new(StandardError)
+  CredentialsError   = Class.new(StandardError)
+end

data/lib/brillo/helpers/exec_helper.rb

@@ -0,0 +1,31 @@
+require 'open3'
+module Brillo
+  module Helpers
+    module ExecHelper
+      def execute *command
+        command_string = Array(command).join(' ')
+        log_anonymized command_string
+        stdout, stderr, status = Open3.capture3 command_string
+        [status.success?, stdout, stderr]
+      end
+
+      def execute! *command
+        success, stdout, stderr = execute(command)
+        if success
+          [success, stdout, stderr]
+        else
+          raise RuntimeError, stderr
+        end
+      end
+
+      private
+
+      def log_anonymized command_string
+        command_string = command_string.gsub(/--password=[^\s]+/, "--password={FILTERED}")
+        command_string = command_string.gsub(/EC2_ACCESS_KEY=[^\s]+/, "EC2_ACCESS_KEY={FILTERED}")
+        command_string = command_string.gsub(/EC2_SECRET_KEY=[^\s]+/, "EC2_SECRET_KEY={FILTERED}")
+        logger.info "Running \n\t #{command_string}"
+      end
+    end
+  end
+end

data/lib/brillo/loader.rb

@@ -0,0 +1,42 @@
+module Brillo
+  # Responsible for fetching an existing SQL scrub from S3, cleaning the database,
+  # and loading the SQL.
+  class Loader
+    include Helpers::ExecHelper
+    include Logger
+    attr_reader :config
+
+    def initialize(config)
+      raise "⚠️ DON'T LOAD IN PRODUCTION! ⚠️" if Rails.env.production?
+      @config = config
+    end
+
+    def load!
+      config.transferrer.download
+      recreate_db
+      import_sql
+    end
+
+    def recreate_db
+      ["db:drop", "db:create"].each do |t|
+        logger.info "Running\n\trake #{t}"
+        Rake::Task[t].invoke
+      end
+    end
+
+    def import_sql
+      if config.compress
+        execute!("gunzip -c #{config.remote_path} | #{sql_load_command}")
+      else
+        execute!("cat #{config.dump_path} | #{sql_load_command}")
+      end
+      logger.info "Import complete!"
+    end
+
+    private
+
+    def sql_load_command
+      config.adapter.load_command
+    end
+  end
+end

data/lib/brillo/logger.rb

@@ -0,0 +1,15 @@
+module Brillo
+  module Logger
+    def self.logger= logger
+      @logger = logger
+    end
+
+    def self.logger
+      @logger ||= Rails.logger
+    end
+
+    def logger
+      Brillo::Logger.logger
+    end
+  end
+end

data/lib/brillo/railtie.rb

@@ -0,0 +1,10 @@
+module Brillo
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/brillo.rake"
+    end
+    generators do
+      require "generators/brillo.rb"
+    end
+  end
+end

data/lib/brillo/scrubber.rb

@@ -0,0 +1,111 @@
+module Brillo
+  # Responsible for creating a fresh scrubbed SQL copy of the database,
+  # as specified via config, and uploading to S3
+  class Scrubber
+    include Helpers::ExecHelper
+    include Logger
+    JUMBLE_PRNG = Random.new
+    LATEST_LIMIT = 1_000
+
+    # Define some procs as scrubbing strategies for Polo
+    SCRUBBERS = {
+      default_time: ->(t) { t.nil? ? Time.now.to_s(:sql) : t },
+      email:        ->(e) { e.match(/@caring.com/) ? e : Digest::MD5.hexdigest(e) + "@example.com".freeze },
+      jumble:       ->(j) { j.downcase.chars.shuffle!(random: JUMBLE_PRNG.clone).join },
+      phone:        ->(n) { n = n.split(' ').first; n && n.length > 9 ? n[0..-5] + n[-1] + n[-2] + n[-3] + n[-4] : n},   # strips extensions
+      name:         ->(n) { n.downcase.split(' ').map do |word|
+          word.chars.shuffle!(random: JUMBLE_PRNG.clone).join
+        end.each(&:capitalize!).join(' ')
+      },
+    }
+
+    TACTICS = {
+      latest: -> (klass) { klass.order('id desc').limit(LATEST_LIMIT).pluck(:id) },
+      all:    -> (klass) { klass.pluck(:id) }
+    }
+
+    attr_reader :config, :adapter, :transferrer
+
+    def initialize(config)
+      @config = config
+      @adapter = config.adapter
+    end
+
+    def scrub!
+      FileUtils.rm [config.dump_path, config.remote_path], force: true
+      configure_polo
+      adapter.dump_structure_and_migrations(config)
+      explore_all_classes
+      compress
+      config.transferrer.upload
+    end
+
+    def explore_all_classes
+      File.open(config.dump_path, "a") do |sql_file|
+        sql_file.puts(adapter.header)
+        klass_association_map.each do |klass, options|
+          begin
+            klass = deserialize_class(klass)
+            tactic = deserialize_tactic(options)
+          rescue ConfigParseError => e
+            logger.error "Error in brillo.yml: #{e.message}"
+            next
+          end
+          associations = options.fetch("associations", [])
+          explore_class(klass, tactic, associations) do |insert|
+            sql_file.puts(insert)
+          end
+        end
+        sql_file.puts(adapter.footer)
+      end
+    end
+
+    private
+
+    def compress
+      return unless config.compress
+      execute!("gzip -f #{config.dump_path}")
+    end
+
+    def explore_class(klass, tactic_or_ids, associations)
+      ids = tactic_or_ids.is_a?(Symbol) ? TACTICS.fetch(tactic_or_ids).call(klass) : tactic_or_ids
+      logger.info("Scrubbing #{ids.length} #{klass} rows with associations #{associations}")
+      Polo.explore(klass, ids, associations).each do |row|
+        yield "#{row};"
+      end
+    end
+
+    def klass_association_map
+      config.klass_association_map
+    end
+
+    def obfuscations
+      config.obfuscations.map do |field, strategy|
+        [field, SCRUBBERS.fetch(strategy)]
+      end.to_h
+    end
+
+    def configure_polo
+      obfs = obfuscations
+      adapter = config.db[:adapter]
+      Polo.configure do
+        obfuscate obfs
+        if adapter == "mysql2"
+          on_duplicate :ignore
+        end
+      end
+    end
+
+    def deserialize_class(klass)
+      klass.camelize.constantize
+    rescue
+      raise Config::ConfigParseError, "Could not process class '#{klass}'"
+    end
+
+    def deserialize_tactic(options)
+      options.fetch("tactic").to_sym
+    rescue KeyError
+      raise ConfigParseError, "Tactic not specified for class #{klass}"
+    end
+  end
+end

data/lib/brillo/transferrer/s3.rb

@@ -0,0 +1,66 @@
+module Brillo
+  module Transferrer
+    class S3
+      include Helpers::ExecHelper
+      include Logger
+      attr_reader :credentials, :bucket, :remote_filename, :remote_path, :download_enabled, :upload_enabled
+      attr_reader :key_path
+
+      def initialize(config)
+        @download_enabled = config.fetch_from_s3
+        @upload_enabled   = config.send_to_s3
+        @bucket           = config.s3_bucket
+        @key_path         = config.aws_key_path
+        @remote_filename  = config.remote_filename
+        @remote_path      = config.remote_path
+        load_credentials
+      end
+
+      def download
+        return unless download_enabled
+        load_credentials
+        FileUtils.rm [config.dump_path, config.remote_path], force: true
+        aws_s3 "get"
+      end
+
+      def upload
+        return unless upload_enabled
+        load_credentials
+        aws_s3 "put"
+      end
+
+      private
+
+      def load_credentials
+        if File.exist?(key_path)
+          @credentials = YAML.load_file(key_path)
+        else
+          key = ENV["AWS_SECRET_KEY"] || ENV["EC2_SECRET_KEY"]
+          unless key && key.length > 10
+            raise CredentialsError, "AWS credentials not found. Expected AWS_ACCESS_KEY and AWS_SECRET_KEY to be set!"
+          end
+          @credentials = {
+            'aws_access_key' => ENV["AWS_ACCESS_KEY"] || ENV["EC2_ACCESS_KEY"],
+            'aws_secret_key' => key
+          }
+        end
+      end
+
+      def aws_s3 api_command
+        execute!("#{aws_env} #{aws_bin} #{api_command} #{bucket}/#{remote_filename} #{remote_path}")
+      end
+
+      def aws_bin
+        if File.exist?('/usr/local/bin/awstk')
+          '/usr/local/bin/awstk'
+        else
+          '/usr/local/bin/aws'
+        end
+      end
+
+      def aws_env
+        "EC2_ACCESS_KEY=#{credentials['aws_access_key']} EC2_SECRET_KEY=#{credentials['aws_secret_key']}"
+      end
+    end
+  end
+end

data/lib/brillo/validator.rb

@@ -0,0 +1,32 @@
+module Brillo
+  # Responsible for asserting that the config file is valid
+  class Scrubber
+    include Common
+
+    attr_reader :config
+
+    def initialize(config)
+      parse_config(config)
+    end
+
+    def validate
+      errors = Hash.new({}.freeze)
+      klass_association_map.each do |klass, options|
+        begin
+          real_klass = deserialize_class(klass)
+        rescue
+          errors[klass][:name] = "No such class #{klass.camelize}, did you use the singular?"
+        end
+        begin
+          tactic = options.fetch("tactic").to_sym
+        rescue KeyError
+          errors[klass][:tactic] "Tactic not specified"
+        end
+      end
+    end
+
+    def deserialize_class(klass)
+      klass.camelize.constantize
+    end
+  end
+end

data/lib/brillo/version.rb

@@ -0,0 +1,3 @@
+module Brillo
+  VERSION = "1.0.0"
+end

data/lib/brillo.rb

@@ -0,0 +1,50 @@
+require "brillo/version"
+
+require 'brillo/errors'
+require 'brillo/helpers/exec_helper'
+require 'brillo/logger'
+
+require 'brillo/adapter/base'
+require 'brillo/adapter/mysql'
+require 'brillo/adapter/postgres'
+
+require 'brillo/transferrer/s3'
+
+require 'brillo/dumper/mysql_dumper'
+require 'brillo/railtie'
+require 'brillo/config'
+require 'brillo/scrubber'
+require 'brillo/loader'
+require 'polo'
+
+module Brillo
+  def self.configure
+    yield config
+    begin
+      config.verify!
+    rescue ConfigParseError => e
+      puts "Brillo config contains errors: #{e}"
+    end
+  end
+
+  def self.scrub!(logger: ::Logger.new(STDOUT))
+    Brillo::Logger.logger = logger
+    Scrubber.new(config).scrub!
+  end
+
+  def self.load!(logger: ::Logger.new(STDOUT))
+    Brillo::Logger.logger = logger
+    Loader.new(config).load!
+  end
+
+  def self.config
+    @config ||= begin
+      static_config = YAML.load_file("#{Rails.root.to_s}/config/brillo.yml")
+      Config.new(static_config)
+    end
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+end

data/lib/capistrano/brillo.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/db.cap', __FILE__)

data/lib/capistrano/tasks/db.cap

@@ -0,0 +1,30 @@
+namespace :db do
+  desc "Run the DB scrubber and push to S3"
+  task :scrub do
+    on primary(fetch(:brillo_role)) do
+      with rails_env: fetch(:stage) do
+        within current_path do
+          execute :rake, 'db:scrub'
+        end
+      end
+    end
+  end
+
+  desc "Run the S3 scrubbed DB loader"
+  task :load do
+    raise "Don't you dare!" if fetch(:stage) == "production"
+    on release_roles(:all).sample do
+      with rails_env: fetch(:stage) do
+        within current_path do
+          execute :rake, 'db:load'
+        end
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :brillo_role, :batch
+  end
+end

data/lib/generators/brillo.rb

@@ -0,0 +1,9 @@
+class BrilloConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../", __FILE__)
+
+  desc "Create a plain Brillo YAML configuration and initializer"
+  def create_initializer_file
+    copy_file "config/brillo-example.yml", "config/brillo.yml"
+    copy_file "config/brillo-initializer.rb", "config/initializers/brillo.rb"
+  end
+end

data/lib/tasks/brillo.rake

@@ -0,0 +1,26 @@
+require 'yaml'
+
+namespace :db do
+  desc 'Upload a scrubbed copy of the database as specified by config/scrub.yml to S3'
+  task :scrub => :environment do
+    logger = ENV["VERBOSE"] ? Logger.new(STDOUT) : Rails.logger
+    logger = Logger.new(STDOUT)
+    logger.level = ENV["VERBOSE"] ? Logger::DEBUG : Logger::WARN
+    begin
+      Brillo.scrub!(logger: logger)
+    rescue CredentialsError => e
+      puts e
+      exit(1)
+    end
+  end
+
+  desc 'Load a previously created scrubbed database copy from S3'
+  task :load => :environment do
+    begin
+      Brillo.load!
+    rescue CredentialsError => e
+      puts e
+      exit(1)
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: brillo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Bessey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: polo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mbessey@caring.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brillo.gemspec
+- config/brillo-example.yml
+- config/brillo-initializer.rb
+- lib/brillo.rb
+- lib/brillo/adapter/README.md
+- lib/brillo/adapter/base.rb
+- lib/brillo/adapter/mysql.rb
+- lib/brillo/adapter/postgres.rb
+- lib/brillo/config.rb
+- lib/brillo/dumper/mysql_dumper.rb
+- lib/brillo/errors.rb
+- lib/brillo/helpers/exec_helper.rb
+- lib/brillo/loader.rb
+- lib/brillo/logger.rb
+- lib/brillo/railtie.rb
+- lib/brillo/scrubber.rb
+- lib/brillo/transferrer/s3.rb
+- lib/brillo/validator.rb
+- lib/brillo/version.rb
+- lib/capistrano/brillo.rb
+- lib/capistrano/tasks/db.cap
+- lib/generators/brillo.rb
+- lib/tasks/brillo.rake
+homepage: https://github.com/bessey/brillo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails database scrubber and loader, great for seeding your dev db with real
+  but sanitized data
+test_files: []
+has_rdoc: