RubyGems - syc-backup - Versions diffs - 0.0.4 - Mend

syc-backup 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

data/README.rdoc +48 -0
data/Rakefile +7 -0
data/bin/sycbackup +6 -0
data/doc/Backup.html +186 -0
data/doc/Backup/CronEdit.html +381 -0
data/doc/Backup/Environment.html +231 -0
data/doc/Backup/FileBackup.html +363 -0
data/doc/Backup/MySQLBackup.html +305 -0
data/doc/Backup/Options.html +328 -0
data/doc/Backup/Process.html +261 -0
data/doc/Backup/Runner.html +244 -0
data/doc/README_rdoc.html +202 -0
data/doc/Rakefile.html +118 -0
data/doc/TestCronEdit.html +211 -0
data/doc/TestEnvironment.html +156 -0
data/doc/TestFileBackup.html +237 -0
data/doc/TestMySQLBackup.html +167 -0
data/doc/TestOptions.html +156 -0
data/doc/TestProcess.html +236 -0
data/doc/created.rid +18 -0
data/doc/images/add.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +106 -0
data/doc/js/darkfish.js +153 -0
data/doc/js/jquery.js +18 -0
data/doc/js/navigation.js +142 -0
data/doc/js/search.js +94 -0
data/doc/js/search_index.js +1 -0
data/doc/js/searcher.js +228 -0
data/doc/rdoc.css +543 -0
data/doc/table_of_contents.html +148 -0
data/lib/backup/cron_edit.rb +127 -0
data/lib/backup/environment.rb +44 -0
data/lib/backup/file_backup.rb +94 -0
data/lib/backup/mysql_backup.rb +58 -0
data/lib/backup/options.rb +199 -0
data/lib/backup/process.rb +99 -0
data/lib/backup/runner.rb +79 -0
data/lib/backup_version.rb +9 -0
data/syc-backup-0.0.1.gem +0 -0
data/syc-backup-0.0.3.gem +0 -0
data/sycbackup.gemspec +20 -0
data/test/test_cron_edit.rb +49 -0
data/test/test_environment.rb +22 -0
data/test/test_file_backup.rb +70 -0
data/test/test_mysql_backup.rb +71 -0
data/test/test_options.rb +189 -0
data/test/test_process.rb +40 -0
metadata +123 -0

data/doc/table_of_contents.html ADDED

