backup-ssh 4.1.10 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ca21e187d62587f721654eb3ae84a84cf5e5f65
-  data.tar.gz: 359e12d0e6d1e3762207b5cc99ad9cc6584dae0c
+  metadata.gz: 4e204b72f3e7d1cde84dc735f73fb5c2b040d8ff
+  data.tar.gz: '038ef67371243b75efaf003d2af79b822926e0b7'
 SHA512:
-  metadata.gz: ed9a3a6af42428ec67c601d0ecf2a57e3f1e01031d495c7c9d1b00e282eac7e2c66ea36810434321fbb8a02807df5aa8c509df123db4234834609c996aefc9cd
-  data.tar.gz: c6b399157b606def1740f2108ad947140a77466adb90733564cf97650581e7be0dfe17a645e18408910468af99d04d663e4a53d884bd96719ed00eb7671dc806
+  metadata.gz: 1f3a096e09ae0aef5d3be110e99949c4559c3889ba5710ee83273df469c24674e3616e8d5a5082b6a9e9218991c3df9182bf5ab57541889bdfb9a23b7f38eaba
+  data.tar.gz: f0b8d4b1134f7616fcb7b89965e0553b4f5718657efc6d97534381ea4104cce6202f3237727d78a213460d2da8cd5cb568f27ee7a06b6255c965f2ff692fd8d7

data/README.md

@@ -1,25 +1,29 @@
 Backup v4.x
 ===========
+
 [![Code Climate](https://codeclimate.com/github/backup/backup.png)](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]
 
 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][]
+[Installation][] · [Release Notes][] · [Documentation][] · [Issues][] · [Features][] · [Chat][Gitter]
 
 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-2015 [Michael van Rooijen][] ( [@meskyanichi][] )**  
-Released under the **MIT** [License](LICENSE.md).
+**Copyright (c) 2009-2016 [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/meskyanichi/backup-features/issues
-[Michael van Rooijen]: http://michaelvanrooijen.com
-[@meskyanichi]: http://twitter.com/#!/meskyanichi
+[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
+[Michael van Rooijen]: http://github.com/mrrooijen
+[@mrrooijen]: http://twitter.com/mrrooijen

data/lib/backup.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 # Load Ruby Core Libraries
+require 'time'
 require 'fileutils'
 require 'tempfile'
 require 'syslog'
@@ -48,6 +49,7 @@ module Backup
     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
 
   ##
@@ -116,6 +118,7 @@ module Backup
     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
 
   ##

data/lib/backup/config/dsl.rb

@@ -30,7 +30,7 @@ module Backup
               ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis', 'Riak', 'OpenLDAP', 'SQLite'],
               # Storages
               ['S3', 'CloudFiles', 'Ninefold', 'Dropbox', 'FTP',
-              'SFTP', 'SCP', 'RSync', 'Local'],
+              'SFTP', 'SCP', 'RSync', 'Local', 'Qiniu'],
               # Compressors
               ['Gzip', 'Bzip2', 'Custom', 'Pbzip2', 'Lzma'],
               # Encryptors
@@ -43,7 +43,7 @@ module Backup
               # Notifiers
               ['Mail', 'Twitter', 'Campfire', 'Prowl',
               'Hipchat', 'PagerDuty', 'Pushover', 'HttpPost', 'Nagios',
-              'Slack', 'FlowDock', 'Zabbix', 'Ses', 'DataDog']
+              'Slack', 'FlowDock', 'Zabbix', 'Ses', 'DataDog', 'Command']
             ]
           )
         end

data/lib/backup/database/mongodb.rb

@@ -11,7 +11,7 @@ module Backup
 
       ##
       # Credentials for the specified database
-      attr_accessor :username, :password
+      attr_accessor :username, :password, :authdb
 
       ##
       # Connectivity options
@@ -132,6 +132,7 @@ module Backup
         opts = []
         opts << "--username='#{ username }'" if username
         opts << "--password='#{ password }'" if password
+        opts << "--authenticationDatabase='#{ authdb }'" if authdb
         opts.join(' ')
       end
 

data/lib/backup/database/mysql.rb

@@ -105,8 +105,8 @@ module Backup
       private
 
       def mysqldump
-        "#{ ssh_option } #{ utility(:mysqldump) } #{ credential_options } " +
-        "#{ connectivity_options } #{ user_options } #{ name_option } " +
+        "#{ ssh_option } #{ utility(:mysqldump) } #{ user_options } #{ credential_options } " +
+        "#{ connectivity_options } #{ name_option } " +
         "#{ tables_to_dump } #{ tables_to_skip }"
       end
 

data/lib/backup/database/postgresql.rb

@@ -92,7 +92,7 @@ module Backup
       end
 
       def sudo_option
