backup 2.4.5.1 → 3.0.0.build.0

data/lib/backup/storage/sftp.rb

@@ -1,31 +1,106 @@
+# encoding: utf-8
+
+##
+# Only load the Net::SFTP library/gem when the Backup::Storage::SFTP class is loaded
 require 'net/sftp'
 
 module Backup
   module Storage
     class SFTP < Base
-      
-      attr_accessor :user, :password, :ip, :path, :tmp_path, :final_file
-      
-      # Stores the backup file on the remote server using SFTP
-      def initialize(adapter)
-        %w(ip user password path).each do |method|
-          send("#{method}=", adapter.procedure.get_storage_configuration.attributes[method])
+
+      ##
+      # Server credentials
+      attr_accessor :username, :password
+
+      ##
+      # Server IP Address and SFTP port
+      attr_accessor :ip, :port
+
+      ##
+      # Path to store backups to
+      attr_accessor :path
+
+      ##
+      # Creates a new instance of the SFTP storage object
+      # First it sets the defaults (if any exist) and then evaluates
+      # the configuration block which may overwrite these defaults
+      def initialize(&block)
+        load_defaults!
+
+        @port ||= 22
+        @path ||= 'backups'
+
+        instance_eval(&block) if block_given?
+
+        @time = TIME
+        @path = path.sub(/^\~\//, '')
+      end
+
+      ##
+      # This is the remote path to where the backup files will be stored
+      def remote_path
+        File.join(path, TRIGGER)
+      end
+
+      ##
+      # Performs the backup transfer
+      def perform!
+        transfer!
+        cycle!
+      end
+
+    private
+
+      ##
+      # Establishes a connection to the remote server and returns the Net::SFTP object.
+      # Not doing any instance variable caching because this object gets persisted in YAML
+      # format to a file and will issues. This, however has no impact on performance since it only
+      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
+      # background anyway so even if it were a bit slower it shouldn't matter.
+      def connection
+        Net::SFTP.start(ip, username, :password => password, :port => port)
+      end
+
+      ##
+      # Transfers the archived file to the specified remote server
+      def transfer!
+        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
+        create_remote_directories!
+        connection.upload!(
+          File.join(local_path, local_file),
+          File.join(remote_path, remote_file)
+        )
+      end
+
+      ##
+      # Removes the transferred archive file from the server
+      def remove!
+        begin
+          connection.remove!(
+            File.join(remote_path, remote_file)
+          )
+        rescue Net::SFTP::StatusException
+          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
         end
-        
-        final_file = adapter.final_file
-        tmp_path   = adapter.tmp_path
-        
-        Net::SFTP.start(ip, user, :password => password) do |sftp|
+      end
+
+      ##
+      # Creates (if they don't exist yet) all the directories on the remote
+      # server in order to upload the backup file. Net::SFTP does not support
+      # paths to directories that don't yet exist when creating new directories.
+      # Instead, we split the parts up in to an array (for each '/') and loop through
+      # that to create the directories one by one. Net::SFTP raises an exception when
+      # the directory it's trying ot create already exists, so we have rescue it
+      def create_remote_directories!
+        path_parts = Array.new
+        remote_path.split('/').each do |path_part|
+          path_parts << path_part
           begin
-            puts "Storing \"#{final_file}\" to path \"#{path}\" on remote server (#{ip})."
-            sftp.upload!(File.join(tmp_path, final_file).gsub('\ ', ' '), File.join(path, final_file))
-          rescue
-            puts "Could not find \"#{path}\" on \"#{ip}\", please ensure this directory exists."
-            exit
-          end
+            connection.mkdir!(path_parts.join('/'))
+          rescue Net::SFTP::StatusException; end
         end
       end
-      
+
     end
   end
 end

data/lib/backup/version.rb

@@ -1,3 +1,72 @@
+# encoding: utf-8
+
 module Backup
-  VERSION = "2.4.5.1"
+
+  ##
+  # Usage:
+  #
+  #  # Returns the current backup version based on the defined constants
+  #    Backup::Version.current
+  #
+  #  # Returns a gemspec compatible version number based on the defined constants
+  #    Backup::Version.gemspec
+  #
+  class Version
+
+    ##
+    # MAJOR:
+    #  Defines the major version
+    # MINOR:
+    #  Defines the minor version
+    # PATCH:
+    #  Defines the patch version
+    # BUILD:
+    #  Defines the build version ( use 'false' if no build )
+    MAJOR, MINOR, PATCH, BUILD = 3, 0, 0, 0
+
+    # ========================================================= #
+    #  ADJUST THE CONSTANTS ABOVE TO CHANGE THE BACKUP VERSION  #
+    # ========================================================= #
+
+    ##
+    # Returns the major version ( big release based off of multiple minor releases )
+    def self.major
+      MAJOR
+    end
+
+    ##
+    # Returns the minor version ( small release based off of multiple patches )
+    def self.minor
+      MINOR
+    end
+
+    ##
+    # Returns the patch version ( updates, features and (crucial) bug fixes based off of multiple builds )
+    def self.patch
+      PATCH
+    end
+
+    ##
+    # Returns the build version ( improvements, small additions, frequent releases )
+    def self.build
+      BUILD
+    end
+
+    ##
+    # Returns the current version ( not for gemspec / rubygems )
+    def self.current
+      "#{major}.#{minor}.#{patch} / build #{build or 0}"
+    end
+
+    ##
+    # Returns the (gemspec qualified) current version
+    def self.gemspec
+      if build.eql?(false)
+        "#{major}.#{minor}.#{patch}"
+      else
+        "#{major}.#{minor}.#{patch}.build.#{build}"
+      end
+    end
+
+  end
 end

data/lib/templates/archive

@@ -0,0 +1,4 @@
+  archive :my_archive do |archive|
+    archive.add '/path/to/a/file.rb'
+    archive.add '/path/to/a/folder/'
+  end

data/lib/templates/compressor/gzip

@@ -0,0 +1,4 @@
+  compress_with Gzip do |compression|
+    compression.best = true
+    compression.fast = false
+  end

data/lib/templates/database/mongodb

@@ -0,0 +1,10 @@
+  database MongoDB do |db|
+    db.name               = "my_database_name"
+    db.username           = "my_username"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 5432
+    db.ipv6               = false
+    db.only_collections   = ['only', 'these' 'collections']
+    db.additional_options = []
+  end

data/lib/templates/database/mysql

@@ -0,0 +1,11 @@
+  database MySQL do |db|
+    db.name               = "my_database_name"
+    db.username           = "my_username"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 3306
+    db.socket             = "/tmp/mysql.sock"
+    db.skip_tables        = ['skip', 'these', 'tables']
+    db.only_tables        = ['only', 'these' 'tables']
+    db.additional_options = ['--quick', '--single-transaction']
+  end

data/lib/templates/database/postgresql

@@ -0,0 +1,11 @@
+  database PostgreSQL do |db|
+    db.name               = "my_database_name"
+    db.username           = "my_username"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 5432
+    db.socket             = "/tmp/pg.sock"
+    db.skip_tables        = ['skip', 'these', 'tables']
+    db.only_tables        = ['only', 'these' 'tables']
+    db.additional_options = ['--quick', '--single-transaction']
+  end

data/lib/templates/database/redis

@@ -0,0 +1,10 @@
+  database Redis do |db|
+    db.name               = "my_database_name"
+    db.path               = "/usr/local/var/db/redis"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 5432
+    db.socket             = "/tmp/redis.sock"
+    db.additional_options = []
+    db.invoke_save        = true
+  end

data/lib/templates/encryptor/gpg

@@ -0,0 +1,9 @@
+  encrypt_with GPG do |encryption|
+    encryption.key = <<-KEY
+      -----BEGIN PGP PUBLIC KEY BLOCK-----
+      Version: GnuPG v1.4.11 (Darwin)
+
+          <Your GPG Public Key Here>
+      -----END PGP PUBLIC KEY BLOCK-----
+    KEY
+  end

data/lib/templates/encryptor/openssl

@@ -0,0 +1,5 @@
+  encrypt_with OpenSSL do |encryption|
+    encryption.password = 'my_password'
+    encryption.base64   = true
+    encryption.salt     = true
+  end

data/lib/templates/notifier/mail

@@ -0,0 +1,14 @@
+  notify_by Mail do |mail|
+    mail.on_success           = true
+    mail.on_failure           = true
+
+    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.enable_starttls_auto = true
+  end

data/lib/templates/readme

@@ -0,0 +1,15 @@
+##
+# Backup
+# Generated Template
+#
+# For more information:
+#
+# View the Git repository at https://github.com/meskyanichi/backup
+# View the Wiki/Documentation at https://github.com/meskyanichi/backup/wiki
+# View the issue log at https://github.com/meskyanichi/backup/issues
+#
+# When you're finished configuring this configuration file,
+# you can run it from the command line by issuing the following command:
+#
+# $ backup -t my_backup [-c <path_to_configuration_file>]
+

data/lib/templates/storage/cloudfiles

@@ -0,0 +1,7 @@
+  store_with CloudFiles do |cf|
+    cf.api_key   = 'my_api_key'
+    cf.username  = 'my_username'
+    cf.container = 'my_container'
+    cf.path      = '/path/to/my/backups'
+    cf.keep      = 5
+  end

data/lib/templates/storage/dropbox

@@ -0,0 +1,8 @@
+  store_with Dropbox do |db|
+    db.email      = 'my@email.com'
+    db.password   = 'my_password'
+    db.api_key    = 'my_api_key'
+    db.api_secret = 'my_api_secret'
+    db.path       = '/path/to/my/backups'
+    db.keep       = 25
+  end

data/lib/templates/storage/ftp

@@ -0,0 +1,8 @@
+  store_with FTP do |server|
+    server.username = 'my_username'
+    server.password = 'my_password'
+    server.ip       = '123.45.678.90'
+    server.port     = 21
+    server.path     = '~/backups/'
+    server.keep     = 5
+  end

data/lib/templates/storage/rsync

@@ -0,0 +1,7 @@
+  store_with RSync do |server|
+    server.username = 'my_username'
+    server.password = 'my_password'
+    server.ip       = '123.45.678.90'
+    server.port     = 22
+    server.path     = '~/backups/'
+  end

data/lib/templates/storage/s3

@@ -0,0 +1,8 @@
+  store_with S3 do |s3|
+    s3.access_key_id      = 'my_access_key_id'
+    s3.secret_access_key  = 'my_secret_access_key'
+    s3.region             = 'us-east-1'
+    s3.bucket             = 'bucket-name'
+    s3.path               = '/path/to/my/backups'
+    s3.keep               = 10
+  end

data/lib/templates/storage/scp

@@ -0,0 +1,8 @@
+  store_with SCP do |server|
+    server.username = 'my_username'
+    server.password = 'my_password'
+    server.ip       = '123.45.678.90'
+    server.port     = 22
+    server.path     = '~/backups/'
+    server.keep     = 5
+  end

data/lib/templates/storage/sftp

@@ -0,0 +1,8 @@
+  store_with SFTP do |server|
+    server.username = 'my_username'
+    server.password = 'my_password'
+    server.ip       = '123.45.678.90'
+    server.port     = 22
+    server.path     = '~/backups/'
+    server.keep     = 5
+  end

data/spec/archive_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Backup::Archive do
+
+  let(:archive) do
+    Backup::Archive.new(:dummy_archive) do |a|
+      a.add '/home/rspecuser/somefile'
+      a.add '/home/rspecuser/logs/'
+      a.add '/home/rspecuser/dotfiles/'
+    end
+  end
+
+  it 'should have no paths' do
+    archive = Backup::Archive.new(:dummy_archive) { |a| }
+    archive.paths.count.should == 0
+  end
+
+  it 'should have 3 paths' do
+    archive.paths.count.should == 3
+  end
+
+  it do
+    archive.name.should == :dummy_archive
+  end
+
+  describe '#paths_to_package' do
+    it 'should return a tar -c friendly string' do
+      archive.send(:paths_to_package).should ==
+      "'/home/rspecuser/somefile' '/home/rspecuser/logs/' '/home/rspecuser/dotfiles/'"
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      [:mkdir, :run, :utility].each { |method| archive.stubs(method) }
+      Backup::Logger.stubs(:message)
+    end
+
+    it 'should tar all the specified paths' do
+      archive.expects(:mkdir).with(File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive'))
+      archive.expects(:run).with("tar -c '/home/rspecuser/somefile' '/home/rspecuser/logs/' '/home/rspecuser/dotfiles/' 1> '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}' 2> /dev/null")
+      archive.expects(:utility).with(:tar).returns(:tar)
+      archive.perform!
+    end
+
+    it 'should log the status' do
+      Backup::Logger.expects(:message).with("Backup::Archive started packaging and archiving \"/home/rspecuser/somefile\", \"/home/rspecuser/logs/\", \"/home/rspecuser/dotfiles/\".")
+      archive.perform!
+    end
+  end
+end

data/spec/backup_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Backup do
+  it do
+    Backup::TMP_PATH.should    == File.join(ENV['HOME'], 'Backup', '.tmp')
+    Backup::DATA_PATH.should   == File.join(ENV['HOME'], 'Backup', 'data')
+    Backup::CONFIG_FILE.should == File.join(ENV['HOME'], 'Backup', 'config.rb')
+  end
+end

data/spec/compressor/gzip_spec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Compressor::Gzip do
+  let(:compressor) { Backup::Compressor::Gzip.new }
+
+  before do
+    Backup::Model.extension = 'tar'
+  end
+
+  describe 'the options' do
+    it do
+      compressor.send(:best).should == []
+    end
+
+    it do
+      compressor.send(:fast).should == []
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      [:run, :utility].each { |method| compressor.stubs(method) }
+      Backup::Logger.stubs(:message)
+    end
+
+    it 'should perform the compression' do
+      compressor.expects(:utility).with(:gzip).returns(:gzip)
+      compressor.expects(:run).with("gzip  '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
+      compressor.perform!
+    end
+
+    it 'should perform the compression with the --best and --fast options' do
+      compressor = Backup::Compressor::Gzip.new do |c|
+        c.best = true
+        c.fast = true
+      end
+
+      compressor.stubs(:utility).returns(:gzip)
+      compressor.expects(:run).with("gzip --best --fast '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
+      compressor.perform!
+    end
+
+    it 'should set the class variable @extension (Backup::Model.extension) to .gz' do
+      compressor.stubs(:utility).returns(:gzip)
+      compressor.expects(:run)
+
+      Backup::Model.extension.should == 'tar'
+      compressor.perform!
+      Backup::Model.extension.should == 'tar.gz'
+    end
+
+    it 'should log' do
+      Backup::Logger.expects(:message).with("Backup::Compressor::Gzip started compressing the archive.")
+      compressor.perform!
+    end
+  end
+end