irgat 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-10-24
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,45 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+TODO
+bin/irgat
+bin/irgat_setup
+config/hoe.rb
+config/requirements.rb
+lib/irgat.rb
+lib/irgat/console.rb
+lib/irgat/dependencies.rb
+lib/irgat/execs.rb
+lib/irgat/log.rb
+lib/irgat/mail.rb
+lib/irgat/utils.rb
+lib/irgat/version.rb
+lib/modules/backup.rb
+lib/modules/console.rb
+lib/modules/kwallet.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+setup/etc/backup.yml.example
+setup/etc/chroot.yml.example
+setup/etc/console.yml.default
+setup/etc/cron.yml.example
+setup/etc/dar.yml.example
+setup/etc/irgat.yml.example
+setup/etc/kwallet.yml.default
+setup/etc/kwallet.yml.example
+setup/etc/ssh.yml.example
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_irgat.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,4 @@
+Run irgat_setup to setup Irgat
+
+For more information on Irgat, see http://irgat.rubyforge.org
+

data/README.rdoc

@@ -0,0 +1,29 @@
+= irgat
+
+Interactive Ruby for Gnoxys Administration Tools
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+Copyright (c) 2007 - 2008 Gnoxys, info@gnoxys.net
+
+This program is released under the terms of the GPL v3 license as you cand find in http://www.gnu.org/licenses/gpl.html

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/TODO

@@ -0,0 +1,26 @@
+# TODO file
+
+=== General
+
+ - When the folders tree is checked, we build a hash symbol array with the form
+   folders[:<name_dir>]=<absolute path>, that's great, the problem is when two directoris are called eqal, but inside of differents parents folders (for example, /current/archive, /old/archive.
+  
+   In this case, the last folder will be reported as folders[:archive]='/old/archive', and for the first entry, won't be any hash entry
+    
+   [ TODO ] => Think about it ;)
+
+=== Backup
+
+  - Add a prevent control to predict how much space is going to need the backup and check if exist enought. If not, exit of application. Something like
+  {
+  get_older_size_backup=X
+  if df -h(working_folder) < get_older_size_backup
+    exit
+  end
+  }
+
+  - Add a option to distribute backups with ftp
+
+  - Check mount folder
+
+  - Include by default to exclude backup folder from backup

data/bin/irgat

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+#= Usage
+#
+#  irgat -v || --version           # display version information and exit
+#  irgat -h || --help              # display help and exit
+#  irgat < arg >                   # process an irgat petition
+#  ---------------------
+#  irgat works like a modular tool. For example, the syntaxis for a backup is:
+#  $: irgat backup launch
+#
+#= Help 
+#
+# Irgat is an utility to manage administration script and all the tools needed for it.
+#
+# Irgat use two modes (at this moment)
+#
+#  1. Mode Cron
+#
+#  Perform operations in function of irgat config files.
+#  <mas informacion de cron>
+#
+#  2. Mode CMD [command]
+#
+#  In this mode, irgat show you an irb console with the default modules loaded. You can perform all the normal operations and check the works of your irgat's subsytems, make test and launch debug commands.
+#
+#  Also, the command line is builded with the intention of a helpper tool, so you can get easy a lot of help of methods, requirements, external programs needed or all the stuff needed for your administration script.
+#
+#  For more info, view the API of irgat and read the documentation
+#
+#= License
+#
+#  IRGAT (Intuitive Ruby for Gnoxys Administration Tools)
+#  2007 - 2008 Gnoxys. info@gnoxys.net
+#  This program is released under the terms of the GPL v3 license as you cand find in http://www.gnu.org/licenses/gpl.html
+#
+#
+
+
+# IRGAT constants
+IRGAT_ROOT = File.dirname(__FILE__) + '/..'
+puts IRGAT_ROOT
+# Default paths, if you want to change, change hear
+IRGAT_CONFIG = '/etc/irgat'   unless defined?(IRGAT_CONFIG)
+IRGAT_LANG   = IRGAT_ROOT + '/lang'     unless defined?(IRGAT_LANG)
+IRGAT_LIB    = IRGAT_ROOT + '/lib'      unless defined?(IRGAT_LIB)
+
+begin
+  # requiere other modules, if not loaded yet
+  require 'yaml'
+  require 'erb'
+  # RDoc, built inside help
+  require 'rdoc/usage'
+  require 'rdoc/code_objects'
+  require 'rdoc/markup/simple_markup'
+  require 'rdoc/markup/simple_markup/to_flow'
+  require 'rdoc/ri/ri_formatter'
+  require 'rdoc/ri/ri_options'
+  require 'net/smtp'
+  require 'tmail'
+  # irgat Base
+  require 'irgat'
+rescue LoadError => msj
+  puts "Irgat needed the follow gem:"+(msj.to_s.split('--'))[1]+", but not found."
+  puts "[ ERROR ] in file "+msj.backtrace.to_s
+end
+
+# check launch
+case $*[0]
+when nil
+  # no command line params. Show usage and exit
+  puts "\n * ERROR: missing options"
+  RDoc::usage(1,'usage')
+when '--version','-v'
+  # display version. license and exit
+  puts "\nVERSION: " + Irgat::VERSION
+  RDoc::usage('license')
+when '--help','-h'
+  # help, and exit
+  RDoc::usage('help')
+else
+  args = $*
+  # process irgat request
+  Irgat.process(args)
+end
+
+

