backup 4.4.1 → 5.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 27f2f7a25217955273c6b721509dacde87c0ba06715004ee3cf732262a4e3fed
-  data.tar.gz: ee514abc68b3d0ecb52f6965b14dac5d6ac8d17386a5ae8ef46029cf6aa332a3
+SHA1:
+  metadata.gz: 3e90aa060ddb761e49388d59c63e4a347ff31b10
+  data.tar.gz: 6daf2c1c7fc2522c806f8cee757d8dbbf024c099
 SHA512:
-  metadata.gz: 0015adf0f7e1b5e226866a11cdd658c129853508df5301c9df641fd377e55e9c73271577aca41d4d57178ba67238f9cd39d2fbce82fe6f89052f1977292138c3
-  data.tar.gz: d338cf0df9fc344c283aa14cc31e17ebe912e51f49e210ab873941986548c56af72a3acccb0dc259131c12727c5d6957eb535bbad52a11667a399799a5bd2d24
+  metadata.gz: fec34c486f7f34829928cca1342ca9986dfd072dae3c3dffa05cfc247547dff113c72d53c9d354d9157d68bf20945b11f07787e02584cda4d28cb554e397cd0d
+  data.tar.gz: 37a71a5c1603c4a280874f07ebc5156daef997ebb0e931a031224d0a79c4af6d502ddc4b4512fb64f38b2624458135300adcf2579c77b9d9e6e284ebcf7203cc

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009-2017 Michael van Rooijen
+
+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

@@ -16,7 +16,7 @@ Please use the Backup features [issue tracker][Features] to suggest new features
 Only use the Backup gem [issue tracker][Issues] for bugs and other issues.
 We're also available on [Gitter] for questions and problems.
 
-**Copyright (c) 2009-2016 [Michael van Rooijen][] ( [@mrrooijen] )**  
+**Copyright (c) 2009-2017 [Michael van Rooijen][] ( [@mrrooijen] )**  
 Released under the **MIT** [LICENSE](LICENSE).
 
 [Installation]:  http://backup.github.io/backup/v4/installation

data/lib/backup.rb

@@ -1,20 +1,18 @@
-# encoding: utf-8
-
 # Load Ruby Core Libraries
-require 'time'
-require 'fileutils'
-require 'tempfile'
-require 'syslog'
-require 'yaml'
-require 'etc'
-require 'forwardable'
-require 'thread'
+require "time"
+require "fileutils"
+require "tempfile"
+require "syslog"
+require "yaml"
+require "etc"
+require "forwardable"
+require "thread"
 
-require 'open4'
-require 'thor'
-require 'shellwords'
+require "open4"
+require "thor"
+require "shellwords"
 
-require 'excon'
+require "excon"
 # Include response.inspect in error messages.
 Excon.defaults[:debug_response] = true
 # Excon should not retry failed requests. We handle that.
@@ -23,107 +21,106 @@ Excon.defaults[:middlewares].delete(Excon::Middleware::Idempotent)
 ##
 # The Backup Ruby Gem
 module Backup
-
   ##
   # Backup's internal paths
-  LIBRARY_PATH       = File.join(File.dirname(__FILE__), 'backup')
-  STORAGE_PATH       = File.join(LIBRARY_PATH, 'storage')
-  SYNCER_PATH        = File.join(LIBRARY_PATH, 'syncer')
-  DATABASE_PATH      = File.join(LIBRARY_PATH, 'database')
-  COMPRESSOR_PATH    = File.join(LIBRARY_PATH, 'compressor')
-  ENCRYPTOR_PATH     = File.join(LIBRARY_PATH, 'encryptor')
-  NOTIFIER_PATH      = File.join(LIBRARY_PATH, 'notifier')
-  TEMPLATE_PATH      = File.expand_path('../../templates', __FILE__)
+  LIBRARY_PATH       = File.join(File.dirname(__FILE__), "backup")
+  STORAGE_PATH       = File.join(LIBRARY_PATH, "storage")
+  SYNCER_PATH        = File.join(LIBRARY_PATH, "syncer")
+  DATABASE_PATH      = File.join(LIBRARY_PATH, "database")
+  COMPRESSOR_PATH    = File.join(LIBRARY_PATH, "compressor")
+  ENCRYPTOR_PATH     = File.join(LIBRARY_PATH, "encryptor")
+  NOTIFIER_PATH      = File.join(LIBRARY_PATH, "notifier")
+  TEMPLATE_PATH      = File.expand_path("../../templates", __FILE__)
 
   ##
   # Autoload Backup storage files
   module Storage
