pgclone 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2474bcd73e35f5a44843eca0dc277ca258dcd9f6
+  data.tar.gz: c326dbac4f21db2e000a97491389770b6d0cef82
+SHA512:
+  metadata.gz: e63e80322ec29399883dfecbdb1d4520df38beeea74cf7e16a1ee4c3e2103d5a46d24bc871bfb8a6de10d09d66b5ae4a54f92259ec5e7e4f9b3c25555d2bc20f
+  data.tar.gz: 2e34346d8d37b382e7515891df09a87b2b866d52f66703c43763a0c068aa2053532f4c2ec6d8471e42cf1e8c1b92217eaaccd7660b8548701aa76231bb0f0748

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pgclone.gemspec
+gemspec

data/README.md

@@ -0,0 +1,67 @@
+# PG Clone
+
+This is a dead simple Postgres/Heroku cloning gem, to make it easier to pull database information from production to local.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pgclone', git: "git://github.com/sashafklein/pgclone.git"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The gem is usable either from the command line or from your Rails app. 
+
+### Command Line
+
+Just call `pgclone` with the required arguments specified (or `-h` for more info). Those arguments are `--appname` (your Heroku appname), `--owner` (the local database owner), and `--local-db` (the local database name). PG Clone will take care of the rest:
+
+```bash
+$ pgclone -a my-heroku-app -o my-db-owner-username -l app_development
+```
+
+### In Rails App
+
+Set the mandatory configuration options in a config file:
+
+```ruby
+# config/initializers/p_g_clone.rb
+Pgclone.configure do |config|
+    config.appname = 'my-heroku-app'
+    config.owner = 'my-db-owner-username'
+    config.local_db = 'app_development'
+    config.file = 'temporary-dumpfile.dump' # optional
+end
+```
+
+Then pull the data from your app like so:
+
+```ruby
+Pgclone::Restore.new.go!
+```
+
+Or call directly with an options hash:
+
+```ruby
+Pgclone::Restore.new({ appname: 'whatever' }).go!
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sashafklein/pgclone/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 a new Pull Request

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "pgclone"
+require 'trollop'
+
+flags = {
+  appname: "Heroku app name (required).",
+  owner: 'Local database owner (required).',
+  local_db: 'Local database name (required).',
+  file: 'File to save temporary DB dump to.'
+}
+
+opts = Trollop::options do
+  flags.each do |k, v|
+    opt k, v, short: k.to_s.chars.first, type: :string, required: k != :file
+  end
+end
+
+Pgclone::Restore.new( opts ).go!

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/lib/pgclone.rb

@@ -0,0 +1,71 @@
+require "pgclone/version"
+
+module Pgclone
+  
+  class Configuration
+    attr_accessor :owner, :appname, :local_db, :file
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield( configuration )
+  end
+
+  class Restore
+    attr_accessor :appname, :owner, :local_db, :file
+    def initialize(opts={})
+      @appname = opts[:appname] || config(:appname)
+      @owner = opts[:owner] || config(:owner)
+      @local_db = opts[:local_db] || config(:local_db)
+      @file = opts[:file] || config(:file) || 'latest.dump'
+      raise_missing_keys!
+    end
+
+    def config(key)
+      Pgclone.configuration.send(key)
+    end
+
+    def go!
+      capture_backup
+      grab_dump
+      restore_db
+    end
+
+    private
+
+    def raise_missing_keys!
+      [:appname, :owner, :local_db].each do |key|
+        raise "Missing required option: #{key}." unless instance_variable_get("@#{ key }")
+      end
+    end
+
+    def capture_backup
+      puts "Capturing new backup"
+      `heroku pg:backups capture --app #{appname}`
+      puts "Captured the production database"
+    end
+
+    def grab_dump
+      "Finding DB URL"
+      url = `heroku pg:backups public-url --app #{appname}`.split(" ").last.strip
+      puts "Dumping database to #{file}"
+      `curl -o #{file} "#{url}"`
+    end
+
+    def restore_db
+      puts "Restoring local DB"
+      `pg_restore --verbose --clean --no-acl --no-owner -h localhost -U #{owner} -d #{local_db} #{file}`
+      
+      puts "Local database restored"
+      `rm #{file}`
+      puts "#{file} removed"
+    end
+  end
+end

data/lib/pgclone/version.rb

@@ -0,0 +1,3 @@
+module Pgclone
+  VERSION = "0.1.1"
+end

data/pgclone.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pgclone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pgclone"
+  spec.version       = Pgclone::VERSION
+  spec.authors       = ["Sasha Klein"]
+  spec.email         = ["sashafklein@gmail.com"]
+
+  spec.summary       = %q{A simple tool for cloning a production database to local.}
+  spec.description   = %q{For PostgreSQL only.}
+  spec.homepage      = "https://www.github.com/sashafklein/pgclone"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['pgclone']
+  spec.require_paths = ["lib"]
+
+  spec.test_files = spec.files.grep(%r{^(spec)/})
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "trollop", '2.1.2'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: pgclone
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sasha Klein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+description: For PostgreSQL only.
+email:
+- sashafklein@gmail.com
+executables:
+- pgclone
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/pgclone
+- bin/setup
+- lib/pgclone.rb
+- lib/pgclone/version.rb
+- pgclone.gemspec
+homepage: https://www.github.com/sashafklein/pgclone
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: A simple tool for cloning a production database to local.
+test_files: []