backup-agoddard 3.0.27

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

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module Cloud
+      class CloudFiles < Base
+
+        ##
+        # 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
+
+        ##
+        # Instantiates a new Cloud::CloudFiles Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::Cloud::CloudFiles
+        # are set via a super() call to Cloud::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and Cloud specific defaults are set,
+        # the block from the user's configuration file is evaluated.
+        def initialize(&block)
+          super
+
+          instance_eval(&block) if block_given?
+          @path = path.sub(/^\//, '')
+        end
+
+        private
+
+        ##
+        # Established and creates a new Fog storage object for CloudFiles.
+        def connection
+          @connection ||= Fog::Storage.new(
+            :provider             => provider,
+            :rackspace_username   => username,
+            :rackspace_api_key    => api_key,
+            :rackspace_auth_url   => auth_url,
+            :rackspace_servicenet => servicenet
+          )
+        end
+
+        ##
+        # Creates a new @repository_object (container).
+        # Fetches it from Cloud Files if it already exists,
+        # otherwise it will create it first and fetch use that instead.
+        def repository_object
+          @repository_object ||= connection.directories.get(container) ||
+            connection.directories.create(:key => container)
+        end
+
+        ##
+        # This is the provider that Fog uses for the Cloud Files
+        def provider
+          "Rackspace"
+        end
+
+      end # class Cloudfiles < Base
+    end # module Cloud
+  end
+end

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

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module Cloud
+      class S3 < Base
+
+        ##
+        # 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
+
+        ##
+        # Instantiates a new Cloud::S3 Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::Cloud::S3
+        # are set via a super() call to Cloud::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and Cloud specific defaults are set,
+        # the block from the user's configuration file is evaluated.
+        def initialize(&block)
+          super
+
+          instance_eval(&block) if block_given?
+          @path = path.sub(/^\//, '')
+        end
+
+        private
+
+        ##
+        # Established and creates a new Fog storage object for S3.
+        def connection
+          @connection ||= Fog::Storage.new(
+            :provider              => provider,
+            :aws_access_key_id     => access_key_id,
+            :aws_secret_access_key => secret_access_key,
+            :region                => region
+          )
+        end
+
+        ##
+        # Creates a new @repository_object (bucket).
+        # Fetches it from S3 if it already exists,
+        # otherwise it will create it first and fetch use that instead.
+        def repository_object
+          @repository_object ||= connection.directories.get(bucket) ||
+            connection.directories.create(:key => bucket, :location => region)
+        end
+
+        ##
+        # This is the provider that Fog uses for the Cloud Files
+        def provider
+          "AWS"
+        end
+
+      end # Class S3 < Base
+    end # module Cloud
+  end
+end

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

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module RSync
+      class Base < Syncer::Base
+        ##
+        # Additional options for the rsync cli
+        attr_accessor :additional_options
+
+        ##
+        # Instantiates a new RSync Syncer object
+        # and sets the default configuration
+        def initialize
+          super
+
+          @additional_options ||= Array.new
+        end
+
+        private
+
+        ##
+        # Returns the @directories as a space-delimited string of
+        # single-quoted values for use in the `rsync` command line.
+        # Each path is expanded, since these refer to local paths
+        # for both RSync::Local and RSync::Push.
+        # RSync::Pull does not use this method.
+        def directories_option
+          @directories.map do |directory|
+            "'#{ File.expand_path(directory) }'"
+          end.join(' ')
+        end
+
+        ##
+        # Returns Rsync syntax for enabling mirroring
+        def mirror_option
+          '--delete' if @mirror
+        end
+
+        ##
+        # Returns Rsync syntax for invoking "archive" mode
+        def archive_option
+          '--archive'
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module RSync
+      class Local < Base
+
+        ##
+        # Instantiates a new RSync::Local Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::RSync::Local
+        # are set via a super() call to RSync::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and RSync specific defaults are set,
+        # the block from the user's configuration file is evaluated.
+        def initialize(&block)
+          super
+
+          instance_eval(&block) if block_given?
+        end
+
+        ##
+        # Performs the RSync::Local operation
+        # debug options: -vhP
+        def perform!
+          Logger.message(
+            "#{ syncer_name } started syncing the following directories:\n\s\s" +
+            @directories.join("\n\s\s")
+          )
+          run("#{ utility(:rsync) } #{ options } " +
+              "#{ directories_option } '#{ dest_path }'")
+        end
+
+        private
+
+        ##
+        # Return expanded @path
+        def dest_path
+          @dest_path ||= File.expand_path(@path)
+        end
+
+        ##
+        # Returns all the specified Rsync::Local options,
+        # concatenated, ready for the CLI
+        def options
+          ([archive_option, mirror_option] +
+            additional_options).compact.join("\s")
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module RSync
+      class Pull < Push
+
+        ##
+        # Performs the RSync::Pull operation
+        # debug options: -vhP
+        def perform!
+          write_password_file!
+
+          @directories.each do |directory|
+            Logger.message("#{ syncer_name } started syncing '#{ directory }'.")
+            run("#{ utility(:rsync) } #{ options } " +
+                "'#{ username }@#{ ip }:#{ directory.sub(/^\~\//, '') }' " +
+                "'#{ dest_path }'")
+          end
+
+        ensure
+          remove_password_file!
+        end
+
+        private
+
+        ##
+        # Return expanded @path, since this path is local
+        def dest_path
+          @dest_path ||= File.expand_path(@path)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module RSync
+      class Push < Base
+
+        ##
+        # 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
+
+        ##
+        # Instantiates a new RSync::Push or RSync::Pull Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::RSync::Push or
+        # Configuration::Syncer::RSync::Pull
+        # are set via a super() call to RSync::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and RSync specific defaults are set,
+        # the block from the user's configuration file is evaluated.
+        def initialize(&block)
+          super
+
+          @port               ||= 22
+          @compress           ||= false
+
+          instance_eval(&block) if block_given?
+        end
+
+        ##
+        # Performs the RSync:Push operation
+        # debug options: -vhP
+        def perform!
+          write_password_file!
+
+          Logger.message(
+            "#{ syncer_name } started syncing the following directories:\n\s\s" +
+            @directories.join("\n\s\s")
+          )
+          run("#{ utility(:rsync) } #{ options } #{ directories_option } " +
+              "'#{ username }@#{ ip }:#{ dest_path }'")
+
+        ensure
+          remove_password_file!
+        end
+
+        private
+
+        ##
+        # Return @path with any preceeding "~/" removed
+        def dest_path
+          @dest_path ||= @path.sub(/^\~\//, '')
+        end
+
+        ##
+        # Returns all the specified Rsync::[Push/Pull] options,
+        # concatenated, ready for the CLI
+        def options
+          ([archive_option, mirror_option, compress_option, port_option,
+            password_option] + additional_options).compact.join("\s")
+        end
+
+        ##
+        # Returns Rsync syntax for compressing the file transfers
+        def compress_option
+          '--compress' if @compress
+        end
+
+        ##
+        # Returns Rsync syntax for defining a port to connect to
+        def port_option
+          "-e 'ssh -p #{@port}'"
+        end
+
+        ##
+        # Returns Rsync syntax for setting a password (via a file)
+        def password_option
+          "--password-file='#{@password_file.path}'" if @password_file
+        end
+
+        ##
+        # Writes the provided password to a temporary file so that
+        # the rsync utility can read the password from this file
+        def write_password_file!
+          unless @password.nil?
+            @password_file = Tempfile.new('backup-rsync-password')
+            @password_file.write(@password)
+            @password_file.close
+          end
+        end
+
+        ##
+        # Removes the previously created @password_file
+        # (temporary file containing the password)
+        def remove_password_file!
+          @password_file.delete if @password_file
+          @password_file = nil
+        end
+      end
+    end
+  end
+end

data/lib/backup/template.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'erb'
+
+module Backup
+  class Template
+
+    # Holds a binding object. Nil if not provided.
+    attr_accessor :binding
+
+    ##
+    # Creates a new instance of the Backup::Template class
+    # and optionally takes an argument that can be either a binding object, a Hash or nil
+    def initialize(object = nil)
+      if object.is_a?(Binding)
+        @binding = object
+      elsif object.is_a?(Hash)
+        @binding = Backup::Binder.new(object).get_binding
+      else
+        @binding = nil
+      end
+    end
+
+    ##
+    # Renders the provided file (in the context of the binding if any) to the console
+    def render(file)
+      puts result(file)
+    end
+
+    ##
+    # Returns a String object containing the contents of the file (in the context of the binding if any)
+    def result(file)
+      ERB.new(file_contents(file), nil, '<>').result(binding)
+    end
+
+  private
+
+    ##
+    # Reads and returns the contents of the provided file path,
+    # relative from the Backup::TEMPLATE_PATH
+    def file_contents(file)
+      File.read(File.join(Backup::TEMPLATE_PATH, file))
+    end
+
+  end
+end