-    autoload :Base,       File.join(STORAGE_PATH, 'base')
-    autoload :Cycler,     File.join(STORAGE_PATH, 'cycler')
-    autoload :S3,         File.join(STORAGE_PATH, 's3')
-    autoload :CloudFiles, File.join(STORAGE_PATH, 'cloud_files')
-    autoload :Ninefold,   File.join(STORAGE_PATH, 'ninefold')
-    autoload :Dropbox,    File.join(STORAGE_PATH, 'dropbox')
-    autoload :FTP,        File.join(STORAGE_PATH, 'ftp')
-    autoload :SFTP,       File.join(STORAGE_PATH, 'sftp')
-    autoload :SCP,        File.join(STORAGE_PATH, 'scp')
-    autoload :RSync,      File.join(STORAGE_PATH, 'rsync')
-    autoload :Local,      File.join(STORAGE_PATH, 'local')
-    autoload :Qiniu,      File.join(STORAGE_PATH, 'qiniu')
+    autoload :Base,       File.join(STORAGE_PATH, "base")
+    autoload :Cycler,     File.join(STORAGE_PATH, "cycler")
+    autoload :S3,         File.join(STORAGE_PATH, "s3")
+    autoload :CloudFiles, File.join(STORAGE_PATH, "cloud_files")
+    autoload :Ninefold,   File.join(STORAGE_PATH, "ninefold")
+    autoload :Dropbox,    File.join(STORAGE_PATH, "dropbox")
+    autoload :FTP,        File.join(STORAGE_PATH, "ftp")
+    autoload :SFTP,       File.join(STORAGE_PATH, "sftp")
+    autoload :SCP,        File.join(STORAGE_PATH, "scp")
+    autoload :RSync,      File.join(STORAGE_PATH, "rsync")
+    autoload :Local,      File.join(STORAGE_PATH, "local")
+    autoload :Qiniu,      File.join(STORAGE_PATH, "qiniu")
   end
 
   ##
   # Autoload Backup syncer files
   module Syncer
-    autoload :Base, File.join(SYNCER_PATH, 'base')
+    autoload :Base, File.join(SYNCER_PATH, "base")
     module Cloud
-      autoload :Base,       File.join(SYNCER_PATH, 'cloud', 'base')
-      autoload :LocalFile,  File.join(SYNCER_PATH, 'cloud', 'local_file')
-      autoload :CloudFiles, File.join(SYNCER_PATH, 'cloud', 'cloud_files')
-      autoload :S3,         File.join(SYNCER_PATH, 'cloud', 's3')
+      autoload :Base,       File.join(SYNCER_PATH, "cloud", "base")
+      autoload :LocalFile,  File.join(SYNCER_PATH, "cloud", "local_file")
+      autoload :CloudFiles, File.join(SYNCER_PATH, "cloud", "cloud_files")
+      autoload :S3,         File.join(SYNCER_PATH, "cloud", "s3")
     end
     module RSync
-      autoload :Base,  File.join(SYNCER_PATH, 'rsync', 'base')
-      autoload :Local, File.join(SYNCER_PATH, 'rsync', 'local')
-      autoload :Push,  File.join(SYNCER_PATH, 'rsync', 'push')
-      autoload :Pull,  File.join(SYNCER_PATH, 'rsync', 'pull')
+      autoload :Base,  File.join(SYNCER_PATH, "rsync", "base")
+      autoload :Local, File.join(SYNCER_PATH, "rsync", "local")
+      autoload :Push,  File.join(SYNCER_PATH, "rsync", "push")
+      autoload :Pull,  File.join(SYNCER_PATH, "rsync", "pull")
     end
   end
 
   ##
   # Autoload Backup database files
   module Database
