ruby-livesync 1.0.0.beta1 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7413a1c3e43254fbaa87386c88f0a550ec6e9f7a17331e74daa182c3aee7ee67
-  data.tar.gz: 34320b16a5886835146b9eb89a408e3481b9afdd62eafbd450ec2b83767aa8a9
+  metadata.gz: 5b752ff64938cd1e8c5abd600ce03aebc501b0a45088aea45d73f14f3cf1bd8f
+  data.tar.gz: a68ed7c8374b0e380d8dc183c222d42c904edbecaf4b198fc82a89e960e3419d
 SHA512:
-  metadata.gz: 604aec4e0bfa4cf29cfbfec5837672d36289e98af3a537cf6dc4ad11706110a2265f079ace49820926eaf5358160caae85b6042ae15b855fa3af4fd4cd0ef012
-  data.tar.gz: fc87708fba1a5db5c1a88eb81bca51268a80bcf2d30bfe9ddf80d7df9656ba3c2c28de7558e8abe375809a8432ec819de5afbe88e6a7295a19a3b0d7b1067696
+  metadata.gz: 9e1e8e35696105846bde4cd4592f70bce67007e0cd570299993587a276845b4366cc71d91608637ae8745ded4c2b61ac247825190b9dbba87ff4d90e11ada15d
+  data.tar.gz: 930d1b2b01093cb90e06ed60316822b0c36d2e17f20089b0d0c30b54faeb358a65d77973c0ccfe30bc1d39960e28fb2d4e400cfd4844128952a5c5ada4ac3ff6

data/config/sample.rb

@@ -0,0 +1,25 @@
+# name of the sync
+# if it is an existing path then `source` is set this value
+sync '4tb' do
+  enabled = false
+
+  # fork to user below, usually associated with private keys 
+  user = :root
+
+  delay = 5
+
+  source = '/mnt/4tb/'
+  target = 'root@bhavapower:/mnt/extensor/4tb'
+
+  rsync.opts = '-ax --partial' # default
+
+  # possible values are: true, false, :initial, :watched
+  delete = true
+
+  excludes = [
+    '.snapshots',
+  ]
+
+  log.info 'starting'
+end
+

data/lib/ruby-livesync/live_sync/daemon.rb

@@ -14,7 +14,7 @@ module LiveSync
     end
 
     def start
-      Process.setpgrp
+      Process.setpgrp rescue nil # not allowed in systemd
       Process.setproctitle 'livesync'
       instance_eval File.read(config), config
       run
@@ -33,11 +33,10 @@ module LiveSync
       @syncs.each do |user, syncs|
         User.wrap user do
           syncs.each do |s|
-            s.run
-            s.guard
+            s.guard if s.start
           rescue => e
             msg  = e.message
-            msg += "\n#{e.backtrace.join "\n"}" if Log.debug
+            msg += "\n#{e.backtrace.join "\n"}" if Log.debug?
             Log.fatal msg
           end
           Process.waitall

data/lib/ruby-livesync/live_sync/dsl.rb

@@ -10,13 +10,16 @@ module LiveSync
       class_attribute :attrs
       self.attrs = []
 
-      def self.dsl attr, default: nil, type: nil, &block
+      def self.dsl attr, default: nil, enum: nil, type: nil, &block
         self.attrs << attr
-        define_method attr do |value=nil|
-          return instance_variable_get("@#{attr}") || default unless value
-          raise "#{ctx}: incorrect type for `#{attr}`" if type and !value.is_a? type
-          instance_exec value, &block if block
-          instance_variable_set "@#{attr}", value
+        define_method attr do |sv=nil|
+          (v = instance_variable_get("@#{attr}"); return(if v.nil? then default else v end)) if sv.nil?
+
+          raise "#{ctx}/#{attr}: incorrect type" if type and !sv.is_a? type
+          raise "#{ctx}/#{attr}: value not one of following #{enum}" if enum and !sv.in? enum
+
+          instance_variable_set "@#{attr}", sv
+          instance_exec sv, &block if block
         end
       end
 

data/lib/ruby-livesync/live_sync/log.rb

@@ -1,41 +1,53 @@
 module LiveSync
   class Log
 
-    class_attribute :ctx
     class_attribute :global
     self.global = self.new
     class << self
       delegate_missing_to :global
     end
 
