backupper 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce592c96453c4ba3158bd67ec109f79362567636
-  data.tar.gz: 3fa69d4716914ef47b9c455925a3ad90e9797f0a
+  metadata.gz: 433774005bc1b3d59b575acf5878d1bb9f202d5f
+  data.tar.gz: 7efb646234fa7392394ce2980728961b13ae196c
 SHA512:
-  metadata.gz: 02c00c602da98a32a785e81ded45b24742247d6b2aa3f6a6225b2ba761d47bd4b29e6caadf790926f4e4ce34328cde33a678a003fff18638844db85cd6e15db7
-  data.tar.gz: c3fd7475f7acf16f5cb3c28506c36aaaf6e5f5110bdee4e207198d51b46df85c6eb5cb32ed9b8579facd284142105fff611be381278b1ea0de1dbaab294211a8
+  metadata.gz: 0f97d4c32a27d19ab7925b6b868acda6325954cfa4870e3a795efd0a96c32930d2ee2258baa95df4fc0ee50aa5a88b9ab4d4d58ad2c9b36e44ed1137c456dbea
+  data.tar.gz: 3439ec0927796ac074a51b51f68d32787c0992622e9dc9c46f38066f55f497bf59a1a15c257d910f5d1411465ecbd84814a530f6f71869cbbd17d6c5965ccaf3

data/README.md

@@ -1,6 +1,6 @@
 # Backupper
 
-Backupper is a useful tool to backup all your databases spreaded in the world!
+Backupper is a tool to backup all your databases spread in the world!
 
 ## Installation
 
@@ -12,7 +12,7 @@ Backupper is a useful tool to backup all your databases spreaded in the world!
 
 ## Configuration file
 
