backup 3.0.16 → 3.0.18

data/lib/backup/storage/ftp.rb

@@ -20,6 +20,10 @@ module Backup
       # Path to store backups to
       attr_accessor :path
 
+      ##
+      # use passive mode?
+      attr_accessor :passive_mode
+
       ##
       # Creates a new instance of the FTP storage object
       # First it sets the defaults (if any exist) and then evaluates
@@ -27,8 +31,9 @@ module Backup
       def initialize(&block)
         load_defaults!
 
-        @port ||= 21
-        @path ||= 'backups'
+        @port         ||= 21
+        @path         ||= 'backups'
+        @passive_mode ||= false
 
         instance_eval(&block) if block_given?
 
@@ -66,7 +71,9 @@ module Backup
           Net::FTP.send(:remove_const, :FTP_PORT)
         end; Net::FTP.send(:const_set, :FTP_PORT, port)
 
-        Net::FTP.new(ip, username, password)
+        ftp = Net::FTP.new(ip, username, password)
+        ftp.passive = true if passive_mode
+        ftp
       end
 
       ##

data/lib/backup/storage/local.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+##
+# Load the Ruby FileUtils library
+require 'fileutils'
+
+module Backup
+  module Storage
+    class Local < Base
+
+      ##
+      # Path to store backups to
+      attr_accessor :path
+
+      ##
+      # Creates a new instance of the Local storage object
+      # First it sets the defaults (if any exist) and then evaluates
+      # the configuration block which may overwrite these defaults
+      def initialize(&block)
+        load_defaults!
+
+        @path ||= "#{ENV['HOME']}/backups"
+
+        instance_eval(&block) if block_given?
+
+        @time = TIME
+        fix_path!
+      end
+
+      ##
+      # This is the remote path to where the backup files will be stored.
+      # Eventhough it says "remote", it's actually the "local" path, but
+      # the naming is necessary for compatibility reasons
+      def remote_path
+        File.join(path, TRIGGER)
+      end
+
+      ##
+      # Performs the backup transfer
+      def perform!
+        transfer!
+        cycle!
+      end
+
+    private
+
+      ##
+      # Transfers the archived file to the specified local path
+      def transfer!
+        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
+        create_local_directories!
+        FileUtils.cp(
+          File.join(local_path, local_file),
+          File.join(remote_path, remote_file)
+        )
+      end
+
+      ##
+      # Removes the transferred archive file from the local path
+      def remove!
+        FileUtils.rm(File.join(remote_path, remote_file))
+      end
+
+      ##
+      # Creates the path to where the backups are stored if it doesn't exist yet
+      def create_local_directories!
+        FileUtils.mkdir_p(remote_path)
+      end
+
+      ##
+      # Replaces ~/ with the full path to the users $HOME directory
+      def fix_path!
+        @path = path.sub(/^\~\//, "#{ENV['HOME']}/")
+      end
+
+    end
+  end
+end

data/lib/backup/storage/ninefold.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+##
+# Only load the Fog gem when the Backup::Storage::Ninefold class is loaded
+Backup::Dependency.load('fog')
+
+module Backup
+  module Storage
+    class Ninefold < Base
+
+      ##
+      # Ninefold Credentials
+      attr_accessor :storage_token, :storage_secret
+
+      ##
+      # Ninefold directory path
+      attr_accessor :path
+
+      ##
+      # Creates a new instance of the Ninefold storage object
+      # First it sets the defaults (if any exist) and then evaluates
+      # the configuration block which may overwrite these defaults
+      #
+      def initialize(&block)
+        load_defaults!
+
+        @path ||= 'backups'
+
+        instance_eval(&block) if block_given?
+
+        @time = TIME
+      end
+
+      ##
+      # This is the remote path to where the backup files will be stored
+      def remote_path
+        File.join(path, TRIGGER).sub(/^\//, '')
+      end
+
+      ##
+      # This is the provider that Fog uses for the Ninefold storage
+      def provider
+        'Ninefold'
+      end
+
+      ##
+      # Performs the backup transfer
+      def perform!
+        transfer!
+        cycle!
+      end
+
+    private
+
+      ##
+      # Establishes a connection to Amazon S3 and returns the Fog object.
+      # Not doing any instance variable caching because this object gets persisted in YAML
+      # format to a file and will issues. This, however has no impact on performance since it only
+      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
+      # background anyway so even if it were a bit slower it shouldn't matter.
+      def connection
+        Fog::Storage.new(
+          :provider                => provider,
+          :ninefold_storage_token  => storage_token,
+          :ninefold_storage_secret => storage_secret
+        )
+      end
+
+      ##
+      # Transfers the archived file to the specified directory
+      def transfer!
+        begin
+          Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
+          directory   = connection.directories.get remote_path
+          directory ||= connection.directories.create(:key => remote_path)
+          directory.files.create(
+            :key  => remote_file,
+            :body => File.open(File.join(local_path, local_file))
+          )
+        rescue Excon::Errors::NotFound
+          raise "An error occurred while trying to transfer the file."
+        end
+      end
+
+      ##
+      # Removes the transferred archive file from the Amazon S3 bucket
+      def remove!
+        begin
+          directory = connection.directories.get remote_path
+          directory.files.get(remote_file).destroy
+        rescue Excon::Errors::SocketError; end
+      end
+
+    end
+  end
+end

data/lib/backup/storage/rsync.rb

@@ -25,6 +25,10 @@ module Backup
       # Path to store backups to
       attr_accessor :path
 
+      ##
+      # Flag to use local backups
+      attr_accessor :local
+
       ##
       # Creates a new instance of the RSync storage object
       # First it sets the defaults (if any exist) and then evaluates
@@ -32,8 +36,9 @@ module Backup
       def initialize(&block)
         load_defaults!
 
-        @port ||= 22
-        @path ||= 'backups'
+        @port   ||= 22
+        @path   ||= 'backups'
+        @local  ||= false
 
         instance_eval(&block) if block_given?
         write_password_file!
@@ -55,6 +60,25 @@ module Backup
         remove_password_file!
       end
 
+      ##
+      # Returns Rsync syntax for defining a port to connect to
+      def port
+        "-e 'ssh -p #{@port}'"
+      end
+
+      ##
+      # Returns Rsync syntax for using a password file
+      def password
+        "--password-file='#{@password_file.path}'" unless @password.nil?
+      end
+
+      ##
+      # RSync options
+      # -z = Compresses the bytes that will be transferred to reduce bandwidth usage
+      def options
+        "-z"
+      end
+
     private
 
       ##
@@ -64,7 +88,7 @@ module Backup
       # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
       # background anyway so even if it were a bit slower it shouldn't matter.
       def connection
-        Net::SSH.start(ip, username, :password => @password, :port => port)
+        Net::SSH.start(ip, username, :password => @password, :port => @port)
       end
 
       ##
@@ -72,7 +96,11 @@ module Backup
       def transfer!
         Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
         create_remote_directories!
-        run("#{ utility(:rsync) } #{ options } #{ password } '#{ File.join(local_path, local_file) }' '#{ username }@#{ ip }:#{ File.join(remote_path, remote_file[20..-1]) }'")
+        if @local
+          run("#{ utility(:rsync) } '#{ File.join(local_path, local_file) }' '#{ File.join(remote_path, TIME+'.'+remote_file[20..-1]) }'")
+        else
+          run("#{ utility(:rsync) } #{ options } #{ port } #{ password } '#{ File.join(local_path, local_file) }' '#{ username }@#{ ip }:#{ File.join(remote_path, remote_file[20..-1]) }'")
+        end
       end
 
       ##
@@ -88,22 +116,11 @@ module Backup
       # Creates (if they don't exist yet) all the directories on the remote
       # server in order to upload the backup file.
       def create_remote_directories!
-        connection.exec!("mkdir -p '#{ remote_path }'")
-      end
-
-      ##
-      # RSync options
-      # -z     = Compresses the bytes that will be transferred to reduce bandwidth usage
-      # --port = the port to connect to through SSH
-      # -Phv   = debug options
-      def options
-        "-z --port='#{ port }'"
-      end
-
-      ##
-      # Returns Rsync syntax for using a password file
-      def password
-        "--password-file='#{@password_file.path}'" unless @password.nil?
+        if @local
+          mkdir(remote_path)
+        else
+          connection.exec!("mkdir -p '#{ remote_path }'")
+        end
       end
 
       ##

data/lib/backup/storage/s3.rb

@@ -77,7 +77,7 @@ module Backup
       # Transfers the archived file to the specified Amazon S3 bucket
       def transfer!
         begin
-          Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
+          Logger.message("#{ self.class } started transferring \"#{ remote_file }\" to bucket \"#{ bucket }\"")
           connection.sync_clock
           connection.put_object(
             bucket,

data/lib/backup/storage/scp.rb

@@ -55,7 +55,7 @@ module Backup
     private
 
       ##
-      # Establishes a connection to the remote server and returns the Net::SCP object.
+      # Establishes a connection to the remote server and returns the Net::SSH object.
       # Not doing any instance variable caching because this object gets persisted in YAML
       # format to a file and will issues. This, however has no impact on performance since it only
       # gets invoked once per object for a #transfer! and once for a remove! Backups run in the

data/lib/backup/syncer/rsync.rb

@@ -100,7 +100,7 @@ module Backup
       ##
       # Returns Rsync syntax for defining a port to connect to
       def port
-        "--port='#{@port}'"
+        "-e 'ssh -p #{@port}'"
       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, 16
+    MAJOR, MINOR, PATCH = 3, 0, 18
 
     ##
     # Returns the major version ( big release based off of multiple minor releases )

data/lib/templates/compressor/lzma

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

data/lib/templates/storage/dropbox

@@ -1,9 +1,9 @@
   ##
   # Dropbox File Hosting Service [Storage]
+  # Note: Initial backup must be performed manually to authorize
+  #       this machine with your Dropbox account.
   #
   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

data/lib/templates/storage/ftp

@@ -2,10 +2,11 @@
   # FTP (File Transfer Protocol) [Storage]
   #
   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
+    server.username     = 'my_username'
+    server.password     = 'my_password'
+    server.ip           = '123.45.678.90'
+    server.port         = 21
+    server.path         = '~/backups/'
+    server.keep         = 5
+    server.passive_mode = false
+  end

data/lib/templates/storage/local

@@ -0,0 +1,7 @@
+  ##
+  # Local (Copy) [Storage]
+  #
+  store_with Local do |local|
+    local.path = '~/backups/'
+    local.keep = 5
+  end

data/lib/templates/storage/ninefold

@@ -0,0 +1,9 @@
+  ##
+  # Ninefold Cloud Storage [Storage]
+  #
+  store_with Ninefold do |nf|
+    nf.storage_token   = 'my_storage_token'
+    nf.storage_secret  = 'my_storage_secret'
+    nf.path            = '/path/to/my/backups'
+    nf.keep            = 10
+  end

data/lib/templates/storage/rsync

@@ -7,4 +7,5 @@
     server.ip       = '123.45.678.90'
     server.port     = 22
     server.path     = '~/backups/'
+    server.local    = false
   end

data/spec/archive_spec.rb

@@ -58,7 +58,6 @@ describe Backup::Archive do
   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

data/spec/compressor/bzip2_spec.rb

@@ -22,7 +22,6 @@ describe Backup::Compressor::Bzip2 do
   describe '#perform!' do
     before do
       [:run, :utility].each { |method| compressor.stubs(method) }
-      Backup::Logger.stubs(:message)
     end
 
     it 'should perform the compression' do

data/spec/compressor/gzip_spec.rb

@@ -22,7 +22,6 @@ describe Backup::Compressor::Gzip do
   describe '#perform!' do
     before do
       [:run, :utility].each { |method| compressor.stubs(method) }
-      Backup::Logger.stubs(:message)
     end
 
     it 'should perform the compression' do

data/spec/compressor/lzma_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Compressor::Lzma do
+  let(:compressor) { Backup::Compressor::Lzma.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) }
+    end
+
+    it 'should perform the compression' do
+      compressor.expects(:utility).with(:lzma).returns(:lzma)
+      compressor.expects(:run).with("lzma  '#{ 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::Lzma.new do |c|
+        c.best = true
+        c.fast = true
+      end
+
+      compressor.stubs(:utility).returns(:lzma)
+      compressor.expects(:run).with("lzma --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 .lzma' do
+      compressor.stubs(:utility).returns(:lzma)
+      compressor.expects(:run)
+
+      Backup::Model.extension.should == 'tar'
+      compressor.perform!
+      Backup::Model.extension.should == 'tar.lzma'
+    end
+
+    it 'should log' do
+      Backup::Logger.expects(:message).with("Backup::Compressor::Lzma started compressing the archive.")
+      compressor.perform!
+    end
+  end
+end