sliday_backup 0.1

data/lib/sliday_backup/storage/ftp.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+require 'net/ftp'
+
+module SlidayBackup
+  module Storage
+    class FTP < Base
+      include Storage::Cycler
+
+      ##
+      # Server credentials
+      attr_accessor :username, :password
+
+      ##
+      # Server IP Address and FTP port
+      attr_accessor :ip, :port
+
+      ##
+      # Use passive mode?
+      attr_accessor :passive_mode
+
+      ##
+      # Configure connection open and read timeouts.
+      # Net::FTP's open_timeout and read_timeout will both be configured using
+      # this setting.
+      # @!attribute [rw] timeout
+      #   @param [Integer|Float]
+      #   @return [Integer|Float]
+      attr_accessor :timeout
+
+      def initialize(model, storage_id = nil)
+        super
+
+        @port         ||= 21
+        @path         ||= 'backups'
+        @passive_mode ||= false
+        @timeout      ||= nil
+        path.sub!(/^~\//, '')
+      end
+
+      private
+
+      ##
+      # Establishes a connection to the remote server
+      #
+      # Note:
+      # Since the FTP port is defined as a constant in the Net::FTP class, and
+      # might be required to change by the user, we dynamically remove and
+      # re-add the constant with the provided port value
+      def connection
+        if Net::FTP.const_defined?(:FTP_PORT)
+          Net::FTP.send(:remove_const, :FTP_PORT)
+        end; Net::FTP.send(:const_set, :FTP_PORT, port)
+
+        Net::FTP.open(ip, username, password) do |ftp|
+          if timeout
+            ftp.open_timeout = timeout
+            ftp.read_timeout = timeout
+          end
+          ftp.passive = true if passive_mode
+          yield ftp
+        end
+      end
+
+      def transfer!
+        connection do |ftp|
+          create_remote_path(ftp)
+
+          package.filenames.each do |filename|
+            src = File.join(Config.tmp_path, filename)
+            dest = File.join(remote_path, filename)
+            Logger.info "Storing '#{ ip }:#{ dest }'..."
+            ftp.put(src, dest)
+          end
+        end
+      end
+
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
+      def remove!(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
+
+        remote_path = remote_path_for(package)
+        connection do |ftp|
+          package.filenames.each do |filename|
+            ftp.delete(File.join(remote_path, filename))
+          end
+
+          ftp.rmdir(remote_path)
+        end
+      end
+
+      ##
+      # Creates (if they don't exist yet) all the directories on the remote
+      # server in order to upload the backup file. Net::FTP 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::FTP raises an exception when the directory it's trying to create
+      # already exists, so we have rescue it
+      def create_remote_path(ftp)
+        path_parts = Array.new
+        remote_path.split('/').each do |path_part|
+          path_parts << path_part
+          begin
+            ftp.mkdir(path_parts.join('/'))
+          rescue Net::FTPPermError; end
+        end
+      end
+
+    end
+  end
+end

data/lib/sliday_backup/storage/local.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module SlidayBackup
+  module Storage
+    class Local < Base
+      include Storage::Cycler
+      class Error < SlidayBackup::Error; end
+
+      def initialize(model, storage_id = nil)
+        super
+
+        @path ||= '~/backups'
+      end
+
+      private
+
+      def transfer!
+        FileUtils.mkdir_p(remote_path)
+
+        transfer_method = package_movable? ? :mv : :cp
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
+
+          FileUtils.send(transfer_method, src, dest)
+        end
+      end
+
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
+      def remove!(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
+
+        FileUtils.rm_r(remote_path_for(package))
+      end
+
+      # expanded since this is a local path
+      def remote_path(pkg = package)
+        File.expand_path(super)
+      end
+      alias :remote_path_for :remote_path
+
+      ##
+      # If this Local Storage is not the last Storage for the Model,
+      # force the transfer to use a *copy* operation and issue a warning.
+      def package_movable?
+        if self == model.storages.last
+          true
+        else
+          Logger.warn Error.new(<<-EOS)
+            Local File Copy Warning!
+            The final backup file(s) for '#{ model.label }' (#{ model.trigger })
+            will be *copied* to '#{ remote_path }'
+            To avoid this, when using more than one Storage, the 'Local' Storage
+            should be added *last* so the files may be *moved* to their destination.
+          EOS
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/sliday_backup/storage/qiniu.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+require 'qiniu'
+
+module SlidayBackup
+  module Storage
+    class Qiniu < Base
+      include Storage::Cycler
+      class Error < SlidayBackup::Error; end
+
+      ##
+      # Qiniu API credentials
+      attr_accessor :access_key, :secret_key
+
+      ##
+      # Qiniu bucket name
+      attr_accessor :bucket
+
+      def initialize(model, storage_id = nil)
+        super
+
+        @path ||= 'backups'
+
+        check_configuration
+        config_credentials
+      end
+
+      private
+      def transfer!
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
+
+          ::Qiniu.upload_file(uptoken: ::Qiniu.generate_upload_token,
+                              bucket: bucket,
+                              file: src,
+                              key: dest)
+        end
+      end
+
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
+      def remove!(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
+        remote_path = remote_path_for(package)
+        package.filenames.each do |filename|
+          ::Qiniu.delete(bucket, File.join(remote_path, filename))
+        end
+      end
+
+      def check_configuration
+         required = %w{ access_key secret_key bucket }
+
+        raise Error, <<-EOS if required.map {|name| send(name) }.any?(&:nil?)
+          Configuration Error
+          #{ required.map {|name| "##{ name }"}.join(', ') } are all required
+        EOS
+      end
+
+      def config_credentials
+        ::Qiniu.establish_connection!(access_key: access_key, secret_key: secret_key)
+      end
+    end
+  end
+end

data/lib/sliday_backup/storage/rsync.rb

@@ -0,0 +1,248 @@
+# encoding: utf-8
+
+module SlidayBackup
+  module Storage
+    class RSync < Base
+      include Utilities::Helpers
+
+      ##
+      # Mode of operation
+      #
+      # [:ssh (default)]
+      #   Connects to the remote via SSH.
+      #   Does not use an rsync daemon on the remote.
+      #
+      # [:ssh_daemon]
+      #   Connects to the remote via SSH.
+      #   Spawns a single-use daemon on the remote, which allows certain
+      #   daemon features (like modules) to be used.
+      #
+      # [:rsync_daemon]
+      #   Connects directly to an rsync daemon via TCP.
+      #   Data transferred is not encrypted.
+      #
+      attr_accessor :mode
+
+      ##
+      # Server Address
+      #
+      # If not specified, the storage operation will be local.
+      attr_accessor :host
+
+      ##
+      # SSH or RSync port
+      #
+      # For `:ssh` or `:ssh_daemon` mode, this specifies the SSH port to use
+      # and defaults to 22.
+      #
+      # For `:rsync_daemon` mode, this specifies the TCP port to use
+      # and defaults to 873.
+      attr_accessor :port
+
+      ##
+      # SSH User
+      #
+      # If the user running the backup is not the same user that needs to
+      # authenticate with the remote server, specify the user here.
+      #
+      # The user must have SSH keys setup for passphrase-less access to the
+      # remote. If the SSH User does not have passphrase-less keys, or no
+      # default keys in their `~/.ssh` directory, you will need to use the
+      # `-i` option in `:additional_ssh_options` to specify the
+      # passphrase-less key to use.
+      #
+      # Used only for `:ssh` and `:ssh_daemon` modes.
+      attr_accessor :ssh_user
+
+      ##
+      # Additional SSH Options
+      #
+      # Used to supply a String or Array of options to be passed to the SSH
+      # command in `:ssh` and `:ssh_daemon` modes.
+      #
+      # For example, if you need to supply a specific SSH key for the `ssh_user`,
+      # you would set this to: "-i '/path/to/id_rsa'". Which would produce:
+      #
+      #   rsync -e "ssh -p 22 -i '/path/to/id_rsa'"
+      #
+      # Arguments may be single-quoted, but should not contain any double-quotes.
+      #
+      # Used only for `:ssh` and `:ssh_daemon` modes.
+      attr_accessor :additional_ssh_options
+
+      ##
+      # RSync User
+      #
+      # If the user running the backup is not the same user that needs to
+      # authenticate with the rsync daemon, specify the user here.
+      #
+      # Used only for `:ssh_daemon` and `:rsync_daemon` modes.
+      attr_accessor :rsync_user
+
+      ##
+      # RSync Password
+      #
+      # If specified, SlidayBackup will write the password to a temporary file and
+      # use it with rsync's `--password-file` option for daemon authentication.
+      #
+      # Note that setting this will override `rsync_password_file`.
+      #
+      # Used only for `:ssh_daemon` and `:rsync_daemon` modes.
+      attr_accessor :rsync_password
+
+      ##
+      # RSync Password File
+      #
+      # If specified, this path will be passed to rsync's `--password-file`
+      # option for daemon authentication.
+      #
+      # Used only for `:ssh_daemon` and `:rsync_daemon` modes.
+      attr_accessor :rsync_password_file
+
+      ##
+      # Additional String or Array of options for the rsync cli
+      attr_accessor :additional_rsync_options
+
+      ##
+      # Flag for compressing (only compresses for the transfer)
+      attr_accessor :compress
+
+      ##
+      # Path to store the synced backup package file(s) to.
+      #
+      # If no +host+ is specified, then +path+ will be local, and the only
+      # other used option would be +additional_rsync_options+.
+      # +path+ will be expanded, so '~/my_path' will expand to '$HOME/my_path'.
+      #
+      # If a +host+ is specified, this will be a path on the host.
+      # If +mode+ is `:ssh` (default), then any relative path, or path starting
+      # with '~/' will be relative to the directory the ssh_user is logged
+      # into. For `:ssh_daemon` or `:rsync_daemon` modes, this would reference
+      # an rsync module/path.
+      #
+      # In :ssh_daemon and :rsync_daemon modes, +path+ (or path defined by
+      # your rsync module) must already exist.
+      #
+      # In :ssh mode or local operation (no +host+ specified), +path+ will
+      # be created if needed - either locally, or on the remote for :ssh mode.
+      attr_accessor :path
+
+      def initialize(model, storage_id = nil)
+        super
+
+        @mode ||= :ssh
+        @port ||= mode == :rsync_daemon ? 873 : 22
+        @compress ||= false
+        @path ||= '~/backups'
+      end
+
+      private
+
+      def transfer!
+        write_password_file
+        create_remote_path
+
+        package.filenames.each do |filename|
+          src = "'#{ File.join(Config.tmp_path, filename) }'"
+          dest = "#{ host_options }'#{ File.join(remote_path, filename) }'"
+          Logger.info "Syncing to #{ dest }..."
+          run("#{ rsync_command } #{ src } #{ dest }")
+        end
+      ensure
+        remove_password_file
+      end
+
+      ##
+      # Other storages add an additional timestamp directory to this path.
+      # This is not desired here, since we need to transfer the package files
+      # to the same location each time.
+      def remote_path
+        @remote_path ||= begin
+          if host
+            path.sub(/^~\//, '').sub(/\/$/, '')
+          else
+            File.expand_path(path)
+          end
+        end
+      end
+
+      ##
+      # Runs a 'mkdir -p' command on the host (or locally) to ensure the
+      # dest_path exists. This is used because we're transferring a single
+      # file, and rsync won't attempt to create the intermediate directories.
+      #
+      # This is only applicable locally and in :ssh mode.
+      # In :ssh_daemon and :rsync_daemon modes the `path` would include a
+      # module name that must define a path on the remote that already exists.
+      def create_remote_path
+        if host
+          run("#{ utility(:ssh) } #{ ssh_transport_args } #{ host } " +
+                  %Q["mkdir -p '#{ remote_path }'"]) if mode == :ssh
+        else
+          FileUtils.mkdir_p(remote_path)
+        end
+      end
+
+      def host_options
+        @host_options ||= begin
+          if !host
+            ''
+          elsif mode == :ssh
+            "#{ host }:"
+          else
+            user = "#{ rsync_user }@" if rsync_user
+            "#{ user }#{ host }::"
+          end
+        end
+      end
+
+      def rsync_command
+        @rsync_command ||= begin
+          cmd = utility(:rsync) << ' --archive' <<
+              " #{ Array(additional_rsync_options).join(' ') }".rstrip
+          cmd << compress_option << password_option << transport_options if host
+          cmd
+        end
+      end
+
+      def compress_option
+        compress ? ' --compress' : ''
+      end
+
+      def password_option
+        return '' if mode == :ssh
+
+        path = @password_file ? @password_file.path : rsync_password_file
+        path ? " --password-file='#{ File.expand_path(path) }'" : ''
+      end
+
+      def transport_options
+        if mode == :rsync_daemon
+          " --port #{ port }"
+        else
+          %Q[ -e "#{ utility(:ssh) } #{ ssh_transport_args }"]
+        end
+      end
+
+      def ssh_transport_args
+        args = "-p #{ port } "
+        args << "-l #{ ssh_user } " if ssh_user
+        args << Array(additional_ssh_options).join(' ')
+        args.rstrip
+      end
+
+      def write_password_file
+        return unless host && rsync_password && mode != :ssh
+
+        @password_file = Tempfile.new('backup-rsync-password')
+        @password_file.write(rsync_password)
+        @password_file.close
+      end
+
+      def remove_password_file
+        @password_file.delete if @password_file
+      end
+
+    end
+  end
+end