-A common config file for backupper looks like this:
+A common [YAML](http://yaml.org/) config file for backupper looks like this:
 
 ```yaml
 mailer:
@@ -36,7 +36,7 @@ db1:
 
 db2:
   disabled: false
-  dump: '/home/backup/db2
+  dump: '/home/backup/db2'
   extra_copy: '/mnt/backup-disk/backups/db2'
   username: user
   host: '1.2.3.4'
@@ -48,7 +48,7 @@ db2:
   db_password: db_Pa$$w0rD
 ```
 
-After the backup a report email is sent to you using gmail smtp service (remember to permit less secure app [here](https://myaccount.google.com/lesssecureapps)).
+After done all backups a report email is sent to you using gmail smtp service (remember to permit less secure app [here](https://myaccount.google.com/lesssecureapps)).
 
 ⚠️ __WARNING__: the backupper configuration file contains many important passwords, so be careful to lock it and protect it with care!
 
@@ -62,9 +62,9 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## About Uqido
 
-[![uqido](https://www.uqido.com/assets/uqido/logo_Uqido@2x-07d759d29607a31dcc13d18b5c67585377eee4fceff1ea733340113ca4f574c0.png)](http://uqido.com)
+[![uqido](https://i.imgur.com/FAo2W7w.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).
+The [Uqido team](https://www.uqido.com/en/about-us/).

data/backupper.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = 'backupper'
   spec.version       = Backupper::VERSION
   spec.authors       = ['pioz']
-  spec.email         = ['epilotto@gmx.com']
+  spec.email         = ['enrico.pilotto@uqido.com']
 
   spec.summary       = %q{Tool to backup databases}
-  spec.description   = %q{Tool to backup databases}
+  spec.description   = %q{Backupper is a tool to backup all your databases spread in the world}
   spec.homepage      = 'https://github.com/uqido/backupper'
   spec.license       = 'MIT'
 

data/lib/backupper.rb

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

data/lib/backupper/backupper.rb

@@ -2,6 +2,8 @@ require 'yaml'
 require 'fileutils'
 require 'sshkit'
 require 'sshkit/dsl'
+require 'backupper/dump_command'
+require 'backupper/mailer'
 include SSHKit::DSL
 
 class Backupper
@@ -23,103 +25,91 @@ class Backupper
 
   def backup!
     @conf.each do |k, options|
-      o = @default.merge(options)
       puts "⬇️  backing up #{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!'
+      o, err = setup_options(options)
+      if err
         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'],
+          key:          k,
+          adapter:      o['adapter'],
+          url:          o['url'],
+          password:     o['password'],
+          database:     o['database'],
+          db_username:  o['db_username'],
+          db_password:  o['db_password'],
           dump_options: o['dump_options'],
-          outdir: outdir,
-          extra_copy: o['extra_copy']
+          outdir:       o['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
+    send_report_email!
   end
 
-  def mysql_dump_command(database:, username: 'root', password: nil, dump_options: nil, outfile:)
-    params = []
-    params << "--databases '#{database}'"
-    params << "-u#{username}"
-    params << "-p#{password}" if password
-    params << dump_options if dump_options
-    return "mysqldump #{params.join(' ')} | bzip2 > '#{outfile}'"
+  def download_dump(key:, adapter: 'mysql', url:, password: nil, database:, db_username: 'root', db_password: nil, dump_options: nil, outdir:, extra_copy: nil)
+    t = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    path = 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)
+    on(url) do |client|
+      client.password = password
+      execute 'set -o pipefail; ' + DumpCommand.send(adapter, database: database, username: db_username, password: db_password, dump_options: dump_options, 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: (Process.clock_gettime(Process::CLOCK_MONOTONIC) - t).round(2)
+    }
+    @report[key].merge!({extra_copy: File.absolute_path(File.join(extra_copy, dumpname))}) if extra_copy
   end
 
-  def postgresql_dump_command(database:, username: 'root', password: nil, dump_options: nil, outfile:)
-    params = []
-    params << "-U #{username}"
-    params << "'#{database}'"
-    params << dump_options if dump_options
-    return "PGPASSWORD=#{password} pg_dump #{params.join(' ')} | bzip2 > '#{outfile}'"
+  private
+
+  def setup_options(options)
+    o = @default.merge(options)
+    o['outdir'] = check_dir(o['dump'].to_s)
+    unless o['outdir']
+      return nil, 'Invalid directory where to save database dump'
+    end
+    unless o['database']
+      return nil, 'Please specify the database name!'
+    end
+    unless o['host']
+      return nil, 'Please specify the host!'
+    end
+    o['url'] = o['host']
+    o['url'] = "#{o['username']}@#{o['url']}" if o['username']
+    o['url'] = "#{o['url']}:#{o['port']}" if o['port']
+    o['adapter'] ||= 'mysql'
+    unless DumpCommand.respond_to?(o['adapter'])
+      return nil, "Cannot handle adapter '#{o['adapter']}'"
+    end
+    return o, nil
   end
 
-  def download_dump(key:, adapter: 'mysql', host:, password: nil, database:, db_username: 'root', db_password: nil, dump_options: nil, outdir:, extra_copy: nil)
-    if self.respond_to?("#{adapter}_dump_command")
-      t = Time.now
-      path = 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 |client|
-        client.password = password
-        execute 'set -o pipefail; ' + backupper.send("#{adapter}_dump_command", database: database, username: db_username, password: db_password, dump_options: dump_options, outfile: tempfile)
-        download! tempfile, path
-        execute :rm, tempfile
+  def send_report_email!
+    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
-      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

data/lib/backupper/dump_command.rb

@@ -0,0 +1,20 @@
+module DumpCommand
+
+  def self.mysql(database:, username: 'root', password: nil, dump_options: nil, outfile:)
+    params = []
+    params << "--databases '#{database}'"
+    params << "-u#{username}"
+    params << "-p#{password}" if password
+    params << dump_options if dump_options
+    return "mysqldump #{params.join(' ')} | bzip2 > '#{outfile}'"
+  end
+
+  def self.postgresql(database:, username: 'root', password: nil, dump_options: nil, outfile:)
+    params = []
+    params << "-U #{username}"
+    params << "'#{database}'"
+    params << dump_options if dump_options
+    return "PGPASSWORD=#{password} pg_dump #{params.join(' ')} | bzip2 > '#{outfile}'"
+  end
+
+end

data/lib/backupper/version.rb

@@ -1,3 +1,3 @@
 class Backupper
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backupper
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - pioz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit
@@ -66,9 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Tool to backup databases
+description: Backupper is a tool to backup all your databases spread in the world
 email:
-- epilotto@gmx.com
+- enrico.pilotto@uqido.com
 executables:
 - backupper
 extensions: []
@@ -83,6 +83,7 @@ files:
 - bin/backupper
 - lib/backupper.rb
 - lib/backupper/backupper.rb
+- lib/backupper/dump_command.rb
 - lib/backupper/mailer.rb
 - lib/backupper/version.rb
 homepage: https://github.com/uqido/backupper