backup 3.0.20 → 3.0.21

data/spec/syncer/s3_spec.rb

@@ -3,136 +3,225 @@
 require File.expand_path('../../spec_helper.rb', __FILE__)
 
 describe Backup::Syncer::S3 do
-
-  let(:s3) do
+  let(:syncer) do
     Backup::Syncer::S3.new 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.path               = "/my_backups"
 
       s3.directories do |directory|
-        directory.add "/some/random/directory"
-        directory.add "/another/random/directory"
+        directory.add "/some/directory"
+        directory.add "~/home/directory"
       end
-    end
-  end
 
-  before do
-    Backup::Configuration::Syncer::S3.clear_defaults!
+      s3.mirror             = true
+      s3.additional_options = ['--opt-a', '--opt-b']
+    end
   end
 
-  it 'should have defined the configuration properly' do
-    s3.access_key_id.should      == 'my_access_key_id'
-    s3.secret_access_key.should  == 'my_secret_access_key'
-    s3.bucket.should             == 'my-bucket'
-    s3.path.should               == 'backups'
-    s3.mirror.should             == '--delete'
-    s3.directories.should        == ["/some/random/directory", "/another/random/directory"]
-  end
+  describe '#initialize' do
 
-  it 'should use the defaults if a particular attribute has not been defined' do
-    Backup::Configuration::Syncer::S3.defaults do |s3|
-      s3.access_key_id      = 'my_access_key_id'
-      s3.bucket             = 'my-bucket'
-      s3.path               = "/backups"
-      s3.mirror             = true
+    it 'should have defined the configuration properly' do
+      syncer.access_key_id.should      == 'my_access_key_id'
+      syncer.secret_access_key.should  == 'my_secret_access_key'
+      syncer.bucket.should             == 'my-bucket'
+      syncer.path.should               == '/my_backups'
+      syncer.directories.should        == ["/some/directory", "~/home/directory"]
+      syncer.mirror.should             == true
+      syncer.additional_options.should == ['--opt-a', '--opt-b']
     end
 
-    s3 = Backup::Syncer::S3.new do |s3|
-      s3.secret_access_key = 'some_secret_access_key'
-      s3.mirror            = false
+    context 'when options are not set' do
+      it 'should use default values' do
+        syncer = Backup::Syncer::S3.new
+        syncer.access_key_id.should      == nil
+        syncer.secret_access_key.should  == nil
+        syncer.bucket.should             == nil
+        syncer.path.should               == 'backups'
+        syncer.directories.should        == []
+        syncer.mirror.should             == false
+        syncer.additional_options.should == []
+      end
     end
 
-    s3.access_key_id      = 'my_access_key_id'
-    s3.secret_access_key  = 'some_secret_access_key'
-    s3.bucket             = 'my-bucket'
-    s3.path               = "/backups"
-    s3.mirror             = false
-  end
-
-  it 'should have its own defaults' do
-    s3 = Backup::Syncer::S3.new
-    s3.path.should        == 'backups'
-    s3.directories.should == Array.new
-    s3.mirror.should      == nil
-    s3.additional_options.should == []
-  end
+    context 'when setting configuration defaults' do
+      after { Backup::Configuration::Syncer::S3.clear_defaults! }
+
+      it 'should use the configured defaults' do
+        Backup::Configuration::Syncer::S3.defaults do |s3|
+          s3.access_key_id      = 'some_access_key_id'
+          s3.secret_access_key  = 'some_secret_access_key'
+          s3.bucket             = 'some_bucket'
+          s3.path               = 'some_path'
+          #s3.directories        = 'cannot_have_a_default_value'
+          s3.mirror             = 'some_mirror'
+          s3.additional_options = 'some_additional_options'
+        end
+        syncer = Backup::Syncer::S3.new
+        syncer.access_key_id.should      == 'some_access_key_id'
+        syncer.secret_access_key.should  == 'some_secret_access_key'
+        syncer.bucket.should             == 'some_bucket'
+        syncer.path.should               == 'some_path'
+        syncer.directories.should        == []
+        syncer.mirror.should             == 'some_mirror'
+        syncer.additional_options.should == 'some_additional_options'
+      end
 
