synco 1.0.0

data/lib/synco/server.rb

@@ -0,0 +1,90 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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_relative 'controller'
+require_relative 'directory'
+require_relative 'shells/ssh'
+
+require 'shellwords'
+
+module Synco
+	class Server < Controller
+		def initialize(name, root: '/', shell: nil, **options)
+			super()
+			
+			@name = name
+			
+			case @name
+			when Symbol
+				@host = "localhost"
+			else
+				@host = name.to_s
+			end
+			
+			@root = root
+			@shell = shell || Shells::SSH.new
+			
+			@options = options
+		end
+		
+		# The name of the server in the configuration (might be the same as the host).
+		attr :name
+		
+		# The host name (e.g. DNS entry) for the given server.
+		attr_accessor :host
+		
+		# The root path on the server in which all other directories will be relative to.
+		attr_accessor :root
+		
+		# The shell to use to connect to the server.
+		attr_accessor :shell
+
+		attr_accessor :mountpoint
+
+		# Give the full path for a particular subdirectory.
+		def full_path(directory = "")
+			path = File.expand_path(directory.to_s, @root)
+			
+			Directory.normalize(path)
+		end
+
+		# Give a general connection string (e.g +"host:/directory"+ or +"/directory"+ if local).
+		def connection_string(directory, on: nil)
+			if self.host == on.host
+				return full_path(directory).to_s
+			else
+				return @host + ":" + Shellwords.escape(full_path(directory))
+			end
+		end
+		
+		def connection_command
+			@shell.connection_command(self)
+		end
+
+		def same_host?(other)
+			@host == other.host
+		end
+
+		# String representation of the server for logging.
+		def to_s
+			"#{@host}:#{full_path}"
+		end
+	end
+end

data/lib/synco/shell.rb

@@ -0,0 +1,44 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'pathname'
+
+module Synco
+	# A shell provides access to a server, typically to run commands.
+	class Shell
+		def initialize(*command, arguments: [], **options)
+			@command = command.empty? ? default_command : command
+			
+			@arguments = arguments
+			@options = options
+		end
+		
+		attr :arguments
+		
+		# The command required to connect to the remote machine.
+		def connection_command(server, *arguments)
+			[*@command, *@arguments, *arguments, server.host]
+		end
+		
+		def to_s
+			"<#{self.class} #{@command} #{@options.inspect}>"
+		end
+	end
+end

data/lib/synco/shells/ssh.rb

@@ -0,0 +1,52 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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_relative '../shell'
+
+module Synco
+	module Shells
+		# SSH shell provides access to a remote server using SSH.
+		class SSH < Shell
+			def default_command
+				['ssh']
+			end
+			
+			def initialize(*command, arguments: [], port: nil, key: nil, user: nil, batch_mode: nil, **options)
+				if port
+					arguments << '-p' << port
+				end
+				
+				if key
+					arguments << '-i' << value
+				end
+				
+				if user
+					arguments << '-l' << value
+				end
+				
+				unless batch_mode.nil?
+					arguments << '-o' << "BatchMode=#{batch_mode ? 'yes' : 'no'}"
+				end
+				
+				super
+			end
+		end
+	end
+end

data/lib/synco/version.rb

@@ -0,0 +1,23 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 Synco
+	VERSION = "1.0.0"
+end

data/spec/synco/backup_script.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env rspec
+
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'fingerprint'
+require 'process/group'
+require 'fileutils'
+require 'digest'
+
+require 'synco/scope'
+require 'synco/script'
+
+SYNCO_PATH = File.expand_path("../../bin/synco", __dir__)
+
+RSpec.shared_context "backup script" do
+	def create_files(master_path, target_path)
+		FileUtils.rm_rf master_path
+		FileUtils.rm_rf target_path
+		
+		FileUtils.mkdir_p master_path
+		FileUtils.mkdir_p target_path
+		
+		(1...10).each do |i|
+			path = File.join(master_path, i.to_s)
+
+			FileUtils.mkdir(path)
+
+			text = Digest::MD5.hexdigest(i.to_s)
+
+			File.open(File.join(path, i.to_s), "w") { |f| f.write(text) }
+		end
+	end
+	
+	let(:tmp_path) {File.join(__dir__, 'tmp')}
+	let(:master_path) {File.join(__dir__, 'tmp/master')}
+	let(:target_path) {File.join(__dir__, 'tmp/target')}
+	
+	before(:each) do
+		create_files(master_path, target_path)
+	end
+	
+	after(:each) do
+		# FileUtils.rm_rf tmp_path
+	end
+end

