mirrorworks 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 222eb5938e2c9cd60556a8a9ed479001102bcbda
+  data.tar.gz: a6f9bbf43a1ff4d23dceaff53347ea1d01cfb5cc
+SHA512:
+  metadata.gz: e31c0d4d8e6b628276fd9ebead81596f3717b102c9dc8109990209f841dfb272852690d2a2b58b695524ad7c9c45857011ac48c7aed6d9654d2b4651cad758ae
+  data.tar.gz: 21c0cb44184b11b7af6c8d2327f683376e68718cd67b3b15adf35854b8e8a7e364df9058b78418d647f39a397adae99367f6bf70c151f149a5f423ed1e19513d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 
+
+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,38 @@
+Mirrorworks
+===========
+
+A handy rsync wrapper cli tool.
+
+This is a dead-simple script that lets you easily set up pairs of files or
+directories (called 'reflections') and sync them locally or over the network
+with commands like  
+`$ mirrorworks push`  
+and  
+`$ mirrorworks pull`
+
+
+Installation and Configuration
+------------------------------
+Make sure you have rsync and ruby installed on your system.
+
+Install the gem with  
+`$ gem install mirrorworks`
+
+Mirrorworks reads a configuration file at ~/.mirrorworksrc.json.
+To create an example config file run:  
+`$ mirrorworks install`
+
+This file contains some underlying rsync runtime options as well as a set of
+'reflections'. Reflections are pairs files or directories that you want to have
+synchronized. Each consists of a name, a local file/dir, and a remote file/dir.
+There are a few things to remember when setting up your reflections:
+
+* The name of each reflection should be unique.
+* Directory paths should end in a slash /.
+* You can use '$HOME' or '~' to refer to your home directory.
+* Currently, paths including a space can't be used.
+
+Using Mirrorworks
+-----------------
+The script is very straightforward. For usage, run  
+`$ mirrorworks --help`

data/bin/mirrorworks

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'mirrorworks'
+
+Mirrorworks.new.run ARGV

data/example.mirrorworksrc.json

@@ -0,0 +1,16 @@
+{
+  "rsync_opts": ["-irtupEl"],
+
+  "reflections": [
+    {
+      "name":   "first_example",
+      "local":  "/dirs/end/with/slash/",
+      "remote": "me@example.com:~/dest/"
+    },
+    {
+      "name":   "second_example",
+      "local":  "$HOME/.mirrorworksrc.json",
+      "remote": "/public/mirrorworksrc.json"
+    }
+  ]
+}

data/lib/mirrorworks.rb

@@ -0,0 +1,167 @@
+require 'optparse'
+require 'fileutils'
+require 'rsync'
+require 'json'
+
+CONF_AT = File.join(Dir.home, '.mirrorworksrc.json')
+
+class Mirrorworks
+
+  def initialize
+    @help_opts = ''
+    @conf = nil
+  end
+
+
+  def parse_config
+    unless File.readable? CONF_AT
+      raise "Can't read #{CONF_AT}. Use 'install' command to make example conf."
+    end
+    File.open(CONF_AT, 'r') {|f| @conf = JSON.parse(f.read)}
+  end
+
+
+  def each_reflection(args)
+    if args.empty?
+      # use all reflections if none are given
+      @conf['reflections'].each {|r| yield r}
+    else
+      args.each do |a|
+        ref = nil
+        @conf['reflections'].each do |r|
+          if args.include? r['name']
+            ref = r
+            break
+          end
+        end
+        if ref.nil?
+          raise "No reflection '#{a}'"
+        else
+          yield ref
+        end
+      end
+    end
+  end
+
+
+  def install
+    src = File.join(File.dirname(__FILE__), '..', 'example.mirrorworksrc.json')
+    raise "#{CONF_AT} already exists. Nothing to do." if File.exists? CONF_AT
+    FileUtils.cp(src, CONF_AT)
+    puts "Created example config at #{CONF_AT}"
+  end
+
+
+  def push(args)
+    each_reflection(args) do |ref|
+      puts ">>>> Pushing #{ref['name']} >>>>"
+      result = Rsync.run(ref['local'], ref['remote'], @conf['rsync_opts'])
+      raise result.error unless result.success?
+
+      result.changes.each {|c| puts c.filename}
+      puts
+    end
+  end
+
+  def pull(args)
+    each_reflection(args) do |ref|
+      puts "<<<< Pulling #{ref['name']} <<<<"
+      result = Rsync.run(ref['remote'], ref['local'], @conf['rsync_opts'])
+      raise result.error unless result.success?
+
+      result.changes.each {|c| puts c.filename}
+      puts
+    end
+  end
+
+
+  def status(args)
+    each_reflection(args) do |ref|
+      @conf['rsync_opts'] << '-n'
+      push(args)
+      pull(args)
+    end
+  end
+
+
+  def list
+    @conf['reflections'].each do |r|
+      puts "Name: #{r['name']}",
+           "  Local:  #{r['local']}",
+           "  Remote: #{r['remote']}",
+           ''
+    end
+  end
+
+
+  def version
+    path = File.join(File.dirname(__FILE__), '..', 'mirrorworks.gemspec')
+    spec = Gem::Specification::load(path)
+    puts spec.version
+    exit
+  end
+
+
+  def help
+    puts @help_opts
+    puts '',
+         '  Commands:',
+         '    install     create example conf in home directory',
+         '    push        push from local to remote',
+         '    pull        pull from remote to local',
+         '    status      get status of reflections',
+         '    list        list reflections',
+         '',
+         "Reads json configuration file from #{CONF_AT}.",
+         'All reflections will be used when none are specified.',
+         'See the README.md for more information.'
+    exit
+  end
+
+
+  private :parse_config,
+          :each_reflection,
+          :install,
+          :push,
+          :pull,
+          :status,
+          :list,
+          :version,
+          :help
+
+
+  def run(args)
+    begin
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: mirrorworks [options...] <command> [reflections...]'
+        opts.on('-V', '--version', 'print version and exit') {version}
+        opts.on('-h', '--help', 'print help and exit') {help}
+        opts.on('-x', '--hard', 'delete extra files on transfer') do |x|
+          @conf['rsync_opts'] << '--delete' if x
+        end
+        @help_opts = opts.to_s
+      end.parse! args
+
+      help if args.empty?
+
+      command = args.shift
+      parse_config unless command == 'install'
+      case command
+      when 'push'
+        push args
+      when 'pull'
+        pull args
+      when 'status'
+        status args
+      when 'list'
+        list
+      when 'install'
+        install
+      else
+        raise "No command '#{command}'"
+      end
+    rescue Exception => e
+      puts e.message
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mirrorworks
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tyler Brazier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rsync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A file and directory synchronizer tool that wraps rsync
+email: tyler@tylerbrazier.com
+executables:
+- mirrorworks
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/mirrorworks
+- example.mirrorworksrc.json
+- lib/mirrorworks.rb
+homepage: http://github.com/tylerbrazier/mirrorworks
+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: A handy rsync wrapper cli tool
+test_files: []