-  describe '#mirror' do
-    context 'when true' do
-      it do
-        s3.mirror = true
-        s3.mirror.should == '--delete'
+      it 'should override the configured defaults' do
+        Backup::Configuration::Syncer::S3.defaults do |s3|
+          s3.access_key_id      = 'old_access_key_id'
+          s3.secret_access_key  = 'old_secret_access_key'
+          s3.bucket             = 'old_bucket'
+          s3.path               = 'old_path'
+          #s3.directories        = 'cannot_have_a_default_value'
+          s3.mirror             = 'old_mirror'
+          s3.additional_options = 'old_additional_options'
+        end
+        syncer = Backup::Syncer::S3.new do |s3|
+          s3.access_key_id      = 'new_access_key_id'
+          s3.secret_access_key  = 'new_secret_access_key'
+          s3.bucket             = 'new_bucket'
+          s3.path               = 'new_path'
+          s3.directories        = 'new_directories'
+          s3.mirror             = 'new_mirror'
+          s3.additional_options = 'new_additional_options'
+        end
+
+        syncer.access_key_id.should      == 'new_access_key_id'
+        syncer.secret_access_key.should  == 'new_secret_access_key'
+        syncer.bucket.should             == 'new_bucket'
+        syncer.path.should               == 'new_path'
+        syncer.directories.should        == 'new_directories'
+        syncer.mirror.should             == 'new_mirror'
+        syncer.additional_options.should == 'new_additional_options'
       end
+    end # context 'when setting configuration defaults'
+  end # describe '#initialize'
+
+  describe '#perform!' do
+    let(:s) { sequence '' }
+
+    before do
+      syncer.expects(:utility).twice.with(:s3sync).returns('s3sync')
+      syncer.expects(:options).twice.returns('options_output')
     end
 
-    context 'when nil/false' do
-      it do
-        s3.mirror = nil
-        s3.mirror.should == nil
-      end
+    it 'should sync two directories' do
+      syncer.expects(:set_environment_variables!).in_sequence(s)
+
+      # first directory
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Syncer::S3 started syncing '/some/directory'."
+      )
+      syncer.expects(:run).in_sequence(s).with(
+        "s3sync options_output '/some/directory' 'my-bucket:my_backups'"
+      ).returns('messages from stdout')
+      Backup::Logger.expects(:silent).in_sequence(s).with('messages from stdout')
+
+      # second directory
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Syncer::S3 started syncing '~/home/directory'."
+      )
+      syncer.expects(:run).in_sequence(s).with(
+        "s3sync options_output '#{ File.expand_path('~/home/directory') }' " +
+        "'my-bucket:my_backups'"
+      ).returns('messages from stdout')
+      Backup::Logger.expects(:silent).in_sequence(s).with('messages from stdout')
+
+      syncer.expects(:unset_environment_variables!).in_sequence(s)
+
+      syncer.perform!
+    end
+  end # describe '#perform!'
 
-      it do
-        s3.mirror = false
-        s3.mirror.should == nil
+  describe '#directories' do
+    context 'when no block is given' do
+      it 'should return @directories' do
+        syncer.directories.should ==
+            ['/some/directory', '~/home/directory']
       end
     end
-  end
 
-  describe '#recursive' do
-    it do
-      s3.recursive.should == '--recursive'
+    context 'when a block is given' do
+      it 'should evalute the block, allowing #add to add directories' do
+        syncer.directories do
+          add '/new/path'
+          add '~/new/home/path'
+        end
+        syncer.directories.should == [
+          '/some/directory',
+          '~/home/directory',
+          '/new/path',
+          '~/new/home/path'
+        ]
+      end
     end
-  end
+  end # describe '#directories'
 
