db_backup_rails 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5043fefd4c6803e20947086c26997a9c877e3fdc
+  data.tar.gz: 32dbee8fcd57f1a5413da6973fc8e5bea13cba7a
+SHA512:
+  metadata.gz: 65ed5f0c5be50a3d08ab1901d554fec5656743c8d7b400e095495f86d12e55bed79aeb615b0299b55bc0328fcc920e00ee38180ea7662a7ef8563a5b03d147d7
+  data.tar.gz: cc1f9e7d015ec1e78abbe60cc32b7a8a81c69f5b5c1ed6fff2c1d1e044ef6b69db1301b5c4384d800389825f94626a753e1819a71dd3c15c8eb0affd685c9e01

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 db_backup_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Leon Miller-Out
+
+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,68 @@
+# DbBackupRails
+
+This simple gem creates database dump files on the local filesystem. The
+authors use it to enable consistent nightly database backups on cloud servers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'db_backup_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install db_backup_rails
+
+If you are using Rails 2.3, add the following to your Rakefile:
+
+    require 'db_backup_rails/tasks'
+
+## Usage
+
+This gem provides `backup:db` and `backup:db:prune` rake tasks.
+
+    bundle exec rake backup:db
+    bundle exec rake backup:db:prune
+
+### Custom Directory
+
+**Please note that the default dir has changed in 1.0.0!**
+
+This defaults to using a directory at `[Rails.root]/../../shared/backup`, which
+works well with Capistrano's standard directory structure. You can override it
+by setting `BACKUP_DIR`. If `BACKUP_DIR` is relative, it will be relative to
+`Rails.root`. E.g.
+
+    BACKUP_DIR=tmp/backup bundle exec rake backup:db
+
+will back up to `[Rails.root]/tmp/backup`.
+
+`BACKUP_DIR` applies to all provided tasks.
+
+### Setting the number of versions to keep when pruning
+
+`backup:db:prune` keeps 7 versions by default. You can override this with
+`NUMBER_TO_KEEP`, e.g.
+
+    NUMBER_TO_KEEP=30 bundle exec rake backup:db:prune
+
+### Setting the Rails environment
+
+As with most rake tasks, you can specify RAILS_ENV if you want to operate on an
+environment other than development.
+
+## Limitations
+
+* Only works on Unix-y systems
+
+## 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/db_backup_rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_backup_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_backup_rails"
+  spec.version       = DbBackupRails::VERSION
+  spec.authors       = ["Leon Miller-Out"]
+  spec.email         = ["leon@singlebrook.com"]
+  spec.description   = %q{Simple gem to back up your database to local storage}
+  spec.summary       = %q{Simple gem to back up your database to local storage}
+  spec.homepage      = "https://github.com/singlebrook/db_backup_rails"
+  spec.license       = "MIT"
+
+  spec.post_install_message = "Thanks for using db_backup_rails! If you have upgraded to 1.x.x from " +
+                              "0.x.x, please note that THE DEFAULT BACKUP DIR HAS CHANGED! See the " +
+                              "README.md for more info."
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'rails', '~> 2.3'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/db_backup_rails/tasks/backup_db.rake

@@ -0,0 +1,89 @@
+# Simple database backup rake task
+# Supports mysql and postgres
+# Env vars:
+#   BACKUP_DIR - where to store files. Relative to Rails app root. Defaults to '../../shared/backup',
+#                which works nicely with Capistrano's default file structure.
+#   NUM_TO_KEEP - how many backup files to keep. Defaults to 7.
+#   RAILS_ENV - which database to back up. Defaults to development like all Rake tasks.
+
+namespace :backup do
+  desc "Backup database"
+  task :db => [:environment] do
+    FileUtils.mkdir_p backup_dir
+
+    adapter = settings['adapter']
+    host = settings['host'] || '127.0.0.1'
+    port = settings['port']
+    database = settings['database']
+    user = settings['username']
+    password = settings['password']
+
+    # Run the appropriate backup utility
+    case adapter
+    when 'mysql'
+      port ||= '3306'
+      password_arg = password.present? ? "-p#{password}" : ''
+      system "/usr/bin/env mysqldump -h #{host} -P #{port} -u #{user} #{password_arg} #{database} > #{output_file}"
+    when 'postgresql'
+      port ||= '5432'
+
+      # pg_dump doesn't take a password arg, so we have to write the password to the ~/.pgpass file.
+      pgpass_file = ENV['HOME']+'/.pgpass'
+      pgpass_content = "#{host}:#{port}:#{database}:#{user}:#{password}"
+      File.open(pgpass_file, 'a+') do |pgpass|
+        pgpass.write(pgpass_content) unless pgpass.grep(pgpass_content).present?
+      end
+
+      # Ensure that .pgpass has the correct mode (only really needed if we just)
+      # created it.
+      # Ruby 1.8/1.9 compatibility
+      file_util_class = File.respond_to?(:chmod) ? File : FileUtils
+      file_util_class.chmod(0600, pgpass_file)
+
+      system "/usr/bin/env pg_dump -Fc -h #{host} -p #{port} -U #{user} --no-password #{database} > #{output_file}"
+    else
+      raise RuntimeError, "I don't know how to back up #{settings['adapter']} databases!"
+    end
+    system "/usr/bin/env gzip -f #{output_file}"
+  end
+
+  namespace :db do
+    desc "Prune database backups"
+    task :prune => [:environment] do
+      files = Dir.glob("#{output_file_prefix}-*")
+
+      r_index = (-1 * num_to_keep) - 1
+
+      if files.length > num_to_keep
+        files[0..r_index].each do |file|
+          FileUtils.rm file
+        end
+      end
+    end
+  end
+
+  def backup_dir
+    relative_dir = ENV['BACKUP_DIR'] || '../../shared/backup'
+    File.expand_path(relative_dir, Rails.root)
+  end
+
+  def output_file
+    File.expand_path("#{output_file_prefix}-#{Time.now.strftime('%Y%m%d')}.dump", Rails.root)
+  end
+
+  def output_file_prefix
+    "#{backup_dir}/#{settings['database']}"
+  end
+
+  def num_to_keep
+    if ENV['NUM_TO_KEEP'].to_i > 0
+      ENV['NUM_TO_KEEP'].to_i
+    else
+      7
+    end
+  end
+
+  def settings
+    @settings ||= YAML.load(File.read(Rails.root.join("config", "database.yml")))[Rails.env]
+  end
+end

data/lib/db_backup_rails/tasks.rb

@@ -0,0 +1 @@
+load 'db_backup_rails/tasks/backup_db.rake'

data/lib/db_backup_rails/version.rb

@@ -0,0 +1,3 @@
+module DbBackupRails
+  VERSION = "1.0.3"
+end

data/lib/db_backup_rails.rb

@@ -0,0 +1,5 @@
+require "db_backup_rails/version"
+
+module DbBackupRails
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: db_backup_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Leon Miller-Out
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Simple gem to back up your database to local storage
+email:
+- leon@singlebrook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db_backup_rails.gemspec
+- lib/db_backup_rails.rb
+- lib/db_backup_rails/tasks.rb
+- lib/db_backup_rails/tasks/backup_db.rake
+- lib/db_backup_rails/version.rb
+homepage: https://github.com/singlebrook/db_backup_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for using db_backup_rails! If you have upgraded to 1.x.x
+  from 0.x.x, please note that THE DEFAULT BACKUP DIR HAS CHANGED! See the README.md
+  for more info.
+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: Simple gem to back up your database to local storage
+test_files: []