vagrant-sshfs 0.0.5.beta1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ecfea9cb249194e1e907464e021f17a49e5a876
-  data.tar.gz: ca924db4c82d1223c6ecd6caa93f8703d1001227
+  metadata.gz: 921e3c064e20e4bcaea2002e138e70ba527521bf
+  data.tar.gz: d0028070356c7fe9d526d171ea7dd9658676ea6c
 SHA512:
-  metadata.gz: 1e10705226d1af4aab7033e44ccad80a12d0f09abe33aadea1ddbef0001ac3705f50856f48064e5b0ba4d789cbaef3a63304c0fe380603463c29d6125e360898
-  data.tar.gz: 16379fff339b38c6770f145db15919411d16f5fd4ee17cf0e444a33f035979ce7007130acd2b2e470e9b2839cdcc7c986010b0fc69c54cfab36a370f494d4223
+  metadata.gz: c0c4a7d229e4312a01004f39849f66039e71a060b44898cba3b8964ea3818cfa62dd9d10785e22625c020c3945b463afd92390cfa70059e7cd25260a4ef66fc5
+  data.tar.gz: 04be9b79e623f81d163fc3ec2491836a98959c30b4c2f355b8bf6c543db5c8628246129d2017670d5c5ae6c9ef4edbf8069906aaf21b3e111f15322556259f82

data/.gitignore

@@ -1,3 +1,4 @@
+.bundle
 mountpoint
 .vagrant
 *.gem

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## vagrant-sshfs 0.0.5 ##
+## vagrant-sshfs 0.0.5 (May 26, 2014) ##
 
 *   Allows to disable the plugin to run on demand.
 
@@ -8,6 +8,18 @@
 
     *Adrian Olek*
 
+* Checks if the `sshfs` command is available
+
+    *Fabio Kreusch*
+
+* Unmount/mount on vagrant reload
+
+    *Fabio Kreusch*
+
+* Adds sshfs command
+
+    *Fabio Kreusch*
+
 ## vagrant-sshfs 0.0.4 (March 5, 2014) ##
 
 *   Allows to set a custom ssh username.

data/Gemfile.lock