-  describe '#additional_options' do
-    it do
-      s3.additional_options = ['--exclude="*.rb"']
-      s3.options.should == '--verbose --recursive --delete --exclude="*.rb"'
+  describe '#add' do
+    it 'should add the given path to @directories' do
+      syncer.add '/my/path'
+      syncer.directories.should ==
+          ['/some/directory', '~/home/directory', '/my/path']
     end
   end
 
-  describe '#verbose' do
-    it do
-      s3.verbose.should == '--verbose'
+  describe '#dest_path' do
+    it 'should remove any preceeding "/" from @path' do
+      syncer.send(:dest_path).should == 'my_backups'
     end
-  end
 
-  describe '#directories' do
-    context 'when its empty' do
-      it do
-        s3.directories         = []
-        s3.directories.should == []
-      end
+    it 'should set @dest_path' do
+      syncer.send(:dest_path)
+      syncer.instance_variable_get(:@dest_path).should == 'my_backups'
     end
 
-    context 'when it has items' do
-      it do
-        s3.directories         = ['directory1', 'directory1/directory2', 'directory1/directory2/directory3']
-        s3.directories.should == ['directory1', 'directory1/directory2', 'directory1/directory2/directory3']
-      end
+    it 'should return @dest_path if already set' do
+      syncer.instance_variable_set(:@dest_path, 'foo')
+      syncer.send(:dest_path).should == 'foo'
     end
   end
 
   describe '#options' do
-    it do
-      s3.options.should == "--verbose --recursive --delete"
+    context 'when @mirror is true' do
+      it 'should return the options with mirroring enabled' do
+        syncer.send(:options).should ==
+          '--verbose --recursive --delete --opt-a --opt-b'
+      end
     end
-  end
-
-  describe '#perform' do
-    it 'should sync two directories' do
-      s3.expects(:utility).with(:s3sync).returns(:s3sync).twice
-
-      Backup::Logger.expects(:message).with("Backup::Syncer::S3 started syncing '/some/random/directory'.")
-      s3.expects(:run).with("s3sync --verbose --recursive --delete '/some/random/directory' 'my-bucket:backups'")
 
-      Backup::Logger.expects(:message).with("Backup::Syncer::S3 started syncing '/another/random/directory'.")
-      s3.expects(:run).with("s3sync --verbose --recursive --delete '/another/random/directory' 'my-bucket:backups'")
+    context 'when @mirror is false' do
+      before { syncer.mirror = false }
+      it 'should return the options without mirroring enabled' do
+        syncer.send(:options).should ==
+          '--verbose --recursive --opt-a --opt-b'
+      end
+    end
 
-      s3.perform!
+    context 'with no additional options' do
+      before { syncer.additional_options = [] }
+      it 'should return the options without additional options' do
+        syncer.send(:options).should ==
+          '--verbose --recursive --delete'
+      end
+    end
+  end # describe '#options'
+
+  describe 'changing environment variables' do
+    before  { @env = ENV }
+    after   { ENV.replace(@env) }
+
+    it 'should set and unset environment variables' do
+      syncer.send(:set_environment_variables!)
+      ENV['AWS_ACCESS_KEY_ID'].should     == 'my_access_key_id'
+      ENV['AWS_SECRET_ACCESS_KEY'].should == 'my_secret_access_key'
+      ENV['AWS_CALLING_FORMAT'].should    == 'SUBDOMAIN'
+
+      syncer.send(:unset_environment_variables!)
+      ENV['AWS_ACCESS_KEY_ID'].should     == nil
+      ENV['AWS_SECRET_ACCESS_KEY'].should == nil
+      ENV['AWS_CALLING_FORMAT'].should    == nil
     end
   end
 

data/templates/cli/utility/config

@@ -26,6 +26,6 @@ end
 
 ##
 # Load all models from the models directory (after the above global configuration blocks)
-Dir[File.join(File.dirname(Backup::CONFIG_FILE), "models", "*.rb")].each do |model|
+Dir[File.join(File.dirname(Config.config_file), "models", "*.rb")].each do |model|
   instance_eval(File.read(model))
 end

data/templates/cli/utility/database/mongodb

@@ -11,4 +11,8 @@
     db.only_collections   = ['only', 'these' 'collections']
     db.additional_options = []
     db.lock               = false
+    # Optional: Use to set the location of these utilities
+    #   if they cannot be found by their name in your $PATH
+    # db.mongodump_utility = '/opt/local/bin/mongodump'
+    # db.mongo_utility     = '/opt/local/bin/mongo'
   end

data/templates/cli/utility/database/mysql

@@ -11,4 +11,7 @@
     db.skip_tables        = ['skip', 'these', 'tables']
     db.only_tables        = ['only', 'these' 'tables']
     db.additional_options = ['--quick', '--single-transaction']
+    # Optional: Use to set the location of this utility
+    #   if it cannot be found by name in your $PATH
+    # db.mysqldump_utility = '/opt/local/bin/mysqldump'
   end

data/templates/cli/utility/database/postgresql

@@ -11,4 +11,7 @@
     db.skip_tables        = ['skip', 'these', 'tables']
     db.only_tables        = ['only', 'these' 'tables']
     db.additional_options = ['-xc', '-E=utf8']
+    # Optional: Use to set the location of this utility
+    #   if it cannot be found by name in your $PATH
+    # db.pg_dump_utility = '/opt/local/bin/pg_dump'
   end

data/templates/cli/utility/database/redis

@@ -10,4 +10,7 @@
     db.socket             = "/tmp/redis.sock"
     db.additional_options = []
     db.invoke_save        = true
+    # Optional: Use to set the location of this utility
+    #   if it cannot be found by name in your $PATH
+    # db.redis_cli_utility = '/opt/local/bin/redis-cli'
   end

data/templates/cli/utility/database/riak

@@ -5,4 +5,7 @@
     db.name   = "hostname"
     db.node   = "riak@hostname"
     db.cookie = "cookie"
+    # Optional: Use to set the location of this utility
+    #   if it cannot be found by name in your $PATH
+    # db.riak_admin_utility = '/opt/local/bin/riak-admin'
   end

data/templates/cli/utility/storage/dropbox

@@ -6,7 +6,10 @@
   store_with Dropbox do |db|
     db.api_key    = 'my_api_key'
     db.api_secret = 'my_api_secret'
-    db.timeout    = 300
+    # Dropbox Access Type
+    # The default value is :app_folder
+    # Change this to :dropbox if needed
+    # db.access_type = :dropbox
     db.path       = '/path/to/my/backups'
     db.keep       = 25
   end

data/templates/cli/utility/syncer/rsync_local

@@ -0,0 +1,12 @@
+  ##
+  # RSync::Local [Syncer]
+  #
+  sync_with RSync::Local do |rsync|
+    rsync.path     = "~/backups/"
+    rsync.mirror   = true
+
+    rsync.directories do |directory|
+      directory.add "/var/apps/my_app/public/uploads"
+      directory.add "/var/apps/my_app/logs"
+    end
+  end

data/templates/cli/utility/syncer/{rsync → rsync_pull}

@@ -1,7 +1,7 @@
   ##
-  # RSync [Syncer]
+  # RSync::Pull [Syncer]
   #
-  sync_with RSync do |rsync|
+  sync_with RSync::Pull do |rsync|
     rsync.ip       = "123.45.678.90"
     rsync.port     = 22
     rsync.username = "my_username"

data/templates/cli/utility/syncer/rsync_push

@@ -0,0 +1,17 @@
+  ##
+  # RSync::Push [Syncer]
+  #
+  sync_with RSync::Push 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/templates/storage/dropbox/authorization_url.erb

@@ -1,6 +1,6 @@
 
 Visit the following URL to authorize your Dropbox App with Backup:
 