-        "#{ utility(:sudo) } -n -u #{ sudo_user } " if sudo_user
+        "#{ utility(:sudo) } -n -H -u #{ sudo_user } " if sudo_user
       end
 
       def username_option

data/lib/backup/model.rb

@@ -303,7 +303,7 @@ module Backup
       return [] unless databases.any? || archives.any?
 
       [lambda { prepare! }, databases, archives,
-       lambda { package! }, storages, lambda { clean! }]
+       lambda { package! }, lambda { store! }, lambda { clean! }]
     end
 
     ##
@@ -325,6 +325,31 @@ module Backup
       Cleaner.remove_packaging(self)
     end
 
+    ##
+    # Attempts to use all configured Storages, even if some of them result in exceptions.
+    # Returns true or raises first encountered exception.
+    def store!
+      storage_results = storages.map do |storage|
+        begin
+          storage.perform!
+        rescue => ex
+          ex
+        end
+      end
+
+      first_exception, *other_exceptions = storage_results.select { |result| result.is_a? Exception }
+
+      if first_exception
+        other_exceptions.each do |exception|
+         Logger.error exception.to_s
+         Logger.error exception.backtrace.join('\n')
+        end
+        raise first_exception
+      else
+        true
+      end
+    end
+
     ##
     # Removes the final package file(s) once all configured Storages have run.
     def clean!

data/lib/backup/notifier/base.rb

@@ -36,6 +36,15 @@ module Backup
       # Default: 30
       attr_accessor :retry_waitsec
 
+      ##
+      # Message to send. Depends on notifier implementation if this is used.
+      # Default: lambda returning:
+      # "#{ message } #{ model.label } (#{ model.trigger })"
+      #
+      # @yieldparam [model] Backup::Model
+      # @yieldparam [data] Hash containing `message` and `key` values.
+      attr_accessor :message
+
       attr_reader :model
 
       def initialize(model)
@@ -47,6 +56,9 @@ module Backup
         @on_failure = true if on_failure.nil?
         @max_retries    ||= 10
         @retry_waitsec  ||= 30
+        @message        ||= lambda do |model, data|
+          "[#{ data[:status][:message] }] #{ model.label } (#{ model.trigger })"
+        end
       end
 
       # This method is called from an ensure block in Model#perform! and must
@@ -93,6 +105,24 @@ module Backup
         self.class.to_s.sub('Backup::', '')
       end
 
+      ##
+      # Return status data for message creation
+      def status_data_for(status)
+        {
+          :success => {
+            :message => 'Backup::Success',
+            :key => :success
+          },
+          :warning => {
+            :message => 'Backup::Warning',
+            :key => :warning
+          },
+          :failure => {
+            :message => 'Backup::Failure',
+            :key => :failure
+          }
+        }[status]
+      end
     end
   end
 end

data/lib/backup/notifier/campfire.rb

@@ -42,13 +42,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :warning then '[Backup::Warning]'
-              when :failure then '[Backup::Failure]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
-        send_message(message)
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/notifier/command.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+module Backup
+  module Notifier
+    class Command < Base
+
+      ##
+      # Command to execute.
+      #
+      # Make sure it is accessible from your $PATH, or provide
+      # the absolute path to the command.
+      attr_accessor :command
+
+      ##
+      # Arguments to pass to the command.
+      #
+      # Must be an array of strings or callable objects.
+      #
+      # Callables will be invoked with #call(model, status),
+      # and the return value used as the argument.
+      #
+      # In strings you can use the following placeholders:
+      #
+      # %l - Model label
+      # %t - Model trigger
+      # %d - Backup duration (HH:MM:SS)
+      # %s - Status (success/failure/warning)
+      # %v - Status verb (succeeded/failed/succeeded with warnings)
+      #
+      # All placeholders can be used with uppercase letters to capitalize
+      # the value.
+      #
+      # Defaults to ["%L %v"]
+      attr_accessor :args
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @args ||= ["%L %v"]
+      end
+
+      private
+
+      ##
+      # Notify the user of the backup operation results.
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(status)
+        IO.popen([@command] + args.map { |arg| format_arg(arg, status) })
+      end
+
+      def format_arg(arg, status)
+        if arg.respond_to?(:call)
+          arg.call(model, status)
+        else
+          arg.gsub(/%(\w)/) do |match|
+            ph = match[1]
+            val = case ph.downcase
+                  when "l"
+                    model.label
+                  when "t"
+                    model.trigger.to_s
+                  when "d"
+                    model.duration
+                  when "v"
+                    status_verb(status)
+                  when "s"
+                    status.to_s
+                  end
+            val.capitalize! if ph == ph.upcase
+            val
+          end
+        end
+      end
+
+      def status_verb(status)
+        case status
+        when :success
+          "succeeded"
+        when :failure
+          "failed"
+        when :warning
+          "succeeded with warnings"
+        end
+      end
+    end
+  end
+end

data/lib/backup/notifier/datadog.rb

