easy_sync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cea7195f628ae1bb09b15c6fc14d8a97217d20f8
+  data.tar.gz: 6bdd4d0fb5a0ad7149196b817aadcc5d367d2a7d
+SHA512:
+  metadata.gz: 9977a20cc1c688e8e5d1767c4b8533643da3b071f990d59ba6b037bb95f76d3f70844b741ad28aea86316fef7899ac3441390eed7377a7173be95384135143f2
+  data.tar.gz: 22bac584e4ba65fad6d642aaf758b401864b6d615697af1b28b25c00bde5705bea7ef8c2ad7d6ec99723e39b6bfdfe2cde36be9d0d2744b839f44e0564636b45

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    easy_sync (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.1.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.4.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-minitest (2.2.0)
+      guard (~> 2.0)
+      minitest (>= 3.0)
+    listen (2.5.0)
+      celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    minitest (5.2.3)
+    nio4r (1.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    slop (3.4.7)
+    terminal-notifier-guard (1.5.3)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  easy_sync!
+  guard-minitest
+  rake
+  terminal-notifier-guard

data/Guardfile

@@ -0,0 +1,28 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  # with Minitest::Unit
+  #watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  #watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  #watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+   watch(%r{^spec/(.*)_spec\.rb$})
+   #watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+   watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Carlos Espejo
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,35 @@
+easy_sync
+=========
+
+### Why?
+* Did you just get a shiny new 1TB 2.5 inch external hard drive and suddenly have the urge to back :poop: up?
+* Did you just hear about [CryptoLocker](http://en.wikipedia.org/wiki/CryptoLocker) and thought crap how can i protect my friends and family?
+
+**Note:** Once you get [CryptoLocker](http://en.wikipedia.org/wiki/CryptoLocker) it will encrypt the crap out
+of any drive letter it can find including mapped network shares :cry:
+
+Now if you use **Ruby** plus **Rsync** you can easily have many cold snapshots to restore from :thumbsup:
+
+
+### Installation
+    gem install easy_sync
+
+
+### Requirements
+* rsync 2.5.6 and up
+
+
+### Usage
+Just run easy_sync to generate a template mapping file, configure
+your paths and next time you run **easy_sync** it will create the first
+backup. After first backup it will create incremental backups.
+
+
+### Todo
+* ~~Given a source and destination a snapshot should be created.~~
+* ~~It should use the latest backup for Rsync's --link-dest option and create a new snapshot with the files that changed.~~
+* ~~Add logging~~
+* If source or destination doesn't exists don't run rsync
+* ~~excluded list~~
+* ~~Support multiple source and destination configurations by using a yaml config file.~~
+* ~~Convert to a gem and create a easy_sync bin file~~

data/Rakefile

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

data/bin/easy_sync

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'easy_sync'
+EasySync::SyncRunner.new.run

data/easy_sync.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_sync"
+  spec.version       = EasySync::VERSION
+  spec.authors       = ["Carlos Espejo"]
+  spec.email         = ["carlosespejo@gmail.com"]
+  spec.summary       = %q{Ruby wrapper around rsync to easily create incremental backups.}
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/CarlosEspejo/easy_sync"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "terminal-notifier-guard"
+
+end

data/lib/easy_sync/rsync.rb

@@ -0,0 +1,46 @@
+require 'logger'
+
+module EasySync
+
+  class Rsync
+    attr_reader :sync_name, :source, :destination, :exclude_file, :last_snapshot, :current, :logging
+
+    def initialize(options)
+      @sync_name = options[:sync_name]
+      @source = options[:source]
+      @destination = options[:destination]
+      @exclude_file = options[:exclude_file]
+      @logging = options.fetch(:logging){:off}
+    end
+
+    def latest_snapshot
+      @last_snapshot = Dir["#{destination}/*"].max_by{|s| File.mtime s}
+    end
+
+    def current_snapshot
+      @current = File.join destination, Time.now.strftime("%Y-%m-%d")
+    end
+
+    def sync
+      commands = [
+                  "rsync",
+                  "-avhiPH",
+                  "--exclude-from", "#{exclude_file}",
+                  "--link-dest", "#{latest_snapshot}"
+                  ]
+
+      commands << ['--log-file', "#{ENV['HOME']}/easy_sync.log" ] if logging == :on
+      commands << ["#{source}", "#{current_snapshot}"]
+      commands = commands.flatten
+
+      name = "\n\n\n------------------ Running #{sync_name} ------------------\n\n\n"
+      puts name
+
+      IO.popen(commands).each_line do |l|
+        puts l
+      end
+    end
+
+  end
+
+end

data/lib/easy_sync/sync_logger.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+
+module EasySync
+
+  class SyncLogger
+    attr_reader :log
+
+    def initialize(path)
+      @log = Logger.new(path)
+    end
+
+    def info(message)
+      puts message
+      log.info message
+    end
+
+  end
+
+end

data/lib/easy_sync/sync_runner.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+module EasySync
+
+  class SyncRunner
+    attr_reader :config
+
+    def initialize()
+      handle_config
+    end
+
+    def run
+      config[:tasks].each do |c|
+        c[:logging] = config[:logging]
+        Rsync.new(c).sync
+      end
+    end
+
+    private
+
+    def handle_config
+      path = "#{ENV["HOME"]}/.easy_syncrc.yml"
+      generate_yaml(path) unless File.exist? path
+      @config = YAML.load_file path
+    end
+
+    def generate_yaml(path)
+      File.open(path, 'w') do |f|
+        h = {:logging => :on,
+             :tasks => [{
+                            sync_name: "sample_sync",
+                            source: "[/example/path]",
+                            destination: "[/example/path]",
+                            exclude_file: "[/example/path]"
+                          }]}
+        f.puts h.to_yaml
+      end
+
+      $stderr.puts "Generated sample config file: #{path}\n\n"
+    end
+
+  end
+
+end

data/lib/easy_sync/version.rb

@@ -0,0 +1,3 @@
+module EasySync
+  VERSION = '0.0.1'
+end

data/lib/easy_sync.rb

@@ -0,0 +1,4 @@
+require_relative 'easy_sync/version'
+require_relative 'easy_sync/sync_runner'
+require_relative 'easy_sync/rsync'
+require_relative 'easy_sync/sync_logger'

data/spec/easy_sync/rsync_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Rsync do
+
+  let(:task){config_file_data[:tasks].first}
+
+  it "should find the latest snapshot directory" do
+    Rsync.new(task) \
+          .latest_snapshot.must_equal File.join(destination_directory, "2013-12-30")
+  end
+
+  it "should create the new snapshot directory" do
+    Rsync.new(task) \
+          .current_snapshot.must_equal File.join(destination_directory, Time.now.strftime("%Y-%m-%d"))
+  end
+
+  it "should log to a file" do
+    log_file = "#{temp_directory}/easy_sync.log"
+    task[:logging] = :on
+
+    Rsync.new(task).sync
+    File.exist?(log_file).must_equal true
+  end
+
+end

data/spec/easy_sync/sync_runner_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe SyncRunner do
+
+  it "should create template config if no config file passed" do
+    SyncRunner.new
+    config = YAML.load_file default_config_path
+    config.must_equal blank_config
+  end
+
+  it "should use default config file" do
+    File.open(default_config_path, "w"){|f| f.puts config_file_data.merge({logging: :off}).to_yaml}
+    SyncRunner.new.config[:logging].must_equal :off
+  end
+
+  it "should sync files between source and destination" do
+    create_config_file
+    SyncRunner.new.run
+    Dir["#{File.join(destination_directory, Time.now.strftime("%Y-%m-%d"))}/*"].map{|f| File.basename f}.must_equal ["file1.txt", "file2.txt", "file3.txt", "file4.txt"]
+  end
+
+  it "should create hard links to the files that didn't change in the new snapshot directory" do
+    create_config_file
+    SyncRunner.new.run
+
+    snapshot_file = Dir["#{File.join(destination_directory, "2013-12-30")}/*"].first
+    new_file = Dir["#{File.join(destination_directory, Time.now.strftime("%Y-%m-%d"))}/*"].first
+
+    File.stat(snapshot_file).ino.must_equal File.stat(new_file).ino
+  end
+
+  it "should use exclude-from option" do
+    exclude_file = "#{destination_directory}/exclude.txt"
+    File.open(exclude_file, "w"){|f| f.puts "file4.txt"}
+
+    config_file_data[:tasks].first[:exclude_file] = exclude_file
+    File.open(default_config_path, 'w'){|f| f.puts config_file_data.to_yaml}
+
+    SyncRunner.new.run
+
+    Dir["#{File.join(destination_directory, Time.now.strftime("%Y-%m-%d"))}/*"].map{|f| File.basename f}.must_equal ["file1.txt", "file2.txt", "file3.txt"]
+  end
+
+  it "should apply log setting to all task" do
+    log_file = "#{temp_directory}/easy_sync.log"
+    create_config_file
+    s = SyncRunner.new
+    s.config[:logging] = :on
+    s.run
+
+    File.exist?(log_file).must_equal true
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require "minitest/autorun"
+require "minitest/pride"
+require 'pry'
+
+require 'easy_sync'
+require_relative 'support'
+
+include EasySync
+
+class MiniTest::Spec
+
+  before do
+    create_root_directory
+    create_source_directory
+    create_destination_directory
+    create_snapshot_directories
+    create_source_files
+    copy_to_latest
+
+    # Silences output, comment out to debug test cases
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+    ENV['HOME'] = temp_directory
+  end
+
+
+  after do
+    FileUtils.rm_r temp_directory
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+
+end

data/spec/support.rb

@@ -0,0 +1,89 @@
+require 'fileutils'
+require 'tmpdir'
+require 'time'
+
+
+def create_root_directory
+  @temp_directory = Dir.mktmpdir('test_data', File.expand_path('./', File.dirname(__FILE__)))
+end
+
+def temp_directory
+  @temp_directory
+end
+
+def create_source_directory
+  @source_directory = File.join(temp_directory, 'source')
+  Dir.mkdir @source_directory
+end
+
+def create_destination_directory
+  @destination_directory = File.join(temp_directory, 'backup')
+  Dir.mkdir @destination_directory
+end
+
+def source_directory
+  "#{@source_directory}/"
+end
+
+def destination_directory
+  @destination_directory
+end
+
+def create_snapshot_directories
+  %w{2013-12-30 2013-11-10 2013-10-10 2013-11-07}.each do |date|
+    path = File.join destination_directory, date
+
+    Dir.mkdir path
+    time = Time.parse date
+
+    File.utime(time, time, path)
+
+  end
+end
+
+def create_source_files
+  %w{file1.txt file2.txt file3.txt file4.txt}.each do |file|
+    File.open(File.join(source_directory, file), 'w'){|f| f.puts "This is some sample text"}
+  end
+
+end
+
+def copy_to_latest
+  %w{file1.txt file2.txt file3.txt}.each do |file|
+    FileUtils.cp File.join(source_directory, file), File.join(destination_directory, "2013-12-30")
+  end
+end
+
+def blank_config
+  @blank_config ||= {
+                          logging: :on,
+                          tasks: [{
+                              sync_name: "sample_sync",
+                              source: "[/example/path]",
+                              destination: "[/example/path]",
+                              exclude_file: "[/example/path]"
+                            }]
+                          }
+end
+
+def config_file_data
+  @config_file_data ||= {
+                          logging: :off,
+                          tasks: [
+                            {
+                              sync_name: "test_sync",
+                              source: "#{source_directory}",
+                              destination: "#{destination_directory}",
+                              exclude_file: ""
+                            }]
+                        }
+end
+
+def create_config_file
+  File.open(default_config_path, 'w'){|f| f.puts config_file_data.to_yaml}
+  default_config_path
+end
+
+def default_config_path
+  "#{temp_directory}/.easy_syncrc.yml"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: easy_sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carlos Espejo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- carlosespejo@gmail.com
+executables:
+- easy_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/easy_sync
+- easy_sync.gemspec
+- lib/easy_sync.rb
+- lib/easy_sync/cli.rb
+- lib/easy_sync/rsync.rb
+- lib/easy_sync/sync_logger.rb
+- lib/easy_sync/sync_runner.rb
+- lib/easy_sync/version.rb
+- spec/easy_sync/rsync_spec.rb
+- spec/easy_sync/sync_runner_spec.rb
+- spec/spec_helper.rb
+- spec/support.rb
+homepage: https://github.com/CarlosEspejo/easy_sync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around rsync to easily create incremental backups.
+test_files:
+- spec/easy_sync/rsync_spec.rb
+- spec/easy_sync/sync_runner_spec.rb
+- spec/spec_helper.rb
+- spec/support.rb