backup 2.3.0.3 → 2.3.1

data/CHANGELOG

@@ -1,7 +1,7 @@
 PATCH
-=== 2.3.2 ====================================
+=== 2.3.0.3 ====================================
 
-	- Small bug was patched. Error would occur when a list of triggers should be shown
+  - Small bug was patched. Error would occur when a list of triggers should be shown
 	
 
 BIG UPDATE

data/README.textile

@@ -4,27 +4,56 @@ h2. A Backup Ruby Gem
 
 Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with and without the Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as MySQL/PostgreSQL and Files/Folders. All backups can be transferred to Amazon S3 or any remote server you have access to, using either SCP, SFTP or regular FTP. Backup handles Compression, Archiving, Encryption and Backup Cleaning (Cycling).
 
-h2. New Commands as of 2.3.0.2
+h2. Email Notification as of 2.3.1!
 
-*Finders*
+The first thing you will notice when you re-generate a new copy of the default "backup.rb" template, will be this:
 
-Unix Environment:
+bc.. notifier_settings do
+  
+  to    "example1@gmail.com"
+  from  "example2@gmail.com"
+  
+  smtp do
+    host            "smtp.gmail.com"
+    port            "587"
+    username        "example1@gmail.com"
+    password        "example1password"
+    authentication  "plain"
+    domain          "localhost.localdomain"
+    tls             true
+  end
+
+end
 
-bc. sudo backup --find [trigger]
 
-Rails Environment:
 
-bc. rake backup:find trigger='trigger'
 
-*Finders in Table Format*
 
-Unix Environment:
+p. This is disabled by default. You must uncomment it. Once you uncomment it, fill in your credentials. By default I setup a "gmail"-based configuration.
+Once you've filled in your smtp credentials, all you have to do is set "notify false" to "notify true" inside each *backup* block you wish to be notified of on each successful backup.
+
+
+bc.. backup 'mysql-backup-s3' do
+  
+  adapter :mysql do
+    ...
+  end
+  
+  storage :s3 do
+    ...
+  end
+  
+  keep_backups 25
+  encrypt_with_password 'password'
+  notify false # set this to "true"
+  
+end
+
+
 
-bc. sudo backup --table --find [trigger]
 
-Rails Environment:
 
-bc. rake backup:find trigger='trigger' table=true
+p. And that's it! Now after every 'mysql-backup-s3', given you've provided the correct smtp configuration, you will be notified of each backup that has been created by email!
 
 
 h2. Backup goes independent with the release of version 2.3.0! Ruby on Rails is no longer "required"!

data/Rakefile

@@ -24,6 +24,7 @@ begin
     gem.add_dependency "activerecord",  ">= 2.3.5"
     gem.add_dependency "sqlite3-ruby",  ">= 1.2.5"
     gem.add_dependency "hirb",          ">= 0.2.9"
+    gem.add_dependency "pony",          ">= 0.5"
     
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-2.3.0.3
+2.3.1