-    class_attribute :debug
-    self.debug = !!ENV['DEBUG']
+    class_attribute :ctx
+
+    LEVELS = {
+       debug:   0,
+       verbose: 1,
+       info:    2,
+       warning: 3,
+       error:   4,
+       fatal:   5,
+     }
+    class_attribute :level
+    self.level = if !!ENV['DEBUG'] then :debug else ENV['LEVEL']&.to_sym || :info end
+    def self.debug?; level == :debug; end
 
     def initialize ctx=nil
       self.ctx = ctx
     end
 
-    def debug msg
-      return unless debug
-      puts "DEBUG: #{parse msg}"
+    def log? level
+      LEVELS[level] >= LEVELS[self.level]
     end
 
+    def debug msg
+      puts "DEBUG: #{parse msg}" if log? :debug
+    end
     def info msg
-      puts "INFO: #{parse msg}"
+      puts "INFO: #{parse msg}" if log? :info
     end
 
     def warning msg
-      STDERR.puts "WARNING: #{parse msg}"
+      STDERR.puts "WARNING: #{parse msg}" if log? :warning
     end
-
     def error msg
-      STDERR.puts "ERROR: #{parse msg}"
+      STDERR.puts "ERROR: #{parse msg}" if log? :error
     end
-
     def fatal msg
-      STDERR.puts "FATAL: #{parse msg}"
+      STDERR.puts "FATAL: #{parse msg}" if log? :fatal
     end
 
+    protected
+
     def parse msg
       msg = "#{ctx}: #{msg}" if ctx
       msg

data/lib/ruby-livesync/live_sync/rsync.rb

@@ -1,7 +1,8 @@
 module LiveSync
   class Rsync
 
-    attr_reader :sync, :opts
+    attr_reader :sync
+    attr_accessor :opts
 
     def initialize sync
       @sync = sync
@@ -13,11 +14,15 @@ module LiveSync
     end
 
     def initial
-      run :initial
+      args  = []
+      args << '--delete' if sync.delete.in? [true, :initial]
+      run :initial, *args, loglevel: :info
     end
 
-    def from_list paths
-      run :partial, '--files-from=-' do |stdin, stdout, stderr|
+    def partial paths
+      args  = ['--files-from=-']
+      args << '--delete-missing-args' if sync.delete.in? [true, :watched]
+      run :partial, *args do |stdin, stdout, stderr|
         stdin.write paths.join "\n"
         stdin.close
       end
@@ -25,15 +30,17 @@ module LiveSync
 
     protected
 
-    def run type, args=nil
-      cmd = "rsync -e '#{rsh}' #{opts} #{sync.source} #{sync.target} #{args}"
-      sync.log.info "#{type}: starting with cmd: #{cmd}"
+    def run type, *args, loglevel: :debug
+      cmd = "rsync -e '#{rsh}' #{opts} #{sync.source} #{sync.target} #{args.join ' '}"
+      sync.excludes.each{ |e| cmd << " --exclude='#{e}'" }
+
+      sync.log.send loglevel, "#{type}: starting with cmd: #{cmd}"
       stdin, stdout, stderr, @wait_thr = Open3.popen3 cmd
       yield stdin, stdout, stderr if block_given?
       Thread.new do
         Process.wait @wait_thr.pid rescue Errno::ECHILD; nil
         @wait_thr = nil
-        sync.log.info "#{type}: finished"
+        sync.log.send loglevel, "#{type}: finished"
       end
     end
 

data/lib/ruby-livesync/live_sync/ssh.rb

@@ -30,7 +30,6 @@ module LiveSync
           Log.error "ssh/#{userhost}: #{stderr.read}"
         end
       end
-      sleep 1 while !available?
     end
 
     def available?

data/lib/ruby-livesync/live_sync/sync.rb

@@ -14,6 +14,7 @@ module LiveSync
       fill_name name
       source name if File.exist? name
       @to_sync = Set.new
+      @rsync   = Rsync.new self
     end
 
     def fill_name name
@@ -22,9 +23,11 @@ module LiveSync
       @log = Log.new ctx
     end
 
+    dsl :enabled, default: true
+
     dsl :user, default: :root
     dsl :source do |source|
-      raise "#{ctx}: source not found" unless File.exist? source
+      raise "#{ctx}: source isn't a directory" unless File.directory? source
       fill_name source
       @pathname = Pathname.new source
     end
@@ -32,24 +35,30 @@ module LiveSync
     dsl :target do |target|
       @userhost, @target_path = target.split(':')
       raise "#{ctx}: missing target path" unless @target_path
-      @user, @host = if @userhost.index '@' then @userhost.split('@') else [@user, @userhost] end
+      source File.join(@source, '') if File.basename(@source) == File.basename(@target_path)
     end
 
     dsl :delay, default: 5, type: Integer
 
