simple_sync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 103aad0ffc5a90c307ccc0f9ed7c78a167978a72
+  data.tar.gz: 33655b87ce9d39722b5a4cc9a295b1d99d784587
+SHA512:
+  metadata.gz: 3e0c8dcf91ff8d3e882aec76b402627d3230509e9170d1fe52c68eaafb1583564502c68bd9dacc9bc6baafbc430b3422c5ffa7caa7854fd0529e7068dc990013
+  data.tar.gz: 41c3dfb3b0b547cdac28190df1a5ef9eb1362e1475f83ca9820332327224717f45f78faaa5b72dfceee7d8cabb65ff76b7b4731b5fe7fafb956d2145ac2cf31d

data/.autotest

@@ -0,0 +1,8 @@
+require 'autotest/fsevent'
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |autotest|
+  %w{test/test_destination}.each { |exception|
+    autotest.add_exception(exception)
+  }
+end

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+test/test_destination/*
+!test/test_destination/.keep

data/.ruby-version

@@ -0,0 +1 @@
+2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+gem 'rsync'
+gem 'rake'
+
+group :development, :test do
+  gem 'minitest'
+  gem 'minitest-rg'
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'autotest-standalone'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Claburn
+
+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,82 @@
+# SimpleSync
+
+A simple script that rsnycs the given list of files and directories to the specified output directory.
+
+[![Build Status](https://travis-ci.org/nclaburn/simple_sync.svg?branch=master)](https://travis-ci.org/nclaburn/simple_sync)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_sync'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_sync
+
+## Configuration
+SimpleSync looks in the current directory for a json configuration file named `.simple_sync`. 
+
+### Example
+```json
+{ "configurations" : [ 
+  { "config" : { 
+    "name" : "1st configuration",
+    "rsync" : "-azv",
+    "sources" : ["test/test_source/file1.txt", "test/test_source/file2.txt"], 
+    "destination" : "test/test_destination/first_config/" 
+    }},
+  { "config" : {
+    "name" : "2nd configuration",
+    "rsync" : "-azrv",
+    "rsync_suffix" : "2>&1", 
+    "sources" : ["test/test_source/somedirectory"] , 
+    "destination" : "test/test_destination/second_config" 
+    }},
+  { "config" : { 
+    "name" : "ssh configuration",
+    "rsync" : "-azrv --recursive -e ssh -i /Users/someuser/.ssh/backup_server",
+    "sources" : ["test_source/file1.txt", "test_source/file2.txt", "test_source/somedirectory"] , 
+    "destination" : "someuser@backupserver:/BACKUP/personal" 
+    }}
+  ]
+}
+```
+
+#### rsync
+If the rsync configuration option is given it is passed unmodified to rsync.
+
+#### rsync_suffix
+The rsync_suffix option provides a method to redirect the rsync stdio
+
+#### sources
+A list of files and/or directories that are to be rsynced to a single directory
+
+#### destination
+A destination for the synced files
+
+## Usage
+
+SimpleSync is meant to be run from cron or another script. To run it from the command line, simpley type in
+
+`simple_sync`
+
+SimpleSync can also be used as a library
+```ruby
+require 'simple_sync'
+sync = SimpleSync.new
+sync.load_config
+sync.copy_to_destination
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_sync/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'test/unit'
+  t.libs << 'lib'
+  #t.test_files = ['test/unit/simple_sync_test.rb']
+  t.test_files = ['test/unit/test_simple_sync.rb']
+  t.verbose = true
+end
+
+task default: :test
+

data/bin/simple_sync

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'simple_sync'
+bs = SimpleSync.new
+bs.load_config
+bs.copy_to_destination
+

data/lib/simple_sync/simple_sync.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'rsync'
+require 'json'
+
+class SimpleSync
+  attr_reader :config_list
+  def initialize(config_file = nil)
+    @config_file = config_file.nil? ? '.simple_sync' : config_file
+    @config_list = {}
+  end
+
+  def read_config_from_file
+    if File.exists?(@config_file)
+      #puts "opening file #{@config_file}"
+      config = File.open(@config_file).read
+    elsif File.exists?(File.join(Dir.home, @config_file))
+      config = File.open(File.join(Dir.home, @config_file)).read
+      #puts "opening file #{File.join(Dir.home, @config_file)}"
+    else
+      #puts "opening environment #{ENV['BACKUP_SYNC']}"
+      return { status: 'error ', message:  "could not find configuration file #{@config_file}" } unless ENV['BACKUP_SYNC']
+      return { status: 'error ', message:  "could not find configuration file #{@config_file}" } unless File.exists?(ENV['BACKUP_SYNC'])
+      config = File.open(ENV['BACKUP_SYNC']).read
+    end
+    { status: 'success', config: config }
+  end
+
+  def load_config
+    configuration = read_config_from_file()
+    return configuration if configuration[:status] == 'error'
+    @config_list = JSON.parse(configuration[:config], symbolize_names: true)
+    return { status: 'success' }
+  end
+ 
+  def copy_to_destination
+    output = []
+    @config_list[:configurations].each { |config| 
+      config[:config][:sources].each { |source| 
+       #puts "Synching from #{source} to #{@config[:destination]}..."
+       #puts "rsync #{config[:config][:rsync]} --itemize-changes #{source} #{config[:config][:destination]} #{config[:config][:rsync_suffix]} "
+       output << IO.popen("rsync #{config[:config][:rsync]} --itemize-changes #{source} #{config[:config][:destination]} #{config[:config][:rsync_suffix]} ").read 
+      }
+    }
+    { status: 'success', message: output }.to_json
+  end
+end

data/lib/simple_sync/version.rb

@@ -0,0 +1,3 @@
+module SimpleSync
+  VERSION = "0.0.1"
+end

data/lib/simple_sync.rb

@@ -0,0 +1,2 @@
+require "simple_sync/version"
+require 'simple_sync/simple_sync'

data/simple_sync.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_sync"
+  spec.version       = SimpleSync::VERSION
+  spec.authors       = ["Nathan Claburn"]
+  spec.email         = ["nathan.claburn@1st-edge.com"]
+  spec.summary       = %q{A simple library for synching a given list of source files/directories to a specified output directory.}
+  spec.description   = %q{A library for synching a given list of source files/directories to a specified output directory. The library wraps a call to rsync, which provide synchronization capabilities.}
+  spec.homepage      = "http://github.com/nclaburn/simple_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.6"
+  spec.add_development_dependency "rake", "~>10"
+  spec.add_development_dependency "pry", "~>0.9"
+  spec.add_development_dependency "pry-nav", "~>0.2"
+  spec.add_development_dependency "autotest-standalone", "~>4.4"
+
+end

data/test/multiple_configurations.json

@@ -0,0 +1,16 @@
+{ "configurations" : [ 
+  { "config" : { 
+    "name" : "1st configuration",
+    "rsync" : "-azv",
+    "sources" : ["test/test_source/file1.txt", "test/test_source/file2.txt"], 
+    "destination" : "test/test_destination/first_config/" 
+    }},
+  { "config" : {
+    "name" : "2nd configuration",
+    "rsync" : "-azrv",
+    "rsync_suffix" : "2>&1", 
+    "sources" : ["test/test_source/somedirectory"] , 
+    "destination" : "test/test_destination/second_config" 
+    }}
+  ]
+}

data/test/ssh_configuration.json

@@ -0,0 +1,9 @@
+{ "configurations" : [ 
+  { "config" : { 
+    "name" : "ssh configuration",
+    "rsync" : "-azrv --recursive -e ssh -i /Users/someuser/.ssh/backup_server",
+    "sources" : ["test_source/file1.txt", "test_source/file2.txt", "test_source/somedirectory"] , 
+    "destination" : "someuser@backupserver:/BACKUP/personal" 
+    }}
+  ]
+}

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/rg'

data/test/test_source/file1.txt

@@ -0,0 +1 @@
+file 1

data/test/test_source/file2.txt

@@ -0,0 +1 @@
+file 2

data/test/test_source/somedirectory/dir1/another_file1.txt

@@ -0,0 +1 @@
+dir1

data/test/test_source/somedirectory/dir2/another_file2.txt

@@ -0,0 +1 @@
+dir2

data/test/unit/test_simple_sync.rb

@@ -0,0 +1,52 @@
+require 'simple_sync/simple_sync'
+require 'test_helper'
+require 'pry'
+
+class SimpleSyncTest < MiniTest::Test
+  include MiniTest::Assertions
+
+  MiniTest.after_run { 
+    FileUtils.rm_rf(Dir.glob('test/test_destination/*'))
+  }
+
+    describe 'configuration' do
+    it 'locates the configuration file' do
+      sync = SimpleSync.new('test/ssh_configuration.json')
+      assert_respond_to(sync, :read_config_from_file)
+      config = sync.read_config_from_file
+      assert_equal('success', config[:status])
+    end
+
+    it 'loads configuration file' do
+      sync = SimpleSync.new('test/ssh_configuration.json')
+      assert_respond_to(sync, :load_config)
+      assert_equal({ status: 'success' }, sync.load_config)
+      configurations = sync.config_list
+      assert_equal("-azrv --recursive -e ssh -i /Users/someuser/.ssh/backup_server", configurations[:configurations][0][:config][:rsync])
+      assert_equal("ssh configuration", configurations[:configurations][0][:config][:name])
+
+      sync = SimpleSync.new('test/multiple_configurations.json')
+      assert_respond_to(sync, :load_config)
+      assert_equal({ status: 'success' }, sync.load_config)
+      configurations = sync.config_list
+
+      assert_equal("1st configuration", configurations[:configurations][0][:config][:name])
+      assert_equal("-azv", configurations[:configurations][0][:config][:rsync])
+      #assert_equal("2>&1", configurations[:configurations][0][:config][:rsync_suffix])
+
+      assert_equal("2nd configuration", configurations[:configurations][1][:config][:name])
+      assert_equal("-azrv", configurations[:configurations][1][:config][:rsync])
+    end
+
+    it 'copies source files/directories  to destination directories' do
+      sync = SimpleSync.new('test/multiple_configurations.json')
+      assert_respond_to(sync, :copy_to_destination)
+      sync.load_config
+      sync.copy_to_destination
+      assert File.exists?('test/test_destination/first_config/file1.txt'), "file1.txt didn't exist"
+      assert File.exists?('test/test_destination/first_config/file2.txt'), "file2.txt didn't exist"
+      assert File.exists?('test/test_destination/second_config/somedirectory/dir1/another_file1.txt'), "another_file1.txt didn't exist"
+      assert File.exists?('test/test_destination/second_config/somedirectory/dir2/another_file2.txt'), "another_file1.txt didn't exist"
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: simple_sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Claburn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+description: A library for synching a given list of source files/directories to a
+  specified output directory. The library wraps a call to rsync, which provide synchronization
+  capabilities.
+email:
+- nathan.claburn@1st-edge.com
+executables:
+- simple_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".autotest"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/simple_sync
+- lib/simple_sync.rb
+- lib/simple_sync/simple_sync.rb
+- lib/simple_sync/version.rb
+- simple_sync.gemspec
+- test/multiple_configurations.json
+- test/ssh_configuration.json
+- test/test_destination/.keep
+- test/test_helper.rb
+- test/test_source/file1.txt
+- test/test_source/file2.txt
+- test/test_source/somedirectory/dir1/another_file1.txt
+- test/test_source/somedirectory/dir2/another_file2.txt
+- test/unit/test_simple_sync.rb
+homepage: http://github.com/nclaburn/simple_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.0
+signing_key: 
+specification_version: 4
+summary: A simple library for synching a given list of source files/directories to
+  a specified output directory.
+test_files:
+- test/multiple_configurations.json
+- test/ssh_configuration.json
+- test/test_destination/.keep
+- test/test_helper.rb
+- test/test_source/file1.txt
+- test/test_source/file2.txt
+- test/test_source/somedirectory/dir1/another_file1.txt
+- test/test_source/somedirectory/dir2/another_file2.txt
+- test/unit/test_simple_sync.rb
+has_rdoc: