backup 3.0.19 → 3.0.20

data/.gitignore

@@ -1,3 +1,7 @@
 .DS_Store
 *.gem
 .rvmrc
+.bundle/
+vendor/bundle
+*.swp
+*.swo

data/Gemfile

@@ -1,20 +1,21 @@
-##
+# encoding: utf-8
+
 # RubyGems Source
 source 'http://rubygems.org'
 
-##
+# Include gem dependencies from the gemspec for development purposes
+gemspec
+
 # Load Backup::Dependency
-%w[cli dependency].each do |path|
-  require File.expand_path("../lib/backup/#{path}", __FILE__)
+["cli/helpers", "dependency"].each do |library|
+  require File.expand_path("../lib/backup/#{library}", __FILE__)
 end
 
-##
 # Dynamically define the dependencies specified in Backup::Dependency.all
 Backup::Dependency.all.each do |name, gemspec|
   gem(name, gemspec[:version])
 end
 
-##
 # Define gems to be used in the 'test' environment
 group :test do
   gem 'rspec'
@@ -24,8 +25,8 @@ group :test do
 
   gem 'guard'
   gem 'guard-rspec'
-  gem 'rb-fsevent' # guard notifications for osx 
+  gem 'rb-fsevent' # guard notifications for osx
   gem 'growl'      # $ brew install growlnotify
   gem 'rb-inotify' # guard notifications for linux
   gem 'libnotify'  # $ apt-get install ???
-end
+end

data/Gemfile.lock

@@ -1,6 +1,17 @@
+PATH
+  remote: .
+  specs:
+    backup (3.0.19)
+      POpen4 (~> 0.1.4)
+      thor (~> 0.14.6)
+
 GEM
   remote: http://rubygems.org/
   specs:
+    POpen4 (0.1.4)
+      Platform (>= 0.4.0)
+      open4
+    Platform (0.4.0)
     addressable (2.2.6)
     builder (3.0.0)
     crack (0.1.8)
@@ -38,6 +49,8 @@ GEM
     guard-rspec (0.3.1)
       guard (>= 0.2.2)
     hashie (1.1.0)
+    hipchat (0.4.1)
+      httparty
     httparty (0.7.4)
       crack (= 0.1.8)
     i18n (0.6.0)
@@ -59,7 +72,9 @@ GEM
     net-ssh (2.1.4)
     nokogiri (1.5.0)
     oauth (0.4.5)
+    open4 (1.2.0)
     polyglot (0.3.2)
+    prowler (1.3.1)
     rack (1.3.2)
     rb-fsevent (0.4.0)
     rb-inotify (0.8.5)
@@ -93,20 +108,23 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  backup!
   dropbox (~> 1.3.0)
   fog (>= 0.11.0)
   fuubar
   growl
   guard
   guard-rspec
+  hipchat (~> 0.4.1)
   httparty (~> 0.7.4)
   json (~> 1.5.1)
   libnotify
-  mail (~> 2.3.0)
+  mail (>= 2.2.15)
   mocha
   net-scp (~> 1.0.4)
   net-sftp (~> 2.0.5)
   net-ssh (~> 2.1.4)
+  prowler (>= 1.3.1)
   rb-fsevent
   rb-inotify
   rspec

data/Guardfile

@@ -1,17 +1,21 @@
-##
-# To run the test suite against all 3 rubies: 1.9.2, 1.8.7 and REE, simply run the following command:
+# encoding: utf-8
+
+# To run the test suite against all 3 rubies: 1.9.3, 1.9.2, and 1.8.7, simply run the following command:
+#
 # $ guard start
 #
-# Be use you are using RVM and have Ruby 1.9.2, 1.8.7 and REE installed as well as all
-# Backup's gem dependencies for each of these Ruby intepreters.
+# Be use you are using RVM and have Ruby 1.9.3, 1.9.2, 1.8.7 installed as well as all of Backup's gem
+# dependencies for each of these Ruby versions.
+#
+# Be sure to run `bundle install` against every Ruby version, as well as `gem install thor POpen4`
 
-guard 'rspec',
+guard "rspec",
   :version => 2,
-  :rvm     => ['1.9.3', '1.9.2', '1.8.7', 'ree'],
+  :rvm     => ["1.9.3", "1.9.2", "1.8.7"],
   :bundler => true,
