backup 3.11.0 → 4.0.0rc1

data/lib/backup/database/riak.rb

@@ -77,25 +77,6 @@ module Backup
         "#{ utility(:sudo) } -n -u #{ user } #{ utility('riak-admin') }"
       end
 
-      attr_deprecate :utility_path, :version => '3.0.21',
-          :message => 'Use Backup::Utilities.configure instead.',
-          :action => lambda {|klass, val|
-            Utilities.configure { riak_admin val }
-          }
-
-      attr_deprecate :riak_admin_utility, :version => '3.3.0',
-          :message => 'Use Backup::Utilities.configure instead.',
-          :action => lambda {|klass, val|
-            Utilities.configure { riak_admin val }
-          }
-
-      attr_deprecate :name, :version => '3.3.0',
-          :message => "If you wish to add an identifier to the dump filename,\n" +
-          "use a +database_id+ when defining the database in your Model.\n" +
-          "e.g. database Riak, :my_id do |db|"
-
-      attr_deprecate :group, :version => '3.3.0'
-
     end
   end
 end

data/lib/backup/encryptor/base.rb

@@ -3,8 +3,8 @@
 module Backup
   module Encryptor
     class Base
-      include Backup::Utilities::Helpers
-      include Backup::Configuration::Helpers
+      include Utilities::Helpers
+      include Config::Helpers
 
       def initialize
         load_defaults!

data/lib/backup/encryptor/gpg.rb

@@ -217,17 +217,6 @@ module Backup
       # @return [Hash]
       attr_accessor :keys
 
-      ##
-      # @deprecated Use {#keys} and {#recipients}.
-      # @!attribute key
-      attr_deprecate :key,
-        :version => '3.0.26',
-        :message => "This has been replaced with #keys and #recipients",
-        :action  => lambda {|klass, val|
-          identifier = klass.send(:import_key, 'deprecated :key', val)
-          klass.recipients = identifier
-        }
-
       ##
       # Specifies the recipients to use when encrypting the backup archive.
       #
@@ -370,7 +359,7 @@ module Backup
       #   end
       #
       # @!scope class
-      # @see Configuration::Helpers::ClassMethods#defaults
+      # @see Config::Helpers::ClassMethods#defaults
       # @yield [config] OpenStruct object
       # @!method defaults
 

data/lib/backup/logger/fog_adapter.rb

@@ -14,8 +14,7 @@ module Backup
         # supplemental messages for our own warnings.
         # These will generally occur during retry attempts.
         def write(message)
-          Logger.info message.split("\n").
-              map {|line| "[fog] #{ line }" }.join("\n")
+          Logger.info message.chomp
         end
 
         def tty?

data/lib/backup/model.rb

@@ -156,27 +156,6 @@ module Backup
     ##
     # Adds an Syncer. Multiple Syncers may be added to the model.
     def sync_with(name, syncer_id = nil, &block)
-      ##
-      # Warn user of DSL changes
-      case name.to_s
-      when 'Backup::Config::RSync'
-        Logger.warn Error.new(<<-EOS)
-          Configuration Update Needed for Syncer::RSync
-          The RSync Syncer has been split into three separate modules:
-          RSync::Local, RSync::Push and RSync::Pull
-          Please update your configuration.
-          i.e. 'sync_with RSync' is now 'sync_with RSync::Push'
-        EOS
-        name = 'RSync::Push'
-      when /(Backup::Config::S3|Backup::Config::CloudFiles)/
-        syncer = $1.split('::')[2]
-        Logger.warn Error.new(<<-EOS)
-          Configuration Update Needed for '#{ syncer }' Syncer.
-          This Syncer is now referenced as Cloud::#{ syncer }
-          i.e. 'sync_with #{ syncer }' is now 'sync_with Cloud::#{ syncer }'
-        EOS
-        name = "Cloud::#{ syncer }"
-      end
       @syncers << get_class_from_scope(Syncer, name).new(syncer_id, &block)
     end
 
@@ -208,7 +187,7 @@ module Backup
     # +suffix_length+ controls the number of characters used in the suffix
     # (and the maximum number of chunks possible).
     # ie. 1 (-a, -b), 2 (-aa, -ab), 3 (-aaa, -aab)
