vagrant-rsync-pull 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (1 July 2014)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gemspec
+end

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2013 Mitchell Hashimoto
+
+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,27 @@
+# Vagrant RSync-Pull Plugin
+
+This is a [Vagrant](http://www.vagrantup.com) 1.5+ plugin that works the same as the built-in RSync plugin,
+except files are sync'd from the guest to the host.
+
+**NOTE:** This plugin requires Vagrant 1.5+
+
+## Usage
+
+1. Install using standard Vagrant 1.1+ plugin installation methods. 
+```
+$ vagrant plugin install vagrant-rsync-pull
+```
+2. After installing, edit your Vagrantfile and add a configuration directive similar to the below:
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.vm.synced_folder "/home/myuser/myproject", "/opt/myproject", type: "rsync_pull"
+end
+```
+3. Start up your starting your vagrant box as normal (eg: `vagrant up`)
+
+## Start syncing folders
+
+Folders will be pulled from the guest on `vagrant up`.
+
+Run `vagrant rsync-pull` to manually sync files from the guest to your local host.

data/lib/vagrant-rsync-pull.rb

@@ -0,0 +1,12 @@
+require "pathname"
+
+require "vagrant-rsync-pull/plugin"
+require "vagrant-rsync-pull/errors"
+
+module VagrantPlugins
+  module SyncedFolderRSyncPull
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-rsync-pull/command.rb

@@ -0,0 +1,46 @@
+require "optparse"
+require "log4r"
+require "vagrant"
+require "vagrant/action/builtin/mixin_synced_folders"
+
+require_relative "helper"
+
+module VagrantPlugins
+  module SyncedFolderRSyncPull
+    class Command < Vagrant.plugin("2", :command)
+      include Vagrant::Action::Builtin::MixinSyncedFolders
+
+      def self.synopsis
+        "rsyncs guest files to host"
+      end
+
+      def execute
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant rsync-pull [vm-name]"
+          o.separator ""
+        end
+
+        argv = parse_options(opts)
+        return if !argv
+
+        error = false
+        with_target_vms do |machine|
+          if !machine.communicate.ready?
+            machine.ui.error(I18n.t("vagrant.rsync_communicator_not_ready"))
+            error = true
+            next
+          end
+
+          folders = synced_folders(machine)[:rsync_pull]
+          next if !folders || folders.empty?
+
+          folders.each do |id, folder_opts|
+            RsyncPullHelper.rsync_single(machine, folder_opts)
+          end
+        end
+
+        return error ? 1 : 0
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-pull/errors.rb

@@ -0,0 +1,9 @@
+require "vagrant"
+
+module Vagrant
+  module Errors
+    class SyncedFolderRSyncPullError < VagrantError
+      error_key(:rsync_pull_error, "vagrant_rsync_pull.errors")
+    end
+  end
+end

data/lib/vagrant-rsync-pull/helper.rb

@@ -0,0 +1,105 @@
+require "vagrant/util/platform"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module SyncedFolderRSyncPull
+    class RsyncPullHelper
+      def self.rsync_single(machine, opts)
+        ssh_info = machine.ssh_info
+        guestpath = opts[:guestpath]
+        hostpath = opts[:hostpath]
+        hostpath = File.expand_path(hostpath, machine.env.root_path)
+        hostpath = Vagrant::Util::Platform.fs_real_path(hostpath).to_s
+
+        if Vagrant::Util::Platform.windows?
+          hostpath = Vagrant::Util::Platform.cygwin_path(hostpath)
+        end
+
+        if !guestpath.end_with?("/")
+          guestpath += "/"
+        end
+
+        if !hostpath.end_with?("/")
+          hostpath += "/"
+        end
+
+        opts[:owner] ||= ssh_info[:username]
+        opts[:group] ||= ssh_info[:username]
+
+        username = ssh_info[:username]
+        host = ssh_info[:host]
+        proxy_command = ""
+        if ssh_info[:proxy_command]
+          proxy_command = "-o ProxyCommand='#{ssh_info[:proxy_command]}' "
+        end
+
+        rsh = [
+          "ssh -p #{ssh_info[:port]} " +
+          proxy_command +
+          "-o StrictHostKeyChecking=no " +
+          "-o UserKnownHostsFile=/dev/null",
+          ssh_info[:private_key_path].map { |p| "-i '#{p}'" },
+        ].flatten.join(" ")
+
+        excludes = ['.vagrant/', 'Vagrantfile']
+        excludes += Array(opts[:exclude]).map(&:to_s) if opts[:exclude]
+        excludes.uniq!
+
+        args = nil
+        args = Array(opts[:args]).dup if opts[:args]
+        args ||= ["--verbose", "--archive", "--delete", "-z", "--copy-links"]
+
+        if Vagrant::Util::Platform.windows? && !args.any? { |arg| arg.start_with?("--chmod=") }
+          args << "--chmod=ugo=rwX"
+
+          args << "--no-perms" if args.include?("--archive") || args.include?("-a")
+        end
+
+        args << "--no-owner" unless args.include?("--owner") || args.include?("-o")
+        args << "--no-group" unless args.include?("--group") || args.include?("-g")
+
+        if machine.guest.capability?(:rsync_command)
+          args << "--rsync-path"<< machine.guest.capability(:rsync_command)
+        end
+
+        command = [
+          "rsync",
+          args,
+          "-e", rsh,
+          excludes.map { |e| ["--exclude", e] },
+          "#{username}@#{host}:#{guestpath}",
+          hostpath,
+        ].flatten
+
+        command_opts = {}
+        command_opts[:workdir] = machine.env.root_path.to_s
+
+        machine.ui.info(I18n.t(
+          "vagrant.rsync_folder", guestpath: guestpath, hostpath: hostpath))
+        if excludes.length > 1
+          machine.ui.info(I18n.t(
+            "vagrant.rsync_folder_excludes", excludes: excludes.inspect))
+        end
+
+        if machine.guest.capability?(:rsync_pre)
+          machine.guest.capability(:rsync_pre, opts)
+        end
+
+        command = command + [command_opts]
+
+        r = Vagrant::Util::Subprocess.execute(*command)
+        if r.exit_code != 0
+          raise Vagrant::Errors::SyncedFolderRSyncPullError,
+            command: command.inspect,
+            guestpath: guestpath,
+            hostpath: hostpath,
+            stderr: r.stderr
+        end
+
+        if machine.guest.capability?(:rsync_post)
+          machine.guest.capability(:rsync_post, opts)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-pull/plugin.rb

@@ -0,0 +1,55 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The vagrant-rsync-pull plugin must be run within Vagrant."
+end
+
+if Vagrant::VERSION < "1.5"
+  raise "The vagrant-rsync-pull plugin is only compatible with Vagrant 1.5+"
+end
+
+module VagrantPlugins
+  module SyncedFolderRSyncPull
+    class Plugin < Vagrant.plugin("2")
+      name "SyncedFolderRSyncPull"
+      description "Vagrant plugin to rsync guest files to host"
+
+      command "rsync-pull" do
+        setup_logging
+        setup_i18n
+        require_relative "command"
+        Command
+      end
+
+      synced_folder("rsync_pull", 5) do
+        require_relative "synced_folder"
+        SyncedFolder
+      end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", SyncedFolderRSyncPull.source_root)
+        I18n.reload!
+      end
+
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          level = nil
+        end
+
+        level = nil if !level.is_a?(Integer)
+
+        if level
+          logger = Log4r::Logger.new("vagrant_rsync_pull")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-pull/synced_folder.rb

@@ -0,0 +1,52 @@
+require "log4r"
+
+require "vagrant/util/subprocess"
+require "vagrant/util/which"
+
+require_relative "helper"
+
+module VagrantPlugins
+  module SyncedFolderRSyncPull
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      include Vagrant::Util
+
+      def initialize(*args)
+        super
+
+        @logger = Log4r::Logger.new("vagrant_rsync_pull")
+      end
+
+      def usable?(machine, raise_error=false)
+        rsync_path = Which.which("rsync")
+        return true if rsync_path
+        return false if !raise_error
+        raise Vagrant::Errors::RSyncNotFound
+      end
+
+      def prepare(machine, folders, opts)
+      end
+
+      def enable(machine, folders, opts)
+        if machine.guest.capability?(:rsync_installed)
+          installed = machine.guest.capability(:rsync_installed)
+          if !installed
+            can_install = machine.guest.capability?(:rsync_install)
+            raise Vagrant::Errors::RSyncNotInstalledInGuest if !can_install
+            machine.ui.info I18n.t("vagrant.rsync_installing")
+            machine.guest.capability(:rsync_install)
+          end
+        end
+
+        ssh_info = machine.ssh_info
+
+        if ssh_info[:private_key_path].empty? && ssh_info[:password]
+          machine.ui.warn(I18n.t("vagrant.rsync_ssh_password"))
+        end
+
+        folders.each do |id, folder_opts|
+          RsyncPullHelper.rsync_single(machine, folder_opts)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-pull/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module SyncedFolderRSyncPull
+    VERSION = "0.0.1"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  vagrant_rsync_pull:
+    errors:
+      rsync_pull_error: |-
+        There was an error when attemping to sync folders using rsync.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+        Full command causing error: 
+        %{command}

data/vagrant-rsync-pull.gemspec

@@ -0,0 +1,50 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-rsync-pull/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-rsync-pull"
+  s.version       = VagrantPlugins::SyncedFolderRSyncPull::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = "Ed Toon"
+  s.email         = "edtoon@edtoon"
+  s.homepage      = "https://github.com/edtoon/vagrant-rsync-pull"
+  s.summary       = "Vagrant plugin to rsync guest files to host"
+  s.description   = "Vagrant plugin to rsync guest files to host"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  s.files         = unignored_files
+  s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  s.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-rsync-pull
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ed Toon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-03 00:00:00.000000000 Z
+dependencies: []
+description: Vagrant plugin to rsync guest files to host
+email: edtoon@edtoon
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vagrant-rsync-pull/command.rb
+- lib/vagrant-rsync-pull/synced_folder.rb
+- lib/vagrant-rsync-pull/helper.rb
+- lib/vagrant-rsync-pull/errors.rb
+- lib/vagrant-rsync-pull/plugin.rb
+- lib/vagrant-rsync-pull/version.rb
+- lib/vagrant-rsync-pull.rb
+- Gemfile
+- vagrant-rsync-pull.gemspec
+- LICENSE
+- README.md
+- locales/en.yml
+- CHANGELOG.md
+- .gitignore
+homepage: https://github.com/edtoon/vagrant-rsync-pull
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Vagrant plugin to rsync guest files to host
+test_files: []