backup 3.5.1 → 3.6.0

data/lib/backup/notifier/prowl.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
-require 'prowler'
+require 'excon'
+require 'uri'
 
 module Backup
   module Notifier
@@ -16,8 +17,7 @@ module Backup
       attr_accessor :api_key
 
       def initialize(model, &block)
-        super(model)
-
+        super
         instance_eval(&block) if block_given?
       end
 
@@ -25,36 +25,44 @@ module Backup
 
       ##
       # 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` was set to `true`
+      # : Notification will be sent if `on_success` is `true`.
       #
       # `:warning`
-      # : The backup completed successfully, but warnings were logged
-      # : Notification will be sent, including a copy of the current
-      # : backup log, if `on_warning` was set to `true`
+      # : 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, including the Exception which caused
-      # : the failure, the Exception's backtrace, a copy of the current
-      # : backup log and other information if `on_failure` was set to `true`
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        name = case status
-               when :success then 'Success'
-               when :warning then 'Warning'
-               when :failure then 'Failure'
-               end
-        message = '[Backup::%s]' % name
-        send_message(message)
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :warning then '[Backup::Warning]'
+              when :failure then '[Backup::Failure]'
+              end
+        send_message(tag)
       end
 
       def send_message(message)
-        client = Prowler.new(:application => application, :api_key => api_key)
-        client.notify(message, "#{@model.label} (#{@model.trigger})")
+        uri = 'https://api.prowlapp.com/publicapi/add'
+        data = {
+          :application  => application,
+          :apikey       => api_key,
+          :event        => message,
+          :description  => "#{ model.label } (#{ model.trigger })"
+        }
+        options = {
+          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          :body     => encode_www_form(data)
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
       end
 
     end

data/lib/backup/notifier/pushover.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
-require 'net/https'
+require 'excon'
+require 'uri'
 
 module Backup
   module Notifier
@@ -27,8 +28,7 @@ module Backup
       attr_accessor :priority
 
       def initialize(model, &block)
-        super(model)
-
+        super
         instance_eval(&block) if block_given?
       end
 
@@ -36,56 +36,46 @@ module Backup
 
       ##
       # 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` was set to `true`
+      # : Notification will be sent if `on_success` is `true`.
       #
       # `:warning`
-      # : The backup completed successfully, but warnings were logged
-      # : Notification will be sent, including a copy of the current
-      # : backup log, if `on_warning` was set to `true`
+      # : 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, including the Exception which caused
-      # : the failure, the Exception's backtrace, a copy of the current
-      # : backup log and other information if `on_failure` was set to `true`
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        name = case status
-               when :success then 'Success'
-               when :failure then 'Failure'
-               when :warning then 'Warning'
-               end
-        message = "[Backup::%s] #{@model.label} (#{@model.trigger})" % name
-
+        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)
       end
 
-      # Push a message via the Pushover API
       def send_message(message)
-        url = URI.parse("https://api.pushover.net/1/messages.json")
-
-        request = Net::HTTP::Post.new(url.path)
-        request.set_form_data(parameters.merge({:message => message}))
-        response = Net::HTTP.new(url.host, url.port)
-
-        response.use_ssl = true
-        response.verify_mode = OpenSSL::SSL::VERIFY_PEER
-
-        response.start {|http| http.request(request) }
-      end
-
-      # List available parameters
-      def parameters
-        @values = {}
-        [:token, :user, :message, :title, :priority, :device].each do |k|
-          @values.merge! k => self.instance_variable_get("@#{k}")
+        uri = 'https://api.pushover.net/1/messages.json'
+        data = { :user => user, :token => token, :message => message }
+        [:device, :title, :priority].each do |param|
+          val = send(param)
+          data.merge!(param => val) if val
         end
-        @values
+        options = {
+          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          :body     => encode_www_form(data)
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
       end
+
     end
   end
 end

data/lib/backup/notifier/twitter.rb

@@ -14,8 +14,7 @@ module Backup
       attr_accessor :oauth_token, :oauth_token_secret
 
       def initialize(model, &block)
-        super(model)
-
+        super
         instance_eval(&block) if block_given?
       end
 
@@ -23,33 +22,32 @@ module Backup
 
       ##
       # 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` was set to `true`
+      # : Notification will be sent if `on_success` is `true`.
       #
       # `:warning`
-      # : The backup completed successfully, but warnings were logged
-      # : Notification will be sent, including a copy of the current
-      # : backup log, if `on_warning` was set to `true`
+      # : 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, including the Exception which caused
-      # : the failure, the Exception's backtrace, a copy of the current
-      # : backup log and other information if `on_failure` was set to `true`
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        name = case status
-               when :success then 'Success'
-               when :warning then 'Warning'
-               when :failure then 'Failure'
-               end
-        message = "[Backup::%s] #{@model.label} (#{@model.trigger}) (@ #{@model.time})" % name
+        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)
       end
 