-    def split_into_chunks_of(chunk_size, suffix_length = 2)
+    def split_into_chunks_of(chunk_size, suffix_length = 3)
       if chunk_size.is_a?(Integer) && suffix_length.is_a?(Integer)
         @splitter = Splitter.new(self, chunk_size, suffix_length)
       else
@@ -358,7 +337,7 @@ module Backup
     # +name+ may be Class/Module or String representation
     # of any namespace which exists under +scope+.
     #
-    # The 'Backup::Config::' namespace is stripped from +name+,
+    # The 'Backup::Config::DSL' namespace is stripped from +name+,
     # since this is the namespace where we define module namespaces
     # for use with Model's DSL methods.
     #
@@ -371,7 +350,7 @@ module Backup
     #
     def get_class_from_scope(scope, name)
       klass = scope
-      name = name.to_s.sub(/^Backup::Config::/, '')
+      name = name.to_s.sub(/^Backup::Config::DSL::/, '')
       name.split('::').each do |chunk|
         klass = klass.const_get(chunk)
       end

data/lib/backup/notifier/base.rb

@@ -5,8 +5,8 @@ module Backup
     class Error < Backup::Error; end
 
     class Base
-      include Backup::Utilities::Helpers
-      include Backup::Configuration::Helpers
+      include Utilities::Helpers
+      include Config::Helpers
 
       ##
       # When set to true, the user will be notified by email
@@ -93,21 +93,6 @@ module Backup
         self.class.to_s.sub('Backup::', '')
       end
 
-      # For ruby-1.8.7. Both sorted so specs will match.
-      def encode_www_form(enum)
-        if RUBY_VERSION < '1.9'
-          require 'cgi'
-          str = ''
-          enum.to_a.map {|k,v| [k.to_s, v] }.sort.each do |k,v|
-            str << '&' unless str.empty?
-            str << CGI.escape(k) << '=' << CGI.escape(v)
-          end
-          str
-        else
-          URI.encode_www_form(enum.sort)
-        end
-      end
-
     end
   end
 end

data/lib/backup/notifier/http_post.rb

@@ -106,7 +106,7 @@ module Backup
           :headers => { 'User-Agent' => "Backup/#{ VERSION }" }.
               merge(headers).reject {|k,v| v.nil? }.
               merge('Content-Type' => 'application/x-www-form-urlencoded'),
-          :body => encode_www_form({ 'message' => message }.
+          :body => URI.encode_www_form({ 'message' => message }.
               merge(params).reject {|k,v| v.nil? }.
               merge('status' => status.to_s)),
           :expects => success_codes # raise error if unsuccessful

data/lib/backup/notifier/mail.rb

@@ -66,14 +66,14 @@ module Backup
       ##
       # Set the method of encryption to be used for the +SMTP+ connection.
       #
-      # [:none (default)]
-      #   No encryption will be used.
-      #
-      # [:starttls]
+      # [:starttls (default)]
       #   Use +STARTTLS+ to upgrade the connection to a +SSL/TLS+ connection.
       #
       # [:tls or :ssl]
       #   Use a +SSL/TLS+ connection.
+      #
+      # [:none]
+      #   No encryption will be used.
       attr_accessor :encryption
 
       ##
@@ -123,6 +123,7 @@ module Backup
         instance_eval(&block) if block_given?
 
         @send_log_on ||= [:warning, :failure]
+        @encryption  ||= :starttls
       end
 
       private
@@ -218,25 +219,6 @@ module Backup
         email
       end
 
-      attr_deprecate :enable_starttls_auto, :version => '3.2.0',
-                     :message => "Use #encryption instead.\n" +
-                        'e.g. mail.encryption = :starttls',
-                     :action => lambda {|klass, val|
-                       klass.encryption = val ? :starttls : :none
-                     }
-
-      attr_deprecate :sendmail, :version => '3.6.0',
-          :message => 'Use Backup::Utilities.configure instead.',
-          :action => lambda {|klass, val|
-            Utilities.configure { sendmail val }
-          }
-
-      attr_deprecate :exim, :version => '3.6.0',
-          :message => 'Use Backup::Utilities.configure instead.',
-          :action => lambda {|klass, val|
-            Utilities.configure { exim val }
-          }
-
     end
   end
 end
@@ -254,27 +236,3 @@ module Mail
     end
   end
 end
-
-# Patch mail v2.5.4 for ruby-1.8.7
-# https://github.com/mikel/mail/issues/548
-# https://github.com/mikel/mail/commit/c7318a6c03c1ecb3f574ccd2e3f06778687d1d15
-if RUBY_VERSION < '1.9'
-  module Mail
-    class SMTP
-      private
-      def ssl_context
-        openssl_verify_mode = settings[:openssl_verify_mode]
-
-        if openssl_verify_mode.kind_of?(String)
-          openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
-        end
-
-        context = Net::SMTP.default_ssl_context
-        context.verify_mode = openssl_verify_mode
-        context.ca_path = settings[:ca_path] if settings[:ca_path]
-        context.ca_file = settings[:ca_file] if settings[:ca_file]
-        context
-      end
-    end
-  end
-end

data/lib/backup/notifier/prowl.rb

@@ -58,7 +58,7 @@ module Backup
         }
         options = {
           :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
-          :body     => encode_www_form(data)
+          :body     => URI.encode_www_form(data)
         }
         options.merge!(:expects => 200) # raise error if unsuccessful
         Excon.post(uri, options)

