backup_checksum 3.0.23

data/backup_checksum.gemspec

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require File.expand_path('lib/backup/version')
+
+Gem::Specification.new do |gem|
+
+  ##
+  # General configuration / information
+  gem.name        = 'backup_checksum'
+  gem.version     = Backup::Version.current
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = 'Lukasz Kaniowski'
+  gem.email       = 'lukasz.kaniowski@gmail.com'
+  gem.homepage    = 'http://rubygems.org/gems/backup_checksum'
+  gem.summary     = 'It is a clone of http://rubygems.org/gems/backup with checksum added'
+
+  ##
+  # Files and folder that need to be compiled in to the Ruby Gem
+  gem.files         = %x[git ls-files].split("\n")
+  gem.test_files    = %x[git ls-files -- {spec}/*].split("\n")
+  gem.require_path  = 'lib'
+
+  ##
+  # The Backup CLI executable
+  gem.executables   = ['backup']
+
+  ##
+  # Gem dependencies
+  gem.add_dependency 'thor',   ['~> 0.14.6']
+  gem.add_dependency 'POpen4', ['~> 0.1.4']
+
+end

data/bin/backup

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# Load the Backup core library
+require File.expand_path("../../lib/backup", __FILE__)
+
+# Load the Backup command line interface utility
+require File.expand_path("../../lib/backup/cli/utility", __FILE__)
+
+# Initialize the Backup command line utility
+Backup::CLI::Utility.start

data/lib/backup.rb

@@ -0,0 +1,217 @@
+# encoding: utf-8
+
+# Load Ruby Core Libraries
+require 'rubygems'
+require 'fileutils'
+require 'tempfile'
+require 'yaml'
+require 'etc'
+
+# Attempt load to POpen4 and Thor Libraries
+begin
+  gem 'POpen4', '~> 0.1.4'
+  gem 'thor',   '~> 0.14.6'
+  require 'popen4'
+  require 'thor'
+rescue LoadError
+  puts "\nBackup requires Thor to load the CLI Utility (Command Line Interface Utility) and POpen4 to determine the status of the unix processes."
+  puts "Please install both the Thor and POpen4 libraries first:\n\ngem install thor -v '~> 0.14.6'\ngem install POpen4 -v '~> 0.1.4'"
+  exit 1
+end
+
+##
+# The Backup Ruby Gem
+module Backup
+
+  ##
+  # Backup's internal paths
+  LIBRARY_PATH       = File.join(File.dirname(__FILE__), 'backup')
+  CLI_PATH           = File.join(LIBRARY_PATH, 'cli')
+  STORAGE_PATH       = File.join(LIBRARY_PATH, 'storage')
+  DATABASE_PATH      = File.join(LIBRARY_PATH, 'database')
+  COMPRESSOR_PATH    = File.join(LIBRARY_PATH, 'compressor')
+  CHECKSUM_PATH      = File.join(LIBRARY_PATH, 'checksum')
+  ENCRYPTOR_PATH     = File.join(LIBRARY_PATH, 'encryptor')
+  NOTIFIER_PATH      = File.join(LIBRARY_PATH, 'notifier')
+  SYNCER_PATH        = File.join(LIBRARY_PATH, 'syncer')
+  CONFIGURATION_PATH = File.join(LIBRARY_PATH, 'configuration')
+  TEMPLATE_PATH      = File.expand_path('../../templates', __FILE__)
+
+  ##
+  # Autoload Backup CLI files
+  module CLI
+    autoload :Helpers, File.join(CLI_PATH, 'helpers')
+    autoload :Utility, File.join(CLI_PATH, 'utility')
+  end
+
+  ##
+  # Autoload Backup storage files
+  module Storage
+    autoload :Base,       File.join(STORAGE_PATH, 'base')
+    autoload :Cycler,     File.join(STORAGE_PATH, 'cycler')
+    autoload :S3,         File.join(STORAGE_PATH, 's3')
+    autoload :CloudFiles, File.join(STORAGE_PATH, 'cloudfiles')
+    autoload :Ninefold,   File.join(STORAGE_PATH, 'ninefold')
+    autoload :Dropbox,    File.join(STORAGE_PATH, 'dropbox')
+    autoload :FTP,        File.join(STORAGE_PATH, 'ftp')
+    autoload :SFTP,       File.join(STORAGE_PATH, 'sftp')
+    autoload :SCP,        File.join(STORAGE_PATH, 'scp')
+    autoload :RSync,      File.join(STORAGE_PATH, 'rsync')
+    autoload :Local,      File.join(STORAGE_PATH, 'local')
+  end
+
+  ##
+  # Autoload Backup syncer files
+  module Syncer
+    autoload :Base,       File.join(SYNCER_PATH, 'base')
+    autoload :Cloud,      File.join(SYNCER_PATH, 'cloud')
+    autoload :CloudFiles, File.join(SYNCER_PATH, 'cloud_files')
+    autoload :S3,         File.join(SYNCER_PATH, 's3')
+    module RSync
+      autoload :Base,  File.join(SYNCER_PATH, 'rsync', 'base')
+      autoload :Local, File.join(SYNCER_PATH, 'rsync', 'local')
+      autoload :Push,  File.join(SYNCER_PATH, 'rsync', 'push')
+      autoload :Pull,  File.join(SYNCER_PATH, 'rsync', 'pull')
+    end
+  end
+
+  ##
+  # Autoload Backup database files
+  module Database
+    autoload :Base,       File.join(DATABASE_PATH, 'base')
+    autoload :MySQL,      File.join(DATABASE_PATH, 'mysql')
+    autoload :PostgreSQL, File.join(DATABASE_PATH, 'postgresql')
+    autoload :MongoDB,    File.join(DATABASE_PATH, 'mongodb')
+    autoload :Redis,      File.join(DATABASE_PATH, 'redis')
+    autoload :Riak,       File.join(DATABASE_PATH, 'riak')
+  end
+
+  ##
+  # Autoload compressor files
+  module Compressor
+    autoload :Base,   File.join(COMPRESSOR_PATH, 'base')
+    autoload :Gzip,   File.join(COMPRESSOR_PATH, 'gzip')
+    autoload :Bzip2,  File.join(COMPRESSOR_PATH, 'bzip2')
+    autoload :Pbzip2, File.join(COMPRESSOR_PATH, 'pbzip2')
+    autoload :Lzma,   File.join(COMPRESSOR_PATH, 'lzma')
+  end
+
+  ##
+  # Autoload Checksum files
+  module Checksum
+    autoload :Base,   File.join(CHECKSUM_PATH, 'base')
+    autoload :Shasum,   File.join(CHECKSUM_PATH, 'shasum')
+  end
+
+  ##
+  # Autoload encryptor files
+  module Encryptor
+    autoload :Base,    File.join(ENCRYPTOR_PATH, 'base')
+    autoload :OpenSSL, File.join(ENCRYPTOR_PATH, 'open_ssl')
+    autoload :GPG,     File.join(ENCRYPTOR_PATH, 'gpg')
+  end
+
+  ##
+  # Autoload notification files
+  module Notifier
+    autoload :Base,      File.join(NOTIFIER_PATH, 'base')
+    autoload :Binder,    File.join(NOTIFIER_PATH, 'binder')
+    autoload :Mail,      File.join(NOTIFIER_PATH, 'mail')
+    autoload :Twitter,   File.join(NOTIFIER_PATH, 'twitter')
+    autoload :Campfire,  File.join(NOTIFIER_PATH, 'campfire')
+    autoload :Presently, File.join(NOTIFIER_PATH, 'presently')
+    autoload :Prowl,     File.join(NOTIFIER_PATH, 'prowl')
+    autoload :Hipchat,   File.join(NOTIFIER_PATH, 'hipchat')
+  end
+
+  ##
+  # Autoload Backup configuration files
+  module Configuration
+    autoload :Base,     File.join(CONFIGURATION_PATH, 'base')
+    autoload :Helpers,  File.join(CONFIGURATION_PATH, 'helpers')
+
+    module Notifier
+      autoload :Base,      File.join(CONFIGURATION_PATH, 'notifier', 'base')
+      autoload :Mail,      File.join(CONFIGURATION_PATH, 'notifier', 'mail')
+      autoload :Twitter,   File.join(CONFIGURATION_PATH, 'notifier', 'twitter')
+      autoload :Campfire,  File.join(CONFIGURATION_PATH, 'notifier', 'campfire')
+      autoload :Presently, File.join(CONFIGURATION_PATH, 'notifier', 'presently')
+      autoload :Prowl,     File.join(CONFIGURATION_PATH, 'notifier', 'prowl')
+      autoload :Hipchat,   File.join(CONFIGURATION_PATH, 'notifier', 'hipchat')
+    end
+
+    module Encryptor
+      autoload :Base,    File.join(CONFIGURATION_PATH, 'encryptor', 'base')
+      autoload :OpenSSL, File.join(CONFIGURATION_PATH, 'encryptor', 'open_ssl')
+      autoload :GPG,     File.join(CONFIGURATION_PATH, 'encryptor', 'gpg')
+    end
+
+    module Compressor
+      autoload :Base,   File.join(CONFIGURATION_PATH, 'compressor', 'base')
+      autoload :Gzip,   File.join(CONFIGURATION_PATH, 'compressor', 'gzip')
+      autoload :Bzip2,  File.join(CONFIGURATION_PATH, 'compressor', 'bzip2')
+      autoload :Pbzip2, File.join(CONFIGURATION_PATH, 'compressor', 'pbzip2')
+      autoload :Lzma,   File.join(CONFIGURATION_PATH, 'compressor', 'lzma')
+    end
+
+    module Storage
+      autoload :Base,       File.join(CONFIGURATION_PATH, 'storage', 'base')
+      autoload :S3,         File.join(CONFIGURATION_PATH, 'storage', 's3')
+      autoload :CloudFiles, File.join(CONFIGURATION_PATH, 'storage', 'cloudfiles')
+      autoload :Ninefold,   File.join(CONFIGURATION_PATH, 'storage', 'ninefold')
+      autoload :Dropbox,    File.join(CONFIGURATION_PATH, 'storage', 'dropbox')
+      autoload :FTP,        File.join(CONFIGURATION_PATH, 'storage', 'ftp')
+      autoload :SFTP,       File.join(CONFIGURATION_PATH, 'storage', 'sftp')
+      autoload :SCP,        File.join(CONFIGURATION_PATH, 'storage', 'scp')
+      autoload :RSync,      File.join(CONFIGURATION_PATH, 'storage', 'rsync')
+      autoload :Local,      File.join(CONFIGURATION_PATH, 'storage', 'local')
+    end
+
+    module Checksum
+      autoload :Base,       File.join(CONFIGURATION_PATH, 'checksum', 'base')
+      autoload :Shasum,     File.join(CONFIGURATION_PATH, 'checksum', 'shasum')
+    end
+
+    module Syncer
+      autoload :Base,       File.join(CONFIGURATION_PATH, 'syncer', 'base')
+      autoload :Cloud,      File.join(CONFIGURATION_PATH, 'syncer', 'cloud')
+      autoload :CloudFiles, File.join(CONFIGURATION_PATH, 'syncer', 'cloud_files')
+      autoload :S3,         File.join(CONFIGURATION_PATH, 'syncer', 's3')
+      module RSync
+        autoload :Base,  File.join(CONFIGURATION_PATH, 'syncer', 'rsync', 'base')
+        autoload :Local, File.join(CONFIGURATION_PATH, 'syncer', 'rsync', 'local')
+        autoload :Push,  File.join(CONFIGURATION_PATH, 'syncer', 'rsync', 'push')
+        autoload :Pull,  File.join(CONFIGURATION_PATH, 'syncer', 'rsync', 'pull')
+      end
+    end
+
+    module Database
+      autoload :Base,       File.join(CONFIGURATION_PATH, 'database', 'base')
+      autoload :MySQL,      File.join(CONFIGURATION_PATH, 'database', 'mysql')
+      autoload :PostgreSQL, File.join(CONFIGURATION_PATH, 'database', 'postgresql')
+      autoload :MongoDB,    File.join(CONFIGURATION_PATH, 'database', 'mongodb')
+      autoload :Redis,      File.join(CONFIGURATION_PATH, 'database', 'redis')
+      autoload :Riak,       File.join(CONFIGURATION_PATH, 'database', 'riak')
+    end
+  end
+
+  ##
+  # Require Backup base files
+  %w{
+    model
+    archive
+    packager
+    pipeline
+    package
+    cleaner
+    splitter
+    config
+    binder
+    template
+    dependency
+    logger
+    version
+    errors
+  }.each {|lib| require File.join(LIBRARY_PATH, lib) }
+
+end

data/lib/backup/archive.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+module Backup
+  class Archive
+    include Backup::CLI::Helpers
+
+    ##
+    # Stores the name of the archive
+    attr_accessor :name
+
+    ##
+    # Stores an array of different paths/files to store
+    attr_accessor :paths
+
+    ##
+    # Stores an array of different paths/files to exclude
+    attr_accessor :excludes
+
+    ##
+    # String of additional arguments for the `tar` command
+    attr_accessor :tar_args
+
+    ##
+    # Takes the name of the archive and the configuration block
+    def initialize(model, name, &block)
+      @model    = model
+      @name     = name.to_s
+      @paths    = Array.new
+      @excludes = Array.new
+      @tar_args = ''
+
+      instance_eval(&block) if block_given?
+    end
+
+    ##
+    # Adds new paths to the @paths instance variable array
+    def add(path)
+      path = File.expand_path(path)
+      if File.exist?(path)
+        @paths << path
+      else
+        Logger.warn Errors::Archive::NotFoundError.new(<<-EOS)
+          The following path was not found:
+          #{ path }
+          This path will be omitted from the '#{ name }' Archive.
+        EOS
+      end
+    end
+
+    ##
+    # Adds new paths to the @excludes instance variable array
+    def exclude(path)
+      @excludes << File.expand_path(path)
+    end
+
+    ##
+    # Adds the given String of +options+ to the `tar` command.
+    # e.g. '-h --xattrs'
+    def tar_options(options)
+      @tar_args = options
+    end
+
+    ##
+    # Archives all the provided paths in to a single .tar file
+    # and places that .tar file in the folder which later will be packaged
+    # If the model is configured with a Compressor, the tar command output
+    # will be piped through the Compressor command and the file extension
+    # will be adjusted to indicate the type of compression used.
+    def perform!
+      Logger.message "#{ self.class } has started archiving:\n" +
+          paths.map {|path| "  #{path}" }.join("\n")
+
+      archive_path = File.join(Config.tmp_path, @model.trigger, 'archives')
+      FileUtils.mkdir_p(archive_path)
+
+      archive_ext = 'tar'
+      pipeline = Pipeline.new
+
+      pipeline << "#{ utility(:tar) } #{ tar_args } -cPf - " +
+          "#{ paths_to_exclude } #{ paths_to_package }"
+
+      if @model.compressor
+        @model.compressor.compress_with do |command, ext|
+          pipeline << command
+          archive_ext << ext
+        end
+      end
+
+      pipeline << "cat > '#{ File.join(archive_path, "#{name}.#{archive_ext}") }'"
+      pipeline.run
+      if pipeline.success?
+        Logger.message "#{ self.class } Complete!"
+      else
+        raise Errors::Archive::PipelineError,
+            "Failed to Create Backup Archive\n" +
+            pipeline.error_messages
+      end
+    end
+
+    private
+
+    ##
+    # Returns a "tar-ready" string of all the specified paths combined
+    def paths_to_package
+      paths.map {|path| "'#{path}'" }.join(' ')
+    end
+
+    ##
+    # Returns a "tar-ready" string of all the specified excludes combined
+    def paths_to_exclude
+      if excludes.any?
+        excludes.map {|path| "--exclude='#{path}'" }.join(' ')
+      end
+    end
+
+  end
+end

data/lib/backup/binder.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Backup
+  class Binder
+
+    ##
+    # Creates a new Backup::Notifier::Binder instance. Loops through the provided
+    # Hash to set instance variables
+    def initialize(key_and_values)
+      key_and_values.each do |key, value|
+        instance_variable_set("@#{ key }", value)
+      end
+    end
+
+    ##
+    # Returns the binding (needs a wrapper method because #binding is a private method)
+    def get_binding
+      binding
+    end
+
+  end
+end

data/lib/backup/checksum/base.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module Backup
+  module Checksum
+    class Base
+      include Backup::CLI::Helpers
+      include Backup::Configuration::Helpers
+
+      def initialize
+        load_defaults!
+      end
+
+      def process_checksum_file_before_transfer(file_names_hash, checksum_name, local_path)
+        file_names_hash.each do |local, remote|
+          replace_in_file(File.join(local_path, checksum_name), /#{File.join(local_path, local)}/) do |match|
+            remote
+          end
+        end
+      end
+
+      private
+
+      ##
+      # Return the checksum name, with Backup namespace removed
+      def checksum_name
+        self.class.to_s.sub('Backup::', '')
+      end
+
+      ##
+      # Logs a message to the console and log file to inform
+      # the client that Backup is using the compressor
+      def log!
+        Logger.message "Using #{ checksum_name } for checksum."
+      end
+
+
+      def replace_in_file(filepath, regexp, *args, &block)
+        content = File.read(filepath).gsub(regexp, *args, &block)
+        File.open(filepath, 'wb') { |file| file.write(content) }
+      end
+
+    end
+  end
+end