siba 0.4.3

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+*.log
+tags

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in siba.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,18 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest', :notify=>false do
+  watch(%r|^test/unit/(.*\/)*test_(.*)\.rb|)
+  watch(%r|^lib/siba/(.*\/)*([^/]+)\.rb|)     { |m| "test/unit/#{m[1]}test_#{m[2]}.rb" unless m[2][0] == '.' }
+  #watch(%r|^lib/(.*)([^/]+)\.rb|)     { "test" }
+
+  # with Minitest::Unit
+  # watch(%r|^test/test_(.*)\.rb|)
+  #watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  # watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Evgeny Neumerzhitskiy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Overview
+
+SIBA is a simple backup and restore utility. It implements daily backup rotation scheme. It is most suitable in sutuations when you need to have a history of backups and not just the last one. If run daily, SIBA retains full year history of backups by keeping only 23 files: 6 daily, 5 weekly and 12 monthly full backups.
+
+## Main features
+
+* **Ease of use.** Configure, backup and restore with a single command.
+* **Secure.** All backups are encrypted on your computer before reaching backup destination.
+* **Cross platform.** Utility can be run on any computer with Ruby 1.9 or later.
+* **Easy to extend.** Developers can easily add new backup sources, archivers, encryptors and destinations.
+* **Free and open source.** Use SIBA for any purpose without restrictions.
+
+## Installation
+
+        $ gem install siba
+
+(assuming that Ruby 1.9 and RubyGems are installed)
+
+## Usage
+
+1. Create a configuration file
+
+        $ siba generate mybak
+
+2. Backup
+
+        $ siba backup mybak
+
+3. Restore
+
+	$ siba restore mybak
+
+4. Show available plugins
+
+	$ siba list
+
+5. Create a gem project for a new destination plugin (or for a source, archive, encryption plugin).
+
+	$ siba scaffold destination my-cloud
+
+6. Show other commands and options
+
+        $ siba
+
+## Scheduling backups
+
+It is recommended to run `siba backup` command daily or hourly. Use your favourite scheduler: Cron, Scheduled Tasks, iCal etc.

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+namespace "test" do
+  desc "Run all unit tests"
+  Rake::TestTask.new("unit") do |t|     
+    t.pattern = "test/unit/**/test*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  Rake::TestTask.new("integration") do |t|     
+    t.pattern = "test/integration/**/i9n_*.rb"
+    t.libs << 'test'           
+  end
+  
+  desc "Run all integration tests"
+  task :i9n => ["test:integration"] do
+  end
+end
+
+desc "Run all unit tests"
+task :test => ["test:unit"] do
+end
+
+desc "Run tests"               
+task :default => "test:unit"

data/bin/siba

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'siba'
+Siba::Console.new.parse ARGV
+

data/lib/siba.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'siba/version'
+require 'siba/errors'
+require 'siba/helpers/string_helper'
+require 'siba/helpers/encoding_helper'
+require 'siba/helpers/gem_helper'
+require 'siba/helpers/security_helper'
+require 'siba/siba_file'
+require 'siba/siba_kernel'
+require 'siba/helpers/file_helper'
+require 'siba/logger_plug'
+require 'siba/tmp_dir'
+require 'siba/siba_check'
+require 'siba/globals'
+require 'siba/test_files'
+require 'siba/options_loader'
+require 'siba/plugins/plugins'
+require 'siba/tasks/siba_tasks'
+require 'siba/console'
+require 'siba/options_backup'
+require 'siba/backup'
+require 'siba/restore'
+
+module Siba
+  # Your code goes here...
+end

data/lib/siba/backup.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+module Siba
+  class Backup
+    include Siba::LoggerPlug
+    include Siba::FilePlug
+
+    def backup(path_to_options_yml, path_to_log_file)
+      run_backup path_to_options_yml, path_to_log_file
+    ensure
+      Siba.cleanup
+    end
+
+private
+
+    def run_backup(path_to_options_yml, path_to_log_file)
+      LoggerPlug.create "Backup", path_to_log_file
+      options = Siba::OptionsLoader.load_yml path_to_options_yml
+      Siba.current_dir = File.dirname path_to_options_yml
+      Siba.settings = options["settings"] || {}
+      Siba.backup_name = File.basename path_to_options_yml, ".yml"
+
+      TmpDir.test_access 
+      SibaTasks.new(options, path_to_options_yml, false).backup
+      Siba.cleanup_tmp_dir
+    rescue Exception => e 
+      logger.fatal e
+      logger.log_exception e, true
+    end
+  end
+end

data/lib/siba/console.rb