@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<title>Table of Contents - RDoc Documentation</title>
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+<body class="indexpage">
+<h1>Table of Contents - RDoc Documentation</h1>
+<h2>Pages</h2>
+<ul>
+  <li class="file">
+    <a href="README_rdoc.html">README</a>
+    <img class="toc-toggle" src="images/transparent.png" alt="" title="toggle headings">
+    <ul class="initially-hidden">
+      <li><a href="README_rdoc.html#label-Backup+utility+for+database%2C+folders+and+files">Backup utility for database, folders and files</a>
+      <li><a href="README_rdoc.html#label-Install">Install</a>
+      <li><a href="README_rdoc.html#label-Usage">Usage</a>
+      <li><a href="README_rdoc.html#label-Supported+Platform">Supported Platform</a>
+      <li><a href="README_rdoc.html#label-Notes">Notes</a>
+      <li><a href="README_rdoc.html#label-Tests">Tests</a>
+      <li><a href="README_rdoc.html#label-Links">Links</a>
+    </ul>
+  </li>
+    <li class="file">
+    <a href="Rakefile.html">Rakefile</a>
+  </li>
+</ul>
+<h2 id="classes">Classes/Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Backup.html">Backup</a>
+  </li>
+    <li class="class">
+    <a href="Backup/CronEdit.html">Backup::CronEdit</a>
+  </li>
+    <li class="class">
+    <a href="Backup/Environment.html">Backup::Environment</a>
+  </li>
+    <li class="class">
+    <a href="Backup/FileBackup.html">Backup::FileBackup</a>
+  </li>
+    <li class="class">
+    <a href="Backup/MySQLBackup.html">Backup::MySQLBackup</a>
+  </li>
+    <li class="class">
+    <a href="Backup/Options.html">Backup::Options</a>
+  </li>
+    <li class="class">
+    <a href="Backup/Process.html">Backup::Process</a>
+  </li>
+    <li class="class">
+    <a href="Backup/Runner.html">Backup::Runner</a>
+  </li>
+    <li class="class">
+    <a href="TestCronEdit.html">TestCronEdit</a>
+  </li>
+    <li class="class">
+    <a href="TestEnvironment.html">TestEnvironment</a>
+  </li>
+    <li class="class">
+    <a href="TestFileBackup.html">TestFileBackup</a>
+  </li>
+    <li class="class">
+    <a href="TestMySQLBackup.html">TestMySQLBackup</a>
+  </li>
+    <li class="class">
+    <a href="TestOptions.html">TestOptions</a>
+  </li>
+    <li class="class">
+    <a href="TestProcess.html">TestProcess</a>
+  </li>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+    <li class="method"><a href="Backup/Process.html#method-c-new">::new &mdash; Backup::Process</a>
+    <li class="method"><a href="Backup/Runner.html#method-c-new">::new &mdash; Backup::Runner</a>
+    <li class="method"><a href="Backup/Options.html#method-c-new">::new &mdash; Backup::Options</a>
+    <li class="method"><a href="Backup/MySQLBackup.html#method-c-new">::new &mdash; Backup::MySQLBackup</a>
+    <li class="method"><a href="Backup/FileBackup.html#method-c-new">::new &mdash; Backup::FileBackup</a>
+    <li class="method"><a href="Backup/Environment.html#method-c-ruby">::ruby &mdash; Backup::Environment</a>
+    <li class="method"><a href="Backup/CronEdit.html#method-i-add_command">#add_command &mdash; Backup::CronEdit</a>
+    <li class="method"><a href="Backup/FileBackup.html#method-i-backup">#backup &mdash; Backup::FileBackup</a>
+    <li class="method"><a href="Backup/MySQLBackup.html#method-i-backup">#backup &mdash; Backup::MySQLBackup</a>
+    <li class="method"><a href="Backup/Process.html#method-i-backup">#backup &mdash; Backup::Process</a>
+    <li class="method"><a href="Backup/FileBackup.html#method-i-check_for_inexistent">#check_for_inexistent &mdash; Backup::FileBackup</a>
+    <li class="method"><a href="Backup/CronEdit.html#method-i-cleanup">#cleanup &mdash; Backup::CronEdit</a>
+    <li class="method"><a href="Backup/MySQLBackup.html#method-i-compress">#compress &mdash; Backup::MySQLBackup</a>
+    <li class="method"><a href="Backup/FileBackup.html#method-i-compress">#compress &mdash; Backup::FileBackup</a>
+    <li class="method"><a href="TestCronEdit.html#method-i-crontab_count">#crontab_count &mdash; TestCronEdit</a>
+    <li class="method"><a href="Backup/CronEdit.html#method-i-remove_command">#remove_command &mdash; Backup::CronEdit</a>
+    <li class="method"><a href="Backup/Runner.html#method-i-run">#run &mdash; Backup::Runner</a>
+    <li class="method"><a href="TestProcess.html#method-i-setup">#setup &mdash; TestProcess</a>
+    <li class="method"><a href="TestFileBackup.html#method-i-setup">#setup &mdash; TestFileBackup</a>
+    <li class="method"><a href="TestProcess.html#method-i-teardown">#teardown &mdash; TestProcess</a>
+    <li class="method"><a href="TestFileBackup.html#method-i-teardown">#teardown &mdash; TestFileBackup</a>
+</ul>
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>

data/lib/backup/cron_edit.rb ADDED

