backup_checksum 3.0.23

data/lib/backup/configuration/storage/rsync.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class RSync < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SSH port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+          ##
+          # Flag to use local backups
+          attr_accessor :local
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/s3.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class S3 < Base
+        class << self
+
+          ##
+          # 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
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/scp.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class SCP < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SCP port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/storage/sftp.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Storage
+      class SFTP < Base
+        class << self
+
+          ##
+          # Server credentials
+          attr_accessor :username, :password
+
+          ##
+          # Server IP Address and SFTP port
+          attr_accessor :ip, :port
+
+          ##
+          # Path to store backups to
+          attr_accessor :path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/base.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      class Base < Configuration::Base; end
+    end
+  end
+end
+

data/lib/backup/configuration/syncer/cloud.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      class Cloud < Base
+        class << self
+          ##
+          # Amazon S3 bucket name and path to sync to
+          attr_accessor :bucket, :path
+
+          ##
+          # Directories to sync
+          attr_accessor :directories
+
+          ##
+          # Flag to enable mirroring
+          attr_accessor :mirror
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/cloud_files.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      class CloudFiles < Cloud
+        class << self
+          ##
+          # Rackspace CloudFiles Credentials
+          attr_accessor :api_key, :username
+
+          ##
+          # Rackspace CloudFiles Container
+          attr_accessor :container
+
+          ##
+          # Rackspace AuthURL allows you to connect to a different Rackspace datacenter
+          # - https://auth.api.rackspacecloud.com     (Default: US)
+          # - https://lon.auth.api.rackspacecloud.com (UK)
+          attr_accessor :auth_url
+
+          ##
+          # Improve performance and avoid data transfer costs by setting @servicenet to `true`
+          # This only works if Backup runs on a Rackspace server
+          attr_accessor :servicenet
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/rsync/base.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Base < Syncer::Base
+          class << self
+
+            ##
+            # Path to store the synced files/directories to
+            attr_accessor :path
+
+            ##
+            # Flag for mirroring the files/directories
+            attr_accessor :mirror
+
+            ##
+            # Additional options for the rsync cli
+            attr_accessor :additional_options
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/backup/configuration/syncer/rsync/local.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Local < Base; end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/rsync/pull.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Pull < Push; end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/rsync/push.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      module RSync
+        class Push < Base
+          class << self
+
+            ##
+            # Server credentials
+            attr_accessor :username, :password
+
+            ##
+            # Server IP Address and SSH port
+            attr_accessor :ip
+
+            ##
+            # The SSH port to connect to
+            attr_accessor :port
+
+            ##
+            # Flag for compressing (only compresses for the transfer)
+            attr_accessor :compress
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/syncer/s3.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Syncer
+      class S3 < Cloud
+        class << self
+          ##
+          # Amazon Simple Storage Service (S3) Credentials
+          attr_accessor :access_key_id, :secret_access_key
+
+          ##
+          # The S3 bucket to store files to
+          attr_accessor :bucket
+
+          ##
+          # The AWS region of the specified S3 bucket
+          attr_accessor :region
+        end
+      end
+    end
+  end
+end

data/lib/backup/database/base.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class Base
+      include Backup::CLI::Helpers
+      include Backup::Configuration::Helpers
+
+      ##
+      # Allows the user to specify the path to a "dump" utility
+      # in case it cannot be auto-detected by Backup
+      # [DEPRECATED] - use each subclass' <utility_name>_utility method
+      attr_accessor :utility_path
+
+      ##
+      # Creates a new instance of the MongoDB database object
+      # * Called using super(model) from subclasses *
+      def initialize(model)
+        @model = model
+        load_defaults!
+      end
+
+      ##
+      # Super method for all child (database) objects. Every database object's #perform!
+      # method should call #super before anything else to prepare
+      def perform!
+        prepare!
+        log!
+      end
+
+      private
+
+      ##
+      # Defines the @dump_path and ensures it exists by creating it
+      def prepare!
+        @dump_path = File.join(
+          Config.tmp_path,
+          @model.trigger,
+          'databases',
+          self.class.name.split('::').last
+        )
+        FileUtils.mkdir_p(@dump_path)
+      end
+
+      ##
+      # Return the database name, with Backup namespace removed
+      def database_name
+        self.class.to_s.sub('Backup::', '')
+      end
+
+      ##
+      # Logs a message to the console and log file to inform
+      # the client that Backup is dumping the database
+      def log!
+        Logger.message "#{ database_name } started dumping and archiving '#{ name }'."
+      end
+    end
+  end
+end

data/lib/backup/database/mongodb.rb

