rshare 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

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/.rspec

@@ -0,0 +1 @@
+--color --format progress --fail-fast

data/.travis.yml

@@ -0,0 +1,8 @@
+before_install: gem install bundler --pre
+
+script: bundle exec rspec
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :cli => '--options spec/.rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Johannes Huning
+
+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,48 @@
+# rshare
+
+Tiny ruby app allowing for automated file sharing between friends using rsync
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rshare'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rshare
+
+
+## Usage
+
+1. Install rshare
+2. Create a JSON configuration file for your repository:
+
+        {
+          "local": "~/public/",
+          "remote": "user@somehost.com:~/public/",
+          "options": [ "--bwidth=10", "--progress" ]
+        }
+   *The trailing slash tells rshare/rsync to sync the directory's contents instead of the directories themselves*
+
+3. **Either** pull files from the repository: `rshare pull conf.json`
+4. **Or** mark some of your repository's directories to be pushed by placing a `.rshare` file in them:
+
+        touch path/to/shared/dir/.rshare
+   Then push your files:
+
+        rshare push conf.json
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rshare

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'rshare'
+require 'rshare/exec'
+require 'rshare/opts'
+
+RShare::Exec.run!(ARGV)

data/lib/rshare.rb

@@ -0,0 +1,4 @@
+require "rshare/version"
+require "rshare/conf"
+require "rshare/repo"
+require "rshare/rsync"

data/lib/rshare/conf.rb

@@ -0,0 +1,16 @@
+require 'json'
+
+module RShare
+  module Configuration
+    extend self
+
+    def load(filename)
+      conf = File.open(filename, "rt") { |f| JSON.load(f.read()) }
+      # Expand local paths
+      had_trailing_slash = conf['local'][-1].eql?('/')
+      conf['local'] = File.expand_path(conf['local']) +
+        (had_trailing_slash ? '/' : '')
+      conf
+    end
+  end
+end

data/lib/rshare/exec.rb

@@ -0,0 +1,30 @@
+require 'logger'
+
+module RShare
+  module Exec
+    def self.run!(args)
+      $opts = Options.parse!(args)
+
+      if ARGV.length < 2 or ARGV.first !~ /^push|pull$/
+        # Invalid arguments: Pretend the user asked for help
+        Options.parse! %w{--help}
+      end
+
+      # Log to $stdout by default
+      $log = Logger.new($stdout, shift_age = 'weekly')
+      $log.level = $opts[:verbose] ? Logger::DEBUG : Logger::INFO
+
+      # Daemonize if asked to
+      if $opts[:daemon]
+        $stdout.reopen File.open("./rshare.log", 'a')
+        Process.daemon(nochdir=true, noclose=true)
+        $log.info "Daemonized with PID #{Process.pid}"
+      end
+
+      confs = ARGV[1, ARGV.length].map { |f| Configuration.load(f) }
+      confs.each { |c| ARGV.first =~ /push/ ? RSync.push!(c) : RSync.pull!(c) }
+
+      $log.info "Exiting (PID #{Process.pid})"
+    end
+  end
+end

data/lib/rshare/opts.rb

@@ -0,0 +1,32 @@
+require 'optparse'
+
+module RShare
+  module Options
+    def self.parse!(args)
+      opts = {}
+
+      op = OptionParser.new { |op|
+        op.banner = "Usage: #{$0} <push|pull> <configuration...> [option...]"
+        op.separator ""
+        op.separator "Options:"
+
+        op.on("-d", "--daemonize", "Daemonize podshot") { |p|
+          opts[:daemon] = true
+        }
+
+        op.on_tail("-h", "--help", "Show this message") {
+          puts op
+          Kernel.exit(1)
+        }
+
+        op.on_tail("-v", "--version", "Show version") {
+          puts RShare::VERSION
+          Kernel.exit(2)
+        }
+      }
+
+      op.parse!(args)
+      opts
+    end
+  end
+end

data/lib/rshare/repo.rb