data/spec/synco/directory_spec.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env rspec
+
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'synco/directory'
+
+describe Synco::Directory.new(".", arguments: ['--foo']) do
+	it "should have arguments" do
+		expect(subject.arguments).to include('--foo')
+	end
+	
+	it "must be relative path" do
+		expect{Synco::Directory.new("/var")}.to raise_error(ArgumentError)
+	end
+end

data/spec/synco/local_backup.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'synco'
+require 'synco/shells/ssh'
+require 'synco/methods/rsync'
+
+# Check we've got two paths for sync.
+unless ARGV.size == 2
+	$stderr.puts "Usage: #{$0} [master] [copy]"
+	exit(255)
+end
+
+# $growl = Growl.new "localhost", "Synco", ["Backup Status"]
+# $growl.register
+
+$stdout.sync = true
+$stderr.sync = true
+
+Synco::run_script do |script|
+	self.method = Synco::Methods::RSyncSnapshot.new(:push, "--archive", "--compress", "--stats")
+	
+	self.master = :src
+	
+	server(:src) do |server|
+		server.root = ARGV[0]
+	end
+	
+	server(:dst) do |server|
+		server.root = ARGV[1]
+		
+		# Runs after all directories have been successfully backed up.
+		server.on(:success) do
+			target.run "synco", "rotate"
+			target.run "synco", "prune"
+		end
+	end
+	
+	# This event is fired before the backup starts
+	#script.on(:prepare) do
+	#	$growl.notify "Backup Status", "Starting Backup", "Starting at #{Time.now.to_s}"
+	#end
+	#
+	## This event occurs if the backup is successful
+	#script.on(:success) do
+	#	$growl.notify "Backup Status", "Backup Successful", script.log.string
+	#end
+	#
+	## This event occurs if any part of the backup fails and is not handled elsewhere.
+	#script.on(:failure) do |failure|
+	#	$growl.notify "Backup Status", "Backup Failure", failure.to_s
+	#	
+	#	raise failure
+	#end
+	
+	backup('./')
+end

data/spec/synco/local_sync.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+# You need to have the FSSM gem installed for this to work.
+require 'fssm'
+
+require 'synco'
+require 'synco/shells/ssh'
+require 'synco/methods/rsync'
+require 'synco/event_timer'
+
+MONITOR = ARGV.delete "-m"
+
+# Check we've got two paths for sync.
+unless ARGV.size == 2
+	$stderr.puts "Usage: #{$0} [master] [copy]"
+	exit(255)
+end
+
+script = Synco::Script.new do |script|
+	script.method = Synco::Methods::RSync.new(:push, :arguments => ["--archive", "--delete"])
+	
+	script.master = :src
+	
+	server(:src) do |server|
+		server.root = ARGV[0]
+	end
+	
+	server(:dst) do |server|
+		server.root = ARGV[1]
+		
+		#server.on(:prepare) do
+		#	logger.warn "Aborting backup!"
+		#	server.abort!
+		#end
+	end
+	
+	#server(:remote) do |server|
+	#	server.host = "ayako.oriontransfer.org"
+	#	server.shell = Synco::Shells::SSH.new(:user => "nobody")
+	#	server.root = "/tmp/sync-test"
+	#end
+	
+	#server(:remote2) do |server|
+	#	server.host = "remote2.example.com"
+	#	server.root = "/tmp/sync-test"
+	#	
+	#	server.on(:prepare) do |controller|
+	#		controller.run! "mysqldump", "..."
+	#	end
+	#	
+	#	server.on(:success) do |controller|
+	#		controller.run! "uname", "-a"
+	#	end
+	#end
+	
+	backup('./')
+end
+
+# Initial sync:
+
+context = Synco::Context.new(script)
+context.run!
+
+if MONITOR
+	# Monitor directories for changes:
+	monitor = FSSM::Monitor.new(:directories => true)
+
+	# The event timer aggregates events into a single callback which will be called at most
+	# once every k seconds (where k = 10 in this case).
+	$event_timer = Synco::EventTimer.new(10) do
+		$script.run!
+	end
+
+	$script.directories.each do |directory|
+		full_path = $script[:src].full_path(directory)
+		puts "Monitoring path: #{full_path}"
+	
+		monitor.path(full_path, "**/*") do
+			update { $event_timer.trigger! }
+			delete { $event_timer.trigger! }
+			create { $event_timer.trigger! }
+		end
+	end
+
+	begin
+		monitor.run
+	ensure
+		# We should wait for the backup to complete nicely.
+		$event_timer.join
+	end
+end