@@ -0,0 +1,127 @@
+require 'open3'
+module Backup
+  # Adds or removes a command to the user's crontab. To make sure that the
+  # Ruby application is invoked as a cron job it needs the environment
+  # variables that are available when run from command line. To meet these
+  # requirements the environment variables are read and added to the crontab. If
+  # variables already exist in the crontab they are overridden.
+  class CronEdit
+    # Temporary file that holds the entries to be written to the crontab
+    CRON_ENTRIES_FILE = ".cron_entries"
+    # Adds a command to the user's crontab. If the provided command is empty
+    # add_command will exit the application with exit status -1.
+    # The method uses the <tt>crontab -l</tt> and <tt>crontab file</tt> command.
+    # If the crontab call fails the error message and exit status of
+    # <tt>crontab</tt> will be returned and the application exits
+    def add_command(command, environment=[])
+      command = command.strip.squeeze(" ")
+      if command.empty?
+        STDERR.puts "Cannot add empty command to cron"
+        exit -1
+      end
+      read_crontab_command = 'crontab -l'
+      stdout, stderr, status = Open3.capture3(read_crontab_command)
+      entries = [] + environment
+      stdout.split(/\n/).each do |entry|
+        entry = entry.strip.squeeze(" ")
+        variable = entry.match(/\A\w+(?=\=)/).to_s
+        unless variable.empty?
+          entries << entry unless environment.grep(/\A#{variable}/)
+        else
+          entries << entry
+        end
+      end
+      unless entries.include? command
+        entries << command
+        cron_entries_file = CRON_ENTRIES_FILE
+        File.open(cron_entries_file, 'w') do |f|
+          entries.each {|entry| f.puts entry}
+        end
+        write_crontab_command = "crontab #{cron_entries_file}"
+        stdout, stderr, status = Open3.capture3(write_crontab_command)
+        cleanup
+        unless status.exitstatus == 0
+          STDERR.puts "There is a problem executing command"
+          STDERR.puts write_crontab_command
+          STDERR.puts stderr
+          exit status.exitstatus
+        end
+      end
+      command
+    end
+    # Removes a command from the user's crontab. If the provided command is
+    # empty remove_command will exit the application with exit status -1.
+    # The method uses the <tt>crontab -l</tt> and <tt>crontab file</tt> command.
+    # If the crontab call fails the error message and exit status of
+    # <tt>crontab</tt> will be returned and the application exits
+    def remove_command(command)
+      command = command.strip.squeeze(" ")
+      if command.empty?
+        STDERR.puts "Cannot delete empty command from crontab"
+        exit -1
+      end
+      read_crontab_command = "crontab -l"
+      stdout, stderr, status = Open3.capture3(read_crontab_command)
+      unless status.exitstatus == 0
+        STDERR.puts "There is a problem executing command"
+        STDERR.puts read_crontab_command
+        STDERR.puts stderr
+        exit status.existatus
+      end
+      entries = stdout.split(/\n/).each {|entry| entry.strip.squeeze(" ")}
+      entries.delete(command)
+      cron_entries_file = CRON_ENTRIES_FILE #".cron_entries"
+      File.open(cron_entries_file, 'w') do |file|
+        entries.each {|entry| file.puts entry}
+      end
+      write_crontab_command = "crontab #{cron_entries_file}"
+      stdout, stderr, status = Open3.capture3(write_crontab_command)
+      cleanup
+      unless status.exitstatus == 0
+        STDERR.puts "There is a problem executing command"
+        STDERR.puts write_crontab_command
+        STDERR.puts stderr
+        exit status.exitstatus
+      end
+      command
+    end
+    # Removes the CRON_ENTRIES_FILE after the values have been written to
+    # crontab
+    def cleanup
+      File.delete CRON_ENTRIES_FILE if File.exists? CRON_ENTRIES_FILE
+    end
+  end
+end

data/lib/backup/environment.rb ADDED

@@ -0,0 +1,44 @@
+module Backup
+  # Reads and filters the user's environment variables to meet Ruby and Gem
+  # requirements to run the application as a cron job
+  class Environment
+    # Contains the environment variable names that are required to run a Ruby
+    # application from as a cron job
+    VARIABLES = ["RVM_BIN_PATH",
+                 "GEM_HOME",
+                 "SHELL",
+                 "MY_RUBY_HOME",
+                 "USER",
+                 "RVM_PATH",
+                 "RVM_PREFIX",
+                 "PATH",
+                 "RVM_VERSION",
+                 "HOME",
+                 "LOGNAME",
+                 "GEM_PATH",
+                 "RUBY_VERSION"]
+    # Retrieves the environment variables that are required running a Ruby
+    # application as a cron job. The variable are returned in an Array
+    def self.ruby
+      file = ".current_environment.tmp"
+      system ("env > #{file}")
+      lines = []
+      File.open(file, 'r') do |f|
+        while line = f.gets
+          variable = line.chomp.match(/\A\w+(?=\=)/).to_s
+          lines << line.chomp if VARIABLES.find_index variable.upcase
+        end
+      end
+      File.delete file
+      lines
+    end
+  end
+end

data/lib/backup/file_backup.rb ADDED

@@ -0,0 +1,94 @@
+require 'fileutils'
+require 'open3'
+# Backup contains functions to backup a MySQL database and files and directories
+# to a default or specified backup directory. Instead of instant backup the
+# invoked command can be added to a crontab and invoked based on the provided
+# schedule that is a parameter of the --cron option. The backed up files are
+# per default compressed but this can be ommitted
+module Backup
+  # Backup directories and files to a backup directory
+  class FileBackup
+    # Initializes the files to be backed up. If no file is provided an error
+    # is returned
+    def initialize(files=[])
+      @files = files
+    end
+    # Compress the files to the backup directory
+    def compress(files, backup_folder)
+      inexistent_files = check_for_inexistent files
+      unless inexistent_files.empty?
+        STDERR.puts "Cannot compress inexistent files"
+        STDERR.puts "Following #{inexistent_files.size} file(s) do not exist"
+        STDERR.puts inexistent_files.join(" ")
+        exit 2
+      end
+      timestamp = Time.now.strftime("%Y%m%d-%H%M%S")
+      backup_folder += '/' unless backup_folder.match(/.*\/\Z/)
+      compress_file = backup_folder + timestamp + "_" + "files.tar.gz"
+      tar_command = "tar cfz #{compress_file} " + files.join(" ")
+      stdout_str, stderr_str, status = Open3.capture3(tar_command)
+      unless status.exitstatus == 0
+        STDERR.puts "There was a problem running tar command"
+        STDERR.puts "--> #{tar_command}"
+        STDERR.puts stderr_str
+        exit(2)
+      end
+      status.exitstatus
+    end
+    # The files to be backed up are initilized when creating an instance of
+    # FileBackup. These files are then backed up to the backup directory
+    def backup(backup_folder)
+      inexistent_files = []
+      @files.each do |file|
+        inexistent_files << file unless File.exists? file
+      end
+      unless inexistent_files.empty?
+        STDERR.puts "Cannot backup inexistent files"
+        STDERR.puts "Following #{inexistent_files.size} file(s) do not exist"
+        STDERR.puts "#{inexistent_files.join(', ')}"
+        exit 1
+      end
+      backup_folder += '/' unless backup_folder.match(/.*\/\Z/)
+      Dir.mkdir backup_folder unless File.exists? backup_folder
+      backup_files = []
+      @files.each.with_index do |file, index|
+        backup_files << backup_file = backup_folder+File.basename(file)
+        FileUtils.cp file, backup_file
+      end
+      backup_files
+    end
+    # Checks if the files all exist. Files that do not exist are returned in
+    # an Array
+    def check_for_inexistent (files)
+      inexistent_files = []
+      files.each do |f|
+        inexistent_files << f unless File.exists? f
+      end
+      inexistent_files
+    end
+  end
+end

data/lib/backup/mysql_backup.rb ADDED

@@ -0,0 +1,58 @@
+require 'open3'
+module Backup
+  # MySQLBackup creates a dump file of a MySQL database with _mysqldump_ and
+  # returns the dump file.
+  class MySQLBackup
+    # database is the database to be backed up with the user that has the
+    # credentials to access the database with the provided password
+    def initialize(database, user, password)
+      @database = database
+      @user = user
+      @password = password
+    end
+    # Compresses the MySQL dump file. If an error occurs when compressing the
+    # file an error message is printed and the application terminates
+    def compress(backup_file)
+      tar_file = backup_file + '.tar.gz'
+      tar_command = "tar cfz #{tar_file} #{backup_file}"
+      stdout_str, stderr_str, status = Open3.capture3(tar_command)
+      unless status.exitstatus == 0
+        File.delete tar_file if File.exists? tar_file
+        STDERR.puts "There was a problem compressing the backup file"
+        STDERR.puts "-->#{tar_command}"
+        STDERR.puts stderr_str
+        exit(2)
+      end
+      status.exitstatus
+    end
+    # Creates a MySQL dump file and returns the file
+    def backup(backup_folder="./")
+      Dir.mkdir backup_folder unless File.exists? backup_folder
+      timestamp = Time.now.strftime('%Y%m%d-%H%M%S')
+      backup_file = backup_folder + @database + '_' + timestamp + '.sql'
+      mysqldump = "mysqldump -u#{@user} -p#{@password} #{@database}"
+      backup_command = "#{mysqldump} > #{backup_file}"
+      stdout_str, stderr_str, status = Open3.capture3(backup_command)
+      unless status.exitstatus == 0
+        File.delete backup_file if File.exists? backup_file
+        STDERR.puts "There was a problem running mysqldump"
+        STDERR.puts "--> #{backup_command}"
+        STDERR.puts stderr_str
+        exit(1)
+      end
+      backup_file
+    end
+  end
+end