alg-backup 3.0.10

data/lib/backup/version.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module Backup
+  class Version
+
+    ##
+    # Change the MAJOR, MINOR and PATCH constants below
+    # to adjust the version of the Backup gem
+    #
+    # MAJOR:
+    #  Defines the major version
+    # MINOR:
+    #  Defines the minor version
+    # PATCH:
+    #  Defines the patch version
+    MAJOR, MINOR, PATCH = 3, 0, 10
+
+    ##
+    # 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 )
+    def self.patch
+      PATCH
+    end
+
+    ##
+    # Returns the current version of the Backup gem ( qualified for the gemspec )
+    def self.current
+      "#{major}.#{minor}.#{patch}"
+    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/notifier/twitter

@@ -0,0 +1,9 @@
+  notify_by Twitter do |tweet|
+    tweet.on_success = true
+    tweet.on_failure = true
+
+    tweet.consumer_key       = 'my_consumer_key'
+    tweet.consumer_secret    = 'my_consumer_secret'
+    tweet.oauth_token        = 'my_oauth_token'
+    tweet.oauth_token_secret = 'my_oauth_token_secret'
+  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,9 @@
+  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.timeout    = 300
+    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/lib/templates/syncer/rsync

@@ -0,0 +1,14 @@
+  sync_with RSync do |rsync|
+    rsync.ip       = "123.45.678.90"
+    rsync.port     = 22
+    rsync.username = "my_username"
+    rsync.password = "my_password"
+    rsync.path     = "~/backups/"
+    rsync.mirror   = true
+    rsync.compress = true
+
+    rsync.directories do |directory|
+      directory.add "/var/apps/my_app/public/uploads"
+      directory.add "/var/apps/my_app/logs"
+    end
+  end

data/lib/templates/syncer/s3

@@ -0,0 +1,12 @@
+  sync_with S3 do |s3|
+    s3.access_key_id     = "my_access_key_id"
+    s3.secret_access_key = "my_secret_access_key"
+    s3.bucket            = "my-bucket"
+    s3.path              = "/backups"
+    s3.mirror            = true
+
+    s3.directories do |directory|
+      directory.add "/path/to/directory/to/sync"
+      directory.add "/path/to/other/directory/to/sync"
+    end
+  end

data/spec/archive_spec.rb

@@ -0,0 +1,90 @@
+# 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/'
+      a.exclude '/home/rspecuser/excludefile'
+      a.exclude '/home/rspecuser/excludedir/'
+    end
+  end
+
+  it 'should have no paths' do
+    archive = Backup::Archive.new(:dummy_archive) { |a| }
+    archive.paths.count.should == 0
+  end
+
+  it 'should have no excludes' do
+    archive = Backup::Archive.new(:dummy_archive) { |a| }
+    archive.excludes.count.should == 0
+  end
+
+  it 'should have 3 paths' do
+    archive.paths.count.should == 3
+  end
+
+  it 'should have 2 excludes' do
+    archive.excludes.count.should == 2
+  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 '#paths_to_exclude' do
+    it 'should be empty' do
+      archive = Backup::Archive.new(:dummy_archive) { |a| }
+      archive.send(:paths_to_exclude).should be_nil
+    end
+
+    it 'should return a tar -c friendly string' do
+      archive.send(:paths_to_exclude).should ==
+      "--exclude={'/home/rspecuser/excludefile','/home/rspecuser/excludedir/'}"
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      [:mkdir, :run, :utility].each { |method| archive.stubs(method) }
+      Backup::Logger.stubs(:message)
+    end
+
+    context 'when both paths were added and paths that should be excluded were added' do
+      it 'should render both the syntax for the paths that be included as well as excluded' do
+        archive.expects(:mkdir).with(File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive'))
+        archive.expects(:run).with("tar -c --exclude={'/home/rspecuser/excludefile','/home/rspecuser/excludedir/'} '/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
+    end
+
+    context 'when there are paths to add, and no exclude patterns were defined' do
+      it 'should only render syntax for the defined paths' do
+        archive = Backup::Archive.new(:dummy_archive) do |a|
+          a.add '/path/to/archive'
+        end
+
+        archive.stubs(:utility).returns(:tar)
+        archive.expects(:run).with("tar -c  '/path/to/archive' 1> '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}' 2> /dev/null")
+        archive.perform!
+      end
+    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

data/spec/configuration/base_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Configuration::Helpers do
+
+  before do
+    class Backup::Configuration::Base
+      class << self
+        attr_accessor :rspec_method, :rspec_test, :rspec_mocha
+      end
+    end
+  end
+
+  it 'should clear the defaults' do
+    Backup::Configuration::Base.expects(:send).with('rspec_method=', nil)
+    Backup::Configuration::Base.expects(:send).with('rspec_test=', nil)
+    Backup::Configuration::Base.expects(:send).with('rspec_mocha=', nil)
+    Backup::Configuration::Base.clear_defaults!
+  end
+
+  it 'should return the setters' do
+    Backup::Configuration::Base.setter_methods.count.should == 3
+    %w[rspec_method= rspec_test= rspec_mocha=].each do |method|
+      Backup::Configuration::Base.setter_methods.should include(method)
+    end
+  end
+
+  it 'should return the getters' do
+    Backup::Configuration::Base.getter_methods.count.should == 3
+    %w[rspec_method rspec_test rspec_mocha].each do |method|
+      Backup::Configuration::Base.getter_methods.should include(method)
+    end
+  end
+end