@@ -0,0 +1,196 @@
+# encoding: UTF-8
+
+require 'optparse'
+require 'siba/scaffold'
+require 'siba/generator'
+
+module Siba
+  class Console
+    include Siba::FilePlug 
+
+    UNUSED_COMMAND = "unused" # unused command for testing command line options
+    attr_accessor :test_mode, :parser, :options
+
+    def initialize(test_mode=false)
+      @test_mode = test_mode
+      @options = {}
+    end
+
+    def parse(argv)
+      @parser = parse_options argv
+      return if parser.nil?
+      parse_command argv
+    end
+
+  private
+
+    def parse_options(argv)
+      parser = OptionParser.new do |o|
+        o.banner = "Usage: siba command ARGUMENTS [options...]
+
+Examples: 
+    siba generate mybak         Generate mybak.yml options file                        
+    siba backup mybak           Run backup, reading options from mybak.yml
+    siba restore mybak          Restore the backup
+    siba list                   Show available plugins
+    siba scaffold source my-db  Create a new gem for a source plugin
+                                (or archive, encryption or destination)
+
+    Note: single letter commands are also supported, like b for backup
+
+Options:"
+
+        o.on("--log FILE", "Set path to log FILE") do |log|
+          options['log'] = log
+        end
+        
+        o.on("--no-log", "Work without logging") do 
+          SibaLogger.no_log = true
+        end
+
+        o.on("-q", "--quiet", "No output to console") do
+          SibaLogger.quiet = true
+        end
+
+        o.on("-v", "--verbose", "Detailed progress messages and error reports") do
+          SibaLogger.verbose = true
+        end
+
+        o.on("-h", "--help", "Show this message") do
+          show_message o
+          return
+        end
+
+        o.on("--version", "Show version") do
+          show_message "SIBA (SImple BAckup) #{Siba::VERSION}"
+          return
+        end
+      end
+
+      if argv.empty? 
+        show_message parser.to_s
+        return
+      end
+      
+      begin      
+        parser.parse! argv
+      rescue Exception => e
+        @parser = parser
+        show_error e.to_s, true, e
+      end
+
+      if !options['log'].nil? && SibaLogger.no_log
+        show_error "ambiguous usage of both --log and --no-log switches"
+        return
+      end
+      
+      parser
+    end
+
+    def parse_command(argv)
+      command = argv.shift
+      show_error "missing a command", true if command.nil?
+      
+      case command.downcase
+      when "b", "backup"
+        backup argv
+      when "s", "scaffold"
+        scaffold argv
+      when "l", "list"
+        list
+      when "g", "generate"
+        generate argv
+      when "r", "restore"
+        restore argv
+      when Siba::Console::UNUSED_COMMAND
+      else
+        show_error "Invalid command '#{command}'", true
+      end
+
+      exit_with_error if Siba::SibaLogger.count("warn",false) > 0
+    end
+
+    def show_error(msg, show_help = false, exception = nil)
+      if msg.is_a? Exception
+        exception = msg
+        msg = msg.message
+      end
+      msg += "\n\n#{parser.to_s}" if show_help
+      show_message "Error: #{msg}"
+      exit_with_error
+      raise (exception || Siba::ConsoleArgumentError.new(msg))
+    end
+
+    def show_message(msg)
+      puts msg unless test_mode
+    end
+
+    def exit_with_error
+      exit 1 unless test_mode
+    end
+
+    def backup(argv)
+      path_to_options = argv.shift
+      show_error "missing backup options file argument" if path_to_options.nil?
+      show_error "needless arguments: #{argv.join(', ')}" unless argv.empty?
+      path_to_options = siba_file.file_expand_path path_to_options
+      path_to_log = options['log']
+
+      unless path_to_log.nil?
+        path_to_log = siba_file.file_expand_path path_to_log
+      else
+        log_name = "#{File.basename(path_to_options,".yml")}.log"
+        path_to_log = File.join(File.dirname(path_to_options), "#{log_name}")
+      end
+
+      path_to_options += ".yml" unless path_to_options =~ /\.yml$/
+      Siba::Backup.new.backup path_to_options, path_to_log
+    end
+
+    def scaffold(argv)
+      category = argv.shift
+      if category.nil?
+        show_error "missing category argument"
+      end
+
+      name = argv.shift
+      show_error "missing name argument" if name.nil?
+      show_error "needless arguments: #{argv.join(', ')}" unless argv.empty?
+
+      begin
+        Siba::Scaffold.new(category, name).scaffold(siba_file.dir_pwd)
+      rescue Exception => ex
+        show_error ex
+      end
+    end
+
+    def list
+      show_message "Available SIBA plugins:
+      
+#{Siba::Plugins.get_list} * Currently installed"
+    end
+
+    def generate(argv)
+      file = argv.shift
+      if file.nil?
+        show_error "missing file name"
+      end      
+      begin
+        path_to_yaml = Siba::Generator.new(file).generate
+        show_message "Options file generated: #{path_to_yaml}
+Edit it and run backup command" unless path_to_yaml.nil?
+      rescue Exception => ex
+        show_error ex
+      end
+    end
+
+    def restore(argv)
+      path_to_options = argv.shift
+      show_error "missing backup options file argument" if path_to_options.nil?
+      show_error "needless arguments: #{argv.join(', ')}" unless argv.empty?
+      path_to_options = siba_file.file_expand_path path_to_options
+      path_to_options += ".yml" unless path_to_options =~ /\.yml$/
+      Siba::Restore.new.restore path_to_options
+    end
+  end
+end

