dmitryv-backup 2.4.0

data/lib/backup/configuration/base.rb

@@ -0,0 +1,77 @@
+module Backup
+  module Configuration
+    class Base
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(encrypt_with_password encrypt_with_gpg_public_key keep_backups notify)
+      
+      attr_accessor :trigger, :storage_name, :adapter_name
+
+      def initialize(trigger)
+        @trigger = trigger
+        @adapter_configuration = Backup::Configuration::Adapter.new
+        @storage_configuration = Backup::Configuration::Storage.new
+        @compressor = :gzip
+      end
+
+      def adapter(adapter, &block)
+        @adapter_name = adapter
+        @adapter_configuration.instance_eval &block
+      end
+  
+      def storage(storage, &block)
+        @storage_name = storage
+        @storage_configuration.instance_eval &block
+      end
+
+      def compressor(compressor)
+        @compressor = compressor
+      end
+
+      def storage_class
+        case @storage_name.to_sym
+          when :cloudfiles then Backup::Storage::CloudFiles
+          when :s3         then Backup::Storage::S3
+          when :scp        then Backup::Storage::SCP
+          when :ftp        then Backup::Storage::FTP
+          when :sftp       then Backup::Storage::SFTP
+          when :local      then Backup::Storage::Local
+        end
+      end
+
+      def record_class
+        case @storage_name.to_sym
+          when :cloudfiles then Backup::Record::CloudFiles
+          when :s3         then Backup::Record::S3
+          when :scp        then Backup::Record::SCP
+          when :ftp        then Backup::Record::FTP
+          when :sftp       then Backup::Record::SFTP
+          when :local      then Backup::Record::Local
+        end        
+      end
+
+      def compressor_class
+        case @compressor.to_sym
+          when :gzip       then Backup::Compressors::Gzip
+          when :seven_zip  then Backup::Compressors::SevenZip 
+        end
+      end
+
+      # Initializes the storing process depending on the store settings
+      def initialize_storage(adapter)
+        storage_class.new(adapter)
+      end
+
+      def initialize_record
+        record_class.new
+      end
+  
+      def get_adapter_configuration
+        @adapter_configuration
+      end
+  
+      def get_storage_configuration
+        @storage_configuration
+      end
+    end
+  end
+end

data/lib/backup/configuration/helpers.rb

@@ -0,0 +1,24 @@
+module Backup
+  module Configuration
+    module Helpers
+      
+      # A helper method for the config/backup.rb configuration file
+      # Expects a trigger in argument one (STRING)
+      # Expects a block of settings
+      def backup(trigger, &block)
+        backup = Backup::Configuration::Base.new(trigger)
+        backup.instance_eval &block
+        @backup_procedures ||= Array.new
+        @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,20 @@
+module Backup
+  module Configuration
+    class Mail
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(from to smtp)
+
+      def initialize
+        @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,8 @@
+module Backup
+  module Configuration
+    class SMTP
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(host port username password authentication domain tls)
+    end
+  end
+end

data/lib/backup/configuration/storage.rb

@@ -0,0 +1,8 @@
+module Backup
+  module Configuration
+    class Storage
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(ip user password path access_key_id secret_access_key use_ssl bucket username api_key container)
+    end
+  end
+end

data/lib/backup/connection/cloudfiles.rb

@@ -0,0 +1,75 @@
+require 'cloudfiles'
+
+module Backup
+  module Connection
+    class CloudFiles
+
+      attr_accessor :adapter, :procedure, :api_key, :username, :cf_container, :final_file, :tmp_path
+
+      # Initializes the Cloud Files connection, setting the values using the
+      # Cloud Files adapter
+      def initialize(adapter = false)
+        if adapter
+          self.adapter            = adapter
+          self.procedure          = adapter.procedure
+          self.final_file         = adapter.final_file
+          self.tmp_path           = adapter.tmp_path.gsub('\ ', ' ')
+          load_storage_configuration_attributes
+        end
+      end
+
+      # Sets values from a procedure, rather than from the adapter object
+      def static_initialize(procedure)
+        self.procedure = procedure
+        load_storage_configuration_attributes(true)
+      end
+
+      # Establishes a connection with Rackspace Cloud Files using the
+      # credentials provided by the user
+      def connect
+        connection
+      end
+
+      # Wrapper for the Connection object
+      def connection
+        ::CloudFiles::Connection.new(username, api_key)
+      end
+
+      # Wrapper for the Container object
+      def container
+        connection.container(cf_container)
+      end
+
+      # Initializes the file transfer to Rackspace Cloud Files
+      # This can only run after a connection has been made using the #connect method
+      def store
+        object = container.create_object(final_file)
+        object.write(open(File.join(tmp_path, final_file)))
+      end
+
+      # Destroys file from a bucket on Amazon S3
+      def destroy(file, c)
+        c = connection.container(c)
+        c.delete_object(file)
+      end
+
+      private
+
+        def load_storage_configuration_attributes(static = false)
+          %w(api_key username).each do |attribute|
+            if static
+              send("#{attribute}=", procedure.get_storage_configuration.attributes[attribute])
+            else
+              send("#{attribute}=", adapter.procedure.get_storage_configuration.attributes[attribute])
+            end
+          end
+
+          if static
+            self.cf_container = procedure.get_storage_configuration.attributes['container']
+          else
+            self.cf_container = adapter.procedure.get_storage_configuration.attributes['container']
+          end
+        end
+    end
+  end
+end

data/lib/backup/connection/s3.rb

@@ -0,0 +1,85 @@
+require 's3'
+
+module Backup
+  module Connection
+    class S3
+      
+      attr_accessor :adapter, :procedure, :access_key_id, :secret_access_key, :s3_bucket, :use_ssl, :final_file, :tmp_path
+      
+      # Initializes the S3 connection, setting the values using the S3 adapter
+      def initialize(adapter = false)
+        if adapter
+          self.adapter            = adapter
+          self.procedure          = adapter.procedure
+          self.final_file         = adapter.final_file
+          self.tmp_path           = adapter.tmp_path.gsub('\ ', ' ')
+          load_storage_configuration_attributes
+        end
+      end
+      
+      # Sets values from a procedure, rather than from the adapter object
+      def static_initialize(procedure)
+        self.procedure = procedure
+        load_storage_configuration_attributes(true)
+      end
+      
+      # Establishes a connection with Amazon S3 using the credentials provided by the user
+      def connect
+        service
+      end
+
+      # Wrapper for the Service object
+      def service
+        ::S3::Service.new(:access_key_id => access_key_id,
+                          :secret_access_key => secret_access_key,
+                          :use_ssl => use_ssl)
+      end
+
+      # Wrapper for the Bucket object
+      def bucket
+        begin
+          # Find existing bucket:
+          bucket = service.buckets.find(s3_bucket)
+        rescue ::S3::Error::NoSuchBucket => e
+          # Apparently the bucket doesn't exist yet, so create a new one:
+          bucket = service.buckets.build(s3_bucket)
+          bucket.save
+        end
+        bucket.retrieve
+      end
+
+      # Initializes the file transfer to Amazon S3
+      # This can only run after a connection has been made using the #connect method 
+      def store
+        object = bucket.objects.build(final_file)
+        object.content = open(File.join(tmp_path, final_file))
+        object.save
+      end
+
+      # Destroys file from a bucket on Amazon S3
+      def destroy(file, bucket_as_string)
+        object = bucket.objects.find(file)
+        object.destroy
+      end
+
+      private
+
+        def load_storage_configuration_attributes(static = false)          
+          %w(access_key_id secret_access_key use_ssl).each do |attribute|
+            if static
+              send("#{attribute}=", procedure.get_storage_configuration.attributes[attribute])
+            else
+              send("#{attribute}=", adapter.procedure.get_storage_configuration.attributes[attribute])
+            end
+          end
+          
+          if static
+            self.s3_bucket = procedure.get_storage_configuration.attributes['bucket']
+          else
+            self.s3_bucket = adapter.procedure.get_storage_configuration.attributes['bucket']
+          end
+        end
+        
+    end
+  end 
+end

data/lib/backup/environment/base.rb

@@ -0,0 +1,12 @@
+module Backup
+  module Environment
+    module Base
+      
+      def current_environment
+        return :rails if defined?(Rails.root)
+        return :unix
+      end
+      
+    end
+  end
+end

data/lib/backup/environment/rails_configuration.rb

