backup_zh 4.0.3.1 → 4.2.0

data/lib/backup/notifier/slack.rb

@@ -7,12 +7,8 @@ module Backup
     class Slack < Base
 
       ##
-      # The Team name
-      attr_accessor :team
-
-      ##
-      # The Integration Token
-      attr_accessor :token
+      # The incoming webhook url
+      attr_accessor :webhook_url
 
       ##
       # The channel to send messages to
@@ -65,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))
@@ -151,7 +141,7 @@ module Backup
       end
 
       def uri
-        @uri ||= "https://#{team}.slack.com/services/hooks/incoming-webhook?token=#{token}"
+        @uri ||= webhook_url
       end
     end
   end

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/package.rb

@@ -47,5 +47,9 @@ module Backup
       "#{ trigger }.#{ extension }"
     end
 
+    def time_as_object
+      Time.strptime(time, '%Y.%m.%d.%H.%M.%S')
+    end
+
   end
 end

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/storage/base.rb

@@ -10,8 +10,18 @@ module Backup
       attr_accessor :path
 
       ##
-      # Sets the limit to how many backups to keep in the remote location.
-      # If exceeded, the oldest will be removed to make room for the newest
+      # Number of backups to keep or time until which to keep.
+      #
+      # If an Integer is given it sets the limit to how many backups to keep in
+      # the remote location. If exceeded, the oldest will be removed to make
+      # room for the newest.
+      #
+      # If a Time object is given it will remove backups _older_ than the given
+      # date.
+      #
+      # @!attribute [rw] keep
+      #   @param [Integer|Time]
+      #   @return [Integer|Time]
       attr_accessor :keep
 
       attr_reader :model, :package, :storage_id
@@ -33,7 +43,9 @@ module Backup
       def perform!
         Logger.info "#{ storage_name } Started..."
         transfer!
-        cycle! if respond_to?(:cycle!, true) && keep.to_i > 0
+        if respond_to?(:cycle!, true) && (keep.to_i > 0 || keep.is_a?(Time))
+          cycle!
+        end
         Logger.info "#{ storage_name } Finished!"
       end
 

data/lib/backup/storage/cycler.rb

@@ -14,24 +14,34 @@ module Backup
         Logger.info 'Cycling Started...'
 
         packages = yaml_load.unshift(package)
-        excess = packages.count - keep.to_i
+        cycled_packages = []
 
-        if excess > 0
-          packages.pop(excess).each do |pkg|
-            begin
-              remove!(pkg) unless pkg.no_cycle
-            rescue => err
-              Logger.warn Error.wrap(err, <<-EOS)
-                There was a problem removing the following package:
-                Trigger: #{pkg.trigger} :: Dated: #{pkg.time}
-                Package included the following #{ pkg.filenames.count } file(s):
-                #{ pkg.filenames.join("\n") }
-              EOS
-            end
+        if keep.is_a?(Date) || keep.is_a?(Time)
+          cycled_packages = packages.select do |p|
+            p.time_as_object < keep.to_time
           end
+        else
+          excess = packages.count - keep.to_i
+          cycled_packages = packages.last(excess)
         end
 
-        yaml_save(packages)
+        saved_packages = packages - cycled_packages
+        cycled_packages.each { |package| delete_package package }
+
+        yaml_save(saved_packages)
+      end
+
+      def delete_package(package)
+        begin
+          remove!(package) unless package.no_cycle
+        rescue => err
+          Logger.warn Error.wrap(err, <<-EOS)
+            There was a problem removing the following package:
+            Trigger: #{package.trigger} :: Dated: #{package.time}
+            Package included the following #{ package.filenames.count } file(s):
+            #{ package.filenames.join("\n") }
+          EOS
+        end
       end
 
       # Returns path to the YAML data file.

data/lib/backup/storage/ftp.rb

@@ -15,15 +15,25 @@ module Backup
       attr_accessor :ip, :port
 
       ##
-      # use passive mode?
+      # Use passive mode?
       attr_accessor :passive_mode
 
+      ##
+      # Configure connection open and read timeouts.
+      # Net::FTP's open_timeout and read_timeout will both be configured using
+      # this setting.
+      # @!attribute [rw] timeout
+      #   @param [Integer|Float]
+      #   @return [Integer|Float]
+      attr_accessor :timeout
+
       def initialize(model, storage_id = nil)
         super
 
         @port         ||= 21
         @path         ||= 'backups'
         @passive_mode ||= false
