backup 4.2.0 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b3395ec5399914784eeb39f638352a1ce486589
-  data.tar.gz: 7e8dfbc5aea5da8abed31b2dbf14d920cfcebb41
+  metadata.gz: d08d993d32d7569046700f059019d19276be8d4f
+  data.tar.gz: a0f8b82c36a16137008774c5107c03f2cb560488
 SHA512:
-  metadata.gz: 4e9ac7c7b0ad9ef5d7b4d5ac4147206c4407cceba3704aa15f53b0c99fadfe4c8703e07daa16dd874f0c3c80e836f89d1db56204de60e5c607080c4f96c498cc
-  data.tar.gz: e64842958d8d39f15f739e76b554012389fbd7720710a0602cded468ae2c0829ed43039b0757bbec5d6f48a1e1b58db6aec625ad8954d956c44b8eec125f69ca
+  metadata.gz: 3bd3300ce800e95d11097dcf02c79965917d9aac7bb58a89e482248a6f3a37084efce66885cfd6b2f8892611b17dd2381df3fdb78c3e052da34e9eb8882b215e
+  data.tar.gz: dec002458b652dde7ea835c4366581252d1bd1961fca6e125c3677abedf72c03ca90313fa78ca0d8dfc2449575f3542cf399eb98bbdcd8873971f71d57a8fb6c

data/lib/backup/notifier/hipchat.rb

@@ -9,6 +9,11 @@ module Backup
       # The Hipchat API token
       attr_accessor :token
 
+      ##
+      # The Hipchat API version
+      # Either 'v1' or 'v2' (default is 'v1')
+      attr_accessor :api_version
+
       ##
       # Who the notification should appear from
       attr_accessor :from
@@ -45,6 +50,7 @@ module Backup
         @success_color  ||= 'yellow'
         @warning_color  ||= 'yellow'
         @failure_color  ||= 'yellow'
+        @api_version    ||= 'v1'
       end
 
       private
@@ -72,9 +78,13 @@ module Backup
         send_message(msg, status_data[:color])
       end
 
+      def client_options
+        { api_version: @api_version }
+      end
+
       # Hipchat::Client will raise an error if unsuccessful.
       def send_message(msg, color)
-        client = HipChat::Client.new(token)
+        client = HipChat::Client.new(token, client_options)
         rooms_to_notify.each do |room|
           client[room].send(from, msg, :color => color, :notify => notify_users)
         end

data/lib/backup/notifier/mail.rb

@@ -37,6 +37,18 @@ module Backup
       # Receiver Email Address
       attr_accessor :to
 
+      ##
+      # CC receiver Email Address
+      attr_accessor :cc
+
+      ##
+      # BCC receiver Email Address
+      attr_accessor :bcc
+
+      ##
+      # Set reply to email address
+      attr_accessor :reply_to
+
       ##
       # SMTP Server Address
       attr_accessor :address
@@ -208,8 +220,11 @@ module Backup
         end
 
         email = ::Mail.new
-        email.to   = @to
-        email.from = @from
+        email.to       = to
+        email.from     = from
+        email.cc       = cc
+        email.bcc      = bcc
+        email.reply_to = reply_to
         email
       end
 

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/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) if excess > 0
         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/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Backup
-  VERSION = '4.2.0'
+  VERSION = '4.2.2'
 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/storages/dropbox

@@ -16,4 +16,5 @@
     db.access_type = :app_folder
     db.path        = "/path/to/my/backups"
     db.keep        = 25
+    # db.keep        = Time.now - 2592000 # Remove all backups older than 1 month.
   end

data/templates/cli/storages/ftp

@@ -8,5 +8,6 @@
     server.port         = 21
     server.path         = "~/backups/"
     server.keep         = 5
+    # server.keep         = Time.now - 2592000 # Remove all backups older than 1 month.
     server.passive_mode = false
   end

data/templates/cli/storages/local

@@ -4,4 +4,5 @@
   store_with Local do |local|
     local.path       = "~/backups/"
     local.keep       = 5
+    # local.keep       = Time.now - 2592000 # Remove all backups older than 1 month.
   end

data/templates/cli/storages/ninefold

@@ -6,4 +6,5 @@
     nf.storage_secret  = "my_storage_secret"
     nf.path            = "/path/to/my/backups"
     nf.keep            = 10
+    # nf.keep            = Time.now - 2592000 # Remove all backups older than 1 month.
   end

data/templates/cli/storages/s3

@@ -11,4 +11,6 @@
     s3.region            = "us-east-1"
     s3.bucket            = "bucket-name"
     s3.path              = "path/to/backups"
+    s3.keep              = 5
+    # s3.keep              = Time.now - 2592000 # Remove all backups older than 1 month.
   end

data/templates/cli/storages/scp

@@ -8,6 +8,7 @@
     server.port       = 22
     server.path       = "~/backups/"
     server.keep       = 5
+    # server.keep       = Time.now - 2592000 # Remove all backups older than 1 month.
 
     # Additional options for the SSH connection.
     # server.ssh_options = {}

data/templates/cli/storages/sftp

@@ -8,6 +8,7 @@
     server.port       = 22
     server.path       = "~/backups/"
     server.keep       = 5
+    # server.keep         = Time.now - 2592000 # Remove all backups older than 1 month.
 
     # Additional options for the SSH connection.
     # server.ssh_options = {}

metadata

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