@@ -0,0 +1,12 @@
+module RShare
+  module Repository
+    extend self
+
+    def includes(dir)
+      dir = File.expand_path(dir)
+      dirs = Dir[dir + "/**/*"].keep_if { |f| File.directory?(f) }
+      dirs.keep_if { |d| File.exist?(d + "/.rshare") }
+      dirs.map { |d| d.gsub(dir, '') }
+    end
+  end
+end

data/lib/rshare/rsync.rb

@@ -0,0 +1,45 @@
+require 'tempfile'
+
+module RShare
+  module RSync
+    extend self
+
+    def push!(config, log = $log, provider = Kernel)
+      rsync!(push_command(config), log, provider)
+    end
+
+    def pull!(config, log = $log, provider = Kernel)
+      rsync!(pull_command(config), log, provider)
+    end
+
+    private
+
+    def push_command(config)
+      options = config['options'] + %w{--delete --append-verify --recursive}
+
+      filelist = Tempfile.new("includes")
+      filelist.puts Repository.includes(config['local']).join("\n")
+      filelist.close
+
+      options << "--files-from=#{filelist.path}"
+      options.uniq!
+      rsync_command(config['local'], config['remote'], options)
+    end
+
+    def pull_command(config)
+      options = config['options'] + %w{--append-verify --recursive}
+      options.delete("--delete")
+      rsync_command(config['remote'], config['local'], options)
+    end
+
+    def rsync_command(source, target, options)
+      options_string = options.join(' ')
+      'rsync "%s" "%s" %s' % [ source, target, options_string ]
+    end
+
+    def rsync!(command, log, system_provider)
+      log.info "Running RSYNC:\n\t#{command}"  if log
+      system_provider.system(command)
+    end
+  end
+end

data/lib/rshare/version.rb

@@ -0,0 +1,3 @@
+module RShare
+  VERSION = "0.1.2"
+end