+        @timeout      ||= nil
         path.sub!(/^~\//, '')
       end
 
@@ -42,6 +52,10 @@ module Backup
         end; Net::FTP.send(:const_set, :FTP_PORT, port)
 
         Net::FTP.open(ip, username, password) do |ftp|
+          if timeout
+            ftp.open_timeout = timeout
+            ftp.read_timeout = timeout
+          end
           ftp.passive = true if passive_mode
           yield ftp
         end

data/lib/backup/storage/s3.rb

@@ -76,7 +76,8 @@ module Backup
         @retry_waitsec  ||= 30
         @path           ||= 'backups'
         @storage_class  ||= :standard
-        path.sub!(/^\//, '')
+
+        @path = @path.sub(/^\//, '')
 
         check_configuration
       end

data/lib/backup/syncer/base.rb

@@ -28,8 +28,8 @@ module Backup
         load_defaults!
 
         @mirror ||= false
-        @directories = []
-        @excludes = []
+        @directories ||= []
+        @excludes ||= []
       end
 
       ##

data/lib/backup/version.rb

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

data/templates/cli/config

@@ -3,8 +3,8 @@
 ##
 # Backup v<%= Backup::VERSION.split('.').first %>.x Configuration
 #
-# Documentation: http://meskyanichi.github.io/backup
-# Issue Tracker: https://github.com/meskyanichi/backup/issues
+# Documentation: http://backup.github.io/backup
+# Issue Tracker: https://github.com/backup/backup/issues
 
 ##
 # Config Options

data/templates/cli/databases/sqlite

@@ -0,0 +1,11 @@
+  ##
+  # SQLite [Database]
+  #
+  database SQLite do |db|
+    # Path to database file
+    db.path               = "/path/to/my/sqlite/db.sqlite"
+
+    # Optional: Use to set the location of this utility
+    #   if it cannot be found by name in your $PATH
+    db.sqlitedump_utility = "/opt/local/bin/sqlite3"
+  end

data/templates/cli/model

@@ -7,7 +7,7 @@
 # $ backup perform -t <%= @options[:trigger] %> [-c <path_to_configuration_file>]
 #
 # For more information about Backup's components, see the documentation at:
-# http://meskyanichi.github.io/backup
+# http://backup.github.io/backup
 #
 Model.new(:<%= @options[:trigger] %>, 'Description for <%= @options[:trigger] %>') do
 <% if @options[:splitter] %>

data/templates/cli/notifiers/command

@@ -0,0 +1,32 @@
+  ##
+  # Command [Notifier]
+  #
+  notify_by Command do |cmd|
+    cmd.on_success = true
+    cmd.on_warning = true
+    cmd.on_failure = true
+
+    # Command to execute
+    cmd.command = 'notify-send'
+
+    # 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
+    # %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"]
+    #
+    # cmd.args = ["Backup %L", "%V"]
+  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

data/templates/cli/notifiers/hipchat

@@ -12,4 +12,5 @@
     hipchat.success_color  = "green"
     hipchat.warning_color  = "yellow"
     hipchat.failure_color  = "red"
+    hipchat.api_version    = "v1"
   end

data/templates/cli/notifiers/mail

@@ -11,6 +11,9 @@
 
     mail.from                 = "sender@email.com"
     mail.to                   = "receiver@email.com"
+    mail.cc                   = "cc@email.com"
+    mail.bcc                  = "bcc@email.com"
+    mail.reply_to             = "reply_to@email.com"
     mail.address              = "smtp.gmail.com"
     mail.port                 = 587
     mail.domain               = "your.host.name"

data/templates/cli/notifiers/pagerduty

@@ -0,0 +1,12 @@
+##
+# PagerDuty [Notifier]
+#
+
+notify_by PagerDuty do |pagerduty|
+  pagerduty.on_success = true
+  pagerduty.on_warning = true
+  pagerduty.on_failure = true
+
+  pagerduty.service_key = '0123456789abcdef01234567890abcde'
+  pagerduty.resolve_on_warning = true
+end

data/templates/cli/notifiers/ses

@@ -0,0 +1,15 @@
+  ##
+  # SES [Notifier]
+  #
+  notify_by Ses do |ses|
+    ses.on_success = true
+    ses.on_warning = true
+    ses.on_failure = true
+
+    ses.access_key_id = ''
+    ses.secret_access_key = ''
+    ses.region = 'eu-west-1'
+
+    ses.from = "sender@email.com"
+    ses.to = "receiver@email.com"
+  end

data/templates/cli/notifiers/slack

@@ -6,11 +6,10 @@
     slack.on_warning = true
     slack.on_failure = true
 
-    # The team name
-    slack.team = 'my_team'
+    # The incoming webhook url
+    # https://hooks.slack.com/services/xxxxxxxx/xxxxxxxxx/xxxxxxxxxx
+    slack.webhook_url = 'xxxxxxxxxxxxxxxxxxxxxxxx'
 
-    # The integration token
-    slack.token = 'xxxxxxxxxxxxxxxxxxxxxxxx'
 
     ##
     # Optional