lsync 2.1.0 → 2.3.1

data/lib/lsync/server.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
 
 require 'lsync/event_handler'
 require 'lsync/shells/ssh'
@@ -6,19 +25,24 @@ module LSync
 	class Server
 		include EventHandler
 		
-		def initialize(host)
+		def initialize(host, options = {})
+			@options = options
+ 
 			@host = host
 			@root = "/"
-			
-			@platform = "generic"
-			
+
+			@platform = nil
+
 			@shell = Shells::SSH.new
-			
+
 			@enabled = true
-			@connection = nil
-			@pid = nil
+
+			@roles = Set.new
 		end
 		
+		# The roles that dictate how the server fits into the overall infratstructure.
+		attr :roles, true
+		
 		# The host name (e.g. DNS entry) for the given server
 		attr :host, true
 		
@@ -35,20 +59,24 @@ module LSync
 		def full_path(directory = "./")
 			p = File.expand_path(directory.to_s, @root)
 
-			return Pathname.new(p).cleanpath.normalize_trailing_slash.to_s
+			return Pathname.new(p).cleanpath.normalize_trailing_slash
 		end
 
 		# Give a general connection string (e.g +"host:/directory"+ or +"/directory"+ if local).
 		def connection_string(directory)
-			if is_local?
+			if local?
 				return full_path(directory)
 			else
-				return @host + ":" + full_path(directory).dump
+				return @host + ":" + full_path(directory).to_cmd
 			end
 		end
 
+		def role?(role)
+			@roles.include?(role) || @roles.include?(:all) || role == :any
+		end
+
 		# Checks if the host resolves to the local machine.
-		def is_local?
+		def local?
 			return true if @host == "localhost"
 
 			hostname = Socket.gethostname
@@ -66,14 +94,5 @@ module LSync
 		def to_s
 			"#{@host}:#{full_path}"
 		end
-
-		# Connect to the server using the given #shell and #connection_string.
-		def connect
-			unless @connection
-				@connection, @pid = @shell.connect(self)
-			end
-
-			return @connection
-		end
 	end
 end

data/lib/lsync/shell.rb

@@ -1,10 +1,30 @@
+# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
 
 require 'rexec'
 require 'pathname'
 
 module LSync
-	CLIENT_CODE = (Pathname.new(__FILE__).dirname + "shell_client.rb").read
-	
+
+	CLIENT_CODE = (Pathname.new(__FILE__).dirname + "client.rb").read
+
 	# There was an error establishing a connection with a server.
 	class ConnectionError < StandardError
 	end
@@ -22,7 +42,6 @@ module LSync
 			@options = options
 		end
 		
-		# The command required to start an instance of Ruby.
 		def ruby_command
 			@options[:ruby] || ["ruby"]
 		end
@@ -32,33 +51,13 @@ module LSync
 			@command + (@options[:arguments] || []) + arguments + [server.host]
 		end
 		
-		# Establish a connection to the server using this shell configuration.
 		def connect(server)
-			begin
-				connection, pid = open_connection(server)
-				message = connection.receive_object
-			ensure
-				connection.dump_errors if connection
-			end
-			
-			if message != :ready
-				raise ConnectionError.new("Remote shell connection was not successful: #{message}")
-			end
-			
-			return connection, pid
-		end
-		
-		protected
-		# Return a connection object representing a connection to the given server.
-		def open_connection(server)
-			command = ruby_command
-			
-			unless server.is_local?
-				command = connection_command(server) + command
+			options = {:passthrough => []}
+			if server.local?
+				return RExec::start_server(CLIENT_CODE, ruby_command, options)
+			else
+				return RExec::start_server(CLIENT_CODE, connection_command(server) + ruby_command, options)
 			end
-			
-			return RExec::start_server(CLIENT_CODE, command)
 		end
 	end
-	
 end

data/lib/lsync/shells/ssh.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
 
 require 'lsync/shell'
 

data/lib/lsync/tee_logger.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
 
 module LSync
 	# A helper to provide easy access to the TeeLogger functionality.

data/lib/lsync/version.rb

@@ -1,23 +1,28 @@
-# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv2.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
 # 
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# 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:
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 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.
 
 module LSync
-  module VERSION #:nodoc:
+  module VERSION
     MAJOR = 2
-    MINOR = 1
-    TINY  = 0
+    MINOR = 3
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lsync
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 1
+  prerelease: 
   segments: 
   - 2