-    autoload :Base,       File.join(DATABASE_PATH, 'base')
-    autoload :MySQL,      File.join(DATABASE_PATH, 'mysql')
-    autoload :PostgreSQL, File.join(DATABASE_PATH, 'postgresql')
-    autoload :MongoDB,    File.join(DATABASE_PATH, 'mongodb')
-    autoload :Redis,      File.join(DATABASE_PATH, 'redis')
-    autoload :Riak,       File.join(DATABASE_PATH, 'riak')
-    autoload :OpenLDAP,   File.join(DATABASE_PATH, 'openldap')
-    autoload :SQLite,     File.join(DATABASE_PATH, 'sqlite')
+    autoload :Base,       File.join(DATABASE_PATH, "base")
+    autoload :MySQL,      File.join(DATABASE_PATH, "mysql")
+    autoload :PostgreSQL, File.join(DATABASE_PATH, "postgresql")
+    autoload :MongoDB,    File.join(DATABASE_PATH, "mongodb")
+    autoload :Redis,      File.join(DATABASE_PATH, "redis")
+    autoload :Riak,       File.join(DATABASE_PATH, "riak")
+    autoload :OpenLDAP,   File.join(DATABASE_PATH, "openldap")
+    autoload :SQLite,     File.join(DATABASE_PATH, "sqlite")
   end
 
   ##
   # Autoload compressor files
   module Compressor
-    autoload :Base,   File.join(COMPRESSOR_PATH, 'base')
-    autoload :Gzip,   File.join(COMPRESSOR_PATH, 'gzip')
-    autoload :Bzip2,  File.join(COMPRESSOR_PATH, 'bzip2')
-    autoload :Custom, File.join(COMPRESSOR_PATH, 'custom')
+    autoload :Base,   File.join(COMPRESSOR_PATH, "base")
+    autoload :Gzip,   File.join(COMPRESSOR_PATH, "gzip")
+    autoload :Bzip2,  File.join(COMPRESSOR_PATH, "bzip2")
+    autoload :Custom, File.join(COMPRESSOR_PATH, "custom")
   end
 
   ##
   # Autoload encryptor files
   module Encryptor
-    autoload :Base,    File.join(ENCRYPTOR_PATH, 'base')
-    autoload :OpenSSL, File.join(ENCRYPTOR_PATH, 'open_ssl')
-    autoload :GPG,     File.join(ENCRYPTOR_PATH, 'gpg')
+    autoload :Base,    File.join(ENCRYPTOR_PATH, "base")
+    autoload :OpenSSL, File.join(ENCRYPTOR_PATH, "open_ssl")
+    autoload :GPG,     File.join(ENCRYPTOR_PATH, "gpg")
   end
 
   ##
   # Autoload notification files
   module Notifier
-    autoload :Base,      File.join(NOTIFIER_PATH, 'base')
-    autoload :Mail,      File.join(NOTIFIER_PATH, 'mail')
-    autoload :Twitter,   File.join(NOTIFIER_PATH, 'twitter')
-    autoload :Campfire,  File.join(NOTIFIER_PATH, 'campfire')
-    autoload :Prowl,     File.join(NOTIFIER_PATH, 'prowl')
-    autoload :Hipchat,   File.join(NOTIFIER_PATH, 'hipchat')
-    autoload :PagerDuty, File.join(NOTIFIER_PATH, 'pagerduty')
-    autoload :Pushover,  File.join(NOTIFIER_PATH, 'pushover')
-    autoload :Slack,     File.join(NOTIFIER_PATH, 'slack')
-    autoload :HttpPost,  File.join(NOTIFIER_PATH, 'http_post')
-    autoload :Nagios,    File.join(NOTIFIER_PATH, 'nagios')
-    autoload :FlowDock,  File.join(NOTIFIER_PATH, 'flowdock')
-    autoload :Zabbix,    File.join(NOTIFIER_PATH, 'zabbix')
-    autoload :DataDog,   File.join(NOTIFIER_PATH, 'datadog')
-    autoload :Ses,       File.join(NOTIFIER_PATH, 'ses')
-    autoload :Command,   File.join(NOTIFIER_PATH, 'command')
+    autoload :Base,      File.join(NOTIFIER_PATH, "base")
+    autoload :Mail,      File.join(NOTIFIER_PATH, "mail")
+    autoload :Twitter,   File.join(NOTIFIER_PATH, "twitter")
+    autoload :Campfire,  File.join(NOTIFIER_PATH, "campfire")
+    autoload :Prowl,     File.join(NOTIFIER_PATH, "prowl")
+    autoload :Hipchat,   File.join(NOTIFIER_PATH, "hipchat")
+    autoload :PagerDuty, File.join(NOTIFIER_PATH, "pagerduty")
+    autoload :Pushover,  File.join(NOTIFIER_PATH, "pushover")
+    autoload :Slack,     File.join(NOTIFIER_PATH, "slack")
+    autoload :HttpPost,  File.join(NOTIFIER_PATH, "http_post")
+    autoload :Nagios,    File.join(NOTIFIER_PATH, "nagios")
+    autoload :FlowDock,  File.join(NOTIFIER_PATH, "flowdock")
+    autoload :Zabbix,    File.join(NOTIFIER_PATH, "zabbix")
+    autoload :DataDog,   File.join(NOTIFIER_PATH, "datadog")
+    autoload :Ses,       File.join(NOTIFIER_PATH, "ses")
+    autoload :Command,   File.join(NOTIFIER_PATH, "command")
   end
 
   ##
   # Require Backup base files