-  <%= @session.authorize_url %>
+  <%= @session.get_authorize_url %>
 
 Hit "Enter/Return" once you're authorized.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 3.0.20
+  version: 3.0.21
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000 Z
+date: 2012-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70199932850880 !ruby/object:Gem::Requirement
+  requirement: &70322872021320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70199932850880
+  version_requirements: *70322872021320
 - !ruby/object:Gem::Dependency
   name: POpen4
-  requirement: &70199932850360 !ruby/object:Gem::Requirement
+  requirement: &70322872019160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 0.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *70199932850360
+  version_requirements: *70322872019160
 description: 
 email: meskyanichi@gmail.com
 executables:
@@ -60,6 +60,7 @@ files:
 - lib/backup/compressor/gzip.rb
 - lib/backup/compressor/lzma.rb
 - lib/backup/compressor/pbzip2.rb
+- lib/backup/config.rb
 - lib/backup/configuration/base.rb
 - lib/backup/configuration/compressor/base.rb
 - lib/backup/configuration/compressor/bzip2.rb
@@ -93,7 +94,11 @@ files:
 - lib/backup/configuration/storage/s3.rb
 - lib/backup/configuration/storage/scp.rb
 - lib/backup/configuration/storage/sftp.rb
-- lib/backup/configuration/syncer/rsync.rb
+- lib/backup/configuration/syncer/base.rb
+- lib/backup/configuration/syncer/rsync/base.rb
+- lib/backup/configuration/syncer/rsync/local.rb
+- lib/backup/configuration/syncer/rsync/pull.rb
+- lib/backup/configuration/syncer/rsync/push.rb
 - lib/backup/configuration/syncer/s3.rb
 - lib/backup/database/base.rb
 - lib/backup/database/mongodb.rb
@@ -106,7 +111,6 @@ files:
 - lib/backup/encryptor/gpg.rb
 - lib/backup/encryptor/open_ssl.rb
 - lib/backup/errors.rb
-- lib/backup/finder.rb
 - lib/backup/logger.rb
 - lib/backup/model.rb
 - lib/backup/notifier/base.rb
@@ -116,36 +120,43 @@ files:
 - lib/backup/notifier/presently.rb
 - lib/backup/notifier/prowl.rb
 - lib/backup/notifier/twitter.rb
+- lib/backup/package.rb
 - lib/backup/packager.rb
 - lib/backup/splitter.rb
 - lib/backup/storage/base.rb
 - lib/backup/storage/cloudfiles.rb
+- lib/backup/storage/cycler.rb
 - lib/backup/storage/dropbox.rb
 - lib/backup/storage/ftp.rb
 - lib/backup/storage/local.rb
 - lib/backup/storage/ninefold.rb
-- lib/backup/storage/object.rb
 - lib/backup/storage/rsync.rb
 - lib/backup/storage/s3.rb
 - lib/backup/storage/scp.rb
 - lib/backup/storage/sftp.rb
 - lib/backup/syncer/base.rb
-- lib/backup/syncer/rsync.rb
+- lib/backup/syncer/rsync/base.rb
+- lib/backup/syncer/rsync/local.rb
+- lib/backup/syncer/rsync/pull.rb
+- lib/backup/syncer/rsync/push.rb
 - lib/backup/syncer/s3.rb
 - lib/backup/template.rb
 - lib/backup/version.rb
 - spec/archive_spec.rb
-- spec/backup_spec.rb
+- spec/cleaner_spec.rb
 - spec/cli/helpers_spec.rb
 - spec/cli/utility_spec.rb
+- spec/compressor/base_spec.rb
 - spec/compressor/bzip2_spec.rb
 - spec/compressor/gzip_spec.rb
 - spec/compressor/lzma_spec.rb
 - spec/compressor/pbzip2_spec.rb
+- spec/config_spec.rb
 - spec/configuration/base_spec.rb
 - spec/configuration/compressor/bzip2_spec.rb
 - spec/configuration/compressor/gzip_spec.rb
 - spec/configuration/compressor/lzma_spec.rb
