backup 3.0.2 → 3.0.3.build.0

data/lib/backup/storage/rsync.rb

@@ -1,100 +0,0 @@
-# encoding: utf-8
-
-##
-# Only load the Net::SSH library when the Backup::Storage::RSync class is loaded
-require 'net/ssh'
-
-module Backup
-  module Storage
-    class RSync < Base
-      include Backup::CLI
-
-      ##
-      # Server credentials
-      attr_accessor :username, :password
-
-      ##
-      # Server IP Address and SSH port
-      attr_accessor :ip, :port
-
-      ##
-      # Path to store backups to
-      attr_accessor :path
-
-      ##
-      # Creates a new instance of the RSync 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!
-
-        @port ||= 22
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
-      ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER)
-      end
-
-      ##
-      # Performs the backup transfer
-      def perform!
-        transfer!
-      end
-
-    private
-
-      ##
-      # 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
-      # 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)
-      end
-
-      ##
-      # Transfers the archived file to the specified remote server
-      def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-        create_remote_directories!
-        run("#{ utility(:rsync) } #{ options } '#{ File.join(local_path, local_file) }' '#{ username }@#{ ip }:#{ File.join(remote_path, remote_file[20..-1]) }'")
-      end
-
-      ##
-      # Removes the transferred archive file from the server
-      def remove!
-        response = connection.exec!("rm #{ File.join(remote_path, remote_file) }")
-        if response =~ /No such file or directory/
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
-        end
-      end
-
-      ##
-      # 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
-      # -e     = Allow the usage of SSH remote shell
-      # --port = the port to connect to through SSH
-      # -Phv   = debug options
-      def options
-        "-z -e ssh --port='#{ port }'"
-      end
-
-    end
-  end
-end

data/lib/backup/storage/s3.rb

@@ -1,108 +0,0 @@
-# encoding: utf-8
-
-##
-# Only load the Fog gem when the Backup::Storage::S3 class is loaded
-require 'fog'
-
-module Backup
-  module Storage
-    class S3 < Base
-
-      ##
-      # Amazon Simple Storage Service (S3) Credentials
-      attr_accessor :access_key_id, :secret_access_key
-
-      ##
-      # Amazon S3 bucket name and path
-      attr_accessor :bucket, :path
-
-      ##
-      # Region of the specified S3 bucket
-      attr_accessor :region
-
-      ##
-      # Creates a new instance of the Amazon S3 storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      #
-      # Currently available regions:
-      #   eu-west-1, us-east-1, ap-southeast-1, us-west-1
-      def initialize(&block)
-        load_defaults!
-
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @path = path.sub(/^\//, '')
-        @time = TIME
-      end
-
-      ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER, '/')
-      end
-
-      ##
-      # This is the provider that Fog uses for the S3 Storage
-      def provider
-        'AWS'
-      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,
-          :aws_access_key_id      => access_key_id,
-          :aws_secret_access_key  => secret_access_key,
-          :region                 => region
-        )
-      end
-
-      ##
-      # Transfers the archived file to the specified Amazon S3 bucket
-      def transfer!
-        begin
-          Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-          connection.sync_clock
-          connection.put_object(
-            bucket,
-            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
-        end
-      end
-
-      ##
-      # Removes the transferred archive file from the Amazon S3 bucket
-      def remove!
-        begin
-          connection.sync_clock
-          connection.delete_object(bucket, File.join(remote_path, remote_file))
-        rescue Excon::Errors::SocketError; end
-      end
-
-    end
-  end
-end

data/lib/backup/storage/scp.rb

@@ -1,105 +0,0 @@
-# encoding: utf-8
-
-##
-# Only load the Net::SSH and Net::SCP library/gems
-# when the Backup::Storage::SCP class is loaded
-require 'net/ssh'
-require 'net/scp'
-
-module Backup
-  module Storage
-    class SCP < Base
-
-      ##
-      # Server credentials
-      attr_accessor :username, :password
-
-      ##
-      # Server IP Address and SCP port
-      attr_accessor :ip, :port
-
-      ##
-      # Path to store backups to
-      attr_accessor :path
-
-      ##
-      # Creates a new instance of the SCP 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!
-
-        @port ||= 22
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
-      ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER)
-      end
-
-      ##
-      # Performs the backup transfer
-      def perform!
-        transfer!
-        cycle!
-      end
-
-    private
-
-      ##
-      # Establishes a connection to the remote server and returns the Net::SCP 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.
-      #
-      # We will be using Net::SSH, and use Net::SCP through Net::SSH to transfer backups
-      def connection
-        Net::SSH.start(ip, username, :password => password, :port => port)
-      end
-
-      ##
-      # Transfers the archived file to the specified remote server
-      def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-        create_remote_directories!
-        connection.scp.upload!(
-          File.join(local_path, local_file),
-          File.join(remote_path, remote_file)
-        )
-      end
-
-      ##
-      # Removes the transferred archive file from the server
-      def remove!
-        response = connection.exec!("rm #{ File.join(remote_path, remote_file) }")
-        if response =~ /No such file or directory/
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
-        end
-      end
-
-      ##
-      # Creates (if they don't exist yet) all the directories on the remote
-      # server in order to upload the backup file. Net::SCP does not support
-      # paths to directories that don't yet exist when creating new directories.
-      # Instead, we split the parts up in to an array (for each '/') and loop through
-      # that to create the directories one by one. Net::SCP raises an exception when
-      # the directory it's trying ot create already exists, so we have rescue it
-      def create_remote_directories!
-        path_parts = Array.new
-        remote_path.split('/').each do |path_part|
-          path_parts << path_part
-          connection.exec!("mkdir '#{ path_parts.join('/') }'")
-        end
-      end
-
-    end
-  end
-end

data/lib/backup/storage/sftp.rb

@@ -1,106 +0,0 @@
-# encoding: utf-8
-
-##
-# Only load the Net::SFTP library/gem when the Backup::Storage::SFTP class is loaded
-require 'net/sftp'
-
-module Backup
-  module Storage
-    class SFTP < Base
-
-      ##
-      # Server credentials
-      attr_accessor :username, :password
-
-      ##
-      # Server IP Address and SFTP port
-      attr_accessor :ip, :port
-
-      ##
-      # Path to store backups to
-      attr_accessor :path
-
-      ##
-      # Creates a new instance of the SFTP 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!
-
-        @port ||= 22
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
-      ##
-      # This is the remote path to where the backup files will be stored
-      def remote_path
-        File.join(path, TRIGGER)
-      end
-
-      ##
-      # Performs the backup transfer
-      def perform!
-        transfer!
-        cycle!
-      end
-
-    private
-
-      ##
-      # Establishes a connection to the remote server and returns the Net::SFTP 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
-        Net::SFTP.start(ip, username, :password => password, :port => port)
-      end
-
-      ##
-      # Transfers the archived file to the specified remote server
-      def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-        create_remote_directories!
-        connection.upload!(
-          File.join(local_path, local_file),
-          File.join(remote_path, remote_file)
-        )
-      end
-
-      ##
-      # Removes the transferred archive file from the server
-      def remove!
-        begin
-          connection.remove!(
-            File.join(remote_path, remote_file)
-          )
-        rescue Net::SFTP::StatusException
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
-        end
-      end
-
-      ##
-      # Creates (if they don't exist yet) all the directories on the remote
-      # server in order to upload the backup file. Net::SFTP does not support
-      # paths to directories that don't yet exist when creating new directories.
-      # Instead, we split the parts up in to an array (for each '/') and loop through
-      # that to create the directories one by one. Net::SFTP raises an exception when
-      # the directory it's trying ot create already exists, so we have rescue it
-      def create_remote_directories!
-        path_parts = Array.new
-        remote_path.split('/').each do |path_part|
-          path_parts << path_part
-          begin
-            connection.mkdir!(path_parts.join('/'))
-          rescue Net::SFTP::StatusException; end
-        end
-      end
-
-    end
-  end
-end

data/lib/backup/version.rb

@@ -1,72 +0,0 @@
-# encoding: utf-8
-
-module Backup
-
-  ##
-  # Usage:
-  #
-  #  # Returns the current backup version based on the defined constants
-  #    Backup::Version.current
-  #
-  #  # Returns a gemspec compatible version number based on the defined constants
-  #    Backup::Version.gemspec
-  #
-  class Version
-
-    ##
-    # MAJOR:
-    #  Defines the major version
-    # MINOR:
-    #  Defines the minor version
-    # PATCH:
-    #  Defines the patch version
-    # BUILD:
-    #  Defines the build version ( use 'false' if no build )
-    MAJOR, MINOR, PATCH, BUILD = 3, 0, 2, false
-
-    # ========================================================= #
-    #  ADJUST THE CONSTANTS ABOVE TO CHANGE THE BACKUP VERSION  #
-    # ========================================================= #
-
-    ##
-    # Returns the major version ( big release based off of multiple minor releases )
-    def self.major
-      MAJOR
-    end
-
-    ##
-    # Returns the minor version ( small release based off of multiple patches )
-    def self.minor
-      MINOR
-    end
-
-    ##
-    # Returns the patch version ( updates, features and (crucial) bug fixes based off of multiple builds )
-    def self.patch
-      PATCH
-    end
-
-    ##
-    # Returns the build version ( improvements, small additions, frequent releases )
-    def self.build
-      BUILD
-    end
-
-    ##
-    # Returns the current version ( not for gemspec / rubygems )
-    def self.current
-      "#{major}.#{minor}.#{patch} / build #{build or 0}"
-    end
-
-    ##
-    # Returns the (gemspec qualified) current version
-    def self.gemspec
-      if build.eql?(false)
-        "#{major}.#{minor}.#{patch}"
-      else
-        "#{major}.#{minor}.#{patch}.build.#{build}"
-      end
-    end
-
-  end
-end