-  %w{
+  %w[
     errors
     logger
     utilities
@@ -139,6 +136,5 @@ module Backup
     splitter
     template
     version
-  }.each {|lib| require File.join(LIBRARY_PATH, lib) }
-
+  ].each { |lib| require File.join(LIBRARY_PATH, lib) }
 end

data/lib/backup/archive.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Archive
     class Error < Backup::Error; end
@@ -55,45 +53,47 @@ module Backup
       @model   = model
       @name    = name.to_s
       @options = {
-        :sudo        => false,
-        :root        => false,
-        :paths       => [],
-        :excludes    => [],
-        :tar_options => ''
+        sudo: false,
+        root: false,
+        paths: [],
+        excludes: [],
+        tar_options: ""
       }
       DSL.new(@options).instance_eval(&block)
     end
 
     def perform!
-      Logger.info "Creating Archive '#{ name }'..."
+      Logger.info "Creating Archive '#{name}'..."
 
-      path = File.join(Config.tmp_path, @model.trigger, 'archives')
+      path = File.join(Config.tmp_path, @model.trigger, "archives")
       FileUtils.mkdir_p(path)
 
       pipeline = Pipeline.new
       with_files_from(paths_to_package) do |files_from|
         pipeline.add(
-          "#{ tar_command } #{ tar_options } -cPf -#{ tar_root } " +
-          "#{ paths_to_exclude } #{ files_from }",
+          "#{tar_command} #{tar_options} -cPf -#{tar_root} " \
+            "#{paths_to_exclude} #{files_from}",
           tar_success_codes
         )
 
-        extension = 'tar'
-        @model.compressor.compress_with do |command, ext|
-          pipeline << command
-          extension << ext
-        end if @model.compressor
+        extension = "tar"
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            pipeline << command
+            extension << ext
+          end
+        end
 
-        pipeline << "#{ utility(:cat) } > " +
-            "'#{ File.join(path, "#{ name }.#{ extension }") }'"
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(path, "#{name}.#{extension}")}'"
         pipeline.run
       end
 
       if pipeline.success?
-        Logger.info "Archive '#{ name }' Complete!"
+        Logger.info "Archive '#{name}' Complete!"
       else
-        raise Error, "Failed to Create Archive '#{ name }'\n" +
-            pipeline.error_messages
+        raise Error, "Failed to Create Archive '#{name}'\n" +
+          pipeline.error_messages
       end
     end
 
@@ -101,30 +101,30 @@ module Backup
 
     def tar_command
       tar = utility(:tar)
-      options[:sudo] ? "#{ utility(:sudo) } -n #{ tar }" : tar
+      options[:sudo] ? "#{utility(:sudo)} -n #{tar}" : tar
     end
 
     def tar_root
-      options[:root] ? " -C '#{ File.expand_path(options[:root]) }'" : ''
+      options[:root] ? " -C '#{File.expand_path(options[:root])}'" : ""
     end
 
     def paths_to_package
-      options[:paths].map {|path| prepare_path(path) }
+      options[:paths].map { |path| prepare_path(path) }
     end
 
     def with_files_from(paths)
-      tmpfile = Tempfile.new('backup-archive-paths')
-      paths.each {|path| tmpfile.puts path }
+      tmpfile = Tempfile.new("backup-archive-paths")
+      paths.each { |path| tmpfile.puts path }
       tmpfile.close
-      yield "-T '#{ tmpfile.path }'"
+      yield "-T '#{tmpfile.path}'"
     ensure
       tmpfile.delete
     end
 
     def paths_to_exclude
-      options[:excludes].map {|path|
-        "--exclude='#{ prepare_path(path) }'"
-      }.join(' ')
+      options[:excludes].map do |path|
+        "--exclude='#{prepare_path(path)}'"
+      end.join(" ")
     end
 
     def prepare_path(path)
