clone_remote_db 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e4ef1f0948c75e7b40317ada0a5561c677ce93a
+  data.tar.gz: c1f4de4836d591b99952a9587ac908b072715f13
+SHA512:
+  metadata.gz: b3b63f475666459d1a108fca67f0129814195a0e8379ee00584193066e2df20724247c8f24f541a1ee0e06e6cd23e70b48c42b1c7dfdb7cbfcc39cb61df3e369
+  data.tar.gz: 7551aee85ba3d6e42b9c9f86c20edce8c68251daa569593f12cb50b1979d28919d18c9d36e60e20e017e01a6a68c7a7052c26526954073bb25be0431460cc0c6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Josh McDade
+
+MIT License
+
+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,83 @@
+# clone_remote_db
+
+Simple script to backup a PostgreSQL database from a remote server, and restore
+it into a local database (such as development or staging).
+
+## Installation
+
+Install the gem.
+
+    gem install clone_remote_db
+
+And then execute:
+
+    $ clone_remote_db --help
+
+## Usage
+
+The script can run with just arguments, but to make it easier, environments can
+be defined in a a configuration file (by default: `$HOME/.clone_remote_db.yml`).
+
+Below is an example YAML configuration file:
+
+    ---
+    defaults: &defaults
+      local_dest: '~/pg_dumps/{remote_db}/%Y-%m/%Y-%m-%d_%H.%M.sql.gz'
+      remote_user: 'postgres'
+      gzip_opts:
+        - '-9'
+        - '--stdout'
+      pg_dump_opts:
+        - '-c'
+        - '-O'
+      pg_exclude_data:
+        - 'versions'
+    environments:
+      foo:
+        <<: *defaults
+        host: 'foo-ssh-alias'
+        local_db: 'foo_development'
+        remote_db: 'foo_development'
+        pg_exclude_data:
+          - versions
+          - session_logs
+          - send_mails
+          - job_logs
+      bar:
+        <<: *defaults
+        host: 'bar-ssh-alias'
+        local_db: 'bar_development'
+        remote_db: 'bar_production'
+        pg_exclude_data: []
+
+You can avoid command-line arguments all together by using a configuration
+file, so the below command would copy the remote database "foo_production" into
+your local database "foo_development".
+
+    clone_remote_db foo
+
+If a database has already been downloaded, you can skip the download step and
+import the saved backup right away:
+
+    clone_remote_db foo --import-only \
+        ~/pg_dumps/foo_production/2014-01/2014-01-01_12-00.sql.gz
+
+Placeholders can be used for the --local-dest argument:
+
+    clone_remote_db foo --local-dest \
+        '~/pg_dumps/{remote_db}/%Y-%m/%Y-%m-%d_%H.%M.sql.gz'
+
+Configuration values from the YAML file can be overwritten so you do not need
+to modify the file:
+
+    clone_remote_db foo --local-db foo_staging
+    # instead of copying foo_production into foo_development, it will copy
+    # foo_production into foo_staging
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/clone_remote_db/fork )
+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

data/Rakefile

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

data/bin/clone_remote_db

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'yaml'
+require 'fileutils'
+require 'shellwords'
+
+require File.expand_path('../../lib/clone_remote_db', __FILE__)
+
+loader = CloneRemoteDb::Loader.new(File.basename(__FILE__))
+cli_opts = loader.parse_opts!
+
+def escape_opts(opts)
+  if opts.is_a?(Enumerable)
+    opts.map { |o| Shellwords.escape(o) }.join(' ')
+  elsif opts.nil? || opts == ''
+    ''
+  else
+    Shellwords.escape(opts.to_s)
+  end
+end
+
+def run_cmd(cmd, msg, opts = {})
+  start_time = Time.now
+  puts ">> [#{start_time}] #{msg}: #{cmd}"
+
+  unless opts[:dry_run]
+    pipe = IO.popen(cmd)
+    while (line = pipe.gets)
+      print line
+    end
+  end
+
+  end_time = Time.now
+  puts "<< [#{end_time} %.1fs] #{msg}" % [end_time - start_time]
+end
+
+config_file = File.join(ENV['HOME'], '.clone_remote_db.yml')
+if File.exist?(config_file)
+  CONFIG = YAML.load(File.read(config_file))
+else
+  CONFIG = { 'environments' => {} }
+end
+
+# merge the CLI options with the configuration from the YAML file
+cmd = ARGV.shift
+if cmd
+  cmd_config = CONFIG['environments'][cmd]
+  if cmd_config
+    cmd_config = cmd_config.symbolize_keys
+    loader.options.merge!(cmd_config.select { |k,v| cli_opts[k].nil? })
+  else
+    loader.die("unknown subcommand #{cmd}")
+  end
+end
+
+opts = loader.options
+
+[:local_db, :remote_db, :host].each do |opt|
+  loader.die(opt, "is required") unless opts[opt]
+end
+
+loader.die(:import_only, "file not found") if opts[:import_only] && !File.exist?(opts[:import_only])
+
+# gzip compression options
+gzip_opts = opts[:gzip_opts]
+
+# pg_dump exclude-table-data tables
+pg_exclude_data = opts[:pg_exclude_data]
+
+db_name = opts[:remote_db]
+local_dbname = opts[:local_db]
+host = opts[:host]
+
+# pg_dump setup
+pg_user = opts[:remote_user]
+pg_options = opts[:pg_dump_opts] << "-x #{escape_opts(db_name)}"
+pg_options_joined = pg_exclude_data.map { |t| '--exclude-table-data=' + escape_opts(t) }.
+  join(' ') + ' ' + pg_options.join(' ')
+pg_dump_part = "pg_dump #{pg_options_joined}"
+
+local_dest = loader.replace_variables(opts[:local_dest])
+now = Time.now
+output_file = File.expand_path(now.strftime(local_dest))
+dir_name = File.dirname(output_file)
+
+FileUtils.mkdir_p(dir_name) unless opts[:dry_run]
+
+gzip_part = "gzip #{escape_opts(opts[:gzip_opts])}"
+sudo_part = %~sudo -u #{pg_user} #{pg_dump_part} | #{gzip_part}~
+
+if opts[:import_only]
+  output_file = loader.replace_variables(opts[:import_only])
+else
+  ssh_cmd = %~ssh #{host} "#{sudo_part}" > #{output_file}~
+  run_cmd(ssh_cmd, "downloading #{db_name}", opts)
+end
+
+import_cmd = "gunzip --stdout #{output_file} | psql #{local_dbname}"
+run_cmd(import_cmd, "importing #{db_name} into #{local_dbname}", opts)
+
+# vim: set ft=ruby :