+- spec/configuration/compressor/pbzip2_spec.rb
 - spec/configuration/database/base_spec.rb
 - spec/configuration/database/mongodb_spec.rb
 - spec/configuration/database/mysql_spec.rb
@@ -154,6 +165,7 @@ files:
 - spec/configuration/database/riak_spec.rb
 - spec/configuration/encryptor/gpg_spec.rb
 - spec/configuration/encryptor/open_ssl_spec.rb
+- spec/configuration/notifier/base_spec.rb
 - spec/configuration/notifier/campfire_spec.rb
 - spec/configuration/notifier/hipchat_spec.rb
 - spec/configuration/notifier/mail_spec.rb
@@ -169,7 +181,10 @@ files:
 - spec/configuration/storage/s3_spec.rb
 - spec/configuration/storage/scp_spec.rb
 - spec/configuration/storage/sftp_spec.rb
-- spec/configuration/syncer/rsync_spec.rb
+- spec/configuration/syncer/rsync/base_spec.rb
+- spec/configuration/syncer/rsync/local_spec.rb
+- spec/configuration/syncer/rsync/pull_spec.rb
+- spec/configuration/syncer/rsync/push_spec.rb
 - spec/configuration/syncer/s3_spec.rb
 - spec/database/base_spec.rb
 - spec/database/mongodb_spec.rb
@@ -177,32 +192,40 @@ files:
 - spec/database/postgresql_spec.rb
 - spec/database/redis_spec.rb
 - spec/database/riak_spec.rb
+- spec/dependency_spec.rb
+- spec/encryptor/base_spec.rb
 - spec/encryptor/gpg_spec.rb
 - spec/encryptor/open_ssl_spec.rb
 - spec/errors_spec.rb
-- spec/finder_spec.rb
 - spec/logger_spec.rb
 - spec/model_spec.rb
+- spec/notifier/base_spec.rb
 - spec/notifier/campfire_spec.rb
 - spec/notifier/hipchat_spec.rb
 - spec/notifier/mail_spec.rb
 - spec/notifier/presently_spec.rb
 - spec/notifier/prowl_spec.rb
 - spec/notifier/twitter_spec.rb
+- spec/package_spec.rb
+- spec/packager_spec.rb
 - spec/spec_helper.rb
 - spec/splitter_spec.rb
 - spec/storage/base_spec.rb
 - spec/storage/cloudfiles_spec.rb
+- spec/storage/cycler_spec.rb
 - spec/storage/dropbox_spec.rb
 - spec/storage/ftp_spec.rb
 - spec/storage/local_spec.rb
 - spec/storage/ninefold_spec.rb
-- spec/storage/object_spec.rb
 - spec/storage/rsync_spec.rb
 - spec/storage/s3_spec.rb
 - spec/storage/scp_spec.rb
 - spec/storage/sftp_spec.rb
-- spec/syncer/rsync_spec.rb
+- spec/syncer/base_spec.rb
+- spec/syncer/rsync/base_spec.rb
+- spec/syncer/rsync/local_spec.rb
+- spec/syncer/rsync/pull_spec.rb
+- spec/syncer/rsync/push_spec.rb
 - spec/syncer/s3_spec.rb
 - spec/version_spec.rb
 - templates/cli/utility/archive
@@ -235,7 +258,9 @@ files:
 - templates/cli/utility/storage/s3
 - templates/cli/utility/storage/scp
 - templates/cli/utility/storage/sftp
-- templates/cli/utility/syncer/rsync
+- templates/cli/utility/syncer/rsync_local
+- templates/cli/utility/syncer/rsync_pull
+- templates/cli/utility/syncer/rsync_push
 - templates/cli/utility/syncer/s3
 - templates/general/links
 - templates/general/version.erb
@@ -265,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Backup is a RubyGem, written for Linux and Mac OSX, that allows you to easily