data/lib/siba/errors.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+module Siba
+  class Error < RuntimeError; end
+  class PluginLoadError < RuntimeError; end
+  class CheckError < RuntimeError; end
+  class ConsoleArgumentError < RuntimeError; end
+end

data/lib/siba/generator.rb

@@ -0,0 +1,115 @@
+# encoding: UTF-8
+
+module Siba
+  class Generator
+    include Siba::FilePlug
+    include Siba::KernelPlug
+
+    PLUGIN_YAML_NAME = "options.yml"
+
+    attr_accessor :name
+    def initialize(name)
+      @name = String.new name
+    end
+
+    # Generates yaml options file and returns its path
+    def generate
+      siba_file.run_this do
+        file_path = @name.gsub /\.yml$/, ""
+        file_path += ".yml"
+        file_path = siba_file.file_expand_path file_path
+        if siba_file.file_file?(file_path) || siba_file.file_directory?(file_path)
+          raise Siba::Error, "Options file already exists: #{file_path}"
+        end
+
+        options_data = []
+        Siba::Plugins::PLUGINS_HASH.each do |category, types|
+          type = nil
+          if types.size > 1
+            max_type_length = types.keys.max do |a,b|
+              a.length <=> b.length
+            end.length + 5
+
+            siba_kernel.puts "\nChoose #{category} plugin:"
+            types.keys.each_index do |i|
+              type = types.keys[i]
+              siba_kernel.puts "  #{i+1}. #{Siba::Plugins.plugin_type_and_description(category, type, max_type_length)}"
+            end
+
+            type = Siba::Generator.get_plugin_user_choice types.keys
+            if type.nil?
+              siba_kernel.puts "Cancelled by user"
+              return
+            end
+
+            unless Siba::InstalledPlugins.installed? category, type
+              siba_kernel.puts "#{type} plugin is not installed."
+              siba_kernel.puts "Run 'gem install #{Siba::InstalledPlugins.gem_name(category, type)}' to install it and try again."
+              return
+            end
+          else
+            type = types.keys.first
+          end
+
+          options = Siba::Generator.load_plugin_yaml_content category, type 
+          unless options =~ /^\s*type:/
+            options = "type: #{type}\n" + options
+          end
+
+          options.gsub! /^/, "  "
+          options = "#{category}:\n" + options
+          options_data << options
+        end
+
+        file_data = options_data.join("\n")
+        file_data = "# SIBA options file\n" + file_data
+        dest_dir = File.dirname file_path
+        siba_file.file_utils_mkpath(dest_dir) unless siba_file.file_directory?(dest_dir)
+        Siba::FileHelper.write file_path, file_data
+        file_path
+      end
+    end
+
+    class << self
+      include Siba::FilePlug
+      include Siba::KernelPlug
+
+      def load_plugin_yaml_content(category, type)
+        siba_file.run_this do
+          path = get_plugin_yaml_path category, type
+          begin
+            Siba::OptionsLoader.load_erb path
+          rescue Exception => ex
+            raise "Failed to load options for #{InstalledPlugins.plugin_category_and_type(category, type)} plugin from file: #{path}. Error: #{ex.message}"
+          end
+        end
+      end 
+
+      def get_plugin_yaml_path(category, type)
+        siba_file.run_this do
+          dir = InstalledPlugins.plugin_path(category, type)
+          options_path = File.join dir, PLUGIN_YAML_NAME
+          unless siba_file.file_file? options_path
+            raise Siba::Error, "Failed to load options for #{InstalledPlugins.plugin_category_and_type(category, type)} plugin from file: #{options_path}"
+          end
+          options_path
+        end
+      end
+
+      def get_plugin_user_choice(types)
+        msg = "\nEnter plugin number from 1 to #{types.size}, or 0 to exit.\n> "
+        siba_kernel.printf msg
+        while true
+          user_choice = siba_kernel.gets.chomp.strip
+          number = Integer(user_choice) rescue -1
+          if number >= 0 && number <= types.size
+            return if number == 0
+            return types[number-1]
+          else
+            siba_kernel.printf msg
+          end 
+        end
+      end
+    end
+  end
+end