@@ -14,7 +14,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-sshfs (0.0.5.beta1)
+    vagrant-sshfs (0.0.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,7 +4,7 @@ A Vagrant plugin to mount a folder from the box to the host using sshfs.
 
 ## Why
 
-Common solutions for sharing folders with Vagrant include synced folder, which is pretty slow when dealing with many files, and NFS. NFS didn't work for me because of encrypted disk restrictions. An alternative was to mount a folder in the host machine pointing the a folder in the box with sshfs.
+Common solutions for sharing folders with Vagrant include synced folder, which is pretty slow when dealing with many files, and NFS. NFS didn't work for me because of encrypted disk restrictions. An alternative was to mount a folder in the host machine pointing to a folder in the box with sshfs.
 
 ## Installation
 
@@ -26,6 +26,8 @@ The plugin is enabled by default, so it will run everytime the machine starts. I
 
 `config.sshfs.enabled = false`
 
+To manually run it, you can use the `sshfs` command. Please check `vagrant -h`.
+
 ## Issues
 
 ### Connection reset by peer

data/lib/vagrant-sshfs/actions.rb

@@ -1,144 +1,12 @@
-require 'fileutils'
+require 'vagrant-sshfs/builders/base'
+require 'vagrant-sshfs/builders/host'
+require 'vagrant-sshfs/builders/guest'
 
 module Vagrant
   module SshFS
     module Actions
-      class Builder
-        def initialize(env)
-          @env = env
-        end
-
-        def mount!
-          paths.each do |src, target|
-            info("mounting", src: src, target: target)
-            mount(src, target)
-          end
-        end
-
-        def mount
-          raise NotImplementedError
-        end
-
-        def paths
-          machine.config.sshfs.paths
-        end
-
-        def machine
-          @env[:machine]
-        end
-
-        def info(key, *args)
-          @env[:ui].info(i18n("info.#{key}", *args))
-        end
-
-        def ask(key, *args)
-          @env[:ui].ask(i18n("ask.#{key}", *args), :new_line => true)
-        end
-
-        def error(key, *args)
-          @env[:ui].error(i18n("error.#{key}", *args))
-          raise Error, :base
-        end
-
-        def i18n(key, *args)
-          I18n.t("vagrant.config.sshfs.#{key}", *args)
-        end
-      end
-
-      class HostBuilder < Builder
-        private
-
-        def mount(src, target)
-          `sshfs -p #{port} #{username}@#{host}:#{check_src!(src)} #{check_target!(target)} -o IdentityFile=#{private_key}`
-        end
-
-        def ssh_info
-          machine.ssh_info
-        end
-
-        def username
-          machine.config.sshfs.username ||= ssh_info[:username]
-        end
-
-        def host
-          ssh_info[:host]
-        end
-
-        def port
-          ssh_info[:port]
-        end
-
-        def private_key
-          Array(ssh_info[:private_key_path]).first
-        end
-
-        def check_src!(src)
-          unless machine.communicate.test("test -d #{src}")
-            if ask("create_src", src: src) == "y"
-              machine.communicate.execute("mkdir -p #{src}")
-              info("created_src", src: src)
-            else
-              error("not_created_src", src: src)
-            end
-          end
-
-          src
-        end
-
-        def check_target!(target)
-          folder = target_folder(target)
-
-          # entries return . and .. when empty
-          if File.exist?(folder) && Dir.entries(folder).size > 2
-            error("non_empty_target", target: folder)
-          elsif !File.exist?(folder)
-            if ask("create_target", target: folder) == "y"
-              FileUtils.mkdir_p(folder)
-              info("created_target", target: folder)
-            else
-              error("not_created_target", target: folder)
-            end
-          end
-
-          folder
-        end
-
-        def target_folder(target)
-          File.expand_path(target)
-        end
-      end
-
-      class GuestBuilder < Builder
-        private
-
-        def mount(src, target)
-          source = File.expand_path(src)
-
-          status = machine.communicate.execute(
-            "echo \"#{password}\" | sshfs -o allow_other -o password_stdin #{username}@#{host}:#{source} #{target}",
-            :sudo => true, :error_check => false)
-
-          if status != 0
-            error('not_mounted', src: source, target: target)
-          end
-        end
-
-        def host
-          machine.config.sshfs.host_addr
-        end
-
-        def username
-          `whoami`.strip
-        end
-
-        def password
-          Shellwords.escape(@env[:ui].ask(i18n("ask.pass", :user => "#{username}@#{host}"), :echo => false))
-        end
-      end
-
       class Up
         def initialize(app, env)
-          @app     = app
           @machine = env[:machine]
         end
 
@@ -146,14 +14,18 @@ module Vagrant
           get_builder(env).mount! if @machine.config.sshfs.enabled
         end
 
+        private
+
         def get_builder(env)
           if @machine.config.sshfs.mount_on_guest
-            GuestBuilder.new(env)
+            Builders::Guest.new(env[:machine], env[:ui])
           else
-            HostBuilder.new(env)
+            Builders::Host.new(env[:machine], env[:ui])
           end
         end
       end
+
+      class Reload < Up; end
     end
   end
 end

data/lib/vagrant-sshfs/builders/base.rb

@@ -0,0 +1,47 @@
+module Vagrant
+  module SshFS
+    module Builders
+      class Base
+        attr_reader :machine, :ui
+
+        def initialize(machine, ui)
+          @machine, @ui = machine, ui
+        end
+
+        def mount!
+          paths.each do |src, target|
+            info("unmounting", src: target)
+            unmount(target)
+            info("mounting", src: src, target: target)
+            mount(src, target)
+          end
+        end
+
+        def mount
+          raise NotImplementedError
+        end
+
+        def paths
+          machine.config.sshfs.paths
+        end
+
+        def info(key, *args)
+          ui.info(i18n("info.#{key}", *args))
+        end
+
+        def ask(key, *args)
+          ui.ask(i18n("ask.#{key}", *args), :new_line => true)
+        end
+
+        def error(key, *args)
+          ui.error(i18n("error.#{key}", *args))
+          raise Error, :base
+        end
+
+        def i18n(key, *args)
+          I18n.t("vagrant.config.sshfs.#{key}", *args)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/builders/guest.rb

@@ -0,0 +1,41 @@
+module Vagrant
+  module SshFS
+    module Builders
+      class Guest < Base
+        private
+
+        def unmount(target)
+          if machine.communicate.execute("which fusermount", error_check: false) == 0
+            machine.communicate.execute("fusermount -u -q #{target}", error_check: false)
+          else
+            machine.communicate.execute("umount #{target}", error_check: false)
+          end
+        end
+
+        def mount(src, target)
+          source = File.expand_path(src)
+
+          status = machine.communicate.execute(
+            "echo \"#{password}\" | sshfs -o allow_other -o password_stdin #{username}@#{host}:#{source} #{target}",
+            :sudo => true, :error_check => false)
+
+          if status != 0
+            error('not_mounted', src: source, target: target)
+          end
+        end
+
+        def host
+          machine.config.sshfs.host_addr
+        end
+
+        def username
+          `whoami`.strip
+        end
+
+        def password
+          Shellwords.escape(ui.ask(i18n("ask.pass", :user => "#{username}@#{host}"), :echo => false))
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/builders/host.rb

@@ -0,0 +1,88 @@
+require 'fileutils'
+
+module Vagrant
+  module SshFS
+    module Builders
+      class Host < Base
+        private
+
+        def unmount(target)
+          if `which fusermount`.empty?
+            `umount #{target}`
+          else
+            `fusermount -u -q #{target}`
+          end
+        end
+
+        def mount(src, target)
+          `#{sshfs_bin} -p #{port} #{username}@#{host}:#{check_src!(src)} #{check_target!(target)} -o IdentityFile=#{private_key}`
+        end
+
+        def ssh_info
+          machine.ssh_info
+        end
+
+        def username
+          machine.config.sshfs.username ||= ssh_info[:username]
+        end
+
+        def host
+          ssh_info[:host]
+        end
+
+        def port
+          ssh_info[:port]
+        end
+
+        def private_key
+          Array(ssh_info[:private_key_path]).first
+        end
+
+        def sshfs_bin
+          bin = `which sshfs`.chomp
+
+          if bin.empty?
+            error("bin_not_found")
+          else
+            bin
+          end
+        end
+
+        def check_src!(src)
+          unless machine.communicate.test("test -d #{src}")
+            if ask("create_src", src: src) == "y"
+              machine.communicate.execute("mkdir -p #{src}")
+              info("created_src", src: src)
+            else
+              error("not_created_src", src: src)
+            end
+          end
+
+          src
+        end
+
+        def check_target!(target)
+          folder = target_folder(target)
+
+          # entries return . and .. when empty
+          if File.exist?(folder) && Dir.entries(folder).size > 2
+            error("non_empty_target", target: folder)
+          elsif !File.exist?(folder)
+            if ask("create_target", target: folder) == "y"
+              FileUtils.mkdir_p(folder)
+              info("created_target", target: folder)
+            else
+              error("not_created_target", target: folder)
+            end
+          end
+
+          folder
+        end
+
+        def target_folder(target)
+          File.expand_path(target)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/command.rb

@@ -0,0 +1,27 @@
+module Vagrant
+  module SshFS
+    class Command < Vagrant.plugin(2, :command)
+      def self.synopsis
+        "mounts sshfs shared folders"
+      end
+
+      def execute
+        with_target_vms do |machine|
+          get_builder(machine).mount!
+        end
+
+        0
+      end
+
+      private
+
+      def get_builder(machine)
+        if machine.config.sshfs.mount_on_guest
+          Builders::Guest.new(machine, @env.ui)
+        else
+          Builders::Host.new(machine, @env.ui)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/plugin.rb

@@ -12,6 +12,14 @@ module Vagrant
       action_hook(:sshfs, :machine_action_up) do |hook|
         hook.append(Vagrant::SshFS::Actions::Up)
       end
+
+      action_hook(:sshfs, :machine_action_reload) do |hook|
+        hook.append(Vagrant::SshFS::Actions::Reload)
+      end
+
+      command "sshfs" do
+        Vagrant::SshFS::Command
+      end
     end
   end
 end

data/lib/vagrant-sshfs/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module SshFS
-    VERSION = "0.0.5.beta1"
+    VERSION = "0.0.5"
   end
 end

data/lib/vagrant-sshfs.rb

@@ -8,6 +8,7 @@ require "vagrant-sshfs/version"
 require "vagrant-sshfs/errors"
 require "vagrant-sshfs/plugin"
 require "vagrant-sshfs/actions"
+require "vagrant-sshfs/command"
 
 module Vagrant
   module SshFS

data/locales/en.yml

@@ -3,6 +3,7 @@ en:
     config:
       sshfs:
         info:
+          unmounting: "Unmounting SSHFS for `%{src}`"
           mounting: "Mounting SSHFS for `%{src}` to `%{target}`"
           unmounted: "Unmounted SSHFS for `%{target}`"
           created_src: "Created src `%{src}`"
@@ -16,4 +17,5 @@ en:
           non_empty_target: "Non empty target folder `%{target}`"
           not_created_src: "Source folder `%{src}` was not created"
           not_created_target: "Target folder `%{target}` was not created"
-          not_mounted: "Error when mounting `%{src}` to `%{target}`"
+          not_mounted: "Error when mounting `%{src}` to `%{target}`"
+          bin_not_found: "Could not find sshfs bin in the host machine. Please make sure it is installed."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-sshfs
 version: !ruby/object:Gem::Version
-  version: 0.0.5.beta1
+  version: 0.0.5
 platform: ruby
 authors:
 - fabiokr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,6 +54,10 @@ files:
 - Vagrantfile
 - lib/vagrant-sshfs.rb
 - lib/vagrant-sshfs/actions.rb
+- lib/vagrant-sshfs/builders/base.rb
+- lib/vagrant-sshfs/builders/guest.rb
+- lib/vagrant-sshfs/builders/host.rb
+- lib/vagrant-sshfs/command.rb
 - lib/vagrant-sshfs/config.rb
 - lib/vagrant-sshfs/errors.rb
 - lib/vagrant-sshfs/plugin.rb
@@ -75,12 +79,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Vagrant plugin that mounts folders with sshfs in the host machine.