backup 4.3.0 → 5.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c7e4e7ea9006f973c8df272ad4520265fb5a25e1
-  data.tar.gz: ce45e91cc9d2b80f721cbcda2f4012fce936fb7f
+SHA256:
+  metadata.gz: be84fcf585977ffff359b7f8b1052b87d6fd505fdf7b2324a7f309ec41bf8007
+  data.tar.gz: f46f2e94686a50cab3ee91ef64320aab6a5a7f249069906f52c9f37bc9fa371c
 SHA512:
-  metadata.gz: 866350af1103a7eeb171bd80d01c73d4a728f31eda444823b4250d3788d09402f6cbca600a6dfc0d48e05c0c74a2746fd68dee230b847acff3ba7d92a2a8bb07
-  data.tar.gz: b0585f85c576423c12291990521ad7d33a82fc6d1cadf97b009e332bbc8e0a42840b3debb9cd382291115e2282bbaa1f5b18088fa0dd6fde98e8edacc7f90e2b
+  metadata.gz: 1fcf15d44034f42fdbc319e1754c2df3a8b9b61f3658a753d0bc576fc000b185ebfb897cb77543dae86a785a0ae192b996eba05e6ca6043cdd4028db9ec77a6d
+  data.tar.gz: 103d3d83c801d70ac6f249e4a9bb1720aa0decb4475d37f722f6628ee16c5b38d9940048c30880c5c8f9555eb3c9e9c575e5a464c4d7e0509987aa027ac63c56

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

@@ -1,29 +1,33 @@
-Backup v4.x
-===========
+Backup
+======
 
-[![Code Climate](https://codeclimate.com/github/backup/backup.png)](https://codeclimate.com/github/backup/backup)
+[![Code Climate](https://codeclimate.com/github/backup/backup.svg)](https://codeclimate.com/github/backup/backup)
 [![Build Status](https://travis-ci.org/backup/backup.svg?branch=master)](https://travis-ci.org/backup/backup)
 [![Join the chat at https://gitter.im/backup/backup](https://badges.gitter.im/Join%20Chat.svg)][Gitter]
 
+> This project is now in maintenance. No new features are planned.
+
 Backup is a system utility for Linux and Mac OS X, distributed as a RubyGem, that allows you to easily perform backup
 operations. It provides an elegant DSL in Ruby for _modeling_ your backups. Backup has built-in support for various
 databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It
 was built with modularity, extensibility and simplicity in mind.
 
-[Installation][] · [Release Notes][] · [Documentation][] · [Issues][] · [Features][] · [Chat][Gitter]
+[Installation][] · [Release Notes][] · [Documentation][] · [Issues][] ·  [Chat][Gitter]
+
+## Project Status: Maintenance-Only ##
+
+This project is not under active development, although we will continue to provide support for current users, and at least one more maintenance release: version 5.0. The version 5.0 release will include support for Ruby 2.4, and various other fixes. Future releases of Backup will only include bug fixes.
 
-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.
+If you use this project and would like to develop it further, please introduce yourself on the [maintainers wanted][Maintainers wanted] ticket.
 
-**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
 [Release Notes]: http://backup.github.io/backup/v4/release-notes
 [Documentation]: http://backup.github.io/backup/v4
 [Issues]: https://github.com/backup/backup/issues
-[Features]: https://github.com/backup/backup-features/issues
 [Gitter]: https://gitter.im/backup/backup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[Maintainers wanted]: https://github.com/backup/backup/issues/803
 [Michael van Rooijen]: http://github.com/mrrooijen
 [@mrrooijen]: http://twitter.com/mrrooijen

data/bin/docker_test

@@ -0,0 +1,24 @@
+#!/bin/bash
+set -eu
+
+export BUNDLE_PATH=/tmp/docker/bundle
+export BUNDLE_JOBS=4
+
+case "${1-}" in
+prepare)
+  bundle check || bundle install
+  ;;
+rspec)
+  bundle exec rspec spec
+  ;;
+integration)
+  bundle exec rspec integration/acceptance/
+  ;;
+console)
+  bash
+  ;;
+*)
+  echo "Task not found"
+  exit 1
+  ;;
+esac

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