lsync 1.2.5 → 2.0.2

data/lib/lsync/shells/ssh.rb

@@ -0,0 +1,47 @@
+
+require 'lsync/shell'
+
+module LSync
+	module Shells
+		# SSH shell provides access to a remote server using SSH.
+		class SSH < Shell
+			def initialize(options = {})
+				super(options[:command] || "ssh", options)
+			end
+			
+			# The connection options for ssh
+			# [`:port`]        The remote port to use.
+			# [`:key`]         A specific key file to use.
+			# [`:keys`]        A specific array of key files to use.
+			# [`:timeout`]     How long to wait until connection fails if no response is received.
+			# [`:compression`] Enable compression.
+			# [`:user`]        Connect as a specific user.
+			def command_arguments
+				args = []
+
+				@options.each do |k,v|
+					case(k.to_sym)
+					when :port
+						args += ['-p', v.to_s]
+					when :key
+						args += ['-i', v]
+					when :keys
+						v.each { |key_path| args += ['-i', key_path] } 
+					when :timeout
+						args += ['-o', "ConnectTimeout #{v.to_i}".to_cmd]
+					when :compression
+						args += ['-C'] if v
+					when :user
+						args += ['-l', v.to_s]
+					end
+				end
+
+				return args
+			end
+			
+			def connection_command(server, arguments = [])
+				super(server, arguments + command_arguments)
+			end
+		end
+	end
+end

data/lib/lsync/tee_logger.rb

@@ -1,37 +1,50 @@
 
-module TeeHelper
-  def tee(*loggers)
-    return TeeLogger.new(self, *loggers)
-  end
-end
-
-class TeeLogger
-  def initialize(*loggers)
-    @loggers = Set.new(loggers.flatten.compact)
-  end
-
-  attr :loggers
-
-  def self.logger_methods
-    Set.new(Logger.instance_methods) - Set.new(Object.instance_methods + %w(tee))
-  end
-
-  logger_methods.each do |method|
-    define_method(method) do |*args|
-      @loggers.each { |l| l.send(method, *args) }
-    end
-  end
-  
-  include TeeHelper
+module LSync
+	# A helper to provide easy access to the TeeLogger functionality.
+	module TeeHelper
+		def tee(*loggers)
+			return TeeLogger.new(self, *loggers)
+		end
+	end
+
+	# The tee logger provides a simple split logging system where multiple logs may receive the same
+	# messages. These logs can route messages to different destinations using different formatting.
+	class TeeLogger
+		def initialize(*loggers)
+			@loggers = Set.new(loggers.flatten.compact)
+		end
+
+		attr :loggers
+
+		def self.logger_methods
+			Set.new(Logger.instance_methods) - Set.new(Object.instance_methods + %w(tee))
+		end
+
+		logger_methods.each do |method|
+			define_method(method) do |*args|
+				@loggers.each { |l| l.send(method, *args) }
+			end
+		end
+
+		include TeeHelper
+	end
+	
+	# A minimal log format that keeps track of the start time, and prints the minimal amount of information.
+	class MinimalLogFormat
+		def initialize
+			@start_time = nil
+		end
+		
+		def call(severity, time, progname, msg)
+			@start_time ||= time
+			diff = time - @start_time
+			
+			"[T+#{sprintf('%0.1f', diff).ljust(5)} #{severity.rjust(5)}] #{msg}\n"
+		end
+	end
 end
 
 class Logger
-  include TeeHelper
-end
-
-class MinimalLogFormat
-  def call(severity, time, progname, msg)
-    "[#{severity.rjust(8)}] #{msg}\n"
-  end
+	include LSync::TeeHelper
 end
 

data/lib/lsync/version.rb

@@ -15,9 +15,9 @@
 
 module LSync
   module VERSION #:nodoc:
-    MAJOR = 1
-    MINOR = 2
-    TINY  = 5
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: lsync
 version: !ruby/object:Gem::Version 
-  hash: 21
   prerelease: false
   segments: 
-  - 1
   - 2
-  - 5
-  version: 1.2.5
+  - 0
+  - 2
+  version: 2.0.2
 platform: ruby
 authors: 
 - Samuel Williams
@@ -15,75 +14,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-09 00:00:00 +12:00
-default_executable: lsync
+date: 2011-07-19 00:00:00 +12:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: termios
+  name: fingerprint
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: net-ssh
+  name: rexec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 2
+        - 6
+        version: 1.2.6
   type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: ruleby
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rexec
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id004
 description: 
 email: samuel.williams@oriontransfer.co.nz
-executables: 
-- lsync
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- bin/lsync
 - lib/lsync/action.rb
 - lib/lsync/actions/darwin/disk
 - lib/lsync/actions/darwin/terminal
@@ -93,21 +63,22 @@ files:
 - lib/lsync/actions/linux/terminal
 - lib/lsync/directory.rb
 - lib/lsync/error.rb
-- lib/lsync/extensions.rb
-- lib/lsync/lb.py
+- lib/lsync/event_handler.rb
+- lib/lsync/event_timer.rb
 - lib/lsync/method.rb