@@ -13,9 +13,10 @@ module Backup
       # The title of the event
       attr_accessor :title
 
-      ##
-      # The text information for the event
-      attr_accessor :text
+      attr_deprecate :text,
+        :version => '4.2',
+        :message => 'Please use the `message` attribute. For more information '\
+          'see https://github.com/backup/backup/pull/698'
 
       ##
       # The timestamp for the event
@@ -48,9 +49,7 @@ module Backup
       def initialize(model, &block)
         super
         instance_eval(&block) if block_given?
-
-        @title          ||= default_title
-        @text           ||= default_text
+        @title ||= "Backup #{ model.label }"
       end
 
       private
@@ -73,7 +72,9 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        hash = {alert_type: default_alert_type(status)}
+        msg = message.call(model, :status => status_data_for(status))
+
+        hash = { alert_type: default_alert_type(status) }
         hash.store(:msg_title,        @title)
         hash.store(:date_happened,    @date_happened)    if @date_happened
         hash.store(:priority,         @priority)         if @priority
@@ -82,13 +83,13 @@ module Backup
         hash.store(:aggregation_key,  @aggregation_key)  if @aggregation_key
         hash.store(:source_type_name, @source_type_name) if @source_type_name
         hash.store(:alert_type,       @alert_type)       if @alert_type
-        send_event(hash)
+        send_event(msg, hash)
       end
 
       # Dogapi::Client will raise an error if unsuccessful.
-      def send_event(hash)
+      def send_event(msg, hash)
         client = Dogapi::Client.new(@api_key)
-        event = Dogapi::Event.new(@text, hash)
+        event = Dogapi::Event.new(msg, hash)
         client.emit_event(event)
       end
 
@@ -101,16 +102,6 @@ module Backup
         end
       end
 
-      # set default title
-      def default_title
-        "Backup #{ model.label }"
-      end
-
-      # set default text
-      def default_text
-        "Backup Notification for #{ model.label }"
-      end
-
     end
   end
 end

data/lib/backup/notifier/flowdock.rb

@@ -61,15 +61,16 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        @tags  += default_tags(status)
-        message = "#{ model.label } (#{ model.trigger })"
-        send_message(message)
+        @tags += default_tags(status)
+        send_message(message.call(model, status: status_data_for(status)))
       end
 
       # Flowdock::Client will raise an error if unsuccessful.
       def send_message(msg)
-        client = Flowdock::Flow.new(:api_token => token, :source => source,
-                                    :from => {:name => from_name, :address => from_email })
+        client = Flowdock::Flow.new(
+          :api_token => token, :source => source,
+          :from => {:name => from_name, :address => from_email }
+        )
 
         client.push_to_team_inbox(:subject => subject,
                                   :content => msg,

data/lib/backup/notifier/hipchat.rb

@@ -9,10 +9,19 @@ module Backup
       # The Hipchat API token
       attr_accessor :token
 
+      ##
+      # The Hipchat API version
+      # Either 'v1' or 'v2' (default is 'v1')
+      attr_accessor :api_version
+
       ##
       # Who the notification should appear from
       attr_accessor :from
 
+      ##
+      # Custom server URL
+      attr_accessor :server_url
+
       ##
       # The rooms that should be notified
       attr_accessor :rooms_notified
@@ -45,6 +54,7 @@ module Backup
         @success_color  ||= 'yellow'
         @warning_color  ||= 'yellow'
         @failure_color  ||= 'yellow'
+        @api_version    ||= 'v1'
       end
 
       private
@@ -67,18 +77,20 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag, color = case status
-                     when :success then ['[Backup::Success]', success_color]
-                     when :warning then ['[Backup::Warning]', warning_color]
-                     when :failure then ['[Backup::Failure]', failure_color]
-                     end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
-        send_message(message, color)
+        status_data = status_data_for(status)
+        msg = message.call(model, :status => status_data)
+        send_message(msg, status_data[:color])
+      end
+
+      def client_options
+        { api_version: @api_version }.tap do |h|
+          h[:server_url] = server_url if server_url
+        end
       end
 
       # Hipchat::Client will raise an error if unsuccessful.
       def send_message(msg, color)
-        client = HipChat::Client.new(token)
+        client = HipChat::Client.new(token, client_options)
         rooms_to_notify.each do |room|
           client[room].send(from, msg, :color => color, :notify => notify_users)
         end
@@ -88,6 +100,19 @@ module Backup
         Array(rooms_notified).map {|r| r.split(',').map(&:strip) }.flatten
       end
 
+      def status_data_for(status)
+        data = super(status)
+        data[:color] = status_color_for(status)
+        data
+      end
+
+      def status_color_for(status)
+        {
+          :success => success_color,
+          :warning => warning_color,
+          :failure => failure_color
+        }[status]
+      end
     end
   end
 end