backup 3.0.15 → 3.0.16

data/lib/backup/configuration/compressor/bzip2.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Bzip2 < Base
+        class << self
+
+          ##
+          # Tells Backup::Compressor::Bzip2 to compress
+          # better (-9) which is bzip2 default anyway
+          attr_accessor :best
+
+          ##
+          # Tells Backup::Compressor::Bzip2 to compress
+          # faster (-1) (but not significantly faster)
+          attr_accessor :fast
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/notifier/presently.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Notifier
+      class Presently < Base
+        class << self
+
+          ##
+          # Presently subdomain
+          attr_accessor :subdomain
+
+          ##
+          # Presently credentials
+          attr_accessor :user_name, :password
+
+          ##
+          # Group id
+          attr_accessor :group_id
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/encryptor/gpg.rb

@@ -30,7 +30,7 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        @key = key.gsub(/^(\s|\t)+/, '')
+        @key = key.gsub(/^[[:blank:]]+/, '')
       end
 
       ##

data/lib/backup/notifier/presently.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+
+Backup::Dependency.load('httparty')
+
+module Backup
+  module Notifier
+    class Presently < Base
+
+      ##
+      # Container for the Presently Client object
+      attr_accessor :presently_client
+
+      ##
+      # Container for the Model object
+      attr_accessor :model
+
+      ##
+      # Presently subdomain
+      attr_accessor :subdomain
+
+      ##
+      # Presently credentials
+      attr_accessor :user_name, :password
+
+      ##
+      # Group id
+      attr_accessor :group_id
+
+      ##
+      # Instantiates a new Backup::Notifier::Presently object
+      def initialize(&block)
+        load_defaults!
+
+        instance_eval(&block) if block_given?
+
+        set_defaults!
+      end
+
+      ##
+      # Performs the notification
+      # Takes an exception object that might've been created if an exception occurred.
+      # If this is the case it'll invoke notify_failure!(exception), otherwise, if no
+      # error was raised, it'll go ahead and notify_success!
+      #
+      # If'll only perform these if on_success is true or on_failure is true
+      def perform!(model, exception = false)
+        @model = model
+
+        if notify_on_success? and exception.eql?(false)
+          log!
+          notify_success!
+        elsif notify_on_failure? and not exception.eql?(false)
+          log!
+          notify_failure!(exception)
+        end
+      end
+
+    private
+
+      ##
+      # Sends a tweet informing the user that the backup operation
+      # proceeded without any errors
+      def notify_success!
+        presently_client.update("[Backup::Succeeded] #{model.label} (#{ File.basename(Backup::Model.file) })")
+      end
+
+      ##
+      # Sends a tweet informing the user that the backup operation
+      # raised an exception
+      def notify_failure!(exception)
+        presently_client.update("[Backup::Failed] #{model.label} (#{ File.basename(Backup::Model.file) })")
+      end
+
+      ##
+      # Create a default Presently::Client object
+      def set_defaults!
+        @presently_client = Client.new subdomain, user_name, password, group_id
+      end
+
+      class Client
+        include HTTParty
+
+        attr_accessor :subdomain, :user_name, :password, :group_id
+
+        def initialize(subdomain, user_name, password, group_id)
+          @subdomain = subdomain
+          @user_name = user_name
+          @password = password
+          @group_id = group_id
+
+          self.class.base_uri "https://#{subdomain}.presently.com"
+          self.class.basic_auth user_name, password
+        end
+
+        def update(message)
+          message = "d @#{group_id} #{message}" if group_id
+          self.class.post "/api/twitter/statuses/update.json", :body => {
+            :status => message,
+            :source => "Backup Notifier"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/backup/storage/s3.rb

@@ -84,12 +84,8 @@ module Backup
             File.join(remote_path, remote_file),
             File.open(File.join(local_path, local_file))
           )
-        rescue Excon::Errors::SocketError
-          puts "\nAn error occurred while trying to transfer the backup."
-          puts "Make sure the bucket exists, and that you specified the correct bucket region.\n\n"
-          puts "The available regions are:\n\n"
-          puts %w[eu-west-1 us-east-1 ap-southeast-1 us-west-1].map{ |region| "\s\s* #{region}" }.join("\n")
-          exit
+        rescue Excon::Errors::NotFound
+          raise "An error occurred while trying to transfer the backup, please make sure the bucket exists."
         end
       end
 

data/lib/backup/syncer/s3.rb

@@ -48,14 +48,14 @@ module Backup
       # and once it's finished syncing the files and directories to Amazon S3, it'll
       # unset these credentials (back to nil values)
       def perform!
-        set_s3sync_credentials!
+        set_environment_variables!
 
         directories.each do |directory|
           Logger.message("#{ self.class } started syncing '#{ directory }'.")
           Logger.silent( run("#{ utility(:s3sync) } #{ options } '#{ directory }' '#{ bucket }:#{ path }'") )
         end
 
-        unset_s3sync_credentials!
+        unset_environment_variables!
       end
 
       ##
@@ -99,16 +99,18 @@ module Backup
       # In order for S3Sync to know what credentials to use, we have to set the
       # AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, these
       # evironment variables will be used by S3Sync
-      def set_s3sync_credentials!
+      def set_environment_variables!
         ENV['AWS_ACCESS_KEY_ID']     = access_key_id
         ENV['AWS_SECRET_ACCESS_KEY'] = secret_access_key
+        ENV['AWS_CALLING_FORMAT']    = 'SUBDOMAIN'
       end
 
       ##
       # Sets the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY back to nil
-      def unset_s3sync_credentials!
+      def unset_environment_variables!
         ENV['AWS_ACCESS_KEY_ID']     = nil
         ENV['AWS_SECRET_ACCESS_KEY'] = nil
+        ENV['AWS_CALLING_FORMAT']    = nil
       end
 
     end

data/lib/backup/version.rb

@@ -13,7 +13,7 @@ module Backup
     #  Defines the minor version
     # PATCH:
     #  Defines the patch version
-    MAJOR, MINOR, PATCH = 3, 0, 15
+    MAJOR, MINOR, PATCH = 3, 0, 16
 
     ##
     # Returns the major version ( big release based off of multiple minor releases )

data/lib/templates/archive

@@ -1,3 +1,6 @@
+  ##
+  # Archive [Archive]
+  #
   archive :my_archive do |archive|
     archive.add '/path/to/a/file.rb'
     archive.add '/path/to/a/folder/'

data/lib/templates/compressor/bzip2

@@ -0,0 +1,7 @@
+  ##
+  # Bzip2 [Compressor]
+  #
+  compress_with Bzip2 do |compression|
+    compression.best = true
+    compression.fast = false
+  end

data/lib/templates/compressor/gzip

@@ -1,3 +1,6 @@
+  ##
+  # Gzip [Compressor]
+  #
   compress_with Gzip do |compression|
     compression.best = true
     compression.fast = false

data/lib/templates/database/mongodb

@@ -1,3 +1,6 @@
+  ##
+  # MongoDB [Database]
+  #
   database MongoDB do |db|
     db.name               = "my_database_name"
     db.username           = "my_username"

data/lib/templates/database/mysql

@@ -1,3 +1,6 @@
+  ##
+  # MySQL [Database]
+  #
   database MySQL do |db|
     db.name               = "my_database_name"
     db.username           = "my_username"

data/lib/templates/database/postgresql

@@ -1,3 +1,6 @@
+  ##
+  # PostgreSQL [Database]
+  #
   database PostgreSQL do |db|
     db.name               = "my_database_name"
     db.username           = "my_username"
@@ -7,5 +10,5 @@
     db.socket             = "/tmp/pg.sock"
     db.skip_tables        = ['skip', 'these', 'tables']
     db.only_tables        = ['only', 'these' 'tables']
-    db.additional_options = ['--quick', '--single-transaction']
+    db.additional_options = ['-xc', '-E=utf8']
   end

data/lib/templates/database/redis

@@ -1,3 +1,6 @@
+  ##
+  # Redis [Database]
+  #
   database Redis do |db|
     db.name               = "my_database_name"
     db.path               = "/usr/local/var/db/redis"

data/lib/templates/encryptor/gpg

@@ -1,3 +1,6 @@
+  ##
+  # GPG [Encryptor]
+  #
   encrypt_with GPG do |encryption|
     encryption.key = <<-KEY
       -----BEGIN PGP PUBLIC KEY BLOCK-----

data/lib/templates/encryptor/openssl

@@ -1,3 +1,6 @@
+  ##
+  # OpenSSL [Encryptor]
+  #
   encrypt_with OpenSSL do |encryption|
     encryption.password = 'my_password'
     encryption.base64   = true

data/lib/templates/notifier/campfire

@@ -1,3 +1,6 @@
+  ##
+  # Campfire [Notifier]
+  #
   notify_by Campfire do |campfire|
     campfire.on_success = true
     campfire.on_failure = true

data/lib/templates/notifier/mail

@@ -1,3 +1,6 @@
+  ##
+  # Mail [Notifier]
+  #
   notify_by Mail do |mail|
     mail.on_success           = true
     mail.on_failure           = true

data/lib/templates/notifier/presently

@@ -0,0 +1,12 @@
+  ##
+  # Presently [Notifier]
+  #
+  notify_by Presently do |presently|
+    presently.on_success = true
+    presently.on_failure = true
+
+    presently.subdomain = 'my_subdomain'
+    presently.user_name = 'my_user_name'
+    presently.password  = 'my_password'
+    presently.group_id  = 'my_group_id' # optional
+  end

data/lib/templates/notifier/twitter

@@ -1,3 +1,6 @@
+  ##
+  # Twitter [Notifier]
+  #
   notify_by Twitter do |tweet|
     tweet.on_success = true
     tweet.on_failure = true

data/lib/templates/readme

@@ -11,5 +11,5 @@
 # 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>]
+# $ backup perform -t my_backup [-c <path_to_configuration_file>]
 

data/lib/templates/storage/cloudfiles

@@ -1,3 +1,6 @@
+  ##
+  # Rackspace Cloud Files [Storage]
+  #
   store_with CloudFiles do |cf|
     cf.api_key   = 'my_api_key'
     cf.username  = 'my_username'

data/lib/templates/storage/dropbox

@@ -1,3 +1,6 @@
+  ##
+  # Dropbox File Hosting Service [Storage]
+  #
   store_with Dropbox do |db|
     db.email      = 'my@email.com'
     db.password   = 'my_password'

data/lib/templates/storage/ftp

@@ -1,3 +1,6 @@
+  ##
+  # FTP (File Transfer Protocol) [Storage]
+  #
   store_with FTP do |server|
     server.username = 'my_username'
     server.password = 'my_password'

data/lib/templates/storage/rsync

@@ -1,3 +1,6 @@
+  ##
+  # RSync [Storage]
+  #
   store_with RSync do |server|
     server.username = 'my_username'
     server.password = 'my_password'

data/lib/templates/storage/s3

@@ -1,3 +1,14 @@
+  ##
+  # Amazon Simple Storage Service [Storage]
+  #
+  # Available Regions:
+  #
+  #  - ap-northeast-1
+  #  - ap-southeast-1
+  #  - eu-west-1
+  #  - us-east-1
+  #  - us-west-1
+  #
   store_with S3 do |s3|
     s3.access_key_id      = 'my_access_key_id'
     s3.secret_access_key  = 'my_secret_access_key'
@@ -5,4 +16,6 @@
     s3.bucket             = 'bucket-name'
     s3.path               = '/path/to/my/backups'
     s3.keep               = 10
-  end
+  end
+  
+  

data/lib/templates/storage/scp

@@ -1,3 +1,6 @@
+  ##
+  # SCP (Secure Copy) [Storage]
+  #
   store_with SCP do |server|
     server.username = 'my_username'
     server.password = 'my_password'

data/lib/templates/storage/sftp

@@ -1,3 +1,6 @@
+  ##
+  # SFTP (Secure File Transfer Protocol) [Storage]
+  #
   store_with SFTP do |server|
     server.username = 'my_username'
     server.password = 'my_password'

data/lib/templates/syncer/rsync

@@ -1,3 +1,6 @@
+  ##
+  # RSync [Syncer]
+  #
   sync_with RSync do |rsync|
     rsync.ip       = "123.45.678.90"
     rsync.port     = 22

data/lib/templates/syncer/s3

@@ -1,3 +1,6 @@
+  ##
+  # Amazon Simple Storage Service [Syncer]
+  #
   sync_with S3 do |s3|
     s3.access_key_id     = "my_access_key_id"
     s3.secret_access_key = "my_secret_access_key"