leipreachan 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1617b7813e458266d6324091531da3f3099a75a2
+  data.tar.gz: 42c96d3a9bfd861d2d2f57211844f4802fe22f24
+SHA512:
+  metadata.gz: 39c06b88689db722b1552d8b87e787251f065bdad11e6c66b276e370eaa8379cb47096797dd9d963ac48f5c5fd1df0931a2803a46c2f80f8ee65a6ecca7e4747
+  data.tar.gz: 03f812d5d96a463d9029400dd9f3f1def7b83f2c9572c165316e2d04cfa38a85f11df0f20826954b4cd779774595688383655f8f35d8e133e0e3c8b28f5d72fc

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anadea Inc.
+
+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,93 @@
+# Leipreachan
+
+Самый простой способ создания резервных копий базы данных проекта на сколько это вообще возможно.
+
+## Установка
+
+Добавьте эту строку в ваш Gemfile:
+
+```ruby
+gem 'leipreachan'
+```
+
+После этого запустите:
+
+    $ bundle
+
+Или установите вручную:
+
+    $ gem install leipreachan
+
+## Использование
+
+### Capistrano 3
+
+Для создания резервных копий с помощью Capistrano добавьте в ваш 'Capfile' эту строку:
+
+    require 'leipreachan/capistrano3'
+
+Это добавит следующие задачи в Capistrano:
+
+    cap deploy:leipreachan:backup      # Backup database
+    cap deploy:leipreachan:list        # List of backups
+    cap deploy:leipreachan:restore     # Restore database
+
+Если вы хотите создать резервную копию в процессе деплоя приложения вам необходимо добавить эту строку в 'deploy.rb':
+
+    before "deploy:migrate", "deploy:leipreachan:backup"
+
+Резервная копия будет создана перед миграциями базы данных.
+
+По умолчанию резервная копия создается в 'shared/backups', но если у вас есть необходимость установить свой каталог, это можно сделать с помощью переменной 'backups_folder':
+
+    set :backups_folder, '../../current'
+
+Gem берет за основу каталог с релизом. Учтите это при установке каталога резервных копий.
+
+Для восстановления сделанного бекапа необходимо запустить:
+
+    $ cap [environment] deploy:leipreachan:restore
+
+ВНИМЕНИЕ!!! Восстанавливается **последняя** сделанная резервная копия.
+
+### Интергация в Whenever
+
+Просто добавьте эти строки в ваш 'config/schedule.rb':
+
+```ruby
+  every 1.day, :at => '4:30 am' do
+    rake "leipreachan:backup"
+  end
+```
+Так же вы можете изменить каталог, куда будут складываться резервные копии. По умолчанию они складываются в './backups', т.е. создается каталог backups в корневом каталоге приложения.
+
+```ruby
+  every 1.month, do
+    rake "leipreachan:backup DIR=/tmp/database_backups"
+  end
+```
+Есть возможность указать сколько дней хранить резервные копии (обратите внимание, что эта настройка не распространяется на количество резервных копий внутри каталога дня; каждый день их может храниться неограниченное количество). По умолчанию хранится 30 каталогов, разбитых по датам.
+
+```ruby
+  every 5.days, do
+    rake "leipreachan:backup DAYS=5"
+  end
+```
+
+### Использование Rake задач
+
+Для работы с резервными копиями базы данных есть неколько rake задач:
+
+    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 - создаст резервную копию базы данных.
+leipreachan:list - выведет список дней и бекапов в последнем дне.
+leipreachan:restore - восстановит базу данных из резервной копии.
+
+Опции, которые можно передать из окружения:
+
+* DIR - каталог, куда необходимо сохранить резервную копию
+* DATE - показать резервные копии на определенную дату
+* DAYS - сколько дней хранить резервные копии

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('lib/tasks/*.rake').each {|r| import r}

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leipreachan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "leipreachan"
+  spec.version       = Leipreachan::VERSION
+  spec.authors       = ["Anadea Inc team (http://anadea.info)"]
+  spec.email         = ["gemmaker@anahoret.com"]
+
+  spec.summary       = %q{Backup and restore your database by the simple way.}
+  spec.description   = %q{Backup and restore your database as simple as posible.}
+  spec.homepage      = "https://github.com/anadea/leipreachan"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 1.9"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'railties'
+  spec.add_development_dependency 'rails'
+end

data/lib/capistrano3/tasks/leipreachan.cap

@@ -0,0 +1,42 @@
+namespace :deploy do
+  set :folder, fetch(:backups_folder) || '../../shared/backups'
+  namespace :leipreachan do
+    desc "Backup database"
+    task :backup do
+      on roles(:app), in: :sequence, wait: 5 do
+        within release_path do
+          with rails_env: fetch(:rails_env) do
+            execute :bundle, :exec, :rake, "leipreachan:backup DIR=#{fetch(:folder)}"
+          end
+        end
+      end
+    end
+    desc "List of backups"
+    task :list 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)}"
+          end
+        end
+      end
+    end
+    desc "Restore database"
+    task :restore do
+      on roles(:app) do
+        within current_path do
+          with rails_env: fetch(:rails_env) 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
+            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)}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/leipreachan/capistrano3.rb

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

data/lib/leipreachan/mysql2.rb

@@ -0,0 +1,13 @@
+module Leipreachan
+  class Backuper < DBBackup
+    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")
+    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']}")
+    end
+  end
+end

data/lib/leipreachan/postgresql.rb

@@ -0,0 +1,29 @@
+module Leipreachan
+  class Backuper < DBBackup
+    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")
+    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']}")
+    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']}")
+    end
+  end
+end

data/lib/leipreachan/railtie.rb