@@ -0,0 +1,232 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class MongoDB < Base
+
+      ##
+      # Name of the database that needs to get dumped
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port
+
+      ##
+      # IPv6 support (disabled by default)
+      attr_accessor :ipv6
+
+      ##
+      # Collections to dump, collections that aren't specified won't get dumped
+      attr_accessor :only_collections
+
+      ##
+      # Additional "mongodump" options
+      attr_accessor :additional_options
+
+      ##
+      # Path to the mongodump utility (optional)
+      attr_accessor :mongodump_utility
+
+      ##
+      # Path to the mongo utility (optional)
+      attr_accessor :mongo_utility
+
+      ##
+      # 'lock' dump meaning wrapping mongodump with fsync & lock
+      attr_accessor :lock
+
+      ##
+      # Creates a new instance of the MongoDB database object
+      def initialize(model, &block)
+        super(model)
+
+        @only_collections   ||= Array.new
+        @additional_options ||= Array.new
+        @ipv6               ||= false
+        @lock               ||= false
+
+        instance_eval(&block) if block_given?
+
+        if @utility_path
+          Logger.warn "[DEPRECATED] " +
+            "Database::MongoDB#utility_path has been deprecated.\n" +
+            "  Use Database::MongoDB#mongodump_utility instead."
+          @mongodump_utility ||= @utility_path
+        end
+        @mongodump_utility  ||= utility(:mongodump)
+        @mongo_utility      ||= utility(:mongo)
+      end
+
+      ##
+      # Performs the mongodump command and outputs the data to the
+      # specified path based on the 'trigger'. If the user hasn't specified any
+      # specific collections to dump, it'll dump everything. If the user has specified
+      # collections to dump, it'll loop through the array of collections and invoke the
+      # 'mongodump' command once per collection
+      def perform!
+        super
+
+        lock_database if @lock
+        @only_collections.empty? ? dump! : specific_collection_dump!
+
+      rescue => err
+        raise Errors::Database::MongoDBError.wrap(err, 'Database Dump Failed!')
+      ensure
+        unlock_database if @lock
+        package! unless err
+      end
+
+      private
+
+      ##
+      # Builds and runs the mongodump command
+      def dump!
+        run(mongodump)
+      end
+
+      ##
+      # For each collection in the @only_collections array, it'll
+      # build the whole 'mongodump' command, append the '--collection' option,
+      # and run the command built command
+      def specific_collection_dump!
+        @only_collections.each do |collection|
+          run("#{mongodump} --collection='#{collection}'")
+        end
+      end
+
+      ##
+      # Builds the full mongodump string based on all attributes
+      def mongodump
+        "#{ mongodump_utility } #{ database } #{ credential_options } " +
+        "#{ connectivity_options } #{ ipv6_option } #{ user_options } #{ dump_directory }"
+      end
+
+      ##
+      # If a compressor is configured, packages the dump_path into a
+      # single compressed tar archive, then removes the dump_path.
+      # e.g.
+      #   if the database was dumped to:
+      #     ~/Backup/.tmp/databases/MongoDB/
+      #   then it will be packaged into:
+      #     ~/Backup/.tmp/databases/MongoDB-<timestamp>.tar.gz
+      def package!
+        return unless @model.compressor
+
+        pipeline  = Pipeline.new
+        base_dir  = File.dirname(@dump_path)
+        dump_dir  = File.basename(@dump_path)
+        timestamp = Time.now.to_i.to_s[-5, 5]
+        outfile   = @dump_path + '-' + timestamp + '.tar'
+
+        Logger.message(
+          "#{ database_name } started compressing and packaging:\n" +
+          "  '#{ @dump_path }'"
+        )
+
+        pipeline << "#{ utility(:tar) } -cf - -C '#{ base_dir }' '#{ dump_dir }'"
+        @model.compressor.compress_with do |command, ext|
+          pipeline << command
+          outfile << ext
+        end
+        pipeline << "cat > #{ outfile }"
+
+        pipeline.run
+        if pipeline.success?
+          Logger.message(
+            "#{ database_name } completed compressing and packaging:\n" +
+            "  '#{ outfile }'"
+          )
+          FileUtils.rm_rf(@dump_path)
+        else
+          raise Errors::Database::PipelineError,
+            "#{ database_name } Failed to create compressed dump package:\n" +
+            "'#{ outfile }'\n" +
+            pipeline.error_messages
+        end
+      end
+
+      ##
+      # Returns the MongoDB database selector syntax
+      def database
+        "--db='#{ name }'" if name
+      end
+
+      ##
+      # Builds the MongoDB credentials syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        %w[username password].map do |option|
+          next if send(option).to_s.empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds the MongoDB connectivity options syntax to connect the user
+      # to perform the database dumping process
+      def connectivity_options
+        %w[host port].map do |option|
+          next if send(option).to_s.empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join(' ')
+      end
+
+      ##
+      # Returns the mongodump syntax for enabling ipv6
+      def ipv6_option
+        @ipv6 ? '--ipv6' : ''
+      end
+
+      ##
+      # Builds a MongoDB compatible string for the
+      # additional options specified by the user
+      def user_options
+        @additional_options.join(' ')
+      end
+
+      ##
+      # Returns the MongoDB syntax for determining where to output all the database dumps,
+      # e.g. ~/Backup/.tmp/databases/MongoDB/<databases here>/<database collections>
+      def dump_directory
+        "--out='#{ @dump_path }'"
+      end
+
+      ##
+      # Locks and FSyncs the database to bring it up to sync
+      # and ensure no 'write operations' are performed during the
+      # dump process
+      def lock_database
+        lock_command = <<-EOS.gsub(/^ +/, ' ')
+          echo 'use admin
+          db.runCommand({"fsync" : 1, "lock" : 1})' | #{ "#{ mongo_utility } #{ mongo_uri }" }
+        EOS
+
+        run(lock_command)
+      end
+
+      ##
+      # Unlocks the (locked) database
+      def unlock_database
+        unlock_command = <<-EOS.gsub(/^ +/, ' ')
+          echo 'use admin
+          db.$cmd.sys.unlock.findOne()' | #{ "#{ mongo_utility } #{ mongo_uri }" }
+        EOS
+
+        run(unlock_command)
+      end
+
+      ##
+      # Builds a Mongo URI based on the provided attributes
+      def mongo_uri
+        ["#{ host }:#{ port }#{ ('/' + name) if name }",
+         credential_options, ipv6_option].join(' ').strip
+      end
+
+    end
+  end
+end