+  - 3
   - 1
-  - 0
-  version: 2.1.0
+  version: 2.3.1
 platform: ruby
 authors: 
 - Samuel Williams
@@ -14,53 +15,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-26 00:00:00 +12:00
-default_executable: 
+date: 2011-08-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fingerprint
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 1
-        - 1
+        - 2
         - 3
-        version: 1.1.3
+        version: 1.2.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rexec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
-        - 2
-        - 6
-        version: 1.2.6
+        - 4
+        - 0
+        version: 1.4.0
   type: :runtime
   version_requirements: *id002
 description: 
 email: samuel.williams@oriontransfer.co.nz
-executables: []
-
+executables: 
+- lsync-mount
+- lsync-prune
+- lsync-rotate
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- lib/lsync/action.rb
-- lib/lsync/actions/darwin/disk
-- lib/lsync/actions/darwin/terminal
-- lib/lsync/actions/generic/prune
-- lib/lsync/actions/generic/rotate
-- lib/lsync/actions/linux/disk
-- lib/lsync/actions/linux/terminal
+- bin/lsync-mount
+- bin/lsync-prune
+- bin/lsync-rotate
+- lib/lsync/client.rb
 - lib/lsync/controller.rb
 - lib/lsync/directory.rb
 - lib/lsync/error.rb
@@ -72,13 +75,11 @@ files:
 - 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
 - README.md
-has_rdoc: yard
 homepage: http://www.oriontransfer.co.nz/gems/lsync
 licenses: []
 
@@ -88,23 +89,27 @@ 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.6
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: LSync is a tool for scripted synchronization and backups.

data/lib/lsync/action.rb

@@ -1,105 +0,0 @@
-
-require 'pathname'
-require 'lsync/run'
-require 'lsync/error'
-
-module LSync
-
-	class AbortBackupException < StandardError
-	end
-	
-	# A runnable action, such as a shell command or action script.
-	#
-	# If the first argument is a symbol, then this will map to one of the standard
-	# actions in the `lsync/actions` subdirectory. These actions are sometimes implemented
-	# on a per-platform basis.
-	class Action
-		def initialize(function)
-			@function = function
-			
-			case @function[0]
-			when Symbol
-				@script_name = @function[0].to_s
-				@arguments = @function[1,@function.size]
-			else
-				@script_name = nil
-			end
-		end
-
-		# Return a string representation of the action for logging.
-		def to_s
-			@function.to_cmd
-		end
-
-		# Run the action on the given server, typically in the root directory specified.
-		def run_on_server(server, logger)
-			# logger.info "Running #{@function.to_cmd} on #{server}"
-
-			if server.is_local?
-				run_locally(server, logger)
-			else
-				run_remotely(server, logger)
-			end
-		end
-
-		private
-		# Run the script locally by invoking it directly.
-		def run_locally(server, logger)
-			command = nil
-
-			if @script_name
-				uname = `uname`.chomp.downcase
-
-				local_path = Action.script_path(uname, @script_name)
-				command = [local_path] + @arguments
-			else
-				command = @function
-			end
-
-			result = nil
-			Dir.chdir(server.root) do
-				result = LSync.run_command(command, logger)
-			end
-
-			if result != 0
-				raise ShellScriptError.new(command, result)
-			end
-		end
-
-		# Run the script remotely by sending the data across the network and executing it.
-		def run_remotely(server, logger)
-			conn = server.connect
-			conn.send_object([:set_working_dir, server.root])
-
-			if @script_name
-				uname = `uname`.chomp.downcase
-
-				local_path = Action.script_path(uname, @script_name)
-
-				logger.info("Sending run_script #{@script_name}...")
-				conn.send_object([:run_script, @script_name, Pathname.new(local_path).read, @arguments])
-			else
-				logger.info("Sending run_command #{@function}...")
-				conn.send_object([:run_command, @function])
-			end
-
-			conn.run do |message|
-				break if message == :done
-
-				logger.send(*message)
-			end
-		end
-
-		# Figure out the path of the script, which may depend on the given platform.
-		def self.script_path(platform, name)
-			exact_script_path(platform, name) || exact_script_path("generic", name)
-		end
-
-		# Return the exact path of a builtin action script.
-		def self.exact_script_path(platform, name)
-			path = (Pathname.new(__FILE__).dirname + "actions" + platform + name).expand_path
-			path.exist? ? path : nil
-		end
-	end
-
-end