data/rshare.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rshare/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Johannes Huning"]
+  gem.email         = ["johannesh@allnightdrive.com"]
+  gem.description   =
+    "Tiny ruby app allowing for automated file sharing between friends " +
+    "using rsync"
+  gem.summary       =
+    "Automate file sharing between friends"
+  gem.homepage      = "https://github.com/johannesh/rshare"
+
+  gem.executables   =
+    `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rshare"
+  gem.require_paths = ["lib"]
+  gem.version       = RShare::VERSION
+
+  %w{rspec dusel}.each { |dep|
+    gem.add_development_dependency(dep)
+  }
+end

data/spec/conf_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__)) + "/spec_helper"
+require 'tempfile'
+require 'json'
+
+describe 'RShare::Configuration' do
+  describe "#load" do
+    it "should throw an exception if given missing file" do
+      expect { RShare::Configuration.load('/tmp/rshare') }.to
+        raise_exception(Errno::ENOENT)
+    end
+
+    it "should correctly load existing configuration and expand paths" do
+      config = {
+        'local' => "~/public/",
+        'remote' => "foo@bar.com:~/public/",
+        'options' => [ "--bwidth=10", "--progress" ]
+      }
+      local = config['local']
+      expanded_config = config.merge({
+        'local' => File.expand_path(local) + (local[-1].eql?('/') ? '/' : '')
+      })
+      conf_file = Tempfile.open("rshare") { |file|
+        JSON.dump(config, file)
+        file.close
+        file
+      }
+      RShare::Configuration.load(conf_file.path).should eq(expanded_config)
+    end
+  end
+end

data/spec/repo_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'RShare::Repository' do
+  include RShare::Repository
+
+  describe "#includes" do
+    it "should return [] for missing directories" do
+      includes("/foo/bar/baz").should eq([])
+    end
+
+    it "should return [] for directories without .rshare files" do
+      Dusel.dir { |d|
+        includes(d.path).should eq([])
+        d.collapse
+      }
+    end
+
+    it "should return directories with .rshare files by relative path" do
+      Dusel.dir { |outer|
+        outer.dir { |inner|
+          inner.file(".rshare")
+          includes(outer.path).should eq([inner.path.gsub(outer.path, '')])
+        }
+        outer.collapse
+      }
+    end
+  end
+end

data/spec/rsync_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'shellwords'
+
+describe 'RShare::RSync' do
+  include RShare::RSync
+
+  before :each do
+    @config = {
+      'local' => "~/public/",
+      'remote' => "foo@bar.com:~/public/",
+      'options' => [ "--bwidth=10", "--progress" ]
+    }
+    @kernel = double('Kernel')
+    @log = double('Log')
+  end
+
+  describe "#push_command" do
+    it "should include the default push options" do
+      cmd = push_command(@config)
+      %w{--append-verify --recursive --delete}.each { |o|
+        cmd.include?(o).should be_true
+      }
+    end
+
+    it "should have the local path as the first argument" do
+      push_command(@config).shellsplit()[1].should eq(@config['local'])
+    end
+
+    it "should have the remote path as the second argument" do
+      push_command(@config).shellsplit()[2].should eq(@config['remote'])
+    end
+
+    it "should add an option to only sync included files" do
+      Dusel.dir { |outer|
+        outer.dir { |inner|
+          inner.file(".rshare")
+
+          @config['local'] = outer.path
+          cmd = push_command(@config)
+          cmd.include?("--files-from").should be_true
+          /--files-from=([^ ]+)/.match(cmd) { |md|
+            File.exist?(md[1]).should be_true
+            File.open(md[1], "r") { |f|
+              f.read.strip.should eq(RShare::Repository.includes(outer).first)
+            }
+          }
+        }
+
+        outer.collapse
+      }
+    end
+  end
+
+  describe "#pull_command" do
+    it "should include the default pull options" do
+      cmd = pull_command(@config)
+      %w{--append-verify --recursive}.each { |o| cmd.include?(o).should be_true }
+    end
+
+    it "should never include the --delete options" do
+      @config['options'] << "--delete"
+      pull_command(@config).include?("--delete").should be_false
+    end
+
+    it "should have the local path as the second argument" do
+      pull_command(@config).shellsplit()[2].should eq(@config['local'])
+    end
+
+    it "should have the remote path as the first argument" do
+      pull_command(@config).shellsplit()[1].should eq(@config['remote'])
+    end
+  end
+
+  describe "#rsync_command" do
+    it "should generate a proper rsync command" do
+      source = "source"
+      target = "target"
+      options = %w{--option --option2}
+      rsync_command(source, target, options).should \
+        eq('rsync "%s" "%s" %s' % [source, target, options.join(' ')])
+    end
+
+    it "should quote source and target for shell usage" do
+      source = target = "~/public/name with spaces"
+      quoted_source, quoted_target, *_ =
+        rsync_command(source, target, []).shellsplit()[1, 3]
+
+      quoted_source.should eq(source)
+      quoted_target.should eq(target)
+    end
+  end
+
+  describe "#rsync!" do
+    it "should log the given command with level INFO" do
+      command = "command"
+      @log.should_receive(:info).with("Running RSYNC:\n\t#{command}")
+      @kernel.should_receive(:system).with(command)
+      rsync!("command", @log, @kernel)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rshare'
+require 'dusel'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rshare
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Johannes Huning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &5126840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *5126840
+- !ruby/object:Gem::Dependency
+  name: dusel
+  requirement: &5126570 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *5126570
+description: Tiny ruby app allowing for automated file sharing between friends using
+  rsync
+email:
+- johannesh@allnightdrive.com
+executables:
+- rshare
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rshare
+- lib/rshare.rb
+- lib/rshare/conf.rb
+- lib/rshare/exec.rb
+- lib/rshare/opts.rb
+- lib/rshare/repo.rb
+- lib/rshare/rsync.rb
+- lib/rshare/version.rb
+- rshare.gemspec
+- spec/conf_spec.rb
+- spec/repo_spec.rb
+- spec/rsync_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/johannesh/rshare
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Automate file sharing between friends
+test_files:
+- spec/conf_spec.rb
+- spec/repo_spec.rb
+- spec/rsync_spec.rb
+- spec/spec_helper.rb
+has_rdoc: