rsync_cron 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e873d38cb9348864b4a9ca645b6462f4491017e9
+  data.tar.gz: 296d2b7efe73ade8ddd131c5ea5082fe700ecaea
+SHA512:
+  metadata.gz: c379474c98d3291d6154ae3ff9be4c25e49be30e1c2fc141920caf6115177a38670f234ca215a2dbdaf64b1c3a47925ef41780e4547253cb9a555b528765f186
+  data.tar.gz: e0f51f2fb215b8a656cc8eec3e9fdba9f967e0f56780b17feb07a712c05c512feeaa710dac684ef1dceb41a0c91a865d1f7140b981f0bffedbd569822693abde

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.1
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rsync_cron.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    rsync_cron (1.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rsync_cron!
+
+BUNDLED WITH
+   1.15.4

data/README.md

@@ -0,0 +1,43 @@
+## Table of Contents
+
+* [Scope](#scope)
+* [Installation](#installation)
+* [Usage](#usage)
+
+# Scope
+The scope of this gem is to wrap the `rsync` command and to trigger it via the `crontab` schedule.
+
+# Installation
+Install the gem from your shell:
+```shell
+gem install rsync_cron
+```
+
+# Usage
+The gem comes with a CLI interface. You can print its help by:
+```shell
+rsync_cron -h
+Usage: rsync_cron --cron=15,30 21 * * * --src=/ --dest=/tmp --log=/var/log/rsync.log
+    -c, --cron=CRON                  The cron string, i.e.: 15 21 * * *
+    -s, --src=SRC                    The rsync source, i.e. user@src.com:files
+    -d, --dest=DEST                  The rsync dest, i.e. user@dest.com:home/
+    -l, --log=LOG                    log command output to specified file
+    -p, --print                      Print crontab command without installing it
+    -k, --check                      Check src and dest before installing crontab
+    -h, --help                       Prints this help
+```
+
+## Default schedule
+The `crontab` is scheduled one per day by default (at midnight).  
+You can specify a different schedule directly on the command line:
+```shell
+# run every sunday
+rsync_cron --cron=* * * * 0 --src=user@src.com:files --dest=~/tmp
+```
+
+## Log to a file
+It is possible to log the `rsync` output to a file:
+```shell
+rsync_cron --src=user@src.com:files --dest=~/tmp --log=./rsync.log
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rsync_cron"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rsync_cron

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "rsync_cron"
+
+RsyncCron::CLI.new(ARGV.clone).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rsync_cron/cli.rb

@@ -0,0 +1,67 @@
+require "optparse"
+require "rsync_cron/host"
+require "rsync_cron/command"
+require "rsync_cron/scheduler"
+require "rsync_cron/cron"
+
+module RsyncCron
+  class CLI
+    SHELL = `which crontab`.strip
+
+    def initialize(args, io = STDOUT, shell = SHELL)
+      @args = args
+      @io = io
+      @cron = Cron.factory("* 0 * * *")
+      @shell = shell
+    end
+
+    def call
+      parser.parse!(@args)
+      return @io.puts "specify valid src" unless @src
+      return @io.puts "specify valid dest" unless @dest
+      command = Command.new(src: @src, dest: @dest, log: @log, io: @io)
+      return unless command.valid? if @check
+      crontab = "#{@cron} #{command}"
+      return @io.puts crontab unless @shell
+      Scheduler.new(crontab, @shell).call.tap do |res|
+        @io.puts "new crontab installed" if res
+      end
+    end
+
+    private def parser
+      OptionParser.new do |opts|
+        opts.banner = "Usage: rsync_cron --cron=15,30 21 * * * --src=/ --dest=/tmp --log=/var/log/rsync.log"
+
+        opts.on("-cCRON", "--cron=CRON", "The cron string, i.e.: 15 21 * * *") do |cron|
+          @cron = Cron.factory(cron)
+        end
+
+        opts.on("-sSRC", "--src=SRC", "The rsync source, i.e. user@src.com:files") do |src|
+          @src = Host.factory(src)
+        end
+
+        opts.on("-dDEST", "--dest=DEST", "The rsync dest, i.e. user@dest.com:home/") do |dest|
+          @dest = Host.factory(dest)
+        end
+
+        opts.on("-lLOG", "--log=LOG", "log command output to specified file") do |log|
+          @log = log
+        end
+
+        opts.on("-p", "--print", "Print crontab command without installing it") do
+          @shell = nil
+        end
+
+        opts.on("-k", "--check", "Check src and dest before installing crontab") do
+          @check = true
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          @io.puts opts
+          exit
+        end
+      end
+    end
+  end
+end
+

data/lib/rsync_cron/command.rb

@@ -0,0 +1,34 @@
+require "rsync_cron/options"
+
+module RsyncCron
+  class Command
+    NAME = `which rsync`.strip
+
+    def initialize(src:, dest:, options: Options.new, name: NAME, log: nil, io: STDOUT)
+      @src = src
+      @dest = dest
+      @options = options
+      @name = name
+      @log = log
+      @io = io
+    end
+
+    def to_s
+      return "echo 'rsync not installed'" if @name.empty?
+      "#{@name} #{@options} #{@src} #{@dest}#{log}"
+    end
+
+    def valid?
+      [@src, @dest].all? do |host|
+        host.exist?.tap do |check|
+          @io.puts "#{host} does not exist" unless check
+        end
+      end
+    end
+
+    private def log
+      return unless @log
+      " >> #{File.expand_path(@log)} 2>&1"
+    end
+  end
+end

data/lib/rsync_cron/cron.rb

@@ -0,0 +1,51 @@
+module RsyncCron
+  class Cron
+    ANY = "*"
+
+    def self.factory(s)
+      mins, hour, day, month, week = s.split(" ")
+      mins = mins.split(",")
+      new(mins: mins, hour: hour, day: day, month: month, week: week)
+    end
+
+    def initialize(mins: nil, hour: nil, day: nil, month: nil, week: nil)
+      @mins = mins.to_a
+      @hour = hour
+      @day = day
+      @month = month
+      @week = week
+    end
+
+    def to_s
+      "#{mins} #{hour} #{day} #{month} #{week}"
+    end
+
+    private def mins
+      return ANY if @mins.empty?
+      return ANY unless @mins.all? { |min| (0..59) === min.to_i }
+      @mins.join(",")
+    end
+
+    private def hour
+      return ANY if @hour == ANY || @hour.nil?
+      return ANY unless (0..23) === @hour.to_i
+      @hour
+    end
+
+    private def day
+      return ANY unless (1..31) === @day.to_i
+      @day
+    end
+
+    private def month
+      return ANY unless (1..12) === @month.to_i
+      @month
+    end
+
+    private def week
+      return ANY if @week == ANY || @week.nil?
+      return ANY unless (0..7) === @week.to_i
+      @week
+    end
+  end
+end

data/lib/rsync_cron/host.rb

@@ -0,0 +1,38 @@
+module RsyncCron
+  class Host
+    def self.factory(s)
+      return new(path: s) unless s.index(":")
+      remote, path = s.split(":")
+      new(path: path, remote: remote)
+    end
+
+    def initialize(path:, remote: nil)
+      @path = path
+      @remote = remote
+    end
+
+    def to_s
+      [remote, path].compact.join(":")
+    end
+
+    def exist?
+      return FileTest.exist?(path) unless remote?
+      %x[ssh #{remote} "test -e #{path}"]
+      $?.exitstatus.zero?
+    end
+
+    private def path
+      return @path if remote?
+      File.expand_path(@path)
+    end
+
+    private def remote
+      return unless remote?
+      @remote
+    end
+
+    private def remote?
+      @remote
+    end
+  end
+end

data/lib/rsync_cron/options.rb

@@ -0,0 +1,38 @@
+module RsyncCron
+  class Options
+    BANDWITH_LIMIT = 5*1024
+    DEFAULT = { 
+      rsh: "ssh",
+      bwlimit: BANDWITH_LIMIT,
+      exclude: "'DfsrPrivate'"
+    }
+    FLAGS = %w[v r t z p L]
+
+    def initialize(data: DEFAULT, flags: FLAGS)
+      @data = data.to_h
+      @flags = flags.to_a
+    end
+
+    def to_s
+      [flags, data].compact.join(" ")
+    end
+
+    def merge(opt)
+      @data = @data.merge(opt)
+      self
+    end
+
+    private def flags
+      return if @flags.empty?
+      "-#{@flags.join}"
+    end
+
+    private def data
+      return if @data.empty?
+      @data.reduce([]) do |acc, (opt, val)|
+        acc << "--#{opt}=#{val}"
+      end.join(" ")
+    end
+  end
+end
+

data/lib/rsync_cron/scheduler.rb

@@ -0,0 +1,17 @@
+module RsyncCron
+  class Scheduler
+    def initialize(content, shell)
+      @content = content
+      @shell = shell
+    end
+
+    def call
+      return if @shell.empty?
+      IO.popen(@shell, "r+") do |pipe|
+        pipe.puts(@content)
+        pipe.close_write
+      end
+      $?.exitstatus.zero?
+    end
+  end
+end

data/lib/rsync_cron/version.rb

@@ -0,0 +1,3 @@
+module RsyncCron
+  VERSION = "1.0.5"
+end

data/lib/rsync_cron.rb

@@ -0,0 +1,2 @@
+require "rsync_cron/version"
+require "rsync_cron/cli"

data/rsync_cron.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rsync_cron/version"
+
+Gem::Specification.new do |s|
+  s.name = "rsync_cron"
+  s.version = RsyncCron::VERSION
+  s.authors = ["costajob"]
+  s.email = ["costajob@gmail.com"]
+  s.summary = "Simple wrapper around rsync, enabled by crontab"
+  s.homepage = "https://github.com/costajob/rsync_cron"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 2.1.8"
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir = "bin"
+  s.executables << "rsync_cron"
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.15"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rsync_cron
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- costajob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- costajob@gmail.com
+executables:
+- rsync_cron
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rsync_cron
+- bin/setup
+- lib/rsync_cron.rb
+- lib/rsync_cron/cli.rb
+- lib/rsync_cron/command.rb
+- lib/rsync_cron/cron.rb
+- lib/rsync_cron/host.rb
+- lib/rsync_cron/options.rb
+- lib/rsync_cron/scheduler.rb
+- lib/rsync_cron/version.rb
+- rsync_cron.gemspec
+homepage: https://github.com/costajob/rsync_cron
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Simple wrapper around rsync, enabled by crontab
+test_files: []