stage_hand 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9c42c01db8f19c46f966972ed64f96e164a25b6
+  data.tar.gz: 50f060eeebe39e348de8596e4e5e368acb4a9e2f
+SHA512:
+  metadata.gz: 8d34bc4e19e581497922d93a8d2e048fd9fc61191a12c4f5af3e7c92d077bfb6e9796bbbde68c4eb15a505b46808cf86253ea4111cea9611678b63dedba4185d
+  data.tar.gz: a2278ba298a9d0eb5351ebef724afc77fe6b3c783df7bb186bc1ab502d152d92cad407b34e2dffe34a14aa771314dc87726a0b906fdd9b5c65f580a53d9825ba

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rob@notch8.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in stage_hand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rob Kaufman
+
+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,84 @@
+# StageHand
+
+Perform backups and restores of databases, scrubbing records along the way. This allows taking limited snapshots of large databases and keeps customer info out of your staging site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stage_hand'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stage_hand
+
+## Usage
+
+Generate an example config file
+
+`stage_hand install`
+
+Create a new, modified copy of the production database
+
+`stage_hand capture -e production`
+
+Load the current database file, currently just does `rake db:structure:load` but may be exapnded in the future
+
+`stage_hand load -e staging`
+
+## Configuration
+
+StageHand uses a configuration file found in config/stage_hand.yml.  There are two sections of this file.
+
+### excluded_tables
+
+This is a list of all the tables to exclude. These tables are skipped by data insertion, but they are reset to the current schema currently. schema_migrations is always in the excluded list, though the structure load will set the values of that table to the most recent migration.
+
+```yaml
+excluded_tables:
+  - sites
+  - secrets
+```
+
+### fields
+
+Here is where the real magic happens. You can specify fields to either be set to blank (by using nil or false) or by evaluating code.  [Faker](https://github.com/stympy/faker) is included to make doing so easy. There is also a special variable called `existing_value` which contains the value before any changes. These fields will be changed in flight to the sql file and thus sensitive data can be removed from the production data dump.
+
+```yaml
+fields:
+  users:
+    email: "existing_value.match('notch8.com') ? existing_value : Faker::Internet.unique.email"
+    zip: false
+  action_items:
+    name: "Faker::Name.unique.name"
+```
+
+## TODO
+
+-[ ] File upload
+-[ ] File Download
+-[ ] Ability to limit the number of rows to insert per table
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/notch8/stage_hand. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the StageHand project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/stage_hand/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "stage_hand"
+
+StageHand::HammerOfTheGods.start(ARGV)

data/lib/stage_hand.rb

@@ -0,0 +1,6 @@
+require "stage_hand/version"
+require "stage_hand/cli"
+
+module StageHand
+  # Your code goes here...
+end

data/lib/stage_hand/cli.rb

@@ -0,0 +1,106 @@
+require 'thor'
+require 'sequel'
+require 'yaml'
+require 'erb'
+require 'hashie'
+require 'faker'
+require 'dotenv/load'
+
+module StageHand
+  class HammerOfTheGods < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', '..', 'templates')
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    method_option :environment, type: :string, aliases: '-e'
+    desc "capture", "grab a new stager copy of your db"
+    def capture(dir=".")
+      Dir.chdir(dir)
+
+      run 'rake db:structure:dump'
+
+      capture_file = File.join(Dir.pwd, "db", "structure.sql")
+      File.open(capture_file, "a") do |file|
+        db.tables.each do |table_name|
+          next if excluded_tables.include?(table_name)
+          items = db[table_name]
+          items.each do |item|
+            if fields[table_name]
+              fields[table_name].each do |field_name, task|
+                if task
+                  existing_value = item[field_name.to_sym]
+                  item[field_name.to_sym] = eval(task)
+                else
+                  item[field_name.to_sym] = nil
+                end
+              end
+              item
+            end
+            file.puts "#{items.insert_sql(item)};"
+            file.puts
+          end
+        end
+      end
+    end
+
+
+    #desc "upload", "upload your most recent capture to S3"
+    #desc "download", "download your most recent capture from S3"
+
+    method_option :environment, type: :string, aliases: '-e'
+    method_option :structure_file, type: :string, aliases: '-s'
+    method_option :file, type: :string, aliases: '-f'
+    desc "load", "overwrite the current db with the most recently downloaded stager db"
+    def load(dir=".")
+      Dir.chdir(dir)
+      run 'rake db:structure:load'
+    end
+
+    protected
+    def environment
+      @environment ||= options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || "development"
+    end
+
+    def db
+      @db ||= Sequel.connect(YAML.load(ERB.new(File.read(File.join(Dir.pwd, 'config', 'database.yml'))).result)[environment])
+    end
+
+    def config_file
+      return @config_file if @config_file
+      config_file_path = File.join(Dir.pwd, 'config', 'stage_hand.yml')
+      if File.exists?(config_file_path)
+        @config_file = Hashie::Mash.load(config_file_path)
+      else
+        @config_file = {}
+      end
+    end
+
+    def excluded_tables
+      return @excluded_tables if @excluded_tables
+      @excluded_tables = config_file[:excluded_tables] || []
+      @excluded_tables.collect! { |t| t.to_sym }
+      # always skip schema_migrations, they get set by the structure file
+      @excluded_tables = @excluded_tables | [:schema_migrations]
+      return @excluded_tables
+    end
+
+    def fields
+      return @fields if @fields
+      # prototype is people: [{name: "Faker::Name.unique.name"}, {email: false}]
+      # key is table name
+      # fake can be any executable faker string
+      # if fake is not set, no edit is made
+      # skip defaults to false if not set
+      # you should set either fake or skip, not both... duh
+      @fields = config_file[:fields] || {}
+      return @fields
+    end
+
+  end
+end

data/lib/stage_hand/version.rb

@@ -0,0 +1,3 @@
+module StageHand
+  VERSION = "0.0.1"
+end

data/stage_hand.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stage_hand/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stage_hand"
+  spec.version       = StageHand::VERSION
+  spec.authors       = ["Rob Kaufman"]
+  spec.email         = ["rob@notch8.com"]
+
+  spec.summary       = %q{Stage Hand backups and restores databases for staging. Allows scrubbing of records.}
+  spec.description   = %q{Perform backups and restores of databases, scrubbing records along the way. This allows taking limited snapshots of large databases and keeps customer info out of your staging site.}
+  spec.homepage      = "https://gitlab.com/notch8/stage_hand"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "dotenv", "~> 2.2"
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "sequel", "~> 4.41.0"
+  spec.add_runtime_dependency "hashie", "~> 3.5"
+  spec.add_runtime_dependency "faker", "~> 1.9"
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: stage_hand
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Kaufman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.41.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.41.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Perform backups and restores of databases, scrubbing records along the
+  way. This allows taking limited snapshots of large databases and keeps customer
+  info out of your staging site.
+email:
+- rob@notch8.com
+executables:
+- stage_hand
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/stage_hand
+- lib/stage_hand.rb
+- lib/stage_hand/cli.rb
+- lib/stage_hand/version.rb
+- stage_hand.gemspec
+homepage: https://gitlab.com/notch8/stage_hand
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Stage Hand backups and restores databases for staging. Allows scrubbing of
+  records.
+test_files: []