capistrano-db-mirror 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e443f923780b4892b0ea156c2aad67642a71b51
+  data.tar.gz: de208192f6c409e1272ba5961115358050fa038b
+SHA512:
+  metadata.gz: 3d46406392bf96bed93a3c80db3e6f6e951755e7a6ee4d77cf86f193989ea736e6b633bbc5163bc08a96006d710edc475b0a914f6dfd71e1620bd6408d68c883
+  data.tar.gz: 0d2d8f6c4032bac5298145baedda694033333ca0e277f59bbe49c3162d8ae4b0afeb68eec09abd396393c45dfbdc5ed62ac263cfa84abc9600b6494caabdf74e

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/log/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+## Misc
+Gemfile.lock
+gemfiles/*.lock
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=0aa39b8485a9dd2aa62dbb77b02c90d1b58fa8f62a2dc03f26a304993b5908ae
+  matrix:
+    -   
+    - CAP_VERSION=3.0
+
+script: "bundle exec rake spec"
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "capistrano", "~> #{ENV['CAP_VERSION']}" if ENV['CAP_VERSION'].to_s != ''
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Daisuke Taniwaki
+
+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,62 @@
+# capistrano-db-mirror
+
+[![Gem Version][gem-image]][gem-link]
+[![Dependency Status][deps-image]][deps-link]
+[![Build Status][build-image]][build-link]
+[![Coverage Status][cov-image]][cov-link]
+[![Code Climate][gpa-image]][gpa-link]
+
+Mirror DB from Remote.
+
+## Installation
+
+Add the capistrano-db-mirror gem to your Gemfile.
+
+```ruby
+gem "capistrano-db-mirror"
+```
+
+And run `bundle install`.
+
+## Usage
+
+Require `capistrano/db-mirror` in your `Capfile`.
+
+```ruby
+require `capistrano/db-mirror`
+```
+
+Then execute the cap task.
+
+```bash
+$ cap [env] db:mirror
+```
+
+Here, env is the enviornment you deploy and it can be ommited for default env.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Daisuke Taniwaki. See [LICENSE](LICENSE) for details.
+
+
+
+
+[gem-image]:   https://badge.fury.io/rb/capistrano-db-mirror.svg
+[gem-link]:    http://badge.fury.io/rb/capistrano-db-mirror
+[build-image]: https://secure.travis-ci.org/kaizenplatform/capistrano-db-mirror.png
+[build-link]:  http://travis-ci.org/kaizenplatform/capistrano-db-mirror
+[deps-image]:  https://gemnasium.com/kaizenplatform/capistrano-db-mirror.svg
+[deps-link]:   https://gemnasium.com/kaizenplatform/capistrano-db-mirror
+[cov-image]:   https://codeclimate.com/github/kaizenplatform/capistrano-db-mirror/badges/coverage.svg
+[cov-link]:    https://codeclimate.com/github/kaizenplatform/capistrano-db-mirror
+[gpa-image]:   https://codeclimate.com/github/kaizenplatform/capistrano-db-mirror.png
+[gpa-link]:    https://codeclimate.com/github/kaizenplatform/capistrano-db-mirror
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/capistrano-db-mirror.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |gem|
+  gem.name        = "capistrano-db-mirror"
+  gem.version     = ::File.read(::File.expand_path('../VERSION', __FILE__)).to_s.strip
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Daisuke Taniwaki"]
+  gem.email       = ["daisuketaniwaki@gmail.com"]
+  gem.homepage    = "https://github.com/kaizenplatform/capistrano-db-mirror"
+  gem.summary     = "Mirror DB from Remote"
+  gem.description = "Mirror DB from Remote"
+  gem.license     = "MIT"
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "capistrano", ">= 3.0"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", ">= 3.0"
+end

data/lib/capistrano-db-mirror.rb

@@ -0,0 +1,26 @@
+module Capistrano
+  module DbMirror
+    VERSION = ::File.read(::File.expand_path('../../VERSION', __FILE__)).to_s.strip
+
+    class << self
+      attr_accessor :excludes, :sanitizer
+
+      def excludes
+        @excludes ||= [:production]
+      end
+
+      def sanitizer
+        {
+          '*' => {
+            email: "CONCAT('user-', id, '@sanitized-email.com')"
+          }
+        }
+      end
+    end
+  end
+end
+
+if defined?(::Rake)
+  require 'rake'
+  Dir.glob(File.join(__dir__, 'capistrano', 'db-mirror', 'tasks', '**', '*.rake')) { |path| load path }
+end

data/lib/capistrano/db-mirror.rb

@@ -0,0 +1 @@
+Dir.glob(File.join(__dir__, 'tasks', '**', '*.cap')) { |path| load path }

data/lib/capistrano/db-mirror/tasks/db-mirror.rake

@@ -0,0 +1,69 @@
+namespace :db do
+  namespace :mirror do
+    def load_config
+      c = YAML.load_file("#{Rails.root}/config/database.yml")[Rails.env] # c == config
+      c.symbolize_keys!
+    end 
+
+    desc "Create database dump via mysqldump"
+    task :dump, [:dumpfile] => :environment do |t, args|
+      raise "arg :dumpfile required" if args[:dumpfile].nil?
+
+      # execute mysqldump command using database.yml credentials
+      c = load_config
+      cmds = ["mysqldump", "-u #{c[:username]}", "--password='#{c[:password]}'"]
+      cmds << ((c[:socket].present?)? "-S #{c[:socket]}" : "-h #{c[:host]}")
+      cmds.concat [c[:database], "| gzip > #{args[:dumpfile]}"]
+      p "writing #{args[:dumpfile]}..."
+      `#{cmds.join " "}`
+    end 
+
+    desc "Load mysqldump file to local database"
+    task :load, [:dumpfile] => :environment do |t, args|
+      raise "The operation is not allowed in #{Rails.env}!!" if Capistrano::DbMirror.excludes.map(&:to_s).include?(Rails.env.to_s)
+      raise "arg :dumpfile does not exist: #{args[:dumpfile]}" unless File.exists? args[:dumpfile]
+
+      # execute mysql load command using local database.yml credentials
+      # - extrace gzip file
+      rawfile = args[:dumpfile].sub(/\.gz$/, "")
+      p rawfile
+      `gunzip -c #{args[:dumpfile]} > #{rawfile}`
+      # - load dumpfile
+      begin
+        c = load_config
+        cmds = ["mysql", "-u #{c[:username]}", "--password='#{c[:password]}'"]
+        cmds << "-S #{c[:socket]}" if c[:socket].present?
+        cmds << "-h #{c[:host]}"   if c[:host].present?
+        cmds.concat [c[:database], %Q|-e "source #{rawfile}"|]
+        p "loading #{args[:dumpfile]} into database..."
+        p cmds.join " " 
+        `#{cmds.join " "}`
+      ensure
+        `rm #{rawfile}`
+      end 
+    end
+
+    desc "Sanitize db"
+    task sanitize: [:environment] do
+      raise "The operation is not allowed in #{Rails.env}!!" if Capistrano::DbMirror.excludes.map(&:to_s).include?(Rails.env.to_s)
+
+      ActiveRecord::Base.connection.tables.each do |table_name|
+        sets = []
+        wheres = []
+        Capistrano::DbMirror.sanitizer.select { |target, _| target == '*' || target.to_s == table_name }.each do |_, config|
+          config.each do |column, format|
+            if ActiveRecord::Base.connection.columns(table_name).map(&:name).include?(column.to_s)
+              sets << %|`#{column}` = #{format}|
+              wheres << %|`#{column}` IS NOT NULL AND `#{column}` != ""|
+            end
+          end
+        end
+        if sets.present? && wheres.present?
+          sql = %|UPDATE `#{table_name}` SET #{sets.join(', ')} WHERE #{wheres.join(' AND ')}|
+          puts "Execute: #{sql}"
+          ActiveRecord::Base.connection.execute sql 
+        end
+      end
+    end
+  end 
+end

data/lib/capistrano/tasks/db-mirror.cap

@@ -0,0 +1,44 @@
+namespace :db do
+  desc 'Download database dump from remote and create mirror in local database - set SKIP_SANITIZE=1 for raw production data (not recommended).'
+  task :mirror do
+    on roles(:db), primary: true do
+      now = Time.now.strftime "%Y%m%d-%H%M%S"
+      filename = "#{now}-#{rails_env}.dump.gz"
+
+      # remote - create dump file
+      remote_f = File.join('/tmp', filename)
+
+      # local - scp dump file from remote
+      local_d = './dump'
+      FileUtils.mkdir_p(local_d)
+      local_f = File.join('./dump', filename)
+
+      within current_path do
+        rake "db:mirror:dump[#{remote_f}]"
+        download! remote_f, local_f, via: :scp
+        execute :rm, remote_f
+      end
+
+      run_locally do
+        local_backup_f = File.join(local_d, "#{now}-local.dump.gz")
+        # local - create current database dump for backup
+        p "creating local db backup as #{local_backup_f} ..."
+        execute "bundle exec rake db:mirror:dump[#{local_backup_f}]"
+        # local - load remote dump into database
+        p "loading remote dump #{local_f} into database..."
+        execute "bundle exec rake db:mirror:load[#{local_f}]"
+
+        unless ENV['SKIP_SANITIZE'] == '1' 
+          p "sanitizing database..."
+          execute "bundle exec rake db:mirror:sanitize"
+        else
+          p "skipping db sanitization..."
+        end 
+
+        # local - remove dumps
+        p "removing backups except the latest local backup..."
+        execute "ls -1 -d #{local_d}/*.dump.gz | grep -v #{local_backup_f} | xargs rm"
+      end
+    end 
+  end
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'simplecov'
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+SimpleCov.start do
+    add_filter 'spec/'
+end
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-db-mirror
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Daisuke Taniwaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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: 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'
+description: Mirror DB from Remote
+email:
+- daisuketaniwaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- capistrano-db-mirror.gemspec
+- lib/capistrano-db-mirror.rb
+- lib/capistrano/db-mirror.rb
+- lib/capistrano/db-mirror/tasks/db-mirror.rake
+- lib/capistrano/tasks/db-mirror.cap
+- spec/spec_helper.rb
+homepage: https://github.com/kaizenplatform/capistrano-db-mirror
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Mirror DB from Remote
+test_files:
+- spec/spec_helper.rb