heroku_db_clone 0.9.0

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heroku-db-clone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cameron Pope
+
+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,42 @@
+# heroku-db-clone
+
+Backup a Heroku app's database and restore it locally. Defaults to
+reading the 'development' section of `config/database.yml` to get
+database configuration information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heroku_db_clone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku_db_clone
+
+## Usage
+
+`heroku-db-clone [app-name]`
+
+`heroku-db-clone --help` to get a list of options
+
+## To Do
+
+* Reasonable error messages if we cannot find required executables
+
+* Specify username and password to postgres database if we cannot find
+it
+
+* Handle multi-file database dumps
+
+## 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

data/Rakefile

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

data/bin/heroku-db-clone

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'heroku_db_clone'
+
+client = HerokuDbClone::Client.new
+client.run

data/heroku_db_clone.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku_db_clone/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "heroku_db_clone"
+  gem.version       = HerokuDbClone::VERSION
+  gem.authors       = ["Cameron Pope"]
+  gem.email         = ["cameron@theaboutbox.com"]
+  gem.description   = %q{Performs a backup of a heroku database, downloads it, and installs it locally, using the information in your config/database.yml file}
+  gem.summary       = %q{Clone a heroku app's database locally}
+  gem.homepage      = ""
+  gem.executables   << 'heroku-db-clone'
+  gem.add_dependency('trollop','~> 2.0.0')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/heroku_db_clone/client.rb

@@ -0,0 +1,81 @@
+require 'trollop'
+
+module HerokuDbClone
+  class Client
+    def initialize
+      @opts = Trollop::options do
+        opt :capture, "Capture a fresh database backup", short: '-c'
+        opt :drop, "Drop the local database before importing the captured copy", short: '-d'
+        opt :keep, "Do not delete the downloaded backup file", short: '-k'
+        opt :verbose, "Verbose console output", short: '-v'
+        opt :dump_name, "Name of the dump to download", type: :string, default: 'db.dump'
+      end
+
+      @app_name = ARGV.shift
+      raise "Please specify a Heroku app name" if @app_name.nil?
+
+      load_db_information 
+
+      log "Capturing Database for #{@app_name}"
+    end
+
+    def run
+      capture if @opts[:capture]
+      download
+      drop if @opts[:drop]
+      import
+      clean_up unless @opts[:keep]
+    end
+
+    def capture
+      log "Capturing production database snapshot..."
+      exec "heroku pgbackups:capture --expire --app #{@app_name}"
+    end
+
+    def download
+      log "Downloading snapshot..."
+      exec "curl -o #{@opts[:dump_name]} \`heroku pgbackups:url --app #{@app_name}\`"
+    end
+
+    def drop
+      log "Dropping Existing Database"
+      exec "dropdb #{@db_name}" rescue nil
+      exec "createdb -T template0 #{@db_name}" rescue nil
+    end
+
+    def import
+      pg_cmd = []
+      pg_cmd << 'pg_restore --verbose --clean --no-acl --no-owner'
+      pg_cmd << "-h #{options[:host]}" if @db_host
+      pg_cmd << "-U #{options[:user]}" if @db_user
+      pg_cmd << "-d #{@db_name} #{@opts[:dump_name]}"
+      cmd = pg_cmd.join(' ')
+      exec cmd
+    end
+
+    def clean_up
+      exec "rm #{@opts[:dump_name]}"
+    end
+
+    # Internal: Prints an output message if the verbose option is true
+    def log(msg)
+      puts msg if @opts[:verbose]
+    end
+
+    # Runs a command, outputting the command and output if verbose is true
+    def exec(cmd)
+      log cmd
+      log `#{cmd}`
+    end
+
+    # Internal: Get the configuration of the local development database
+    def load_db_information 
+      raise "config/database.yml does not exist at the current location: #{File.expand_path('.')}" unless File.exists?('config/database.yml')
+      dev_db = YAML.load_file('config/database.yml')["development"]
+      @db_name     = dev_db["database"]
+      @db_user     = dev_db['username']
+      @db_password = dev_db['password']
+      @db_host     = dev_db['host']
+    end
+  end
+end

data/lib/heroku_db_clone/version.rb

@@ -0,0 +1,3 @@
+module HerokuDbClone
+  VERSION = "0.9.0"
+end

data/lib/heroku_db_clone.rb

@@ -0,0 +1,6 @@
+require "heroku_db_clone/version"
+require "heroku_db_clone/client"
+
+module HerokuDbClone
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: heroku_db_clone
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Cameron Pope
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    none: false
+description: Performs a backup of a heroku database, downloads it, and installs it
+  locally, using the information in your config/database.yml file
+email:
+- cameron@theaboutbox.com
+executables:
+- heroku-db-clone
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/heroku-db-clone
+- heroku_db_clone.gemspec
+- lib/heroku_db_clone.rb
+- lib/heroku_db_clone/client.rb
+- lib/heroku_db_clone/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Clone a heroku app's database locally
+test_files: []