-- lib/lsync/password.rb
-- lib/lsync/plan.rb
+- lib/lsync/methods/rsync.rb
 - lib/lsync/run.rb
 - lib/lsync/script.rb
 - lib/lsync/server.rb
 - lib/lsync/shell.rb
 - lib/lsync/shell_client.rb
+- lib/lsync/shells/ssh.rb
 - lib/lsync/tee_logger.rb
 - lib/lsync/version.rb
 - lib/lsync.rb
-has_rdoc: true
-homepage: http://www.oriontransfer.co.nz/software/lsync
+- README.md
+has_rdoc: yard
+homepage: http://www.oriontransfer.co.nz/gems/lsync
 licenses: []
 
 post_install_message: 
@@ -116,27 +87,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: LSync is a tool for scripted synchronization and backups.

data/bin/lsync

@@ -1,142 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'ftools'
-require 'lsync'
-require 'lsync/version'
-require 'optparse'
-
-OPTIONS = {
-  :ConfigFiles => [],
-  :LogPath => "/var/log/lsync/backup.log"
-}
-
-ARGV.options do |o|
-  script_name = File.basename($0)
-
-  o.set_summary_indent('  ')
-  o.banner = "Usage: #{script_name} [options] [directory | config]"
-  o.define_head "This script is used to run lsync scripts and plans. If you specify a directory, files ending in .lsync-script and .lsync-plan will all be processed."
-
-  o.separator ""
-  o.separator "Help and Copyright information"
-	
-  o.on("-l log_path", String, "Set the directory for backup logs") do |log_path|
-		OPTIONS[:LogPath] = log_path
-	end
-
-  o.on_tail("--copy", "Display copyright information") do
-    puts "#{script_name} v#{LSync::VERSION::STRING}. Copyright (c) 2008-2010 Samuel Williams. Released under the GPLv3."
-    puts "See http://www.oriontransfer.co.nz/ for more information."
-
-    exit
-  end
-
-  o.on_tail("-h", "--help", "Show this help message.") { puts o; exit }
-end.parse!
-
-# ============================== Main Scripts / Plans ==============================
-
-class LogPathChecker
-  def initialize(directory, filename)
-    full_path = File.join(directory, filename)
-
-    @directory_writable = File.directory?(directory) && File.writable?(directory)
-    @file_not_writable = File.exist?(full_path) && !File.writable?(full_path)
-
-    @accessable = @directory_writable && !@file_not_writable
-    @full_path = full_path
-  end
-  
-  attr :accessable
-  attr :full_path
-end
-
-def setup_logging
-  # Console log output
-  $console_log = Logger.new($stdout)
-  $console_log.formatter = MinimalLogFormat.new
-  
-  # File log output
-  filename = File.basename(OPTIONS[:LogPath])
-  directory = File.dirname(OPTIONS[:LogPath])
-  
-  if filename == nil || filename == ""
-    filename = "backup.log"
-  end
-  
-  check = LogPathChecker.new(directory, filename)
-  unless check.accessable
-    $console_log.warn "Could not write to #{check.full_path.dump} - changing log path to #{Dir.pwd.dump}"
-    
-    directory = Dir.pwd
-    check = LogPathChecker.new(directory, filename)
-  end
-  
-  if check.accessable
-    $backup_log = Logger.new(check.full_path, 'weekly')
-  else
-    $console_log.warn "Could not write to #{check.full_path.dump} - not logging to disk"
-    $backup_log = nil
-  end
-  
-  $logger = TeeLogger.new($console_log, $backup_log)
-end
-
-def process_config_files
-  ARGV.each do |p|
-    unless File.exists? p
-      $logger.error "Could not process #{p}"
-      exit(20)
-    end
-  
-    if File.directory? p
-      OPTIONS[:ConfigFiles] += Dir[File.join(p, "*.{lsync-script,lsync-plan}")]
-    else
-      OPTIONS[:ConfigFiles] << p
-    end
-  end
-end
-
-def run_backups(config_files)
-	if config_files.size == 0
-		$logger.warn "No configuration files specified!"
-	else
-		config_files.each do |c|
-			config = LSync::load_from_file(c)
-			config.logger = $logger
-			config.run_backup
-		end
-	end
-end
-
-def dump_exception_backtrace ex
-  ex.backtrace.each do |bt|
-    $logger.error bt
-  end
-end
-
-# Main Script Execution
-setup_logging
-
-process_config_files
-
-$logger.info "  Backup beginning at #{Time.now.to_s}  ".center(96, "=")
-
-begin
-  run_backups(OPTIONS[:ConfigFiles])
-rescue LSync::Error
-  $logger.error "#{$!.class.name}: #{$!.to_s}. Dumping backtrace:"
-  dump_exception_backtrace($!)
-  exit(230)
-rescue Interrupt
-  $logger.error "Backup process recevied interrupt (Ctrl-C). Dumping backtrace:"
-  dump_exception_backtrace($!)
-  exit(240)
-rescue
-  $logger.error "Unknown exception #{$!.class.name} thrown: #{$!.to_s}. Dumping backtrace:"
-  dump_exception_backtrace($!)
-  exit(250)
-ensure
-  $logger.info "  Backup finishing at #{Time.now.to_s}  ".center(96, "=")
-end
-