backup 4.1.12 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05a10c86b1bc49eee3b2e65770817d4c5d19aa32
-  data.tar.gz: 4c4118f48da862a40ccfc92de56014a589490fbd
+  metadata.gz: 4b3395ec5399914784eeb39f638352a1ce486589
+  data.tar.gz: 7e8dfbc5aea5da8abed31b2dbf14d920cfcebb41
 SHA512:
-  metadata.gz: 5d2a68639830362e7250a83f76553c62b08a0511cee9ba105c0b699529edd344a4a2788f525653a377d4b9e114071b88125a7ca736217c1a85fea985465f2865
-  data.tar.gz: 50f8c2d48d66f84f6190cbe1d6497c6b37f44f44357931458b673f5d40dca58dbc165d6c1cbc77e6e27341a9e48237f658748b0842c49616d1715a5955f9b851
+  metadata.gz: 4e9ac7c7b0ad9ef5d7b4d5ac4147206c4407cceba3704aa15f53b0c99fadfe4c8703e07daa16dd874f0c3c80e836f89d1db56204de60e5c607080c4f96c498cc
+  data.tar.gz: e64842958d8d39f15f739e76b554012389fbd7720710a0602cded468ae2c0829ed43039b0757bbec5d6f48a1e1b58db6aec625ad8954d956c44b8eec125f69ca

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/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

@@ -67,13 +67,9 @@ 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
 
       # Hipchat::Client will raise an error if unsuccessful.
@@ -88,6 +84,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

data/lib/backup/notifier/http_post.rb

@@ -95,18 +95,13 @@ 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 :failure then '[Backup::Failure]'
-              when :warning then '[Backup::Warning]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
+        msg = message.call(model, :status => status_data_for(status))
 
         opts = {
           :headers => { 'User-Agent' => "Backup/#{ VERSION }" }.
               merge(headers).reject {|k,v| v.nil? }.
               merge('Content-Type' => 'application/x-www-form-urlencoded'),
-          :body => URI.encode_www_form({ 'message' => message }.
+          :body => URI.encode_www_form({ 'message' => msg }.
               merge(params).reject {|k,v| v.nil? }.
               merge('status' => status.to_s)),
           :expects => success_codes # raise error if unsuccessful

data/lib/backup/notifier/mail.rb

@@ -148,14 +148,8 @@ module Backup
       # : backup log, if `on_failure` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :warning then '[Backup::Warning]'
-              when :failure then '[Backup::Failure]'
-              end
-
         email = new_email
-        email.subject = "#{ tag } #{ model.label } (#{ model.trigger })"
+        email.subject = message.call(model, :status => status_data_for(status))
 
         send_log = send_log_on.include?(status)
         template = Backup::Template.new({ :model => model, :send_log => send_log })

data/lib/backup/notifier/nagios.rb

@@ -14,8 +14,8 @@ module Backup
 
       ##
       # Nagios nrpe configuration file.
-      attr_accessor :send_nsca_cfg     
- 
+      attr_accessor :send_nsca_cfg
+
       ##
       # Name of the Nagios service for the backup check.
       attr_accessor :service_name
@@ -55,12 +55,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        message = case status
-              when :success then 'Completed Successfully'
-              when :warning then 'Completed Successfully (with Warnings)'
-              when :failure then 'Failed'
-              end
-        send_message("#{ message } in #{ model.duration }")
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/notifier/prowl.rb

@@ -16,6 +16,9 @@ module Backup
       attr_accessor :api_key
 
       def initialize(model, &block)
+        @message = lambda do |model, data|
+          "#{ model.label } (#{ model.trigger })"
+        end
         super
         instance_eval(&block) if block_given?
       end
@@ -40,21 +43,17 @@ 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
-        send_message(tag)
+        send_message(status)
       end
 
-      def send_message(message)
+      def send_message(status)
         uri = 'https://api.prowlapp.com/publicapi/add'
+        status_data = status_data_for(status)
         data = {
           :application  => application,
           :apikey       => api_key,
-          :event        => message,
-          :description  => "#{ model.label } (#{ model.trigger })"
+          :event        => status_data[:message],
+          :description  => message.call(model, :status => status_data)
         }
         options = {
           :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },

data/lib/backup/notifier/pushover.rb

@@ -51,13 +51,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 :failure then '[Backup::Failure]'
-              when :warning then '[Backup::Warning]'
-              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/ses.rb

@@ -66,14 +66,8 @@ module Backup
       # : backup log, if `on_failure` is `true`.
       #
       def notify!(status)
-        tag = case status
-                when :success then '[Backup::Success]'
-                when :warning then '[Backup::Warning]'
-                when :failure then '[Backup::Failure]'
-              end
-
         email = ::Mail.new(:to => to, :from => from)
-        email.subject = "#{ tag } #{ model.label } (#{ model.trigger })"
+        email.subject = message.call(model, :status => status_data_for(status))
 
         send_log = send_log_on.include?(status)
         template = Backup::Template.new({ :model => model, :send_log => send_log })

data/lib/backup/notifier/slack.rb

@@ -61,21 +61,15 @@ 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 :failure then '[Backup::Failure]'
-              when :warning then '[Backup::Warning]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
-
-        data = { :text => message }
+        data = {
+          :text => message.call(model, :status => status_data_for(status)),
+          :attachments => [attachment(status)]
+        }
         [:channel, :username, :icon_emoji].each do |param|
           val = send(param)
           data.merge!(param => val) if val
         end
 
-        data.merge!(:attachments => [attachment(status)])
-
         options = {
           :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
           :body     => URI.encode_www_form(:payload => JSON.dump(data))

data/lib/backup/notifier/twitter.rb

@@ -38,13 +38,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 }) (@ #{ model.time })"
-        send_message(message)
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       # Twitter::Client will raise an error if unsuccessful.

data/lib/backup/notifier/zabbix.rb

@@ -45,12 +45,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        message = case status
-              when :success then 'Completed Successfully'
-              when :warning then 'Completed Successfully (with Warnings)'
-              when :failure then 'Failed'
-              end
-        send_message("#{ message } in #{ model.duration }")
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/packager.rb

@@ -42,8 +42,11 @@ module Backup
         # The command's output will then be either piped to the Encryptor
         # or the Splitter (if no Encryptor), or through `cat` into the final
         # output file if neither are configured.
-        @pipeline << "#{ utility(:tar) } -cf - " +
-            "-C '#{ Config.tmp_path }' '#{ @package.trigger }'"
+        @pipeline.add(
+          "#{ utility(:tar) } -cf - " +
+          "-C '#{ Config.tmp_path }' '#{ @package.trigger }'",
+          tar_success_codes
+        )
 
         ##
         # If an Encryptor was configured, it will be called first
@@ -96,6 +99,9 @@ module Backup
         stack.shift
       end
 
+      def tar_success_codes
+        gnu_tar? ? [0, 1] : [0]
+      end
     end
   end
 end

data/lib/backup/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Backup
-  VERSION = '4.1.12'
+  VERSION = '4.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 4.1.12
+  version: 4.2.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList