backup-wakiki 2.4.1

data/lib/backup/adapters/mysql.rb

@@ -0,0 +1,60 @@
+module Backup
+  module Adapters
+    class MySQL < Backup::Adapters::Base
+      
+      attr_accessor :user, :password, :database, :skip_tables, :host, :port, :socket, :additional_options, :tables
+      
+      private
+
+        # Dumps and Compresses the MySQL file 
+        def perform
+          log system_messages[:mysqldump]; log system_messages[:compressing]
+          run "#{mysqldump} -u #{user} --password='#{password}' #{options} #{additional_options} #{database} #{tables_to_include} #{tables_to_skip} | gzip -f --best > #{File.join(tmp_path, compressed_file)}"
+        end
+
+        def mysqldump
+          # try to determine the full path, and fall back to myqsldump if not found
+          cmd = `which mysqldump`.chomp
+          cmd = 'mysqldump' if cmd.empty?
+          cmd
+        end
+        
+        def performed_file_extension
+          ".sql"
+        end
+
+        # Loads the initial settings
+        def load_settings
+          %w(user password database tables skip_tables additional_options).each do |attribute|
+            send(:"#{attribute}=", procedure.get_adapter_configuration.attributes[attribute])
+          end
+          
+          %w(host port socket).each do |attribute|
+            send(:"#{attribute}=", procedure.get_adapter_configuration.get_options.attributes[attribute])
+          end
+        end
+        
+        # Returns a list of options in MySQL syntax
+        def options
+          options = String.new
+          options += " --host='#{host}' "     unless host.blank?
+          options += " --port='#{port}' "     unless port.blank?
+          options += " --socket='#{socket}' " unless socket.blank?
+          options
+        end
+        
+        # Returns a list of tables to skip in MySQL syntax
+        def tables_to_skip
+          return "" unless skip_tables
+          [*skip_tables].map {|table| " --ignore-table='#{database}.#{table}' "}
+        end
+        
+        # Returns a list of tables to include in MySQL syntax
+        def tables_to_include
+          return "" unless tables
+          [*tables].join(" ")
+        end
+                
+    end
+  end
+end

data/lib/backup/adapters/postgresql.rb

@@ -0,0 +1,56 @@
+module Backup
+  module Adapters
+    class PostgreSQL < Backup::Adapters::Base
+
+      attr_accessor :user, :password, :database, :skip_tables, :host, :port, :socket, :additional_options
+      
+      private
+
+        # Dumps and Compresses the PostgreSQL file 
+        def perform
+          log system_messages[:pgdump]; log system_messages[:compressing]
+          ENV['PGPASSWORD'] = password
+          run "#{pg_dump} -U #{user} #{options} #{additional_options} #{tables_to_skip} #{database} | gzip -f --best > #{File.join(tmp_path, compressed_file)}"
+          ENV['PGPASSWORD'] = nil
+        end
+
+        def pg_dump
+          # try to determine the full path, and fall back to pg_dump if not found
+          cmd = `which pg_dump`.chomp
+          cmd = 'pg_dump' if cmd.empty?
+          cmd
+        end
+        
+        def performed_file_extension
+          ".sql"
+        end
+
+        # Loads the initial settings
+        def load_settings
+          %w(user password database skip_tables additional_options).each do |attribute|
+            send(:"#{attribute}=", procedure.get_adapter_configuration.attributes[attribute])
+          end
+          
+          %w(host port socket).each do |attribute|
+            send(:"#{attribute}=", procedure.get_adapter_configuration.get_options.attributes[attribute])
+          end
+        end
+        
+        # Returns a list of options in PostgreSQL syntax
+        def options
+          options = String.new
+          options += " --port='#{port}' "     unless port.blank?
+          options += " --host='#{host}' "     unless host.blank?
+          options += " --host='#{socket}' "   unless socket.blank?  unless options.include?('--host=')
+          options
+        end
+        
+        # Returns a list of tables to skip in PostgreSQL syntax
+        def tables_to_skip
+          return "" unless skip_tables
+          [*skip_tables].map {|table| " -T \"#{table}\" "}
+        end
+
+    end
+  end
+end

data/lib/backup/adapters/sqlite.rb

@@ -0,0 +1,25 @@
+module Backup
+  module Adapters
+    class SQLite < Base
+      
+      attr_accessor :database
+      
+      private
+
+        # Compress the sqlite file
+        def perform
+          log system_messages[:sqlite]
+          run "gzip -c --best #{database} > #{File.join(tmp_path, compressed_file)}"
+        end
+        
+        def load_settings
+          self.database = procedure.get_adapter_configuration.attributes['database']
+        end
+        
+        def performed_file_extension
+          ""
+        end
+
+    end
+  end
+end

data/lib/backup/command_helper.rb

@@ -0,0 +1,11 @@
+module Backup
+  module CommandHelper
+    def run(command)
+      Kernel.system command
+    end
+ 
+    def log(command)
+      puts "Backup => #{command}"
+    end
+  end
+end

data/lib/backup/configuration/adapter.rb

@@ -0,0 +1,21 @@
+module Backup
+  module Configuration
+    class Adapter
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(files exclude user password database tables skip_tables commands additional_options)
+
+      def initialize
+        @options = Backup::Configuration::AdapterOptions.new
+      end
+
+      def options(&block)
+        @options.instance_eval &block
+      end
+      
+      def get_options
+        @options
+      end
+
+    end
+  end
+end

data/lib/backup/configuration/adapter_options.rb

@@ -0,0 +1,8 @@
+module Backup
+  module Configuration
+    class AdapterOptions
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(host port socket)
+    end
+  end
+end

data/lib/backup/configuration/attributes.rb

@@ -0,0 +1,19 @@
+module Backup
+  module Configuration
+    module Attributes
+      
+      def generate_attributes(*attrs)
+        define_method :attributes do
+          @attributes ||= {}
+        end
+        
+        attrs.flatten.each do |att|
+          define_method att do |value|
+            self.attributes[att.to_s] = value
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/backup/configuration/base.rb

@@ -0,0 +1,55 @@
+module Backup
+  module Configuration
+    class Base
+      extend Backup::Configuration::Attributes
+      generate_attributes %w(encrypt_with_password 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
+      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
+
+      # Initializes the storing process depending on the store settings
+      def initialize_storage(adapter)
+        case @storage_name.to_sym
+          when :s3    then Backup::Storage::S3.new(adapter)
+          when :scp   then Backup::Storage::SCP.new(adapter)
+          when :ftp   then Backup::Storage::FTP.new(adapter)
+          when :sftp  then Backup::Storage::SFTP.new(adapter)
+          when :local then Backup::Storage::Local.new(adapter)
+        end
+      end
+
+      def initialize_record
+        case @storage_name.to_sym
+          when :s3    then Backup::Record::S3.new
+          when :scp   then Backup::Record::SCP.new
+          when :ftp   then Backup::Record::FTP.new
+          when :sftp  then Backup::Record::SFTP.new
+          when :local then Backup::Record::Local.new
+        end        
+      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)
+    end
+  end
+end

data/lib/backup/connection/s3.rb

@@ -0,0 +1,87 @@
+require 'aws/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
+        AWS::S3::Base.establish_connection!(
+          :access_key_id     => access_key_id,
+          :secret_access_key => secret_access_key,
+          :use_ssl           => use_ssl
+        )
+      end
+      
+      # Wrapper for the Service object
+      def service
+        AWS::S3::Service
+      end
+      
+      # Wrapper for the Bucket object
+      def bucket
+        AWS::S3::Bucket
+      end
+      
+      # Wrapper for the Object object
+      def object
+        AWS::S3::S3Object
+      end
+      
+      # Initializes the file transfer to Amazon S3
+      # This can only run after a connection has been made using the #connect method 
+      def store
+        puts "Storing \"#{final_file}\" to bucket \"#{s3_bucket}\" on Amazon S3."
+        object.store(
+          final_file,
+          open(File.join(tmp_path, final_file)),
+          s3_bucket )
+      end
+      
+      # Destroys file from a bucket on Amazon S3
+      def destroy(file, bucket)
+        object.delete(
+          file,
+          bucket )
+      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_ENV)
+        return :unix
+      end
+      
+    end
+  end
+end

data/lib/backup/environment/rails.rb

@@ -0,0 +1,17 @@
+module Backup
+  module Environment
+    module Rails
+      
+      if defined? RAILS_ENV
+        
+        # Sets BACKUP_PATH equal to RAILS_ROOT
+        BACKUP_PATH = RAILS_ROOT
+      
+        # Sets DB_CONNECTION_SETTINGS to false
+        DB_CONNECTION_SETTINGS = false
+    
+      end
+    
+    end
+  end
+end