backup 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 697c751e37f7ee0a9c4485ba7c793980a7a5b087
-  data.tar.gz: 2bc9a792c855ed04d7d8e32a95612b7510836a93
+  metadata.gz: 11a5142174a679705cd2443ac0248928a6c5f8b8
+  data.tar.gz: 7e6b4a5a23ab07ecd0e0cdaf96e537b721b6d3bc
 SHA512:
-  metadata.gz: 66fee3c688e30e8c0dca0083d3b65b989578f9cdb42b6d043e6d6880e129bfa2ee08b220ee1b778322f02d52b58ad119a33a46458ced5f4e24663122963f9a1e
-  data.tar.gz: 44d7d2382a074f6f5e83df6b360d26137c6bc2733031cb2b22ce0f5ce1d83b97712366254f248ceb6681aaf5f8d42fcd138484b670bb52acab51d5fdbfe8026b
+  metadata.gz: 18b022a990ce3a8c6010a3d7ea25bce8eca33d1552b03f852e3c02a077ac73b6788ff0d841f5f097b56536282fe1f997dcfeebd4fa1954aa18fc8553ba8f513e
+  data.tar.gz: 710399d76701426778abf1a6713a59b9f01dd532ec00a1fb2d8d2035d421441ffd0a2288fab472a68af649817086461c05e34770db6c8e7bf6698e5a2851eeb9

data/lib/backup/cloud_io/cloud_files.rb

@@ -13,7 +13,8 @@ module Backup
       SEGMENT_BUFFER  = 1024**2         # 1 MiB
 
       attr_reader :username, :api_key, :auth_url, :region, :servicenet,
-                  :container, :segments_container, :segment_size, :days_to_keep
+                  :container, :segments_container, :segment_size, :days_to_keep,
+                  :fog_options
 
       def initialize(options = {})
         super
@@ -27,6 +28,7 @@ module Backup
         @segments_container = options[:segments_container]
         @segment_size       = options[:segment_size]
         @days_to_keep       = options[:days_to_keep]
+        @fog_options        = options[:fog_options]
       end
 
       # The Syncer may call this method in multiple threads,
@@ -139,14 +141,14 @@ module Backup
       private
 
       def connection
-        @connection ||= Fog::Storage.new(
+        @connection ||= Fog::Storage.new({
           :provider             => 'Rackspace',
           :rackspace_username   => username,
           :rackspace_api_key    => api_key,
           :rackspace_auth_url   => auth_url,
           :rackspace_region     => region,
           :rackspace_servicenet => servicenet
-        )
+        }.merge(fog_options || {}))
       end
 
       def create_containers

data/lib/backup/cloud_io/s3.rb

@@ -14,7 +14,8 @@ module Backup
       MAX_MULTIPART_SIZE  = 1024**4 * 5   # 5 TiB
 
       attr_reader :access_key_id, :secret_access_key, :use_iam_profile,
-                  :region, :bucket, :chunk_size, :encryption, :storage_class
+                  :region, :bucket, :chunk_size, :encryption, :storage_class,
+                  :fog_options
 
       def initialize(options = {})
         super
@@ -27,6 +28,7 @@ module Backup
         @chunk_size         = options[:chunk_size]
         @encryption         = options[:encryption]
         @storage_class      = options[:storage_class]
+        @fog_options        = options[:fog_options]
       end
 
       # The Syncer may call this method in multiple threads.
@@ -130,6 +132,7 @@ module Backup
               :aws_secret_access_key  => secret_access_key
             )
           end
+          opts.merge!(fog_options || {})
           conn = Fog::Storage.new(opts)
           conn.sync_clock
           conn

data/lib/backup/config.rb

@@ -38,6 +38,22 @@ module Backup
         module_eval(File.read(@config_file), @config_file)
       end
 
+      # Allows users to create preconfigured models.
+      def preconfigure(name, &block)
+        unless name.is_a?(String) && name =~ /^[A-Z]/
+          raise Error, "Preconfigured model names must be given as a string " +
+                       " and start with a capital letter."
+        end
+
+        if Backup.const_defined?(name)
+          raise Error, "'#{ name }' is already in use " +
+                        "and can not be used for a preconfigured model."
+        end
+
+        Backup.const_set(name, Class.new(Model))
+        Backup.const_get(name).preconfigure(&block)
+      end
+
       def hostname
         @hostname ||= run(utility(:hostname))
       end

data/lib/backup/model.rb

@@ -25,6 +25,18 @@ module Backup
           all.select {|model| trigger == model.trigger }
         end
       end
+
+      # Allows users to create preconfigured models.
+      def preconfigure(&block)
+        @preconfigure ||= block
+      end
+
+      private
+
+      # used for testing
+      def reset!
+        @all = @preconfigure = nil
+      end
     end
 
     ##
@@ -111,6 +123,7 @@ module Backup
       @notifiers  = []
       @syncers    = []
 
+      instance_eval(&self.class.preconfigure) if self.class.preconfigure
       instance_eval(&block) if block_given?
 
       # trigger all defined databases to generate their #dump_filename
@@ -214,7 +227,8 @@ module Backup
     #
     # If any exception is raised, any defined +after+ hook will be skipped.
     def before(&block)
-      @before ||= block
+      @before = block if block
+      @before
     end
 
     ##
@@ -241,7 +255,8 @@ module Backup
     # the exit_status will be elevated to 2. If the exception is not a
     # StandardError, the exit_status will be elevated to 3.
     def after(&block)
-      @after ||= block
+      @after = block if block
+      @after
     end
 
     ##

data/lib/backup/storage/cloud_files.rb

@@ -65,6 +65,11 @@ module Backup
       # Default: 30
       attr_accessor :retry_waitsec
 