@@ -133,7 +133,7 @@ module Backup
 
     def tar_options
       args = options[:tar_options]
-      gnu_tar? ? "--ignore-failed-read #{ args }".strip : args
+      gnu_tar? ? "--ignore-failed-read #{args}".strip : args
     end
 
     def tar_success_codes
@@ -165,6 +165,5 @@ module Backup
         @options[:tar_options] = opts
       end
     end
-
   end
 end

data/lib/backup/binder.rb

@@ -1,14 +1,11 @@
-# encoding: utf-8
-
 module Backup
   class Binder
-
     ##
     # Creates a new Backup::Notifier::Binder instance. Loops through the provided
     # Hash to set instance variables
     def initialize(key_and_values)
       key_and_values.each do |key, value|
-        instance_variable_set("@#{ key }", value)
+        instance_variable_set("@#{key}", value)
       end
     end
 
@@ -17,6 +14,5 @@ module Backup
     def get_binding
       binding
     end
-
   end
-end
+end

data/lib/backup/cleaner.rb

@@ -1,11 +1,8 @@
-# encoding: utf-8
-
 module Backup
   module Cleaner
     class Error < Backup::Error; end
 
     class << self
-
       ##
       # Logs warnings if any temporary files still exist
       # from the last time this model/trigger was run,
@@ -17,7 +14,7 @@ module Backup
         if File.exist?(packaging_folder)
           messages << <<-EOS
             The temporary packaging folder still exists!
-            '#{ packaging_folder }'
+            '#{packaging_folder}'
             It will now be removed.
           EOS
           FileUtils.rm_rf(packaging_folder)
@@ -27,23 +24,23 @@ module Backup
         unless package_files.empty?
           # the chances of the packaging folder AND
           # the package files existing are practically nil
-          messages << ('-' * 74) unless messages.empty?
+          messages << ("-" * 74) unless messages.empty?
 
           messages << <<-EOS
-            The temporary backup folder '#{ Config.tmp_path }'
+            The temporary backup folder '#{Config.tmp_path}'
             appears to contain the package files from the previous backup!
-            #{ package_files.join("\n") }
+            #{package_files.join("\n")}
             These files will now be removed.
           EOS
-          package_files.each {|file| FileUtils.rm_f(file) }
+          package_files.each { |file| FileUtils.rm_f(file) }
         end
 
         unless messages.empty?
           Logger.warn Error.new(<<-EOS)
             Cleanup Warning
-            #{ messages.join("\n") }
+            #{messages.join("\n")}
             Please check the log for messages and/or your notifications
-            concerning this backup: '#{ model.label } (#{ model.trigger })'
+            concerning this backup: '#{model.label} (#{model.trigger})'
             The temporary files which had to be removed should not have existed.
           EOS
         end
@@ -76,7 +73,7 @@ module Backup
         if File.exist?(packaging_folder)
           messages << <<-EOS
             The temporary packaging folder still exists!
-            '#{ packaging_folder }'
+            '#{packaging_folder}'
             This folder may contain completed Archives and/or Database backups.
           EOS
         end
@@ -85,21 +82,21 @@ module Backup
         unless package_files.empty?
           # the chances of the packaging folder AND
           # the package files existing are practically nil
-          messages << ('-' * 74) unless messages.empty?
+          messages << ("-" * 74) unless messages.empty?
 
           messages << <<-EOS
-            The temporary backup folder '#{ Config.tmp_path }'
+            The temporary backup folder '#{Config.tmp_path}'
             appears to contain the backup files which were to be stored:
-            #{ package_files.join("\n") }
+            #{package_files.join("\n")}
           EOS
         end
 
         unless messages.empty?
           Logger.warn Error.new(<<-EOS)
             Cleanup Warning
-            #{ messages.join("\n") }
+            #{messages.join("\n")}
             Make sure you check these files before the next scheduled backup for
-            '#{ model.label } (#{ model.trigger })'
+            '#{model.label} (#{model.trigger})'
             These files will be removed at that time!
           EOS
         end
@@ -108,9 +105,8 @@ module Backup
       private
 
       def package_files_for(trigger)
-        Dir[File.join(Config.tmp_path,"#{ trigger }.tar{,[.-]*}")]
+        Dir[File.join(Config.tmp_path, "#{trigger}.tar{,[.-]*}")]
       end
-
     end
   end
 end