backup 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37dbf9eccc36e1a525fe37d7b98f7345871d4bb7
-  data.tar.gz: de1bc94187f6c906a2d6462b3ed9a9b3f7f65c75
+  metadata.gz: 0598ab928bc914fc5be6f4e473a2dba3f3b80c41
+  data.tar.gz: d8c34be3b2896bb9a1cc024c67df93783ae1853c
 SHA512:
-  metadata.gz: dc9c6a01142ad74966a19b1c3cb076f848d42dc302681d844d55f9df329bdf3d8f453f0077e5dc6ca6458874df35036f0ac3f34c6f475769460a41aa1ff5ac52
-  data.tar.gz: bc312d4ce722018fb6d8d130bc13d18d455a3a00384b31d144ac582eca13e26b95089a0295c66c1ce23e827f9e2fa0c972ebee08246e4da8201c2bf5509eb651
+  metadata.gz: eed55c0c9b7e63ba902db61e8148413a430d21755175c34926ae5348318aefde89876a5dd8231dccef11adaad44ec08575f3e244e7b3ab235e2100e764b9b079
+  data.tar.gz: 20d0efa09f22cf70b9bdaf94ac49d43f1fbe0d499b44bfe31ac93c0b867559c3db83c87a70953d5def9cfe53caff2308f36dc40cc0b1406cf284d310749c80b2

data/lib/backup.rb

@@ -105,6 +105,7 @@ module Backup
     autoload :Prowl,     File.join(NOTIFIER_PATH, 'prowl')
     autoload :Hipchat,   File.join(NOTIFIER_PATH, 'hipchat')
     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')
   end

data/lib/backup/config/dsl.rb

@@ -42,7 +42,7 @@ module Backup
               ],
               # Notifiers
               ['Mail', 'Twitter', 'Campfire', 'Prowl',
-              'Hipchat', 'Pushover', 'HttpPost', 'Nagios']
+              'Hipchat', 'Pushover', 'HttpPost', 'Nagios', 'Slack']
             ]
           )
         end

data/lib/backup/notifier/slack.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require 'uri'
+require 'json'
+
+module Backup
+  module Notifier
+    class Slack < Base
+
+      ##
+      # The Team name
+      attr_accessor :team
+
+      ##
+      # The Integration Token
+      attr_accessor :token
+
+      ##
+      # The channel to send messages to
+      attr_accessor :channel
+
+      ##
+      # The username to display along with the notification
+      attr_accessor :username
+
+      ##
+      # Array of statuses for which the log file should be attached.
+      #
+      # Available statuses are: `:success`, `:warning` and `:failure`.
+      # Default: [:warning, :failure]
+      attr_accessor :send_log_on
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @send_log_on ||= [:warning, :failure]
+      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)
+        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 }
+        [:channel, :username].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))
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+
+      def attachment(status)
+        {
+          :fallback => "#{title(status)} - Job: #{model.label} (#{model.trigger})",
+          :text     => title(status),
+          :color    => color(status),
+          :fields   => [
+            {
+              :title => "Job",
+              :value => "#{model.label} (#{model.trigger})",
+              :short => false
+            },
+            {
+              :title => "Started",
+              :value => model.started_at,
+              :short => true
+            },
+            {
+              :title => "Finished",
+              :value => model.finished_at,
+              :short => true
+            },
+            {
+              :title => "Duration",
+              :value => model.duration,
+              :short => true
+            },
+            {
+              :title => "Version",
+              :value => "Backup v#{Backup::VERSION}\nRuby: #{RUBY_DESCRIPTION}",
+              :short => false
+            },
+            log_field(status)
+          ].compact
+        }
+      end
+
+      def log_field(status)
+        send_log = send_log_on.include?(status)
+
+        return {
+          :title => "Detailed Backup Log",
+          :value => Logger.messages.map(&:formatted_lines).flatten.join("\n"),
+          :short => false,
+        } if send_log
+      end
+
+      def color(status)
+        case status
+        when :success then 'good'
+        when :failure then 'danger'
+        when :warning then 'warning'
+        end
+      end
+
+      def title(status)
+        case status
+        when :success then 'Backup Completed Successfully!'
+        when :failure then 'Backup Failed!'
+        when :warning then 'Backup Completed Successfully (with Warnings)!'
+        end
+      end
+
+      def uri
+        @uri ||= "https://#{team}.slack.com/services/hooks/incoming-webhook?token=#{token}"
+      end
+    end
+  end
+end

data/lib/backup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -582,6 +582,7 @@ files:
 - lib/backup/notifier/nagios.rb
 - lib/backup/notifier/prowl.rb
 - lib/backup/notifier/pushover.rb
+- lib/backup/notifier/slack.rb
 - lib/backup/notifier/twitter.rb
 - lib/backup/package.rb
 - lib/backup/packager.rb
@@ -683,7 +684,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provides an elegant DSL in Ruby for performing backups on UNIX-like systems.