rsync_wrapper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bca87d515e5e5fbf59592fde27ffd171e51757c
+  data.tar.gz: d70b4de43a3fd3f22e48a16fe67b9882aa83e84a
+SHA512:
+  metadata.gz: 9f890de180a81cb136a347546db93b6613448fc58e46c960600c6fabb6da56fe0d53142e0da7c84cac7f4b88fd1dbe2a7670291275a3b06f6f716b8b263963f5
+  data.tar.gz: a64832d767154d5b06a1b74225c2565b4f31419159f51a0690f6b1ec4112585682891c55a85d62b9da29bdb1c35c4cb71e7434d415b46a385952f237b619e9ff

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+spec/actual_sync.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rsync_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sean Huber
+
+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,73 @@
+rsync_wrapper
+==============
+
+`rsync_wrapper` is a simple gem that provides a ruby wrapper to the [rsync](http://linux.die.net/man/1/rsync) file copying tool.
+
+
+Requirements and Dependencies
+-----------------------------
+
+Developed/Tested with Ruby version 2.3, but it should work with any version >= 1.9.  This gem will only work on an *NIX (OSX/Linux) based operating system that has `rsync`.
+
+
+Installation
+-----------------------------
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'rsync_wrapper'
+```
+
+
+Usage
+-----------------------------
+
+First, instantiate an instance of `Rsync`:
+
+```ruby
+rsync = Rsync.new(**options)
+```
+
+The constructor accepts the following named arguments:
+
+| Argument Name         | Required? | Object Type | Description                                                                                                                                                                                                                                   |
+|-----------------------|-----------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `:src_dir`            | Required  | `String`    | An absolute path representing the source directory to have `rsync` copy. e.g., `"/Users/seanhuber/Documents/my_pdfs"`                                                                                                                         |
+| `:dest_dir`           | Required  | `String`    | An absolute path representing the destination directory that `rsync` will copy the `:src_dir` to.                                                                                                                                             |
+| `:include_extensions` | Optional  | `Array`     | An array of symbols or strings for each file extension `rsync` should include, e.g., `[:doc, :docx, :pdf]`                                                                                                                                    |
+| `:subdirs_only`       | Optional  | `Boolean`   | An option to have `rsync` only sync files that are in subfolders of `:src_dir`. Defaults to `false`.                                                                                                                                          |
+| `:log_dir`            | Optional  | `String`    | `rsync_wrapper` has `rsync` pipe its results into a logfile so that the ruby code can then parse this file (and then deletes it). This option should be set to the absolute path of the directory where the temporary logfile will be stored. |
+| `:logfile`            | Optional  | `String`    | If the `:log_dir` is not specified, you can provide an explicit path for `rsync_wrapper`'s temporary logfile.                                                                                                                                 |
+
+To execute `rsync`, invoke the `sync!` method which accepts a block with 2 parameters:
+
+| Argument Index | Object Type | Description                                                                             |
+|----------------|-------------|-----------------------------------------------------------------------------------------|
+| `0`            | `String`    | The relative path (relative to `:dest_dir` from above) of the copied file.              |
+| `1`            | `Boolean`   | `true` if the copied file is a new file. `false` if the copied file is an updated file. |
+
+Example:
+
+```ruby
+source_directory = '/Users/seanhuber/Documents/my_pdfs'
+destination_directory = '/Users/seanhuber/Documents/my_pdfs (copied)'
+
+rsync = Rsync.new(src_dir: source_directory, dest_dir: destination_directory)
+
+rsync.sync! do |file_path, new_file|
+  puts "Full Path: #{File.join(destination_directory, file_path)}"
+  puts "The relative path of the new file is: #{file_path}"
+  if new_file
+    puts "This is a brand new file."
+  else
+    puts "This is an updated file."
+  end
+end
+```
+
+
+License
+-----------------------------
+
+MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rsync_wrapper"
+
+# 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

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_wrapper/rsync.rb

@@ -0,0 +1,56 @@
+class Rsync
+  def initialize **opts
+    @dirs = {}
+    [:src_dir, :dest_dir].each do |k|
+      raise ArgumentError, "#{k} is required" unless opts[k]
+      @dirs[k] = opts[k]
+    end
+    @inclusions = opts[:include_extensions].map{|ext| "*.#{ext}"} || []
+    @exclusions = opts[:exclusions] || []
+    if opts[:subdirs_only]
+      @inclusions << '*/' # include subdirectories
+      @exclusions << '*'
+    end
+    @logfile = opts[:log_dir] ? File.join(opts[:log_dir], "rsync-#{SecureRandom.uuid}.log") : opts[:logfile]
+  end
+
+  def sync! &block
+    exec_rsync
+    parse_logfile &block
+  end
+
+  private
+
+  def exec_rsync
+    rsync_opts = ['-ri', "--log-file '#{@logfile}'", '--size-only', '--prune-empty-dirs']
+    rsync_opts += @inclusions.map{|inc| "--include '#{inc}'"}
+    rsync_opts += @exclusions.map{|exc| "--exclude '#{exc}'"}
+    cmd = "rsync #{rsync_opts.join(' ')} \"#{@dirs[:src_dir]}\" \"#{@dirs[:dest_dir]}\" > /dev/null 2>&1"
+    `#{cmd}`
+  end
+
+  def parse_logfile
+    base_dir = File.basename @dirs[:src_dir]
+    File.open(@logfile, 'r') do |f|
+      f.each_line do |line|
+        line_arr = line.split(/ /)
+        next unless line_arr.length > 4
+        #http://andreafrancia.it/2010/03/understanding-the-output-of-rsync-itemize-changes.html
+        changes = line_arr[3]
+        next unless changes.start_with?('>f') # file transfered to local
+        file_path = line_arr[4..-1].join(' ').strip
+        next unless file_path.start_with?(base_dir)
+
+        if block_given?
+          if changes.start_with?('>f+++')
+            yield file_path, true
+          elsif changes[3] == 's'
+            yield file_path, false
+          end
+        end
+      end
+    end
+
+    # File.delete @logfile
+  end
+end

data/lib/rsync_wrapper/version.rb

@@ -0,0 +1,3 @@
+module RsyncWrapper
+  VERSION = '1.0.0'
+end

data/lib/rsync_wrapper.rb

@@ -0,0 +1,2 @@
+require 'rsync_wrapper/version'
+require 'rsync_wrapper/rsync'

data/rsync_wrapper.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rsync_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rsync_wrapper'
+  spec.version       = RsyncWrapper::VERSION
+  spec.authors       = ['Sean Huber']
+  spec.email         = ['seanhuber@seanhuber.com']
+  spec.summary       = 'Configurable wrapper to rsync utility'
+  spec.homepage      = 'https://github.com/seanhuber/rsync_wrapper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rsync_wrapper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Huber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- seanhuber@seanhuber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rsync_wrapper.rb
+- lib/rsync_wrapper/rsync.rb
+- lib/rsync_wrapper/version.rb
+- rsync_wrapper.gemspec
+homepage: https://github.com/seanhuber/rsync_wrapper
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Configurable wrapper to rsync utility
+test_files: []