+      # Twitter::Client will raise an error if unsuccessful.
       def send_message(message)
         ::Twitter.configure do |config|
           config.consumer_key       = @consumer_key

data/lib/backup/pipeline.rb

@@ -75,12 +75,10 @@ module Backup
     # Returns a multi-line String, reporting all STDERR messages received
     # from the commands in the pipeline (if any), along with the SystemCallError
     # (Errno) message for each command which had a non-zero exit status.
-    #
-    # Each error is wrapped by Backup::Errors to provide formatting.
     def error_messages
       @error_messages ||= (stderr_messages || '') +
           "The following system errors were returned:\n" +
-          @errors.map {|err| Errors::Error.wrap(err).message }.join("\n")
+          @errors.map {|err| "#{ err.class }: #{ err.message }" }.join("\n")
     end
 
     private

data/lib/backup/storage/s3.rb

@@ -233,9 +233,6 @@ module Backup
           end
         end
 
-        # Avoid wrapping Excon::Errors::HTTPStatusError since it's message
-        # includes `request.inspect`. For multipart uploads, this includes
-        # the String#inspect output of `file.read(chunk_size)`.
         def error_with(err, msg)
           if err.is_a? Excon::Errors::HTTPStatusError
             Errors::Storage::S3::UploaderError.new(<<-EOS)

data/lib/backup/utilities.rb

@@ -9,6 +9,7 @@ module Backup
       mongo mongodump mysqldump pg_dump pg_dumpall redis-cli riak-admin
       gpg openssl
       rsync ssh
+      sendmail exim
     }
 
     module DSL
@@ -88,6 +89,10 @@ module Backup
       #     # Syncer and Storage
       #     rsync   '/path/to/rsync'
       #     ssh     '/path/to/ssh'
+      #
+      #     # Notifiers
+      #     sendmail  '/path/to/sendmail'
+      #     exim      '/path/to/exim'
       #   end
       #
       # These paths may be set using absolute paths, or relative to the
@@ -144,6 +149,7 @@ module Backup
       def command_name(command)
         parts = []
         command = command.split(' ')
+        command.shift while command[0].to_s.include?('=')
         parts << command.shift.split('/')[-1]
         if parts[0] == 'sudo'
           until command.empty?
@@ -184,10 +190,8 @@ module Backup
             out, err = stdout.read.strip, stderr.read.strip
           end
         rescue Exception => e
-          raise Errors::Utilities::SystemCallError.wrap(e, <<-EOS)
-            Failed to execute system command on #{ RUBY_PLATFORM }
-            Command was: #{ command }
-          EOS
+          raise Errors::Utilities::SystemCallError.wrap(
+              e, "Failed to execute '#{ name }'")
         ensure
           GC.enable if RUBY_VERSION < '1.9'
         end
@@ -208,10 +212,7 @@ module Backup
           return out
         else
           raise Errors::Utilities::SystemCallError, <<-EOS
-            '#{ name }' Failed on #{ RUBY_PLATFORM }
-            The following information should help to determine the problem:
-            Command was: #{ command }
-            Exit Status: #{ ps.exitstatus }
+            '#{ name }' failed with exit status: #{ ps.exitstatus }
             STDOUT Messages: #{ out.empty? ? 'None' : "\n#{ out }" }
             STDERR Messages: #{ err.empty? ? 'None' : "\n#{ err }" }
           EOS

data/lib/backup/version.rb

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

data/templates/notifier/mail/failure.erb

@@ -1,7 +1,9 @@
 
 Backup <%= @model.label %> (<%= @model.trigger %>) Failed!
+<% if @send_log %>
 
 See the attached backup log for details.
+<% end %>
 
 ===========================================================================
 <%= Backup::Template.new.result("general/version.erb") %>

data/templates/notifier/mail/success.erb

@@ -1,5 +1,9 @@
 
 Backup <%= @model.label %> (<%= @model.trigger %>) finished without any errors!
+<% if @send_log %>
+
+See the attached backup log for details.
+<% end %>
 
 ===========================================================================
 <%= Backup::Template.new.result("general/version.erb") %>

data/templates/notifier/mail/warning.erb

@@ -1,7 +1,9 @@
 
 Backup <%= @model.label %> (<%= @model.trigger %>) finished with warnings.
+<% if @send_log %>
 
 See the attached backup log for details.
+<% end %>
 
 ===========================================================================
 <%= Backup::Template.new.result("general/version.erb") %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.20.1
+        version: 0.22.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.20.1
+        version: 0.22.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.7.3
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -212,28 +212,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +282,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: 0.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: 0.6.5
 - !ruby/object:Gem::Dependency
   name: polyglot
   requirement: !ruby/object:Gem::Requirement
@@ -304,20 +304,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.3.3
-- !ruby/object:Gem::Dependency
-  name: prowler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
   requirement: !ruby/object:Gem::Requirement