data/bin/irgat_setup

@@ -0,0 +1,135 @@
+#!/usr/bin/ruby
+
+=begin
+
+Irgat setup program
+---------------------
+
+Author:  Gnoxys. info@gnoxys.net 
+License: GPL v3.
+
+Read more info in <irgat_path>/README
+
+=end
+
+def stop_install(msj)
+  puts 'Irgat installation was stopped with this message:'
+  puts '"'+msj+'"'
+  puts ''
+  puts 'Bye!'
+  exit 1
+end
+
+
+
+puts ''
+puts 'Welcome to IRGAT setup'
+puts '------------------------'
+puts ''
+
+if Process.euid != 0
+  stop_install('You must run this program as root.')
+end
+
+
+puts ''
+puts '* Irgat is going to check the programs needed'
+puts "  Do it? [Y/n]"
+
+answer = $stdin.gets
+
+stop_install('Halted by user') if answer.strip == 'n'
+
+#programs_needed = [ 'dar', 'dar_manager', 'mutt', 'ssh', 'irb' ]
+programs_needed = [ 'ssh', 'irb' ]
+
+for program in programs_needed
+    program_path = %x[ which #{program}]
+    if program_path == ''
+      puts "Irgat cannot found the following #program:#{program}"
+      stop_install('Program not found')
+    end
+end
+
+puts '-> Programs ok'
+
+#test folder irgat
+
+irgat_config_folder = '/etc/irgat'
+
+if ! test(?d, irgat_config_folder)
+  puts "Folder #{ irgat_config_folder } doesn't exits. Create it? [Y/n]"
+  answer_create = $stdin.gets
+  stop_install('Halted by user') if answer_create.strip == 'n'
+  %x[ mkdir -p #{ irgat_config_folder} ]
+  if $?!=0
+    stop_install("Exec: mkdir -p #{ irgat_config_folder } return error")
+  end
+else
+  if Dir.entries(irgat_config_folder).length > 2
+    puts 'Target folder is not empty, continue anyway? [Y/n]'
+    answer_empty = $stdin.gets
+    stop_install('Halted by user') if answer_empty.strip == 'n'
+  end
+end
+
+
+puts 'Copy Irgat config sample files to destination'
+puts ''
+
+%x[ cp -rf #{ File.dirname(__FILE__) }/../setup/etc/* #{irgat_config_folder} ]
+
+if $? != 0
+  stop_install("Exec: cp -r #{ File.dirname(__FILE__) }/../setup/etc/* #{irgat_config_folder} return error")
+end
+
+=begin
+puts 'Irgat comes with an init.d script that launches the macros init_system and stop_system (see irgat/macros.rb for more information)'
+puts 'Do you want to copy to /etc/init.d/irgat? [Y/n]'
+answer = $stdin.gets
+if answer.strip != 'n'
+%x[ cp bin/irgat_init /etc/init.d/irgat ]
+    %x[ chmod 755 /etc/init.d/irgat]
+    if $? != 0
+      puts '* I can\t copy the file'
+    else
+      puts 'ok'
+      puts ''
+      puts 'Do i also add to the default init? [Y/n]'
+      answer = $stdin.gets
+      if answer.strip != 'n'
+        puts 'Linux Distributions have different ways to make this. So, choose'
+        puts ' 1. Debian way (update-rc.d)'
+        puts ' 2. RedHat way (chkconfig)'
+        puts ''
+        puts ' 0. Make nothing'
+        puts ''
+        puts ' Choose option [1,2,0]'
+        answer_option = $stdin.gets
+        case answer_option.strip.to_s
+          when "1"
+            %x[ update-rc.d irgat defaults 99]
+            if $? != 0
+              puts '* Error, I can\'t add irgat to default run-leves. do it yourself'
+            end
+          when "2"
+            %x[ chkconfig --add irgat]
+            if $? != 0
+              puts '* Error, I can\'t add irgat to default run-leves. do it yourself'
+            end
+          else
+              puts ' Do nothing'
+        end
+      end
+    end
+  end
+end
+=end
+
+puts ''
+puts '* Ok. All done! Edit your config in /etc/irgat to set the variables for irgat and modules'
+puts ''
+puts 'Irgat setup finished!!! Happy Admin ;-)'
+puts 'Bye!'
+
+# finish install

data/config/hoe.rb

@@ -0,0 +1,80 @@
+require 'irgat/version'
+
+AUTHOR = 'Gnoxys'  # can also be an array of Authors
+EMAIL = "info@gnoxys.net"
+DESCRIPTION = "Intuitive Ruby for Gnoxys Administration Tools"
+GEM_NAME = 'irgat' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'irgat' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['net-ssh', '>= 2.0.4'],
+  ['rdoc', '>= 2.2.1'],
+  ['termios', '>= 0.9.4'],
+  ['tmail', '>= 1.2.3.1']
+]    # An array of rubygem dependencies [name, version]
+EXTRA_DEV_DEPENDENCIES = [
+#  ['rspec', '>= 1.1.5']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Irgat::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'irgat documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description    = DESCRIPTION
+  p.summary        = DESCRIPTION
+  p.url            = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs     = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes        = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps     = EXTRA_DEPENDENCIES
+  p.extra_dev_deps = EXTRA_DEV_DEPENDENCIES
+
+    p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/irgat.rb

@@ -0,0 +1,94 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+#= License
+#
+#  IRGAT (Intuitive Ruby for Gnoxys Administration Tools)
+#  2007 - 2008 Gnoxys. info@gnoxys.net
+#  This program is released under the terms of the GPL v3 license
+#  as you cand find in http://www.gnu.org/licenses/gpl.html
+
+# start with Irgat module. Build namespace IRGAT
+module Irgat
+
+  # Singelton pass to Irgat::Irgat.process
+  class << self
+    def process(args = {})
+      irgat = Irgat.new
+      irgat.process(args)
+    end
+  end
+
+  class Irgat
+    #accesor to configs
+    attr_reader :config
+    attr_reader :config_module
+    #accesor to init time
+    attr_reader :init_time
+    #accesor to programs
+    attr :programs
+    #accesor to folders
+    attr :folders
+
+    # add utils
+    require 'irgat/utils'
+    include ::Irgat::Log
+    include ::Irgat::Mail
+    include ::Irgat::Execs
+    include ::Irgat::Dependencies
+
+    # simple initialize of a Irgat object... loading general config
+    def initialize(options = {})
+      @init_time = Time.now
+      @config    = self.load_config
+    end
+
+    def process(args = [])
+      irgat_module = args.shift
+      # get subsytem if active FIXME
+      if !self.config[:enable_subsystem].include?(irgat_module)
+        exit_with_error('Module not enable in irgat config')
+      end
+
+      # action ? 
+      ( args.first ? action = args.shift : action = "default" )
+
+      # no action : is parameter
+      if action.include?("-")
+        args.push(action)
+        action = "default"
+      end
+
+      # debug to stdout?
+      if args.include?("-d")
+        @log_to_stdout = true
+      end
+
+      # init the module
+      begin
+        require 'modules/' + irgat_module
+        irgat_process =  Object.module_eval("#{ irgat_module.capitalize }").new
+      rescue LoadError => msj
+        exit_with_error("Unable to start the #{ irgat_module } module. Error was: #{ msj.backtrace.to_s } ")
+      end
+
+      # scape possible private methods throught a bug in send method
+      # http://joshstaiger.org/archives/2006/12/the_ruby_send_h.html
+      if irgat_process.public_methods.include?(action)
+        irgat_process.send(action, args)
+      else
+        exit_with_error("Unable to exec action. Not avaible public method '#{ action }' in '#{ irgat_module }' Module. }", { :no_finish_process => true })
+      end
+    end
+
+    # method to load the config options for a module and return a hash symbol
+    def load_config(config_file = nil)
+      config_yml = YAML.load_file(config_file || IRGAT_CONFIG + '/' + self.class.to_s.downcase.split('::')[1] + '.yml')
+      # parse to symbols the config options
+      config_to_symbols = Hash.new
+      config_yml.each{|k, v| config_to_symbols[k.to_sym] = v}
+      config_to_symbols
+    end
+  end
+end
+