data/backup.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backup}
-  s.version = "2.3.0.3"
+  s.version = "2.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael van Rooijen"]
-  s.date = %q{2009-12-18}
+  s.date = %q{2010-01-08}
   s.default_executable = %q{backup}
   s.description = %q{
                             Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with and without the
@@ -48,11 +48,15 @@ Gem::Specification.new do |s|
      "lib/backup/configuration/adapter_options.rb",
      "lib/backup/configuration/base.rb",
      "lib/backup/configuration/helpers.rb",
+     "lib/backup/configuration/mail.rb",
+     "lib/backup/configuration/smtp.rb",
      "lib/backup/configuration/storage.rb",
      "lib/backup/connection/s3.rb",
      "lib/backup/environment/base.rb",
      "lib/backup/environment/rails.rb",
      "lib/backup/environment/unix.rb",
+     "lib/backup/mail/base.rb",
+     "lib/backup/mail/mail.txt",
      "lib/backup/record/ftp.rb",
      "lib/backup/record/s3.rb",
      "lib/backup/record/scp.rb",
@@ -82,6 +86,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
       s.add_runtime_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
       s.add_runtime_dependency(%q<hirb>, [">= 0.2.9"])
+      s.add_runtime_dependency(%q<pony>, [">= 0.5"])
     else
       s.add_dependency(%q<aws-s3>, [">= 0.6.2"])
       s.add_dependency(%q<net-ssh>, [">= 2.0.15"])
@@ -90,6 +95,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activerecord>, [">= 2.3.5"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
       s.add_dependency(%q<hirb>, [">= 0.2.9"])
+      s.add_dependency(%q<pony>, [">= 0.5"])
     end
   else
     s.add_dependency(%q<aws-s3>, [">= 0.6.2"])
@@ -99,6 +105,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activerecord>, [">= 2.3.5"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
     s.add_dependency(%q<hirb>, [">= 0.2.9"])
+    s.add_dependency(%q<pony>, [">= 0.5"])
   end
 end
 

data/generators/backup/templates/config/backup.rb

@@ -40,10 +40,35 @@
 #
 # The combination of these, however, do not matter! So experiment with it.
 # 
+# You can also let Backup notify you by email on successfully created backups.
+# - Just uncomment the block of code below (notifier_settings) and fill in your credentials.
+# - Then for set "notify" to "true" in each (backup) block you wish to be notified of.
+# 
 # For more information on "Backup", please refer to the wiki on github
 #   http://wiki.github.com/meskyanichi/backup/configuration-file
 
 
+# Notifier
+#   Uncomment this if you want to enable notification by email on successful backup runs
+#   You will also have to set "notify true" inside each backup block below to enable it for that particular backup
+# notifier_settings do
+#   
+#   to    "example1@gmail.com"
+#   from  "example2@gmail.com"
+#   
+#   smtp do
+#     host            "smtp.gmail.com"
+#     port            "587"
+#     username        "example1@gmail.com"
+#     password        "example1password"
+#     authentication  "plain"
+#     domain          "localhost.localdomain"
+#     tls             true
+#   end
+# 
+# end
+
+
 # Initialize with:
 #   rake backup:run trigger='mysql-backup-s3'
 backup 'mysql-backup-s3' do
@@ -72,6 +97,7 @@ backup 'mysql-backup-s3' do
   
   keep_backups 25
   encrypt_with_password 'password'
+  notify false
   
 end
 
@@ -103,7 +129,8 @@ backup 'postgresql-backup-scp' do
 
   keep_backups :all
   encrypt_with_password false
-  
+  notify false
+
 end
 
 
@@ -125,7 +152,8 @@ backup 'archive-backup-ftp' do
 
   keep_backups 10
   encrypt_with_password false
-  
+  notify false
+
 end
 
 
@@ -149,5 +177,6 @@ backup 'custom-backup-sftp' do
 
   keep_backups :all
   encrypt_with_password 'password'
+  notify false
   
 end

data/lib/backup.rb

@@ -1,27 +1,24 @@
-#
 # Load Gems
-#
 require 'net/ssh'
 require 'net/scp'
 require 'net/ftp'
 require 'net/sftp'
 require 'aws/s3'
+require 'pony'
 require 'hirb'
 
-#
 # Load Environments
-# 
 require 'backup/environment/base'
 require 'backup/environment/unix'
 require 'backup/environment/rails'
 
-#
 # Load Configuration
-# 
 require 'backup/configuration/base'
 require 'backup/configuration/adapter'
 require 'backup/configuration/adapter_options'
 require 'backup/configuration/storage'
+require 'backup/configuration/mail'
+require 'backup/configuration/smtp'
 require 'backup/configuration/helpers'
 
 # Include the Configuration adn Environment Helpers  
@@ -39,31 +36,29 @@ if File.exist?(File.join(BACKUP_PATH, 'config', 'backup.rb'))
   require File.join(BACKUP_PATH, 'config', 'backup.rb')
 end
 
-#
+# Load Mail Notifier
+require 'backup/mail/base'
+
+# Set Mail Configuration (extracted from the backup.rb configuration file) inside the Mail Class
+Backup::Mail::Base.setup(@mail_configuration)
+
 # Load Adapters
-#
 require 'backup/adapters/base'
 require 'backup/adapters/mysql'
 require 'backup/adapters/postgresql'
 require 'backup/adapters/archive'
 require 'backup/adapters/custom'
 
-#
 # Load Connectors
-# 
 require 'backup/connection/s3'
 
-#
 # Load Storage
-#
 require 'backup/storage/s3'
 require 'backup/storage/scp'
 require 'backup/storage/ftp'
 require 'backup/storage/sftp'
 
-#
 # Backup Recorders
-#
 require 'backup/record/s3'
 require 'backup/record/scp'
 require 'backup/record/ftp'

data/lib/backup/adapters/archive.rb

@@ -25,6 +25,7 @@ module Backup
           encrypt
           store
           record
+          notify
         ensure
           remove_tmp_files
         end
@@ -36,8 +37,10 @@ module Backup
         def targz
           files = procedure.get_adapter_configuration.attributes['files']
           if files.is_a?(Array)
+            puts system_messages[:archiving]; puts system_messages[:compressing]
             %x{ tar -czf #{File.join(tmp_path, compressed_file)} #{files.map{|f| f.gsub(' ', '\ ')}.join(' ')} }
           elsif files.is_a?(String)
+            puts system_messages[:archiving]; puts system_messages[:compressing]
             %x{ tar -czf #{File.join(tmp_path, compressed_file)} #{files.gsub(' ', '\ ')} }
           end
         end
@@ -45,6 +48,7 @@ module Backup
         # Encrypts the Archive
         def encrypt
           if encrypt_with_password.is_a?(String)
+            puts system_messages[:encrypting]
             %x{ openssl enc -des-cbc -in #{File.join(tmp_path, compressed_file)} -out #{File.join(tmp_path, encrypted_file)} -k #{encrypt_with_password} }
             self.final_file = encrypted_file
           end

data/lib/backup/adapters/base.rb

@@ -43,10 +43,10 @@ module Backup
       #  Remote Server (SFTP)
       def store
         case procedure.storage_name.to_sym
-          when :s3  then Backup::Storage::S3.new(self)
-          when :scp then Backup::Storage::SCP.new(self)
-          when :ftp then Backup::Storage::FTP.new(self)
-          when :sftp then Backup::Storage::SFTP.new(self)
+          when :s3    then Backup::Storage::S3.new(self)
+          when :scp   then Backup::Storage::SCP.new(self)
+          when :ftp   then Backup::Storage::FTP.new(self)
+          when :sftp  then Backup::Storage::SFTP.new(self)
         end
       end
       
@@ -72,6 +72,22 @@ module Backup
         end
       end
       
+      # Delivers a notification by email regarding the successfully stored backup
+      def notify
+        if Backup::Mail::Base.setup?
+          Backup::Mail::Base.notify!(self)
+        end
+      end
+      
+      def system_messages
+        { :compressing  => "Compressing backup..",
+          :archiving    => "Archiving backup..",
+          :encrypting   => "Encrypting backup..",
+          :mysqldump    => "Creating MySQL dump..",
+          :pgdump       => "Creating PostgreSQL dump..",
+          :commands     => "Executing commands.." }
+      end
+      
     end
   end
 end

data/lib/backup/adapters/custom.rb

@@ -27,6 +27,7 @@ module Backup
           encrypt
           store
           record
+          notify
         ensure
           remove_tmp_files
         end
@@ -37,22 +38,26 @@ module Backup
         # Executes the commands
         def execute_commands
           if commands.is_a?(Array)
+            puts system_messages[:commands]
             commands.each do |command|
               %x{ #{command.gsub(':tmp_path', tmp_path)} }
             end
           elsif commands.is_a?(String)
+            puts system_messages[:commands]
             %x{ #{commands.gsub(':tmp_path', tmp_path)} }
           end
         end
         
         # Archives and Compresses
         def targz
+          puts system_messages[:archiving]; puts system_messages[:compressing]
           %x{ tar -czf #{File.join(tmp_path, compressed_file)} #{File.join(tmp_path, '*')} }
         end
         
         # Encrypts the archive file
         def encrypt
           if encrypt_with_password.is_a?(String)
+            puts system_messages[:encrypting]
             %x{ openssl enc -des-cbc -in #{File.join(tmp_path, compressed_file)} -out #{File.join(tmp_path, encrypted_file)} -k #{encrypt_with_password} }
             self.final_file = encrypted_file
           end

data/lib/backup/adapters/mysql.rb

@@ -25,6 +25,7 @@ module Backup
           encrypt
           store
           record
+          notify
         ensure
           remove_tmp_files
         end
@@ -34,12 +35,14 @@ module Backup
         
         # Dumps and Compresses the MySQL file 
         def mysqldump
+          puts system_messages[:mysqldump]; puts system_messages[:compressing]
           %x{ mysqldump -u #{user} --password='#{password}' #{options} #{additional_options} #{database} #{tables_to_skip} | gzip -f --best > #{File.join(tmp_path, compressed_file)} }
         end
         
         # Encrypts the MySQL file
         def encrypt
           if encrypt_with_password.is_a?(String)
+            puts system_messages[:encrypting]
             %x{ openssl enc -des-cbc -in #{File.join(tmp_path, compressed_file)} -out #{File.join(tmp_path, encrypted_file)} -k #{encrypt_with_password} }
             self.final_file = encrypted_file
           end

data/lib/backup/adapters/postgresql.rb

@@ -25,6 +25,7 @@ module Backup
           encrypt
           store
           record
+          notify
         ensure
           remove_tmp_files
         end
@@ -34,12 +35,14 @@ module Backup
         
         # Dumps and Compresses the PostgreSQL file 
         def pg_dump
+            puts system_messages[:pgdump]; puts system_messages[:compressing]
            %x{ pg_dump -U #{user} #{options} #{additional_options} #{tables_to_skip} #{database} | gzip -f --best > #{File.join(tmp_path, compressed_file)} }
         end
         
         # Encrypts the PostgreSQL file
         def encrypt
           if encrypt_with_password.is_a?(String)
+            puts system_messages[:encrypting]
             %x{ openssl enc -des-cbc -in #{File.join(tmp_path, compressed_file)} -out #{File.join(tmp_path, encrypted_file)} -k #{encrypt_with_password} }
             self.final_file = encrypted_file
           end

data/lib/backup/configuration/base.rb

@@ -3,7 +3,7 @@ module Backup
     class Base
       attr_accessor :attributes, :trigger, :storage_name, :adapter_name
 
-      %w(encrypt_with_password keep_backups).each do |method|
+      %w(encrypt_with_password keep_backups notify).each do |method|
         define_method method do |value|
           attributes[method] = value
         end

data/lib/backup/configuration/helpers.rb

@@ -12,6 +12,13 @@ module Backup
         @backup_procedures << backup
       end
       
+      # A helper method for the config/mail.rb configuration file
+      # Takes a block containing the mail options
+      def notifier_settings(&block)
+        @mail_configuration = Backup::Configuration::Mail.new
+        @mail_configuration.instance_eval &block
+      end
+      
     end
   end
 end

data/lib/backup/configuration/mail.rb

@@ -0,0 +1,26 @@
+module Backup
+  module Configuration
+    class Mail
+      attr_accessor :attributes
+
+      %w(from to smtp).each do |method|
+        define_method method do |value|
+          attributes[method.to_sym] = value
+        end
+      end
+
+      def initialize
+        @attributes = {}
+        @smtp_configuration = Backup::Configuration::SMTP.new
+      end
+
+      def smtp(&block)
+        @smtp_configuration.instance_eval &block
+      end
+    
+      def get_smtp_configuration
+        @smtp_configuration
+      end
+    end
+  end
+end

data/lib/backup/configuration/smtp.rb

@@ -0,0 +1,19 @@
+module Backup
+  module Configuration
+    class SMTP
+      
+      attr_accessor :attributes 
+      
+      %w(host port username password authentication domain tls).each do |method|
+        define_method method do |value|
+          attributes[method.to_sym] = value
+        end
+      end
+
+      def initialize
+        @attributes = {}
+      end
+      
+    end
+  end
+end

data/lib/backup/mail/base.rb

@@ -0,0 +1,89 @@
+module Backup
+  module Mail
+    class Base
+      
+      # Sets up the Mail Configuration for the Backup::Mail::Base class.
+      # This must be set in order to send emails
+      # It will dynamically add class methods (configuration) for each email that will be sent
+      def self.setup(config)
+        if config
+          (class << self; self; end).instance_eval do
+            config.attributes.each do |method, value|
+              define_method method do
+                value
+              end
+            end
+            config.get_smtp_configuration.attributes.each do |method, value|
+              define_method method do
+                value
+              end
+            end
+          end
+        end
+      end
+      
+      # Returns true if the "to" and "from" attributes are set
+      def self.setup?
+        return true if defined?(from) and defined?(to)
+        false
+      end
+      
+      # Delivers the backup details by email to the recipient
+      # Requires the Backup Object
+      def self.notify!(backup)
+        if self.setup? and backup.procedure.attributes['notify'].eql?(true)
+          @backup = backup
+          self.parse_body
+          Pony.mail({
+            :subject  => "Backup for \"#{@backup.trigger}\" was successfully created!",
+            :body     => @content
+            }.merge(self.smtp_configuration))
+          puts "Sending notification to #{self.to}."
+        end
+      end
+            
+      # Retrieves SMTP configuration
+      def self.smtp_configuration
+        { :to       => self.to,
+          :from     => self.from,
+          :via      => :smtp,
+          :smtp     => {
+          :host     => self.host,
+          :port     => self.port,
+          :user     => self.username,
+          :password => self.password,
+          :auth     => self.authentication,
+          :domain   => self.domain,
+          :tls      => self.tls
+        }}
+      end
+      
+      def self.parse_body
+        File.open(File.join(File.dirname(__FILE__), 'mail.txt'), 'r') do |file|
+          self.gsub_content(file.readlines)
+        end
+      end
+      
+      def self.gsub_content(lines)
+        bucket  = @backup.procedure.get_storage_configuration.attributes['bucket']
+        path    = @backup.procedure.get_storage_configuration.attributes['path']
+        ip      = @backup.procedure.get_storage_configuration.attributes['ip']
+        
+        lines.each do |line|
+          line.gsub!(':trigger',   @backup.trigger)
+          line.gsub!(':day',       Time.now.strftime("%A (%d)"))
+          line.gsub!(':month',     Time.now.strftime("%B"))
+          line.gsub!(':year',      Time.now.strftime("%Y"))
+          line.gsub!(':time',      Time.now.strftime("%r"))
+          line.gsub!(':adapter',   @backup.procedure.adapter_name.to_s)
+          line.gsub!(':location',  bucket || path)
+          line.gsub!(':remote',    bucket ? "Amazon S3" : "the remote server (#{ip})")
+          line.gsub!(':backup',    @backup.final_file)
+          @content ||= String.new
+          @content << line
+        end
+      end
+
+    end
+  end
+end

data/lib/backup/mail/mail.txt

@@ -0,0 +1,7 @@
+A backup was successfully created for ":trigger"!
+
+The backup was created on ":day of :month :year at :time".
+
+It has been stored using the ":adapter" adapter, and the file was stored in :location on :remote.
+
+The following backup was stored: ":backup"

data/setup/backup.rb

@@ -39,10 +39,35 @@
 #
 # The combination of these, however, do not matter! So experiment with it.
 # 
+# You can also let Backup notify you by email on successfully created backups.
+# - Just uncomment the block of code below (notifier_settings) and fill in your credentials.
+# - Then for set "notify" to "true" in each (backup) block you wish to be notified of.
+#
 # For more information on "Backup", please refer to the wiki on github
 #   http://wiki.github.com/meskyanichi/backup/configuration-file
 
 
+# Notifier
+#   Uncomment this if you want to enable notification by email on successful backup runs
+#   You will also have to set "notify true" inside each backup block below to enable it for that particular backup
+# notifier_settings do
+#   
+#   to    "example1@gmail.com"
+#   from  "example2@gmail.com"
+#   
+#   smtp do
+#     host            "smtp.gmail.com"
+#     port            "587"
+#     username        "example1@gmail.com"
+#     password        "example1password"
+#     authentication  "plain"
+#     domain          "localhost.localdomain"
+#     tls             true
+#   end
+# 
+# end
+
+
 # Initialize with:
 #  sudo backup --run mysql-backup-s3
 backup 'mysql-backup-s3' do
@@ -71,6 +96,7 @@ backup 'mysql-backup-s3' do
   
   keep_backups 25
   encrypt_with_password 'password'
+  notify false
   
 end
 
@@ -102,6 +128,7 @@ backup 'postgresql-backup-scp' do
 
   keep_backups :all
   encrypt_with_password false
+  notify false
   
 end
 
@@ -124,6 +151,7 @@ backup 'archive-backup-ftp' do
 
   keep_backups 10
   encrypt_with_password false
+  notify false
   
 end
 
@@ -148,5 +176,6 @@ backup 'custom-backup-sftp' do
 
   keep_backups :all
   encrypt_with_password 'password'
-  
+  notify false
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backup
 version: !ruby/object:Gem::Version 
-  version: 2.3.0.3
+  version: 2.3.1
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 +01:00
+date: 2010-01-08 00:00:00 +01:00
 default_executable: backup
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.2.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
 description: "\n                            Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with and without the\n                            Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as\n                            MySQL/PostgreSQL and Files/Folders. All backups can be transferred to Amazon S3 or any remote server you\n                            have access to, using either SCP, SFTP or regular FTP. Backup handles Compression, Archiving, Encryption\n                            and Backup Cleaning (Cycling).\n                        "
 email: meskyan@gmail.com
 executables: 
@@ -115,11 +125,15 @@ files:
 - lib/backup/configuration/adapter_options.rb
 - lib/backup/configuration/base.rb
 - lib/backup/configuration/helpers.rb
+- lib/backup/configuration/mail.rb
+- lib/backup/configuration/smtp.rb
 - lib/backup/configuration/storage.rb
 - lib/backup/connection/s3.rb
 - lib/backup/environment/base.rb
 - lib/backup/environment/rails.rb
 - lib/backup/environment/unix.rb
+- lib/backup/mail/base.rb
+- lib/backup/mail/mail.txt
 - lib/backup/record/ftp.rb
 - lib/backup/record/s3.rb
 - lib/backup/record/scp.rb