+      ##
+      # Additional options to pass along to fog.
+      # e.g. Fog::Storage.new({ :provider => 'Rackspace' }.merge(fog_options))
+      attr_accessor :fog_options
+
       def initialize(model, storage_id = nil)
         super
 
@@ -93,7 +98,8 @@ module Backup
           :segment_size       => segment_size,
           :days_to_keep       => days_to_keep,
           :max_retries        => max_retries,
-          :retry_waitsec      => retry_waitsec
+          :retry_waitsec      => retry_waitsec,
+          :fog_options        => fog_options
         )
       end
 

data/lib/backup/storage/s3.rb

@@ -62,6 +62,11 @@ module Backup
       # Default: :standard
       attr_accessor :storage_class
 
+      ##
+      # Additional options to pass along to fog.
+      # e.g. Fog::Storage.new({ :provider => 'AWS' }.merge(fog_options))
+      attr_accessor :fog_options
+
       def initialize(model, storage_id = nil)
         super
 
@@ -88,7 +93,8 @@ module Backup
           :storage_class      => storage_class,
           :max_retries        => max_retries,
           :retry_waitsec      => retry_waitsec,
-          :chunk_size         => chunk_size
+          :chunk_size         => chunk_size,
+          :fog_options        => fog_options
         )
       end
 

data/lib/backup/syncer/cloud/cloud_files.rb

@@ -28,6 +28,11 @@ module Backup
         # (LAN-based transfers to avoid charges and improve performance)
         attr_accessor :servicenet
 
+        ##
+        # Additional options to pass along to fog.
+        # e.g. Fog::Storage.new({ :provider => 'Rackspace' }.merge(fog_options))
+        attr_accessor :fog_options
+
         def initialize(syncer_id = nil)
           super
 
@@ -50,7 +55,8 @@ module Backup
             :retry_waitsec      => retry_waitsec,
             # Syncer can not use SLOs.
             :segments_container => nil,
-            :segment_size       => 0
+            :segment_size       => 0,
+            :fog_options        => fog_options
           )
         end
 

data/lib/backup/syncer/cloud/s3.rb

@@ -40,6 +40,11 @@ module Backup
         # Default: :standard
         attr_accessor :storage_class
 
+        ##
+        # Additional options to pass along to fog.
+        # e.g. Fog::Storage.new({ :provider => 'AWS' }.merge(fog_options))
+        attr_accessor :fog_options
+
         def initialize(syncer_id = nil)
           super
 
@@ -62,7 +67,8 @@ module Backup
             :max_retries        => max_retries,
             :retry_waitsec      => retry_waitsec,
             # Syncer can not use multipart upload.
-            :chunk_size         => 0
+            :chunk_size         => 0,
+            :fog_options        => fog_options
           )
         end
 

data/lib/backup/version.rb

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

data/templates/cli/config

@@ -16,7 +16,7 @@
 # If you need to use a utility other than the one Backup detects,
 # or a utility can not be found in your $PATH.
 #
-#   Backup::Utilities.configure do
+#   Utilities.configure do
 #     tar       '/usr/bin/gnutar'
 #     redis_cli '/opt/redis/redis-cli'
 #   end
@@ -27,7 +27,7 @@
 # Logging options may be set on the command line, but certain settings
 # may only be configured here.
 #
-#   Backup::Logger.configure do
+#   Logger.configure do
 #     console.quiet     = true            # Same as command line: --quiet
 #     logfile.max_bytes = 2_000_000       # Default: 500_000
 #     syslog.enabled    = true            # Same as command line: --syslog
@@ -45,15 +45,48 @@
 # Set default options to be applied to components in all models.
 # Options set within a model will override those set here.
 #
-#   Backup::Storage::S3.defaults do |s3|
+#   Storage::S3.defaults do |s3|
 #     s3.access_key_id     = "my_access_key_id"
 #     s3.secret_access_key = "my_secret_access_key"
 #   end
 #
-#   Backup::Encryptor::OpenSSL.defaults do |encryption|
-#     encryption.password = "my_password"
-#     encryption.base64   = true
-#     encryption.salt     = true
+#   Notifier::Mail.defaults do |mail|
+#     mail.from                 = 'sender@email.com'
+#     mail.to                   = 'receiver@email.com'
+#     mail.address              = 'smtp.gmail.com'
+#     mail.port                 = 587
+#     mail.domain               = 'your.host.name'
+#     mail.user_name            = 'sender@email.com'
+#     mail.password             = 'my_password'
+#     mail.authentication       = 'plain'
+#     mail.encryption           = :starttls
+#   end
+
+##
+# Preconfigured Models
+#
+# Create custom models with preconfigured components.
+# Components added within the model definition will
+# +add to+ the preconfigured components.
+#
+#   preconfigure 'MyModel' do
+#     archive :user_pictures do |archive|
+#       archive.add '~/pictures'
+#     end
+#
+#     notify_by Mail do |mail|
+#       mail.to = 'admin@email.com'
+#     end
+#   end
+#
+#   MyModel.new(:john_smith, 'John Smith Backup') do
+#     archive :user_music do |archive|
+#       archive.add '~/music'
+#     end
+#
+#     notify_by Mail do |mail|
+#       mail.to = 'john.smith@email.com'
+#     end
 #   end
 
 

data/templates/cli/model.erb

@@ -6,7 +6,7 @@
 #
 # $ backup perform -t <%= @options[:trigger] %> [-c <path_to_configuration_file>]
 #
-Backup::Model.new(:<%= @options[:trigger] %>, 'Description for <%= @options[:trigger] %>') do
+Model.new(:<%= @options[:trigger] %>, 'Description for <%= @options[:trigger] %>') do
 <% if @options[:splitter] %>
 <%= Backup::Template.new.result("cli/splitter") %>
 <% end; if @options[:archives] %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder