backup 4.0.6 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92b075a8c0c4cd0cfb491b9eebe7a832a4bd4e0c
-  data.tar.gz: 3f5d1f313497276ea43879502ad2729d74c417e9
+  metadata.gz: e7bc86c4dc89353c401df759462b0ba4348b707f
+  data.tar.gz: 3e08c40c56ec68a4dd60f7fa4f06f57d20f54965
 SHA512:
-  metadata.gz: 43f674576dfddb1feefc4ffaf068b5994ac15949a12565c2c67e234383d2e6f8f946d9ffe70a6b5ccc9db75c7a94fe32aa508cf8e474b545be83f1e57a520203
-  data.tar.gz: baffa3b4132cce710376518ae9e7af343077dbdadaf7eb1152aaefb870d9832b785c6c5da7d29c59879fb8fbee697529e74933c39e345e633d87ff93debcd4cc
+  metadata.gz: 3f2f379cfd4b36b326487b9688c15d9eafc2c99f3676482b7773a9c79bbbd123396bc44b4f2535bd4cf8a483b8ff07d20cbd7b16359485f12d805dbb435b1217
+  data.tar.gz: 97c930d5f9dc687948e85b3cd622b47763af7d4cb86eff7edecd4f59e52ed9a2c481f6659f261a8c755ffae83cb927cd35a8ee236b8bf91ce61f18e86b47b23e

data/README.md

@@ -10,6 +10,8 @@ was built with modularity, extensibility and simplicity in mind.
 
 [Installation][] · [Release Notes][] · [Documentation][]
 
+Please use the Backup features [issue tracker](https://github.com/meskyanichi/backup-features/issues) to suggest new features.
+Only use the Backup gem [issue tracker](https://github.com/meskyanichi/backup/issues) for bugs and other issues.
 
 **Copyright (c) 2009-2014 [Michael van Rooijen][] ( [@meskyanichi][] )**  
 Released under the **MIT** [License](LICENSE.md).

data/lib/backup.rb

@@ -114,6 +114,7 @@ module Backup
     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')
   end
 
   ##

data/lib/backup/notifier/datadog.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+require 'dogapi'
+
+module Backup
+  module Notifier
+    class DataDog < Base
+
+      ##
+      # The DataDog API key
+      attr_accessor :api_key
+
+      ##
+      # The title of the event
+      attr_accessor :title
+
+      ##
+      # The text information for the event
+      attr_accessor :text
+
+      ##
+      # The timestamp for the event
+      attr_accessor :date_happened
+
+      ##
+      # The priority of the event (low/normal)
+      attr_accessor :priority
+
+      ##
+      # The host that generated the event
+      attr_accessor :host
+
+      ##
+      # The tags for this host (should be an array)
+      attr_accessor :tags
+
+      ##
+      # The alert_type of the event (error/warning/info/success)
+      attr_accessor :alert_type
+
+      ##
+      # The aggregation_key for the event
+      attr_accessor :aggregation_key
+
+      ##
+      # The source_type for the event (nagios, hudson, jenkins, user, my apps, feed, chef, puppet, git, bitbucket, fabric, capistrano)
+      attr_accessor :source_type_name
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @title          ||= default_title
+        @text           ||= default_text
+      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)
+        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
+        hash.store(:host,             @host)             if @host
+        hash.store(:tags,             @tags)             if @tags
+        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)
+      end
+
+      # Dogapi::Client will raise an error if unsuccessful.
+      def send_event(hash)
+        client = Dogapi::Client.new(@api_key)
+        event = Dogapi::Event.new(@text, hash)
+        client.emit_event(event)
+      end
+
+      # set alert type
+      def default_alert_type(status)
+        case status
+        when :success then 'success'
+        when :warning then 'warning'
+        when :failure then 'error'
+        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/version.rb

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

data/templates/cli/notifiers/datadog

@@ -0,0 +1,57 @@
+  ##
+  # DataDog [Notifier]
+  #
+  notify_by DataDog do |datadog|
+    datadog.on_success           = true
+    datadog.on_warning           = true
+    datadog.on_failure           = true
+
+    datadog.api_key              = 'my_api_key'
+
+    ##
+    # Optional
+    #
+    # Override Default Title
+    # Default is: "Backup #{:label}"
+    # datadog.title                = "Backup #{:status}"
+    #
+    # Override Default Text
+    # Default is "Backup Notification for #{:label}"
+    # datadog.text                 = "Backup #{:status} - #{:message}"
+    #
+    # Provide a hostname to associate this backup to
+    # Default is nil
+    # datadog.host                 = 'db.example.com'
+    #
+    # Add Tags to the Event
+    # Default is nil
+    # valid option is an Array
+    # datadog.tags                 = ['backup', 'env:production']
+    #
+    # Override the Alert Type
+    # Default is based on the :status of the backup:
+    # :success => 'success'
+    # :warning => 'warning'
+    # :failure => 'error'
+    # valid options are: 'info', 'success', 'warning', 'error'
+    # datadog.alert_type           = 'info'
+    #
+    # Add a Source Type
+    # Default is nil
+    # see api docs for valid source_type_names
+    # datadog.source_type_name        = 'my apps'
+    #
+    # Override the Priority Level
+    # Default is 'normal'
+    # valid options are: 'normal' or 'low'
+    # datadog.priority             = 'low'
+    #
+    # Override the Event Time (must be a unix Timestamp)
+    # Default is Time.now.to_i
+    # datadog.date_happened        = Time.now.to_i
+    #
+    # Add an Aggregation Key
+    # Default is nil
+    # max length allowed is 100 characters
+    # datadog.aggregation_key      = 'my_aggregation'
+  end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.0.7
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -80,6 +80,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: dogapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: dropbox-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -606,6 +620,7 @@ files:
 - lib/backup/model.rb
 - lib/backup/notifier/base.rb
 - lib/backup/notifier/campfire.rb
+- lib/backup/notifier/datadog.rb
 - lib/backup/notifier/flowdock.rb
 - lib/backup/notifier/hipchat.rb
 - lib/backup/notifier/http_post.rb
@@ -661,6 +676,7 @@ files:
 - templates/cli/model
 - templates/cli/notifier/zabbix
 - templates/cli/notifiers/campfire
+- templates/cli/notifiers/datadog
 - templates/cli/notifiers/flowdock
 - templates/cli/notifiers/hipchat
 - templates/cli/notifiers/http_post