data/lib/backup/notifier/pushover.rb

@@ -69,7 +69,7 @@ module Backup
         end
         options = {
           :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
-          :body     => encode_www_form(data)
+          :body     => URI.encode_www_form(data)
         }
         options.merge!(:expects => 200) # raise error if unsuccessful
         Excon.post(uri, options)

data/lib/backup/packager.rb

@@ -5,7 +5,7 @@ module Backup
     class Error < Backup::Error; end
 
     class << self
-      include Backup::Utilities::Helpers
+      include Utilities::Helpers
 
       ##
       # Build the final package for the backup model.

data/lib/backup/pipeline.rb

@@ -4,7 +4,7 @@ module Backup
   class Pipeline
     class Error < Backup::Error; end
 
-    include Backup::Utilities::Helpers
+    include Utilities::Helpers
 
     attr_reader :stderr, :errors
 

data/lib/backup/splitter.rb

@@ -2,7 +2,7 @@
 
 module Backup
   class Splitter
-    include Backup::Utilities::Helpers
+    include Utilities::Helpers
 
     attr_reader :package, :chunk_size, :suffix_length
 

data/lib/backup/storage/base.rb

@@ -3,7 +3,7 @@
 module Backup
   module Storage
     class Base
-      include Backup::Configuration::Helpers
+      include Config::Helpers
 
       ##
       # Base path on the remote where backup package files will be stored.
@@ -33,7 +33,7 @@ module Backup
       def perform!
         Logger.info "#{ storage_name } Started..."
         transfer!
-        cycle!
+        cycle! if respond_to?(:cycle!, true) && keep.to_i > 0
         Logger.info "#{ storage_name } Finished!"
       end
 
@@ -46,18 +46,6 @@ module Backup
       end
       alias :remote_path_for :remote_path
 
-      ##
-      # Adds the current package being stored to the YAML cycle data file
-      # and will remove any old Package file(s) when the storage limit
-      # set by #keep is exceeded. Any errors raised while attempting to
-      # remove older packages will be rescued and a warning will be logged
-      # containing the original error message.
-      def cycle!
-        return unless keep.to_i > 0
-        Logger.info "Cycling Started..."
-        Cycler.cycle!(self)
-      end
-
       def storage_name
         @storage_name ||= self.class.to_s.sub('Backup::', '') +
             (storage_id ? " (#{ storage_id })" : '')

data/lib/backup/storage/cloud_files.rb

@@ -4,6 +4,7 @@ require 'backup/cloud_io/cloud_files'
 module Backup
   module Storage
     class CloudFiles < Base
+      include Storage::Cycler
       class Error < Backup::Error; end
 
       ##

data/lib/backup/storage/cycler.rb

@@ -5,41 +5,21 @@ module Backup
     module Cycler
       class Error < Backup::Error; end
 
-      class << self
+      private
 
-        ##
-        # Adds the given +package+ to the YAML storage file corresponding
-        # to the given +storage+ and Package#trigger (Model#trigger).
-        # Then, calls the +storage+ to remove the files for any older
-        # packages that were removed from the YAML storage file.
-        def cycle!(storage)
-          @storage = storage
-          @package = storage.package
-          @storage_file = storage_file
+      # Adds the current package being stored to the YAML cycle data file
+      # and will remove any old package file(s) when the storage limit
+      # set by #keep is exceeded.
+      def cycle!
+        Logger.info 'Cycling Started...'
 