data/clone_remote_db.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clone_remote_db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clone_remote_db"
+  spec.version       = CloneRemoteDb::VERSION
+  spec.authors       = ["Josh McDade"]
+  spec.email         = ["josh.ncsu@gmail.com"]
+  spec.summary       = %q{Helper script to dump, download, and remote a remote PostgreSQL database}
+  spec.homepage      = "https://github.com/joshm1/clone_remote_db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/clone_remote_db/hash.rb

@@ -0,0 +1,13 @@
+# monkey patch functionally similar to the one provided by ActiveSupport
+class Hash
+  # recursively symolizes keys in a Hash that are strings
+  # does not modify the original hash; returns a new hash
+  def symbolize_keys
+    self.to_a.reduce({}) do |acc, (key, val)|
+      val = symbolize_keys(val) if val.is_a?(Hash)
+      key = key.to_sym if key.is_a?(String)
+      acc[key] = val
+      acc
+    end
+  end
+end

data/lib/clone_remote_db/loader.rb

@@ -0,0 +1,83 @@
+require 'optparse'
+
+class CloneRemoteDb::Loader
+  attr_reader :script
+
+  def initialize(script)
+    @script = script
+  end
+
+  def parse_opts!
+    OptionParser.new do |opts|
+      banner(opts)
+      version(opts)
+      opt(opts, :local_db, "Local postgresql database name", arg: 'DBNAME', short: '-l')
+      opt(opts, :remote_db, "Remote postgresql database name", arg: 'DBNAME', short: '-r')
+      opt(opts, :host, "Host of the postgresql database", arg: 'HOST', short: '-h')
+      opt(opts, :import_only, "Skip download and provide path to dump.sql.gz file", arg: 'PATH')
+      opt(opts, :local_dest, "The path to save the dump.sql.gz file to", arg: 'PATH')
+      opt(opts, :dry_run, "Don't actually do anything", short: '-n')
+    end.parse!
+    options
+  end
+
+  def die(key_or_msg, msg = nil, exit_code = -1)
+    if key_or_msg.is_a?(String)
+      $stderr.puts "Error: #{key_or_msg}"
+    else
+      arg = '--' + key_or_msg.to_s.gsub('_', '-')
+      $stderr.puts "Error: argument #{arg} #{msg}."
+    end
+    exit(exit_code)
+  end
+
+  def banner(opts)
+    opts.banner = <<-EOS
+Download and import a remote (PostgreSQL) database into a local database.
+
+Usage:
+        #{script} [options]
+
+Options:
+EOS
+  end
+
+  def version(opts)
+    opts.on('--version', 'Show the version') do
+      io.puts "clone_remote_db #{CloneRemoteDb::VERSION} (c) Josh McDade"
+      exit(0)
+    end
+  end
+
+  def opt(opts, key, msg, arg_opts = {})
+    arg = "--#{key.to_s.gsub('_', '-')}"
+    arg << " #{arg_opts[:arg]}" if arg_opts[:arg]
+    on_args = [arg, msg]
+    on_args.unshift(arg_opts[:short]) if arg_opts[:short]
+    opts.on(*on_args, msg) do |v|
+      options[key] = v
+    end
+  end
+
+  def options
+    @options ||= {}.merge(defaults)
+  end
+
+  def defaults
+    {
+      local_dest: '~/pg_dumps/{remote_db}/%Y-%m/%Y-%m-%d_%H.%M.sql.gz',
+      gzip_opts: %w(-9 --stdout),
+      pg_dump_opts: %w(-c -O),
+      pg_exclude_data: %w(versions),
+      remote_user: 'postgres'
+    }
+  end
+
+  def replace_variables(str)
+    new_str = str
+    %w(local_db remote_db remote_user).each do |arg|
+      new_str = new_str.gsub('{' + arg + '}', options[arg.to_sym])
+    end
+    new_str
+  end
+end

data/lib/clone_remote_db/version.rb

@@ -0,0 +1,3 @@
+module CloneRemoteDb
+  VERSION = '0.0.1'
+end

data/lib/clone_remote_db.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../clone_remote_db/hash", __FILE__)
+
+module CloneRemoteDb
+  lib = File.expand_path('../clone_remote_db', __FILE__)
+  autoload :Loader, "#{lib}/loader.rb"
+  autoload :Version, "#{lib}/version.rb"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: clone_remote_db
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh McDade
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: 
+email:
+- josh.ncsu@gmail.com
+executables:
+- clone_remote_db
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/clone_remote_db
+- clone_remote_db.gemspec
+- lib/clone_remote_db.rb
+- lib/clone_remote_db/hash.rb
+- lib/clone_remote_db/loader.rb
+- lib/clone_remote_db/version.rb
+homepage: https://github.com/joshm1/clone_remote_db
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Helper script to dump, download, and remote a remote PostgreSQL database
+test_files: []