@@ -0,0 +1,6 @@
+module Leipreachan
+  # require 'rails'
+  class Railtie < Rails::Railtie
+    rake_tasks { load "tasks/leipreachan.rake" }
+  end
+end

data/lib/leipreachan/version.rb

@@ -0,0 +1,3 @@
+module Leipreachan
+  VERSION = "1.0.0"
+end

data/lib/leipreachan.rb

@@ -0,0 +1,121 @@
+require 'leipreachan/version'
+require 'leipreachan/railtie' if defined?(Rails)
+require 'rails'
+require 'active_record'
+
+module Leipreachan
+  def self.get_backuper_for env
+    db_config = ActiveRecord::Base.configurations[Rails.env]
+    require "leipreachan/#{db_config['adapter']}"
+    Backuper.new(env)
+  end
+
+  class DBBackup
+    MAX_DAYS = 30
+    DIRECTORY = 'backups'
+
+    attr_accessor :max_days,
+                  :directory,
+                  :target_date,
+                  :backup_folder,
+                  :backup_file,
+                  :base_path,
+                  :db_config
+
+    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")
+      @directory = env['DIR'] || DIRECTORY
+      datetime_stamp = Time.now.strftime("%Y%m%d%H%M%S")
+      @base_path = File.join(Rails.root, directory)
+
+      file_name = "#{datetime_stamp}.sql"
+      @backup_file = File.join(backup_base_on(backup_folder), file_name)
+
+      @db_config = ActiveRecord::Base.configurations[Rails.env]
+    end
+
+    def backup!
+      FileUtils.mkdir_p(backup_base_on(backup_folder))
+      dbbackup!
+      puts "Created backup: #{backup_file}.gz"
+      backups_count = Dir.new(backup_base_on(backup_folder)).entries.select{|name| name.match(/sql.gz$/)}.size
+      puts "#{backups_count} backups available for #{backup_folder} date"
+
+      remove_unwanted_backups
+    end
+
+    def restore!
+      dbrestore! get_file_for_restore
+    end
+
+    def restorelast!
+      dbrestore! get_lastfile_for_restore
+    end
+
+    def list
+      target_date.present? ? single_date(target_date) : all_dates
+    end
+
+    private
+
+    def get_backups_list folder
+      Dir.new(backup_base_on(folder)).entries.select{|name| name.match(/sql.gz$/)}.sort
+    end
+
+    def all_dates
+      list = Dir.new(base_path).entries.select{|name| name.match(/\d+/)}.sort
+      list.first(list.size - 1).each_with_index do |folder, index|
+        count = get_backups_list(folder).size
+        puts "-> #{folder}: #{count}"
+      end
+      single_date list.last
+    end
+
+    def single_date date
+      count = get_backups_list(date).size
+      puts "-> #{date}: #{count}"
+      get_backups_list(date).each_with_index do |backup, index|
+        puts "   #{backup}"
+      end
+    end
+
+    def backup_base_on target_date
+      File.join(base_path, target_date)
+    end
+
+    def remove_unwanted_backups
+      all_backups = Dir.new(base_path).entries.select{|folder| folder.match(/\d{8}/)}.sort.reverse
+
+      max_backups = (max_days if max_days > 0) || MAX_DAYS
+      unwanted_backups = all_backups[max_backups..-1] || []
+
+      for unwanted_backup in unwanted_backups
+        FileUtils.rm_rf(File.join(base_path, unwanted_backup))
+      end
+      puts "Deleted #{unwanted_backups.length} days, #{all_backups.length - unwanted_backups.length} days available"
+    end
+
+    def get_file_for_restore
+      backups_list = backup_folder_items.reverse
+      backups_list.each_with_index do |backup, index|
+        puts "#{index}. #{backup}"
+      end
+      puts "="*80
+      puts "WARNING!!! YOUR CURRENT DATABASE DATA WILL BE LOST!!!"
+      puts "Think twice before push the Enter button"
+      puts "="*80
+      puts "Enter file name to restore: [#{backups_list.last}]"
+      STDIN.gets.chomp.presence || backups_list.last
+    end
+
+    def get_lastfile_for_restore
+      backup_folder_items.reverse.last
+    end
+
+    def backup_folder_items
+      get_backups_list(backup_folder).reverse
+    end
+  end
+end

data/lib/tasks/leipreachan.rake

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+namespace :leipreachan do
+  desc 'List of all backups; Options: DATE=20150130'
+  task list: [:environment] do
+    require 'leipreachan'
+    Leipreachan.get_backuper_for(ENV).list
+  end
+  desc 'Restore project database; Options: DIR=backups RAILS_ENV=production DAYS=30'
+  task restore: [:environment] do
+    require 'leipreachan'
+    Leipreachan.get_backuper_for(ENV).restore!
+  end
+  task restorelast: [:environment] do
+    require 'leipreachan'
+    Leipreachan.get_backuper_for(ENV).restorelast!
+  end
+  desc "Backup project database; Options: DIR=backups RAILS_ENV=production DAYS=30"
+  task backup: [:environment] do
+    require 'leipreachan'
+    Leipreachan.get_backuper_for(ENV).backup!
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: leipreachan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anadea Inc team (http://anadea.info)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-28 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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Backup and restore your database as simple as posible.
+email:
+- gemmaker@anahoret.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- leipreachan.gemspec
+- lib/capistrano3/tasks/leipreachan.cap
+- lib/leipreachan.rb
+- lib/leipreachan/capistrano3.rb
+- lib/leipreachan/mysql2.rb
+- lib/leipreachan/postgresql.rb
+- lib/leipreachan/railtie.rb
+- lib/leipreachan/version.rb
+- lib/tasks/leipreachan.rake
+homepage: https://github.com/anadea/leipreachan
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Backup and restore your database by the simple way.
+test_files: []