leipreachan 1.0.2 → 1.1.0

data/Changelog

@@ -0,0 +1,16 @@
+v1.1.0
+[+] Allow restore any backup via Capistarano
+
+v1.0.3
+[+] English doc
+[+] Capistrano 2 support
+[+] Allow restore lasts backup via Capistarano
+[+] Drop tables before restore
+[*] Fix postgresql backup
+
+v1.0.2
+[*] Update gemspec
+[*] Decrease depend gem versions
+
+v1.0.0:
+[+] Initial version

data/README.Eng.md

@@ -0,0 +1,87 @@
+# Leipreachan
+
+As easiest as it is possible to be way for a database backup creating
+
+## Installation
+
+Add the follwing line to your Gemfile:
+
+    gem 'leipreachan'
+
+Run:
+
+    $ bundle
+
+Or install manually:
+
+    $ gem install leipreachan
+
+## Usage
+
+### Capistrano 3
+
+To create the backup copies in Capistrano you need to add the following line to the 'Capfile':
+
+    require 'leipreachan/capistrano3'
+
+This way the following tasks are added to Capistrano:
+
+    cap deploy:leipreachan:backup      # Backup database
+    cap deploy:leipreachan:list        # List of backups
+    cap deploy:leipreachan:restore     # Restore database
+
+If a backup copy is needed in course of an application deploy, the following file needs to be added to 'deploy.rb' line:
+
+    before "deploy:migrate", "deploy:leipreachan:backup"
+
+The backup copy will be created before database migrations.
+
+The backup copy is created in 'shared/backups' by default. If there is a necessity of a folder setup, there is a 'backups_folder' variable:
+
+    set :backups_folder, '../../current'
+
+Gem uses a folder with a release as a basis. This should be considered in course of backup copy folder installation. 
+
+For a recovery of the created backup, the following line needs to be run:
+
+    $ cap [environment] deploy:leipreachan:restore
+
+**!!!CAUTION!!!** The latest backup copy is recovered.
+
+### Integration in Whenever
+
+Add the following lines to 'config/schedule.rb':
+
+    every 1.day, :at => '4:30 am' do
+      rake "leipreachan:backup"
+    end
+
+A folder where the backups are stored can be changed. They are kept in './backups' by default. In other words, backups folder is created in the root folder of an application.
+
+    every 1.month, do
+      rake "leipreachan:backup DIR=/tmp/database_backups"
+    end
+
+There is an option of setting up an amount of days for how long the backups should be kept (note, that the tweak doesn't come with the a number of backups of a daily folder; there are unlimited backups every day). By default, 30 is stored directories, divided by dates.
+
+    every 5.days, do
+      rake "leipreachan:backup DAYS=5"
+    end
+
+### Rake tasks usage.
+
+There are several rake tasks for handling database backups:
+
+    rake leipreachan:backup   # Backup project database; Options: DIR=backups RAILS_ENV=production DAYS=30
+    rake leipreachan:list     # List of all backups; Options: DATE=20150130
+    rake leipreachan:restore  # Restore project database; Options: DIR=backups RAILS_ENV=production
+
+* leipreachan:backup – creates database backup. 
+* leipreachan:list – shows a list of days and a list of the backups within the last day. 
+* leipreachan:restore – restores a database from a backup copy.
+
+The options that can be turned over from an environment:
+
+* DIR – a folder where a backup can be saved.
+* DATE – to show the backups at a specified date
+* DAYS – how many days the backups are stored.

data/README.md

@@ -20,12 +20,16 @@ gem 'leipreachan'
 
 ## Использование
 
-### Capistrano 3
+### Capistrano 2/3
 
-Для создания резервных копий с помощью Capistrano добавьте в ваш 'Capfile' эту строку:
+Для создания резервных копий с помощью Capistrano 3 добавьте в ваш 'Capfile' эту строку:
 
     require 'leipreachan/capistrano3'
 
+В случае Capistrano 2 необходимо в файл 'deploy.rb' добавить эту строку:
+
+    require 'leipreachan/capistrano2'
+
 Это добавит следующие задачи в Capistrano:
 
     cap deploy:leipreachan:backup      # Backup database

data/leipreachan.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= #{Leipreachan::RUBY_VERSION}"
 
   s.add_dependency 'bundler', '~> 1.3'
-  s.add_dependency 'rails', ">= #{Leipreachan::RAILS_VERSION}"
 
+  s.add_development_dependency 'rails', ">= #{Leipreachan::RAILS_VERSION}"
   s.add_development_dependency 'rake', "~> 10.0"
   s.add_development_dependency 'rspec', '>= 3.2.0', '<4'
   s.add_development_dependency 'railties', ">= #{Leipreachan::RAILS_VERSION}"

data/lib/capistrano2/tasks/leipreachan.cap

@@ -0,0 +1,28 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    set :folder, fetch(:backups_folder, '../../shared/backups')
+    namespace :leipreachan do
+      desc "Backup database"
+      task :backup, role: :app do
+        run "cd #{latest_release} && RAILS_ENV=#{fetch(:rails_env)} bundle exec rake leipreachan:backup DIR=#{fetch(:folder)}"
+      end
+
+      desc "List of backups"
+      task :list, role: :app do
+        run "cd #{latest_release} && RAILS_ENV=#{fetch(:rails_env)} bundle exec rake leipreachan:list DIR=#{fetch(:folder)}"
+      end
+
+      desc "Restore database"
+      task :restore, role: :app do
+        puts "="*80
+        puts "  WARNING!!! YOUR CURRENT DATABASE DATA WILL BE LOST!!!"
+        puts "  Think twice before enter 'YES' and push the Enter button"
+        puts "="*80
+        answer = Capistrano::CLI.ui.ask "  \"YES\" for restore last backup of the database: '"
+        if answer == 'YES' then
+          run "cd #{latest_release} && RAILS_ENV=#{fetch(:rails_env)} bundle exec rake leipreachan:restorelast DIR=#{fetch(:folder)}"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano3/tasks/leipreachan.cap

@@ -26,13 +26,25 @@ namespace :deploy do
       on roles(:app) do
         within current_path do
           with rails_env: fetch(:rails_env) do
+            execute :bundle, :exec, :rake, "leipreachan:list DIR=#{fetch(:folder)}"
+            set :date, ask('Please specify date (default: last one)', '')
+            puts "Your choice: #{fetch(:date)}"
+
+            if fetch(:date).strip! != ''
+              execute :bundle, :exec, :rake, "leipreachan:list DIR=#{fetch(:folder)} DATE=#{fetch(:date)}"
+            end
+
+            set :filename, ask('Please specify filename for restore (default: last one)', '')
+            puts "Your choice: #{fetch(:filename)}"
+
             puts "="*80
             puts "WARNING!!! YOUR CURRENT DATABASE DATA WILL BE LOST!!!"
             puts "Think twice before enter 'YES' and push the Enter button"
             puts "="*80
+
             set :answercheck, ask('"YES" for restore last backup of the database: ', 'No')
             if fetch(:answercheck) == 'YES'
-              execute :bundle, :exec, :rake, "leipreachan:restorelast DIR=#{fetch(:folder)}"
+              execute :bundle, :exec, :rake, "leipreachan:restorefile DIR=#{fetch(:folder)} DATE=#{fetch(:date)} FILE=#{fetch(:filename)}"
             end
           end
         end

data/lib/leipreachan.rb

@@ -20,15 +20,17 @@ module Leipreachan
                   :backup_folder,
                   :backup_file,
                   :base_path,
-                  :db_config
+                  :db_config,
+                  :file_for_restore
 
     def initialize env
       @max_days = (env['DAYS'] || MAX_DAYS).to_i
       @target_date = env['DATE']
-      @backup_folder = env['DATE'] || Time.now.strftime("%Y%m%d")
+      @backup_folder = env['DATE'].presence || Time.now.strftime("%Y%m%d")
       @directory = env['DIR'] || DIRECTORY
       datetime_stamp = Time.now.strftime("%Y%m%d%H%M%S")
       @base_path = File.join(Rails.root, directory)
+      @file_for_restore = env['FILE']
 
       file_name = "#{datetime_stamp}.sql"
       @backup_file = File.join(backup_base_on(backup_folder), file_name)
@@ -50,8 +52,8 @@ module Leipreachan
       dbrestore! get_file_for_restore
     end
 
-    def restorelast!
-      dbrestore! get_lastfile_for_restore
+    def restorefile!
+      dbrestore! file_for_restore || get_lastfile_for_restore
     end
 
     def list

data/lib/leipreachan/capistrano2.rb

@@ -0,0 +1 @@
+load File.expand_path('../../capistrano2/tasks/leipreachan.cap', __FILE__)

data/lib/leipreachan/mysql2.rb

@@ -1,13 +1,29 @@
 module Leipreachan
   class Backuper < DBBackup
+    def user
+      @user ||= db_config['username'].present? ? "-u#{db_config['username']}" : ""
+    end
+
+    def password
+      @password ||= db_config['password'].present? ? "-p#{db_config['password']} " : ""
+    end
+
+    def host
+      @host ||= db_config['host'].present? ? db_config['host'] : "localhost"
+    end
+
     def dbbackup!
-      password = db_config['password'].present? ? "-p#{db_config['password']} " : ""
-      system("mysqldump -u#{db_config['username']} #{password}-i -c -q --single-transaction #{db_config['database']} | gzip > #{backup_file}.gz")
+      system("mysqldump -h #{host} #{user} #{password}-i -c -q --single-transaction #{db_config['database']} | gzip > #{backup_file}.gz")
     end
 
     def dbrestore! file
-      password = db_config['password'].present? ? "-p#{db_config['password']} " : ""
-      system("zcat < #{backup_base_on(backup_folder)}/#{file} | mysql -u#{db_config['username']} #{password}#{db_config['database']}")
+      system("zcat < #{backup_base_on(backup_folder)}/#{file} | mysql -h #{host} #{user} #{password}#{db_config['database']}")
+    end
+
+    private
+
+    def drop_tables!
+      system("mysql --silent --skip-column-names -e \"SHOW TABLES\" -h #{host} #{user} #{password}#{db_config['database']} | xargs -L1 -I% echo 'DROP TABLE `%`;' | mysql -v -h #{host} #{user} #{password}#{db_config['database']}")
     end
   end
 end

data/lib/leipreachan/postgresql.rb

@@ -1,29 +1,34 @@
 module Leipreachan
   class Backuper < DBBackup
+    def user
+      @user ||= db_config['user'].present? ? "-U #{db_config['user']}" : ""
+    end
+
+    def password
+      @password ||= db_config['password'].present? ? "PGPASSWORD='#{db_config['password']}' " : ""
+    end
+
+    def host
+      @host ||= db_config['host'].present? ? db_config['host'] : "localhost"
+    end
+
     def dbbackup!
-      username = db_config['username'].present? ? "-U #{db_config['username']}" : ""
-      password = db_config['password'].present? ? "PGPASSWORD='#{db_config['password']}' " : ""
-      system("#{password}pg_dump #{username} #{db_config['database']} | gzip > #{backup_file}.gz")
+      system("#{password}pg_dump -h #{host} #{user} #{db_config['database']} | gzip > #{backup_file}.gz")
     end
 
     def dbrestore! file
-      username = db_config['username'].present? ? "-U #{db_config['username']}" : ""
-      password = db_config['password'].present? ? "PGPASSWORD='#{db_config['password']}' " : ""
-
       puts "Will be restored -> #{file}"
       puts ""
-      drop_pg!
-      system("zcat < #{backup_base_on(backup_folder)}/#{file} | #{password}psql #{username} #{db_config['database']}")
+      drop_tables!
+      system("zcat < #{backup_base_on(backup_folder)}/#{file} | #{password}psql -h #{host} #{user} #{db_config['database']}")
     end
 
     private
 
-    def drop_pg!
-      username = db_config['username'].present? ? "-U #{db_config['username']}" : ""
-      password = db_config['password'].present? ? "PGPASSWORD='#{db_config['password']}' " : ""
-      drop_table_query = "drop schema public cascade; create schema public;"
-
-      system("echo \"#{drop_table_query}\" | #{password}psql #{username} #{db_config['database']}")
+    def drop_tables!
+      # drop_table_query = "drop schema public cascade; create schema public;"
+      system("#{password}psql -h #{host} #{user} #{db_config['database']} -t -c \"select 'drop table \\\"' || tablename || '\\\" cascade;' from pg_tables where schemaname = 'public'\"  | #{password}psql -h #{host} #{user} #{db_config['database']}");
+      # system("echo \"#{drop_table_query}\" | #{password}psql -h #{host} #{user} #{db_config['database']}")
     end
   end
 end

data/lib/leipreachan/version.rb

@@ -1,5 +1,5 @@
 module Leipreachan
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
   RAILS_VERSION = "3.1.12"
   RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip.split("-").first
 end

data/lib/tasks/leipreachan.rake

@@ -11,9 +11,9 @@ namespace :leipreachan do
     require 'leipreachan'
     Leipreachan.get_backuper_for(ENV).restore!
   end
-  task restorelast: [:environment] do
+  task restorefile: [:environment] do
     require 'leipreachan'
-    Leipreachan.get_backuper_for(ENV).restorelast!
+    Leipreachan.get_backuper_for(ENV).restorefile!
   end
   desc "Backup project database; Options: DIR=backups RAILS_ENV=production DAYS=30"
   task backup: [:environment] do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leipreachan
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -35,7 +35,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.12
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -109,15 +109,19 @@ files:
 - .gitignore
 - .rspec
 - .ruby-version
+- Changelog
 - Gemfile
 - LICENSE.txt
+- README.Eng.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - leipreachan.gemspec
+- lib/capistrano2/tasks/leipreachan.cap
 - lib/capistrano3/tasks/leipreachan.cap
 - lib/leipreachan.rb
+- lib/leipreachan/capistrano2.rb
 - lib/leipreachan/capistrano3.rb
 - lib/leipreachan/mysql2.rb
 - lib/leipreachan/postgresql.rb