backupper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 723c61f682f76c26391c958a439f44cb449c1cd6
+  data.tar.gz: 83e680f50cc6f12c401d3def411e6348708a0fa3
+SHA512:
+  metadata.gz: 68da65e4bb05372820267af1415ba43d9d8a37d9fd19f99f13ace62b4da820549f3496ca95ad2402e05e1a0a83f97e77b7702798fc14d9ab057fa5781ba6d38b
+  data.tar.gz: 823297e467198e1feb532d205186e097a58d7eb97a18cefb13b39d3d07709b8cc388cd3cc79769841cb4bd2343ed5d1cba6d668ec19b4abec70b7bbb4482a799

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in backupper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 pioz
+
+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,67 @@
+# Backupper
+
+Backupper is a useful tool to backup all your databases spreaded in the world!
+
+## Installation
+
+    $ gem install backupper
+
+## Usage
+
+    $ backupper path/to/config.yml
+
+## Configuration file
+
+A common config file for backupper looks like this:
+
+```yaml
+mailer:
+  from: support@email.com # Gmail account used to send report email
+  to: pioz@email.com      # Send report email to this address
+  password: Pa$$w0rD      # Gmail account password
+
+db1:
+  disabled: false                            # true to disable this backup
+  dump: '/home/backup/db1'                   # path where to save the dump of the database
+  extra_copy: '/mnt/backup-disk/backups/db1' # path where to save a extra copy of the dump
+  username: user                             # server ssh username
+  host: '1.2.3.4'                            # server ssh ip
+  port: 22                                   # server ssh port
+  password: Pa$$w0rD                         # server ssh password
+  adapter: mysql                             # database to backup (supported are mysql or postgresql)
+  database: db_name                          # database name
+  db_username: db_user                       # database username
+  db_password: db_Pa$$w0rD                   # database password
+
+db2:
+  disabled: false
+  dump: '/home/backup/db2
+  extra_copy: '/mnt/backup-disk/backups/db2'
+  username: user
+  host: '1.2.3.4'
+  port: 22
+  password: Pa$$w0rD
+  adapter: postgresql
+  database: db_name
+  db_username: db_user
+  db_password: db_Pa$$w0rD
+```
+
+After backups a report email is sent to you using gmail smtp service.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uqido/backupper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## About Uqido
+
+[![uqido](https://www.uqido.com/assets/uqido/logo_Uqido@2x-07d759d29607a31dcc13d18b5c67585377eee4fceff1ea733340113ca4f574c0.png)](http://uqido.com)
+
+Backupper is maintained and funded by [Uqido](https://uqido.com).
+The names and logos for Uqido are trademarks of Uqido s.r.l.
+
+The [Uqido team](https://www.uqido.com/#team).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/backupper.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "backupper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "backupper"
+  spec.version       = Backupper::VERSION
+  spec.authors       = ["pioz"]
+  spec.email         = ["epilotto@gmx.com"]
+
+  spec.summary       = %q{Tool to backup databases}
+  spec.description   = %q{Tool to backup databases}
+  spec.homepage      = "https://github.com/uqido/backupper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sshkit", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/backupper

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << './lib'
+
+require 'backupper'
+
+if ARGV.size != 1
+  puts "usage: #{$0} path/to/config.yml"
+  exit 1
+end
+
+b = Backupper.new(ARGV.first)
+b.backup!

data/lib/backupper.rb

@@ -0,0 +1,3 @@
+require 'backupper/backupper'
+require 'backupper/mailer'
+require 'backupper/version'

data/lib/backupper/backupper.rb

@@ -0,0 +1,139 @@
+require 'yaml'
+require 'fileutils'
+require 'sshkit'
+require 'sshkit/dsl'
+include SSHKit::DSL
+
+class Backupper
+
+  SSHKit::Backend::Netssh.configure do |ssh|
+    ssh.connection_timeout = 30
+    ssh.ssh_options = {
+      auth_methods: %w(publickey password)
+    }
+  end
+
+  def initialize(conf_file_path)
+    conf = YAML.load_file(conf_file_path)
+    @default = conf['default'] || {}
+    @mailer = conf['mailer'] || {}
+    @conf = conf.select{|k, v| !%w(default mailer).include?(k) && (v['disabled'].nil? || v['disabled'] == false)}
+    @report = {}
+  end
+
+  def backup!
+    @conf.each do |k, options|
+      o = @default.merge(options)
+      puts "🗄 run backup of #{k}..."
+      outdir = check_dir(o['dump'].to_s)
+      unless outdir
+        err = 'Invalid directory where to save database dump'
+        error(k, err)
+        puts err
+        next
+      end
+      host = o['host']
+      host = "#{o['username']}@#{host}" if o['username']
+      host = "#{host}:#{o['port']}" if o['port']
+      adapter = o['adapter'] || 'mysql'
+      unless self.respond_to?("#{adapter}_dump_command")
+        err = "Cannot handle adapter '#{adapter}'"
+        error(k, err)
+        puts err
+        next
+      end
+      unless o['database']
+        err = 'Please specify database name!'
+        error(k, err)
+        puts err
+        next
+      end
+      begin
+        download_dump(
+          key: k,
+          adapter: adapter,
+          host: host,
+          password: o['password'],
+          database: o['database'],
+          db_username: o['db_username'],
+          db_password: o['db_password'],
+          outdir: outdir,
+          extra_copy: o['extra_copy']
+        )
+      rescue SSHKit::Runner::ExecuteError => e
+        error(k, e.to_s)
+        puts e
+      end
+    end
+    if @report.any? && @mailer['from'] && @mailer['to'] && @mailer['password']
+      begin
+        Mailer.send(from: @mailer['from'], to: @mailer['to'], password: @mailer['password'], report: @report)
+      rescue Net::SMTPAuthenticationError => e
+        puts e
+      end
+    end
+  end
+
+  def mysql_dump_command(database:, username: 'root', password: nil, outfile:)
+    params = []
+    params << "--databases '#{database}'"
+    params << "-u#{username}"
+    params << "-p#{password}" if password
+    return "mysqldump #{params.join(' ')} | bzip2 > '#{outfile}'"
+  end
+
+  def postgresql_dump_command(database:, username: 'root', password: nil, outfile:)
+    params = []
+    params << "-U #{username}"
+    params << "-W #{password}" if password
+    params << "'#{database}'"
+    return "pg_dump #{params.join(' ')} | bzip2 > '#{outfile}'"
+  end
+
+  def download_dump(key:, adapter: 'mysql', host:, password: nil, database:, db_username: 'root', db_password: nil, outdir:, extra_copy: nil)
+    if self.respond_to?("#{adapter}_dump_command")
+      t = Time.now
+      path = nil
+      dump_name = nil
+      filename = "#{key}__#{database}.sql.bz2"
+      tempfile = File.join('/tmp', filename)
+      dumpname = "#{Time.now.strftime('%Y-%M-%d_%H-%M-%S')}__#{filename}"
+      path = File.join(outdir, dumpname)
+      backupper = self
+      on(host) do |host|
+        host.password = password
+        execute backupper.send("#{adapter}_dump_command", database: database, username: db_username, password: db_password, outfile: tempfile)
+        download! tempfile, path
+        execute :rm, tempfile
+      end
+      extra_copy = check_dir(extra_copy)
+      FileUtils.cp(path, extra_copy) if extra_copy
+      @report[key] = {
+        path: File.absolute_path(path),
+        size: (File.size(path).to_f / 2**20).round(2),
+        time: (Time.now - t).round(2)
+      }
+      @report[key].merge!({extra_copy: File.absolute_path(File.join(extra_copy, dumpname))}) if extra_copy
+    end
+  end
+
+  private
+
+  def error(key, error)
+    @report[key] = {error: error}
+  end
+
+  def check_dir(dirpath)
+    return nil if dirpath.nil?
+    unless File.exists?(dirpath)
+      begin
+        FileUtils::mkdir_p(dirpath)
+      rescue => e
+        return nil
+      end
+    end
+    return File.dirname(dirpath) unless File.directory?(dirpath)
+    return dirpath
+  end
+
+end

data/lib/backupper/mailer.rb

@@ -0,0 +1,63 @@
+require 'mail'
+
+class Mailer
+
+  def self.send(from:, to:, password:, report:)
+    options = {
+      address:              'smtp.gmail.com',
+      port:                 587,
+      user_name:            from,
+      password:             password,
+      authentication:       'plain',
+      enable_starttls_auto: true
+    }
+    Mail.defaults do
+      delivery_method :smtp, options
+    end
+    Mail.deliver do
+      to to
+      from from
+      subject Mailer.subject(report)
+      body Mailer.body(report)
+    end
+  end
+
+  private
+
+  def self.body(report)
+    b = []
+    report.each do |k, data|
+      s = ''
+      if data[:error]
+        s << "❌ #{k}\n"
+        s << '=' * 80 << "\n"
+        s << "Backup FAILED!\n"
+        s << "  error: #{data[:error]}\n"
+        b << s
+      else
+        s << "️✅ #{k}\n"
+        s << '=' * 80 << "\n"
+        s << "Backup SUCCESS!\n"
+        s << "  dump path: #{data[:path]}\n"
+        s << "  dump size: #{data[:size]} MB\n"
+        s << "  time: #{data[:time]} seconds\n"
+        if data[:extra_copy]
+          s << "  extra copy in: #{data[:extra_copy]}\n"
+        else
+          s << "  no extra copy has been made\n"
+        end
+        b << s
+      end    
+    end
+    return "Report for backups (#{Time.now})\n\n#{b.join("\n\n")}"
+  end
+
+  def self.subject(report)
+    errors = report.select{|k, v| v[:error]}.size
+    icon = '✅'
+    icon = '⚠️' if errors > 0
+    icon = '❌' if errors == report.size
+    return "[Backupper] #{report.size-errors}/#{report.size} backups successfully completed #{icon}"
+  end
+
+end

data/lib/backupper/version.rb

@@ -0,0 +1,3 @@
+class Backupper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: backupper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pioz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Tool to backup databases
+email:
+- epilotto@gmx.com
+executables:
+- backupper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backupper.gemspec
+- bin/backupper
+- lib/backupper.rb
+- lib/backupper/backupper.rb
+- lib/backupper/mailer.rb
+- lib/backupper/version.rb
+homepage: https://github.com/uqido/backupper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Tool to backup databases
+test_files: []