backup 2.4.5.1 → 3.0.0.build.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.infinity_test

@@ -0,0 +1,7 @@
+infinity_test do
+  heuristics do
+    add('lib/') do |file|
+      run :all => :tests
+    end
+  end
+end

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--tty

data/Gemfile

@@ -0,0 +1,17 @@
+##
+# RubyGems Source
+source 'http://rubygems.org'
+
+##
+# Bundle gems definde inside the gemspec file
+gemspec
+
+##
+# Define gems to be used in the 'test' environment
+group :test do
+  gem 'rspec'
+  gem 'mocha'
+  gem 'infinity_test'
+  gem 'fuubar'
+  gem 'timecop'
+end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    backup (3.0.0.build.0)
+      dropbox (~> 1.2.3)
+      fog (~> 0.5.3)
+      mail (~> 2.2.15)
+      net-scp (~> 1.0.4)
+      net-sftp (~> 2.0.5)
+      thor (~> 0.14.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.5)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    dropbox (1.2.3)
+      json (>= 1.2.0)
+      mechanize (>= 1.0.0)
+      multipart-post (>= 1.0)
+      oauth (>= 0.3.6)
+    excon (0.5.6)
+    fog (0.5.3)
+      builder
+      excon (>= 0.5.2)
+      formatador (>= 0.0.16)
+      json
+      mime-types
+      net-ssh (>= 2.0.23)
+      nokogiri (>= 1.4.4)
+      ruby-hmac
+    formatador (0.0.16)
+    fuubar (0.0.3)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+      ruby-progressbar (~> 0.0.9)
+    i18n (0.5.0)
+    infinity_test (1.0.2)
+      notifiers (>= 1.1.0)
+      watchr (>= 0.7)
+    json (1.5.1)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mechanize (1.0.0)
+      nokogiri (>= 1.2.1)
+    mime-types (1.16)
+    mocha (0.9.12)
+    multipart-post (1.1.0)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.1.3)
+    nokogiri (1.4.4)
+    notifiers (1.1.0)
+    oauth (0.4.4)
+    polyglot (0.3.1)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.6)
+    rspec-mocks (2.5.0)
+    ruby-hmac (0.4.0)
+    ruby-progressbar (0.0.9)
+    thor (0.14.6)
+    timecop (0.3.5)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  backup!
+  fuubar
+  infinity_test
+  mocha
+  rspec
+  timecop

data/LICENSE.md

@@ -0,0 +1,24 @@
+
+Copyright (c) 2009-2011 Michael van Rooijen ( [@meskyanichi](http://twitter.com/#!/meskyanichi) )
+=================================================================================================
+
+The "Backup" RubyGem is released under the **MIT LICENSE**
+----------------------------------------------------------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,122 +1,236 @@
-# Backup
+Backup 3
+========
 
-## A Backup Ruby Gem
+Backup is a RubyGem (for UNIX-like operating systems: Linux, Mac OSX) that allows you to configure and perform backups in a simple manner using an elegant Ruby DSL. It supports various various databases (MySQL, PostgreSQL, MongoDB and Redis), it supports various storage locations (Amazon S3, Rackspace Cloud Files, Dropbox, any remote server through FTP, SFTP, SCP and RSync), it can archive files and folders, it can cycle backups, it can do incremental backups, it can compress backups, it can encrypt backups (OpenSSL or GPG), it can notify you about successful and/or failed backups. It is very extensible and easy to add new functionality to. It's easy to use.
 
-__Backup__ is a Ruby Gem written for __Unix__ and __Ruby on Rails (2 and 3)__ environments. It can be used both with and without the Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as MySQL/PostgreSQL/SQLite and Files/Folders. All backups can be transferred to Amazon S3, Rackspace Cloud Files, Dropbox Web Service, any remote server you have access to (using either SCP, SFTP or regular FTP), or a Local server. Backup handles Compression, Archiving, Encryption, Backup Cleaning (Cycling) and supports Email Notifications.
+Author
+------
 
-## Written for Environments
+Michael van Rooijen ( [@meskyanichi](http://twitter.com/#!/meskyanichi) )
 
-* UNIX (Ubuntu, OSX, etc.)
-* Ruby on Rails 3
-* Ruby on Rails 2
+Drop me a message for any questions, suggestions, requests, bugs or submit them to the [issue log](https://github.com/meskyanichi/backup/issues).
 
-## Authors/Maintainers
+Installation
+------------
 
-* [Meskyanichi - Michael van Rooijen](http://github.com/meskyanichi)
-* [Fernandoluizao - Fernando Migliorini Luizão](http://github.com/fernandoluizao)
+To get the latest stable version
 
-### Contributors
+    gem install backup
 
-* [dtrueman](http://github.com/dtrueman)
-* [Nathan L Smith](http://github.com/smith)
-* [Francesc Esplugas](http://github.com/fesplugas)
-* [wakiki](http://github.com/wakiki)
-* [Dan Hixon](http://github.com/danhixon)
-* [Adam Greene](http://github.com/skippy)
-* [Dmitriy Novotochinov](http://github.com/trybeee)
+To get the latest *build* of the latest stable version
 
+    gem install backup --pre
 
-## Backup's Current Capabilities
+Builds **aim** to be stable, but cannot guarantee it. Builds tend to be released a lot more frequent than the stable versions. So if you want to live on the edge and want the latest improvements, install the build gems.
 
-### Storage Methods
+You can view the list of released versions over at [RubyGems.org (Backup)](https://rubygems.org/gems/backup/versions)
 
-* Amazon S3
-* Rackspace Cloud Files
-* Dropbox (Using your API key/secret from developers.dropbox.com)
-* Remote Server (Available Protocols: SCP, SFTP, FTP)
-* Local server (Example Locations: Another Hard Drive, Network path)
 
-### Adapters
+What Backup 3 currently supports
+================================
 
-* MySQL
-* PostgreSQL
-* SQLite
-* MongoDB
-* Archive (Any files and/or folders)
-* Custom (Anything you can produce using the command line)
+**Below you find a summary of what the Backup gem currently supports. Each of the items below is more or less isolated from each other, meaning that adding new databases, storage locations, compressors, encryptors, notifiers, and such is relatively easy to do.**
 
-### Archiving
+Database Support
+----------------
 
-Handles archiving for the __Archive__ and __Custom__ adapters.
+- MySQL
+- PostgreSQL
+- MongoDB
+- Redis
 
-### Encryption
+[Database Wiki Page](https://github.com/meskyanichi/backup/wiki/Databases)
 
-Handles encryption of __all__ backups for __any__ adapter.
-To decrypt a "Backup encrypted file" you can use Backup's built-in utility command:
+Filesystem Support
+------------------
 
-    sudo backup --decrypt /path/to/encrypted/file.enc
+- Files
+- Folders
 
-### Backup Cleaning
+[Archive Wiki Page](https://github.com/meskyanichi/backup/wiki/Archives)
 
-With Backup you can very easily specify how many backups you would like to have stored (per backup procedure!) on your Amazon S3, Remote or Local server. When the limit you specify gets exceeded, the oldest backup will automatically be cleaned up.
+Storage Locations
+-----------------
 
-### Email Notifications
+- Amazon Simple Storage Service (S3)
+- Rackspace Cloud Files (Mosso)
+- Dropbox
+- Remote Servers *(Available Protocols: FTP, SFTP, SCP and RSync)*
 
-You will be able to specify whether you would like to be notified by email when a backup successfully been stored. Simply fill in the email configuration block and set "notify" to true inside the backup procedure you would like to be notified of.
+[Storage Wiki Page](https://github.com/meskyanichi/backup/wiki/Storages)
 
-### Quick Example of a Single Backup Setting/Procedure inside the Backup Configuration File
+Storage Features
+----------------
 
-    backup 'mysql-backup-s3' do
-      adapter :mysql do
-        user      'user'
-        password  'password'
-        database  'database'
+- Backup Cycling, applies to:
+  - Amazon Simple Storage Service (S3)
+  - Rackspace Cloud Files (Mosso)
+  - Dropbox
+  - Remote Servers *(Only Protocols: FTP, SFTP, SCP)*
+- Incremental Backups, applies to:
+  - Remote Servers *(Only Protocols: RSync)*
+
+[Storage Wiki Page](https://github.com/meskyanichi/backup/wiki/Storages)
+
+Compressors
+-----------
+
+- Gzip
+
+[Compressors Wiki Page](https://github.com/meskyanichi/backup/wiki/Compressors)
+
+Encryptors
+----------
+
+- OpenSSL
+- GPG
+
+[Encryptors Wiki Page](https://github.com/meskyanichi/backup/wiki/Encryptors)
+
+Notifiers
+---------
+
+- Mail
+
+[Notifiers Wiki Page](https://github.com/meskyanichi/backup/wiki/Notifiers)
+
+Supported Ruby versions (Tested with RSpec)
+-------------------------------------------
+
+- Ruby 1.9.2
+- Ruby 1.8.7
+- Ruby Enterprise Edition 1.8.7
+
+Environments
+------------
+
+Backup **3** runs in **UNIX**-based operating systems: Linux, Mac OSX, etc. It does **NOT** run on the Windows operating system, and there are currently no plans to support it.
+
+Compatibility
+-------------
+
+Backup **3** is **NOT** backwards compatible with Backup **2**. The command line interface has changed. The DSL has changed. And a lot more has changed. All for the better.
+
+
+A sample "Backup" configuration file
+====================================
+
+Below you see a sample configuration file you could create for Backup 3. Just read through it slowly and I'm quite sure you will already know what's going to happen before I explain it to you. **(see explanation after the example)**
+
+    Backup::Model.new(:sample_backup, 'A sample backup configuration') do
+
+      database MySQL do |database|
+        database.name               = 'my_sample_mysql_db'
+        database.username           = 'my_username'
+        database.password           = 'my_password'
+        database.skip_tables        = ['logs']
+        database.additional_options = ['--single-transaction', '--quick']
+      end
+
+      database MongoDB do |database|
+        database.name             = 'my_sample_mongo_db'
+        database.only_collections = ['users', 'events', 'posts']
       end
-      storage :s3 do
-        access_key_id     'access_key_id'
-        secret_access_key 'secret_access_key'
-        host              's3-ap-southeast-1.amazonaws.com'
-        bucket            '/bucket/backups/mysql/'
-        use_ssl           true
+
+      archive :user_avatars do |archive|
+        archive.add '/var/apps/my_sample_app/public/avatars'
+      end
+
+      archive :logs do |archive|
+        archive.add '/var/apps/my_sample_app/logs/production.log'
+        archive.add '/var/apps/my_sample_app/logs/newrelic_agent.log'
+        archive.add '/var/apps/my_sample_app/logs/other.log'
+      end
+
+      encrypt_with OpenSSL do |encryption|
+        encryption.password = 'my_secret_password'
+      end
+
+      compress_with Gzip do |compression|
+        compression.best = true
+      end
+
+      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             = 'my_bucket/backups'
+        s3.keep               = 20
+      end
+
+      store_with RSync do |server|
+        server.username = 'my_username'
+        server.password = 'my_password'
+        server.ip       = '123.45.678.90'
+        server.path     = '~/backups/'
+      end
+
+      notify_by Mail do |mail|
+        mail.on_success = false
+        mail.on_failure = true
       end
-      keep_backups 25
-      encrypt_with_password 'my_password'
-      notify true
     end
-  
-Everything above should be pretty straightforward, so now, using the __trigger__ we specified between
-the `backup` and `do` you can execute this backup procedure like so:
 
-__Rails Environment__
+### Explanation for the above example
+
+First it dumps all the tables inside the MySQL database "my_sample_mysql_db", except for the "logs" table. It also dumps the MongoDB database "my_sample_mongo_db", but only the collections "users", "events" and "posts". After that it'll create a "user_avatars.tar" archive with all the uploaded avatars of the users. After that it'll create a "logs.tar" archive with the "production.log", "newrelic_agent.log" and "other.log" logs. After that it'll encrypt the whole backup file (everything included: databases, archives) using "OpenSSL". Now the Backup can only be extracted when you know the password to decrypt it ("my_secret_password" in this case). After that it'll compress the backup file using Gzip (with the mode set to "best", rather than "fast" for best compression). Then it'll store the backup file to Amazon S3 in to 'my_bucket/backups'. Next it'll also transfer a copy of the backup file to a remote server using the RSync protocol, and it'll be stored in to the "$HOME/backups/" path on this server. Finally, it'll notify me by email if the backup raises an error/exception during the process indicating that something went wrong. (When setting `mail.on_success = true` it'll also notify you of every successful backup)
+
+### Things to note
+
+The __keep__ option I passed in to the S3 storage location enables "Backup Cycling". In this case, after the 21st backup file gets pushed, it'll exceed the 20 backup limit, and remove the oldest backup from the S3 bucket.
+
+The __RSync__ protocol doesn't utilize the __keep__ option. RSync is used to do incremental backups, and only stores a single file on your remote server, which gets incrementally updated with each run. For example, if everything you dump ends up to be about 2000MB, the first time, you'll be transferring the full 2000MB. If by the time the next backup run starts this dump has increased to 2100MB, it'll calculate the difference between the source and destination file and only transfer the remaining 100MB, rather than the full 2100MB. (Note: To reduce bandwidth as much as possible with RSync, ensure you don't use compression or encryption, otherwise RSync isn't able to calculate the difference very well and bandwidth usage greatly increases.)
+
+The __Mail__ notifier. I have not provided the SMTP options to use my Gmail account to notify myself when exceptions are raised during the process. So this won't work, check out the wiki on how to configure this. I left it out in this example.
 
-    rake backup:run trigger=mysql-backup-s3
+### And that's it!
 
-__Unix Environment__
+So as you can see the DSL is straightforward and should be simple to understand and extend to your needs. You can have as many databases, archives, storage locations, compressors, encryptors and notifiers inside the above example as you need and it'll bundle all of it up in a nice packaged archive and transfer it to every specified location (as redundant as you like).
 
-    sudo backup --run mysql-backup-s3
+### Running the example
 
-That's it. This was a simple example of how it works.
+Remember the `Backup::Model.new(:sample_backup, 'A sample backup configuration') do`?
+The `:sample_backup` is called the "id", or "trigger". This is used to identify the backup procedure/file and initialize it.
 
-## Want to take Backup for a spin?
+    backup perform -t sample_backup
+
+That's it.
+
+### Automatic backups
+
+Since it's a simple command line utility, just write a cron to invoke it whenever you want. I recommend you use the [Whenever Gem](https://github.com/javan/whenever) to manage your cron tasks. It'll enable you to write such elegant automatic backup syntax in Ruby:
+
+    every 6.hours do
+      command "backup perform -t sample_backup"
+    end
 
-### Wiki Pages
 
-[Check out our (15) helpful wiki pages](http://github.com/meskyanichi/backup/wiki)
+Documentation
+-------------
 
+See the [Wiki Pages](https://github.com/meskyanichi/backup/wiki). The subjects labeled **without** the "Backup 2)"-prefix are meant for Backup 3 users.
 
-### Requests
 
-If anyone has any requests, please send us a message or post it in the [issue log](http://github.com/meskyanichi/backup/issues)!
+Suggestions, Bugs, Requests, Questions
+--------------------------------------
 
+View the [issue log](https://github.com/meskyanichi/backup/issues) and post them there.
 
-### Suggestions?
 
-Send us a message! Fork the project!
+Want to contribute?
+-------------------
 
+- Fork/Clone the **develop** branch
+- Write RSpec tests, and test against:
+  - 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
 
-### Found a Bug?
+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.
 
-[Report it](http://github.com/meskyanichi/backup/issues)
 
+Backup 2 - Issues, Wiki, Source, Gems
+=====================================
 
-__Michael van Rooijen | Final Creation. ([http://michaelvanrooijen.com/](http://michaelvanrooijen.com))__
+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).