-  :cli     => '--color --format Fuubar' do
+  :cli     => "--color --format Fuubar" do
 
   watch(%r{^spec/.+_spec\.rb})
-  watch(%r{^lib/(.+)\.rb})     { 'spec' }
-  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/(.+)\.rb})     { "spec" }
+  watch("spec/spec_helper.rb") { "spec" }
 end

data/README.md

@@ -1,7 +1,7 @@
 Backup 3
 ========
 
-Backup is a RubyGem, written for Linux and Mac OSX, that allows you to easily perform backup operations on both your remote, as well as your local environment. It provides you with an elegant DSL in Ruby for modeling (configuring) your backups. Backup has built-in support for various databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It was built with modularity, extensibility and simplicity in mind.
+Backup is a RubyGem, written for Linux and Mac OSX, that allows you to easily perform backup operations on both your remote and local environments. It provides you with an elegant DSL in Ruby for modeling your backups. Backup has built-in support for various databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It was built with modularity, extensibility and simplicity in mind.
 
 [![Build Status](https://secure.travis-ci.org/meskyanichi/backup.png)](http://travis-ci.org/meskyanichi/backup)
 [![Still Maintained](http://stillmaintained.com/meskyanichi/backup.png)](http://stillmaintained.com/meskyanichi/backup)
@@ -15,18 +15,16 @@ Author
 Drop me a message for any questions, suggestions, requests, bugs or submit them to the [issue log](https://github.com/meskyanichi/backup/issues).
 
 
-Please Donate!
---------------
-
-Please [DONATE](http://pledgie.com/campaigns/16065) to the Backup project. Backup was a huge amount of work and every donation received is encouraging and supports Backup's continued development! Thanks!
+Core Contributor
+----------------
 
-[![Donate to Backup](http://pledgie.com/campaigns/16065.png)](http://pledgie.com/campaigns/16065)
+**[Brian Burns](https://github.com/burns)**
 
 
 Installation
 ------------
 
-To get the latest stable version
+To get the latest stable version (3.0.20)
 
     gem install backup
 
@@ -36,12 +34,12 @@ You can view the list of released versions over at [RubyGems.org (Backup)](https
 Getting Started
 ---------------
 
-I recommend you read this README first, and refer to the [Wiki pages](https://github.com/meskyanichi/backup/wiki) afterwards. There's also a [Getting Started wiki page](https://github.com/meskyanichi/backup/wiki/Getting-Started).
+I recommend you read this README first, and refer to the [wiki pages](https://github.com/meskyanichi/backup/wiki) afterwards. There's also a [Getting Started wiki page](https://github.com/meskyanichi/backup/wiki/Getting-Started).
 
 What Backup 3 currently supports
 ================================
 
-Below you find a list of components that Backup currently supports. If you'd like support for components other than the ones listed here, feel free to request them or to fork Backup and add them yourself. Backup is modular and easy to extend with new components.
+Below you find a list of components that Backup currently supports. If you'd like support for components other than the ones listed here, feel free to request them or to fork Backup and add them yourself. Backup is modular and easy to extend.
 
 Database Support
 ----------------
@@ -50,6 +48,7 @@ Database Support
 - PostgreSQL
 - MongoDB
 - Redis
+- Riak
 
 [Database Wiki Page](https://github.com/meskyanichi/backup/wiki/Databases)
 
@@ -69,23 +68,34 @@ Storage Locations and Services
 - Ninefold Cloud Storage
 - Dropbox Web Service
 - Remote Servers *(Available Protocols: FTP, SFTP, SCP and RSync)*
+- Local Storage
 
 [Storage Wiki Page](https://github.com/meskyanichi/backup/wiki/Storages)
 
 Storage Features
 ----------------
 
-- Backup Cycling, applies to:
+- **Backup Cycling, applies to:**
   - Amazon Simple Storage Service (S3)
   - Rackspace Cloud Files (Mosso)
   - Ninefold Cloud Storage
   - Dropbox Web Service
   - Remote Servers *(Only Protocols: FTP, SFTP, SCP)*
-- Incremental Backups, applies to:
+  - Local Storage
+- **Backup Splitting, applies to:**
+  - Amazon Simple Storage Service (S3)
+  - Rackspace Cloud Files (Mosso)
+  - Ninefold Cloud Storage
+  - Dropbox Web Service
+  - Remote Servers *(Only Protocols: FTP, SFTP, SCP)*
+  - Local Storage
+- **Incremental Backups, applies to:**
   - Remote Servers *(Only Protocols: RSync)*
 
 [Storage Wiki Page](https://github.com/meskyanichi/backup/wiki/Storages)
 
+[Splitter Wiki Page](https://github.com/meskyanichi/backup/wiki/Splitter)
+
 Syncers
 -------
 
@@ -99,6 +109,7 @@ Compressors
 
 - Gzip
 - Bzip2
+- Pbzip2
 - Lzma
 
 [Compressors Wiki Page](https://github.com/meskyanichi/backup/wiki/Compressors)
@@ -118,16 +129,17 @@ Notifiers
 - Twitter
 - Campfire
 - Presently
+- Prowl
+- Hipchat
 
 [Notifiers Wiki Page](https://github.com/meskyanichi/backup/wiki/Notifiers)
 
 Supported Ruby versions (Tested with RSpec)
 -------------------------------------------
 
-- Ruby 1.9.3-preview1
+- Ruby 1.9.3
 - Ruby 1.9.2
 - Ruby 1.8.7
-- Ruby Enterprise Edition 1.8.7
 
 
 A sample Backup configuration file
@@ -138,6 +150,8 @@ This is a Backup configuration file. Check it out and read the explanation below
 ``` rb
 Backup::Model.new(:sample_backup, 'A sample backup configuration') do
 
+  split_into_chunks_of 4000
+
   database MySQL do |database|
     database.name               = 'my_sample_mysql_db'
     database.username           = 'my_username'
@@ -170,6 +184,24 @@ Backup::Model.new(:sample_backup, 'A sample backup configuration') do
     compression.best = true
   end
 
+  store_with SFTP, "Server A" do |server|
+    server.username = 'my_username'
+    server.password = 'secret'
+    server.ip       = 'a.my-backup-server.com'
+    server.port     = 22
+    server.path     = '~/backups'
+    server.keep     = 25
+  end
+
+  store_with SFTP, "Server B" do |server|
+    server.username = 'my_username'
+    server.password = 'secret'
+    server.ip       = 'b.my-backup-server.com'
+    server.port     = 22
+    server.path     = '~/backups'
+    server.keep     = 25
+  end
+
   store_with S3 do |s3|
     s3.access_key_id      = 'my_access_key_id'
     s3.secret_access_key  = 'my_secret_access_key'
@@ -193,11 +225,13 @@ Backup::Model.new(:sample_backup, 'A sample backup configuration') do
 
   notify_by Mail do |mail|
     mail.on_success = false
+    mail.on_warning = true
     mail.on_failure = true
   end
 
   notify_by Twitter do |tweet|
     tweet.on_success = true
+    tweet.on_warning = true
     tweet.on_failure = true
   end
 
@@ -208,8 +242,12 @@ end
 
 It will dump two databases (MySQL and MongoDB), it'll create two (.t)archives (user_avatars and logs). It'll package the two database and two archives together in a single (.t)archive. It'll run the Gzip compressor to compress that archive, and then it'll run the OpenSSL encryptor to encrypt the compressed archive. Then that encrypted archive will be stored to your Amazon S3 account. If all goes well, and no exceptions are raised, you'll be notified via the Twitter notifier that the backup succeeded. If there was an exception raised during the backup process, then you'd receive an email in your inbox containing detailed exception information, as well as receive a simple Twitter message that something went wrong.
 
+Aside of S3, we have also defined two `SFTP` storage methods, and given them two unique identifiers `Server A` and `Server B` to distinguish between the two. With these in place, a copy of the backup will now also be stored on two separate servers: `a.my-backup-server.com` and `b.my-backup-server.com`.
+
 As you can see, you can freely mix and match **archives**, **databases**, **compressors**, **encryptors**, **storages** and **notifiers** for your backups. You could even specify 4 storage locations if you wanted: Amazon S3, Rackspace Cloud Files, Ninefold and Dropbox, it'd then store your packaged backup to 4 separate locations for high redundancy. This also applies to compressors (like Gzip, Bzip2, Lzma) and encryptors, you could double encrypt your backup with OpenSSL followed by GPG if you wanted.
 
+Also, notice the `split_into_chunks_of 4000` at the top of the configuration. This tells Backup to split any backups that exceed in 4000 MEGABYTES of size in to multiple smaller chunks. Assuming your backup file is 12000 MEGABYTES (12GB) in size, then Backup will go ahead and split it in to 3 chunks of 4000 MEGABYTES and transfer them individually. This is useful for when you are using Amazon S3, Rackspace Cloud Files, or other 3rd party storage services which limit you to "5GB per file" uploads. So with this, the backup file size is no longer a constraint.
+
 Additionally we have also defined a **S3 Syncer** ( `sync_with S3` ), which does not follow the above process of archiving/compression/encryption, but instead will directly sync the whole `videos` and `music` folder structures from your machine to your Amazon S3 account. (very efficient and cost-effective since it will only transfer files that were added/changed. Additionally, since we flagged it to 'mirror', it'll also remove files from S3 that no longer exist). If you simply wanted to sync to a separate backup server that you own, you could also use the RSync syncer for even more efficient backups that only transfer the **bytes** of each file that changed.
 
 There are more **archives**, **databases**, **compressors**, **encryptors**, **storages** and **notifiers** than displayed in the example, all available components are listed at the top of this README, as well as in the [Wiki](https://github.com/meskyanichi/backup/wiki) with more detailed information.
@@ -226,7 +264,7 @@ Now it'll run the backup, it's as simple as that.
 
 ### Automatic backups
 
-Since Backup is a simple command line utility, you should write a crontask to invoke it periodically. I recommend you use [Whenever](https://github.com/javan/whenever) to manage your crontab. It'll allow you to write to the crontab in pure Ruby, it provides an elegant DSL to do so, for example:
+Since Backup is an easy-to-use command line utility, you should write a crontask to invoke it periodically. I recommend using [Whenever](https://github.com/javan/whenever) to manage your crontab. It'll allow you to write to the crontab using pure Ruby, and it provides an elegant DSL to do so. Here's an example:
 
 ``` rb
 every 6.hours do
@@ -234,7 +272,7 @@ every 6.hours do
 end
 ```
 
-With this in place, run `whenever --update-crontab backup` to write this Ruby syntax to the crontab in cron-syntax. The operating system will now invoke `backup perform --trigger sample_backup` every 6 hours. Check out the Whenever project page for more information.
+With this in place, run `whenever --update-crontab backup` to write the equivalent of the above Ruby syntax to the crontab in cron-syntax. Cron will now invoke `backup perform --trigger sample_backup` every 6 hours. Check out the Whenever project page for more information.
 
 Documentation
 -------------
@@ -343,6 +381,38 @@ Contributors
     <td><a href="https://github.com/joaovitor" target="_blank">João Vitor ( joaovitor )</a></td>
     <td>Changed default PostgreSQL example options to appropriate ones</td>
   </tr>
+  <tr>
+    <td><a href="https://github.com/swissmanu" target="_blank">Manuel Alabor ( swissmanu )</a></td>
+    <td>Prowl Notifier</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/josephcrim" target="_blank">Joseph Crim ( josephcrim )</a></td>
+    <td>Riak Database, exit() suggestions</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/fearoffish" target="_blank">Jamie van Dyke ( fearoffish )</a></td>
+    <td>POpen4 implementation</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/hmarr" target="_blank">Harry Marr ( hmarr )</a></td>
+    <td>Auth URL for Rackspace Cloud Files Storage</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/manuelmeurer" target="_blank">Manuel Meurer ( manuelmeurer )</a></td>
+    <td>Ensure the storage file (YAML dump) has content before reading it</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/jessedearing" target="_blank">Jesse Dearing ( jessedearing )</a></td>
+    <td>Hipchat Notifier</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/szymonpk" target="_blank">Szymon ( szymonpk )</a></td>
+    <td>Pbzip2 compressor</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/burns" target="_blank">burns ( burns )</a></td>
+    <td>Improved Backup cycling implementation by refreshing all user configuration during the cycle procedure</td>
+  </tr>
 </table>
 
 
@@ -351,21 +421,20 @@ Want to contribute?
 
 - Fork/Clone the **develop** branch
 - Write RSpec tests, and test against:
-  - Ruby 1.9.3-preview1
+  - Ruby 1.9.3
   - Ruby 1.9.2
   - Ruby 1.8.7
-  - Ruby Enterprise Edition 1.8.7
 - Try to keep the overall *structure / design* of the gem the same
 
 I can't guarantee I'll pull every pull request. Also, I may accept your pull request and drastically change parts to improve readability/maintainability. Feel free to discuss about improvements, new functionality/features in the [issue log](https://github.com/meskyanichi/backup/issues) before contributing if you need/want more information.
 
-Easily run tests against all four Ruby versions
------------------------------------------------
+Easily run tests against all three Ruby versions
+------------------------------------------------
 
-Install [RVM](https://rvm.beginrescueend.com/) and use it to install Ruby 1.9.3, 1.9.2, 1.8.7 and REE.
+Install [RVM](https://rvm.beginrescueend.com/) and use it to install Ruby 1.9.3, 1.9.2 and 1.8.7.
 
     rvm get latest && rvm reload
-    rvm install 1.9.3 && rvm install 1.9.2 && rvm install 1.8.7 && rvm install ree
+    rvm install 1.9.3 && rvm install 1.9.2 && rvm install 1.8.7
 
 Once these are installed, go ahead and install all the necessary dependencies.
 
@@ -373,26 +442,19 @@ Once these are installed, go ahead and install all the necessary dependencies.
     rvm use 1.9.3 && gem install bundler && bundle install
     rvm use 1.9.2 && gem install bundler && bundle install
     rvm use 1.8.7 && gem install bundler && bundle install
-    rvm use ree   && gem install bundler && bundle install
 
 The Backup gem uses [Guard](https://github.com/guard/guard) along with [Guard::RSpec](https://github.com/guard/guard-rspec) to quickly and easily test Backup's code against all four Rubies. If you've done the above, all you have to do is run:
 
     bundle exec guard
 
-from Backup's root and that's it. It'll now test against all four Rubies each time you adjust a file in the `lib` or `spec` directories.
+from Backup's root and that's it. It'll now test against all Ruby versions each time you adjust a file in the `lib` or `spec` directories.
 
 
-Or contribute by writing blogs/tutorials
-----------------------------------------
+Or contribute by writing blogs/tutorials/use cases
+--------------------------------------------------
 
 - http://erik.debill.org/2011/03/26/csing-backup-with-rails
 - http://blog.noizeramp.com/2011/03/31/backing-up-backup-ruby-gem/
 - http://www.sebaugereau.com/using-ruby-to-backup-with-beauty
 - http://outofti.me/post/4159686269/backup-with-pgbackups
 - http://h2ik.co/2011/03/backing-up-with-ruby/
-
-
-Backup 2 - Issues, Wiki, Source, Gems
-=====================================
-
-I won't actively support Backup 2 anymore. The source will remain on [a separate branch](https://github.com/meskyanichi/backup/tree/backup-2). [The Issues](https://github.com/meskyanichi/backup/issues) that belong to Backup 2 have been tagged with a black label "Backup 2". The Backup 2 specific [Wiki pages](https://github.com/meskyanichi/backup/wiki) have been prefixed with "Backup 2) <Article>". [The Backup 2 Gems](http://rubygems.org/gems/backup) will always remain so you can still use Backup 2. I might still accept pull requests, but would highly encourage anyone to [move to __Backup 3__ once it's here](https://github.com/meskyanichi/backup).

data/backup.gemspec

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.expand_path(File.dirname(__FILE__) + '/lib/backup')
+require File.expand_path('lib/backup/version')
 
 Gem::Specification.new do |gem|
 
@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.authors     = 'Michael van Rooijen'
   gem.email       = 'meskyanichi@gmail.com'
   gem.homepage    = 'http://rubygems.org/gems/backup'
-  gem.summary     = 'Backup is a RubyGem, written for Linux and Mac OSX, that allows you to easily perform backup operations on both your remote, as well as your local environment. It provides you with an elegant DSL in Ruby for modeling (configuring) your backups. Backup has built-in support for various databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It was built with modularity, extensibility and simplicity in mind.'
+  gem.summary     = 'Backup is a RubyGem, written for Linux and Mac OSX, that allows you to easily perform backup operations on both your remote and local environments. It provides you with an elegant DSL in Ruby for modeling your backups. Backup has built-in support for various databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It was built with modularity, extensibility and simplicity in mind.'
 
   ##
   # Files and folder that need to be compiled in to the Ruby Gem
@@ -27,6 +27,6 @@ Gem::Specification.new do |gem|
   ##
   # Gem dependencies
   gem.add_dependency 'thor',   ['~> 0.14.6']
-  gem.add_dependency 'popen4', ['~> 0.1.2']
+  gem.add_dependency 'POpen4', ['~> 0.1.4']
 
 end