@@ -0,0 +1,15 @@
+module Backup
+  module Environment
+    module RailsConfiguration
+      
+      if defined?(Rails.root)
+        # Sets BACKUP_PATH equal to Rails.root
+        BACKUP_PATH = Rails.root.to_s
+      
+        # Sets DB_CONNECTION_SETTINGS to false
+        DB_CONNECTION_SETTINGS = false
+      end
+    
+    end
+  end
+end

data/lib/backup/environment/unix_configuration.rb

@@ -0,0 +1,109 @@
+module Backup
+  module Environment
+    module UnixConfiguration
+      
+      require 'active_record'
+      
+      # Sets BACKUP_PATH
+      BACKUP_PATH = ENV['BACKUP_PATH'] || "/opt/backup"
+      
+      # Sets DB_CONNECTION_SETTINGS
+      DB_CONNECTION_SETTINGS = {
+        :adapter  => "sqlite3",
+        :database => "#{BACKUP_PATH}/backup.sqlite3",
+        :pool     => 5,
+        :timeout  => 5000 
+      }
+
+      module Commands
+        
+        def setup
+          unless File.directory?(BACKUP_PATH)
+            puts "Installing Backup in #{BACKUP_PATH}.."
+            %x{ #{sudo} mkdir -p #{File.join(BACKUP_PATH, 'config')} }
+            %x{ #{sudo} cp #{File.join(File.dirname(__FILE__), '..', '..', '..', 'setup', 'backup.sqlite3')} #{BACKUP_PATH} }
+            %x{ #{sudo} cp #{File.join(File.dirname(__FILE__), '..', '..', '..', 'setup', 'backup.rb')} #{File.join(BACKUP_PATH, 'config')} }
+            puts <<-MESSAGE
+              
+  ==============================================================
+  Backup has been set up!
+  ==============================================================
+
+  1: Set up some "Backup Settings" inside the configuration file!
+
+    #{BACKUP_PATH}/config/backup.rb
+
+
+  2: Run the backups!
+
+    sudo backup --run [trigger]
+
+
+  For a list of Backup commands:
+
+    sudo backup --help
+  
+
+  For More Information:
+
+    http://github.com/meskyanichi/backup
+
+  ==============================================================
+              
+            MESSAGE
+          else
+            puts "\nBackup is already installed in #{BACKUP_PATH}..\n"
+            puts "If you want to reset it, run:\n\nbackup --reset\n\n"
+            puts "This will reinstall it."
+            puts "Warning: All configuration will be lost!\n\n"
+          end
+        end
+
+        def reset
+          if File.directory?(BACKUP_PATH)
+            remove
+            setup
+          else
+            puts "Backup is not installed.\n"
+            puts "Run the following command to install it:\n\nbackup --setup"
+          end
+        end
+
+        def remove
+          puts "Removing Backup..\n"
+          %x{ #{sudo} rm -rf #{BACKUP_PATH} }
+        end
+      end
+      
+      module Helpers
+
+        def confirm_configuration_file_existence
+          unless File.exist?(File.join(BACKUP_PATH, 'config', 'backup.rb'))
+            puts "\nBackup could not find the Backup Configuration File."
+            puts "Did you set up Backup? Do so if you haven't yet:"
+            puts "\nbackup --setup\n "
+            exit
+          end
+        end
+
+        def sudo
+          if writable?(BACKUP_PATH)
+            ""
+          else
+            "sudo"
+          end
+        end
+
+        private
+        def writable?(f)
+          unless File.exists?(f)
+            writable?(File.dirname(f))
+          else
+            File.writable?(f)
+          end
+        end
+      end
+    
+    end
+  end
+end

data/lib/backup/mail/base.rb

@@ -0,0 +1,97 @@
+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)
+          require 'pony'
+
+          @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)
+        container = @backup.procedure.get_storage_configuration.attributes['container']
+        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',  container || bucket || path)
+          line.gsub!(':backup',    @backup.final_file)
+          case @backup.procedure.storage_name.to_sym
+            when :cloudfiles        then line.gsub!(':remote', "on Rackspace Cloudfiles")
+            when :s3                then line.gsub!(':remote', "on Amazon S3")
+            when :local             then line.gsub!(':remote', "on the local server")
+            when :scp, :sftp, :ftp  then line.gsub!(':remote', "on the remote server (#{ip})")
+          end
+          @content ||= String.new
+          @content << line
+        end
+      end
+
+    end
+  end
+end