-          update_storage_file!
-          remove_packages!
-        end
-
-        private
-
-        ##
-        # Updates the YAML data file according to the #keep setting
-        # for the storage and sets the @packages_to_remove
-        def update_storage_file!
-          packages = yaml_load.unshift(@package)
-          excess = packages.count - @storage.keep.to_i
-          @packages_to_remove = (excess > 0) ? packages.pop(excess) : []
-          yaml_save(packages)
-        end
+        packages = yaml_load.unshift(package)
+        excess = packages.count - keep.to_i
 
-        ##
-        # Calls the @storage to remove any old packages
-        # which were cycled out of the storage file.
-        def remove_packages!
-          @packages_to_remove.each do |pkg|
+        if excess > 0
+          packages.pop(excess).each do |pkg|
             begin
-              @storage.send(:remove!, pkg) unless pkg.no_cycle
+              remove!(pkg) unless pkg.no_cycle
             rescue => err
               Logger.warn Error.wrap(err, <<-EOS)
                 There was a problem removing the following package:
@@ -51,70 +31,35 @@ module Backup
           end
         end
 
-        ##
-        # Return full path to the YAML data file,
-        # based on the current values of @storage and @package
-        def storage_file
-          filename = @storage.class.to_s.split('::').last
-          filename << "-#{ @storage.storage_id }" if @storage.storage_id
-          File.join(Config.data_path, @package.trigger, "#{ filename }.yml")
-        end
+        yaml_save(packages)
+      end
 
-        ##
-        # Load Package objects from YAML file.
-        # Returns an Array, sorted by @time descending.
-        # i.e. most recent is objects[0]
-        def yaml_load
-          packages = []
-          if File.exist?(@storage_file) && !File.zero?(@storage_file)
-            packages = check_upgrade(
-              YAML.load_file(@storage_file).sort do |a, b|
-                b.instance_variable_get(:@time) <=> a.instance_variable_get(:@time)
-              end
-            )
-          end
-          packages
+      # Returns path to the YAML data file.
+      def yaml_file
+        @yaml_file ||= begin
+          filename = self.class.to_s.split('::').last
+          filename << "-#{ storage_id }" if storage_id
+          File.join(Config.data_path, package.trigger, "#{ filename }.yml")
         end
+      end
 
-        ##
-        # Store the given package objects to the YAML data file.
-        def yaml_save(packages)
-          FileUtils.mkdir_p(File.dirname(@storage_file))
-          File.open(@storage_file, 'w') do |file|
-            file.write(packages.to_yaml)
-          end
+      # Returns stored Package objects, sorted by #time descending (oldest last).
+      def yaml_load
+        if File.exist?(yaml_file) && !File.zero?(yaml_file)
+          YAML.load_file(yaml_file).sort_by!(&:time).reverse!
+        else
+          []
         end
+      end
 
-        ##
-        # Upgrade the objects loaded from the YAML file, if needed.
-        def check_upgrade(objects)
-          if objects.any? {|obj| obj.class.to_s =~ /Backup::Storage/ }
-            # Version <= 3.0.20
-            model = @storage.instance_variable_get(:@model)
-            v3_0_20 = objects.any? {|obj| obj.instance_variable_defined?(:@version) }
-            objects.map! do |obj|
-              if v3_0_20 # Version == 3.0.20
-                filename = obj.instance_variable_get(:@filename)[20..-1]
-                chunk_suffixes = obj.instance_variable_get(:@chunk_suffixes)
-              else # Version <= 3.0.19
-                filename = obj.instance_variable_get(:@remote_file)[20..-1]
-                chunk_suffixes = []
-              end
-              time = obj.instance_variable_get(:@time)
-              extension = filename.match(/\.(tar.*)$/)[1]
-
-              package = Backup::Package.new(model)
-              package.instance_variable_set(:@time, time)
-              package.extension = extension
-              package.chunk_suffixes = chunk_suffixes
-
-              package
-            end
-          end
-          objects
+      # Stores the given package objects to the YAML data file.
+      def yaml_save(packages)
+        FileUtils.mkdir_p(File.dirname(yaml_file))
+        File.open(yaml_file, 'w') do |file|
+          file.write(packages.to_yaml)
         end
-
       end
+
     end
   end
 end