-    def run
+    dsl :delete, default: false, enum: [true,false] + %i[initial watched]
+
+    dsl :excludes, default: []
+
+    def start
+      return log.warning('skipping disabled sync') && false unless enabled
       raise "#{ctx}: missing target" unless @target
-      @ssh   = Ssh.connect @userhost
-      @rsync = Rsync.new self
+      @ssh = Ssh.connect @userhost
+      sleep 1 and log.warning 'waiting for ssh' while !@ssh.available?
+      true
     end
 
     def guard
       fork do
         Process.setproctitle "livesync: sync #{ctx}"
-        @watcher   = Watcher.new
+        @watcher   = Watcher.new self
         @scheduler = Rufus::Scheduler.new
 
-        @watcher.dir_rwatch source, *%i[create modify], &method(:track)
+        watch source
         @rsync.initial
         schedule
         sleep 1.day while true
@@ -57,7 +66,13 @@ module LiveSync
     end
 
     def track event
-      @to_sync << Pathname.new(event.absolute_name).relative_path_from(@pathname).to_s
+      path = event.absolute_name
+      watch path if File.directory?(path) and :create.in? event.flags
+      @to_sync << Pathname.new(path).relative_path_from(@pathname).to_s
+    end
+
+    def watch dir
+      @watcher.dir_rwatch dir, &method(:track)
     end
 
     def schedule
@@ -68,7 +83,7 @@ module LiveSync
       return if @rsync.running?
       @watcher.process # calls #track
       return if @to_sync.blank?
-      @rsync.from_list @to_sync
+      @rsync.partial @to_sync
       @to_sync.clear
     ensure
       schedule

data/lib/ruby-livesync/live_sync/version.rb

@@ -1,5 +1,5 @@
 module LiveSync
 
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.0.0.beta3'
 
 end

data/lib/ruby-livesync/live_sync/watcher.rb

@@ -4,13 +4,16 @@ module LiveSync
     attr_reader :notifier
     delegate_missing_to :notifier
 
-    def initialize
+    attr_reader :sync
+
+    def initialize sync=nil
+      @sync     = sync
       @notifier = INotify::Notifier.new
     end
 
     def watch path, *modes
-      Log.info "#{path}: watching for #{modes.join ','}"
-      modes = %i[all_events] if modes.blank?
+      Log.debug "#{path}: watching for #{modes.join ','}"
+      modes  = %i[all_events] if modes.blank?
 
       notifier.watch path, *modes do |event|
         yield event
@@ -20,15 +23,26 @@ module LiveSync
 
     def dir_rwatch path, *modes
       raise "#{path}: not a directory" unless File.directory? path
-      modes = %i[create modify] if modes.blank?
+      modes  = %i[create modify] if modes.blank?
+      modes << :delete if sync&.delete&.in? [true, :watched]
+
+      excs  = sync&.excludes.map{ |e| Regexp.new e } || []
+      tgts  = [path] + Dir.glob("#{path}/{.**,**}/")
+      rtgts = tgts.map{ |t| Pathname.new(t).relative_path_from(path).to_s }
+      excs.each do |e|
+        next unless mt = rtgts.find{ |rt| e.match rt }
+        Log.debug "watcher: skipping #{path}/#{mt} with subdirs"
+        rtgts.delete mt
+        rtgts.delete_if{ |rt| rt.start_with? mt } if File.directory? "#{path}/#{mt}"
+      end
 
-      tgts = [path] + Dir.glob("#{path}/**/*/")
-      tgts.each do |t|
+      rtgts.each do |rt|
+        t = "#{path}/#{rt}"
         notifier.watch t, *modes do |event|
           yield event
         end
       rescue => e
-        Log.warning "#{t}: skipping due to #{e.class}: #{e.message}"
+        Log.warning "watcher: #{t}: skipping due to #{e.class}: #{e.message}"
       end
       self
     end

data/livesync.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=Livesync Daemon
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=Simple
+ExecStart=/usr/bin/livesync /etc/livesync/config.rb
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-livesync
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Braulio Oliveira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/livesync
+- config/sample.rb
 - lib/ruby-livesync.rb
 - lib/ruby-livesync/live_sync.rb
 - lib/ruby-livesync/live_sync/daemon.rb
@@ -86,6 +87,7 @@ files:
 - lib/ruby-livesync/live_sync/user.rb
 - lib/ruby-livesync/live_sync/version.rb
 - lib/ruby-livesync/live_sync/watcher.rb
+- livesync.service
 homepage: https://github.com/brauliobo/ruby-livesync
 licenses:
 - GPLv3