sshfsmount 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15c81068a30c8ed5a61b3fcc19d7a6503036762d
-  data.tar.gz: '0943c0fbd855d60f5c349c29cba4fd209ab89e03'
+  metadata.gz: 0f9330ebd590ac3a49fb68f3166a18f1e8666ca5
+  data.tar.gz: 6ad40fe249ba8b6a82f365fae9518e9b351972d3
 SHA512:
-  metadata.gz: fdc671ab26209081bd02081aba7515a56c7fecbc6ea6e4162cc5866678e9323abe8db71d0d208f7dc6c426e72c329632c7652a989d58f3157db31a5c0e644fc2
-  data.tar.gz: a2a64b1d2500f7889fd46646f7e0e46c7a1c529a059fb8fcca7a456d987504766e5209c0d4c032ff169906c4615ea9ef9542a90aefb4d60922fcb038fbda03ec
+  metadata.gz: 31eac3dbd23722dbacb13dc2d15e0e5495870d758c0a87eaab7e2eadba5b382b83b336f248f6eb04afa5582120e55da270e217eb90193cc9ea15dcfb65c834a9
+  data.tar.gz: d42f434f5a1d99b9099b9e9ec6a97737c5cd83089381fe2ca40429d6ea6fa4678fea67e66c72b517463a6558da83444ffca9dfd5dc3ca3db86d8bafe0b8a00d2

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/nomoon/sshfsmount.svg?branch=master)](https://travis-ci.org/nomoon/sshfsmount)
 [![Coverage Status](https://coveralls.io/repos/github/nomoon/sshfsmount/badge.svg?branch=master)](https://coveralls.io/github/nomoon/sshfsmount?branch=master)
 [![Dependency Status](https://gemnasium.com/badges/github.com/nomoon/sshfsmount.svg)](https://gemnasium.com/github.com/nomoon/sshfsmount)
+[![Gem Version](https://badge.fury.io/rb/sshfsmount.svg)](https://badge.fury.io/rb/sshfsmount)
 
 A simple front-end CLI to SSHFS.
 

data/exe/sshfsmount

@@ -1,156 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "gli"
-require "json"
-require "shellwords"
-require "fileutils"
-
 require "sshfsmount"
-
-#
-# Basic SSHFS flags
-#
-SSHFS_FLAGS = [
-  "-o local",
-  "-o workaround=nonodelaysrv",
-  "-o transform_symlinks",
-  "-o idmap=user",
-  "-C",
-].freeze
-
-#
-# Locate config file.
-#
-CONFIG_FILE = [
-  File.join(Dir.home, ".sshfsmount.json"),
-  File.join(Dir.home, ".config", "sshfsmount.json"),
-  File.join(Dir.home, ".config", "sshfsmount", "sshfsmount.json"),
-].select { |f| File.exist?(f) }.first.freeze
-
-#
-# Parse config file
-#
-CONFIG = (begin
-  if CONFIG_FILE.nil?
-    STDERR.puts "No config file found"
-    {}
-  else
-    JSON.parse(File.read(CONFIG_FILE), symbolize_names: true)
-  end
-rescue JSON::ParserError => e
-  STDERR.puts "Parse error in config file `#{CONFIG_FILE}`: #{e}"
-  {}
-end).freeze
-
-#
-# Create Mount-point Directory
-#
-def mkmountpoint(name)
-  local = File.expand_path(name)
-  if !Dir.exist?(local)
-    STDERR.puts "Creating mount-point directory #{local}"
-    FileUtils.mkdir_p(local)
-  elsif !Dir.empty?(local)
-    raise "Mount point #{local} already exists and is not empty"
-  elsif VERBOSE
-    STDERR.puts "Mount-point directory #{local} already exists and is empty"
-  end
-  local
-end
-
-#
-# Delete mount-point directory
-#
-def rmmountpoint(name)
-  local = File.expand_path(name)
-  if !Dir.exist?(local)
-    STDERR.puts "Mount-point directory not found" if VERBOSE
-  elsif !Dir.empty?(local)
-    raise "Mount-point directory #{local} is not empty"
-  else
-    STDERR.puts "Deleting mount-point directory #{local}"
-    FileUtils.rmdir(local)
-  end
-  local
-end
-
-#
-# Mount an SSHFS volume
-#
-def mount(mount_name, params)
-  local = mkmountpoint(params[:local])
-  volname = params[:volname] || mount_name
-  p_remote = Shellwords.escape(params[:remote])
-  p_local = Shellwords.escape(local)
-  p_volname = Shellwords.escape(volname)
-  port = (params[:port] || 22).to_i
-  cmd = "/usr/local/bin/sshfs #{p_remote} #{p_local} " \
-        "-o volname=\"#{p_volname}\" #{SSHFS_FLAGS.join(' ')} -p #{port}"
-  pgrep = `pgrep -f \"#{cmd}\"`
-  unless pgrep.empty?
-    raise "SSHFS process for #{mount_name} running already (PID: #{pgrep.strip}, " \
-          "Mount-point: #{p_local})"
-  end
-  puts "Mounting #{params[:remote]} to #{params[:local]} as \"#{volname}\""
-  STDERR.puts "> #{cmd}" if VERBOSE
-  system(cmd)
-end
-
-#
-# Unmount an SSHFS volume
-#
-def unmount(mount_name, params)
-  local = File.expand_path(params[:local])
-  p_local = Shellwords.escape(local)
-  cmd = "diskutil unmount #{p_local}"
-  pgrep = `pgrep -f \"#{p_local}\"`
-  if pgrep.empty?
-    raise "No SSHFS process found with the mount-point for #{mount_name} (#{p_local})"
-  end
-  puts "Unmounting #{local}"
-  STDERR.puts "> #{cmd}" if VERBOSE
-  system(cmd)
-  rmmountpoint(local)
-end
-
-#
-# GLI command-line app definition
-#
-include GLI::App
-
-program_desc "A simple front-end CLI to SSHFS"
-version Sshfsmount::VERSION
-
-switch %i[u unmount], desc: "Unmount the volume", negatable: false
-switch %i[v verbose], desc: "Show verbose output", negatable: false
-
-desc "List active SSHFS processes"
-command :active do |c|
-  c.action do
-    system("pgrep -fl sshfs")
-  end
-end
-
-#
-# Define commands from data-file
-#
-extant_commands = commands.keys
-CONFIG.reject { |name, _| extant_commands.include?(name) }.each do |mount_name, params|
-  desc "mount #{params[:remote]} to #{params[:local]}"
-  command mount_name do |c|
-    c.switch %i[u unmount], desc: "Unmount the volume", negatable: false
-    c.switch %i[v verbose], desc: "Show verbose output", negatable: false
-    c.action do |global_options, cmd_options|
-      VERBOSE = global_options[:v] || cmd_options[:v]
-      if global_options[:u] || cmd_options[:u]
-        unmount(mount_name, params)
-      else
-        mount(mount_name, params)
-      end
-    end
-  end
-end
+require "sshfsmount/cli"
 
 # Run the GLI app
-exit run(ARGV)
+exit Sshfsmount::CLI.run(ARGV)

data/lib/sshfsmount.rb

@@ -1,7 +1,164 @@
 # frozen_string_literal: true
 
+require "json"
+require "shellwords"
+require "pathname"
+
 require "sshfsmount/version"
 
 module Sshfsmount
-  # Your code goes here...
+  #
+  # Basic SSHFS flags
+  #
+  SSHFS_FLAGS = [
+    "-o local",
+    "-o workaround=nonodelaysrv",
+    "-o transform_symlinks",
+    "-o idmap=user",
+    "-C",
+  ].freeze
+
+  module_function
+
+  def verbose
+    @verbose
+  end
+
+  def verbose=(val)
+    @verbose = val ? true : false
+  end
+
+  def sshfs_cmd
+    sshfs_cmd = `command -v sshfs`.strip
+    raise "sshfs command not found in path" if sshfs_cmd.empty?
+    sshfs_cmd
+  end
+
+  #
+  # Locate config file.
+  #
+  def find_config_file
+    @config_file ||= begin
+      [
+        Pathname.new(File.join(Dir.home, ".sshfsmount.json")),
+        Pathname.new(File.join(Dir.home, ".config", "sshfsmount.json")),
+        Pathname.new(File.join(Dir.home, ".config", "sshfsmount", "sshfsmount.json")),
+      ].select(&:file?).first
+    end
+  end
+
+  #
+  # Parse config file
+  #
+  def config
+    @config ||= begin
+      config_file = find_config_file
+      if config_file.nil?
+        STDERR.puts "No config file found"
+        {}
+      else
+        JSON.parse(config_file.read, symbolize_names: true)
+      end
+    rescue JSON::ParserError => e
+      STDERR.puts "Parse error in config file `#{config_file}`: #{e}"
+      {}
+    end
+  end
+
+  def active_mounts
+    @active_mounts ||= begin
+      `mount`.lines.each_with_object({}) do |line, mounts|
+        regex = %r{^(?<remote>.+@[^:]+\:/.*?) on (?<local>/.*?) (?<options>\(\b(?:fuse|osxfuse)\b.*?\))$}
+        info = line.match(regex)
+        next if info.nil?
+        pid = `pgrep -f "/sshfs #{Shellwords.escape(info[:remote])} #{Shellwords.escape(info[:local])} "`.strip
+        pid = "None found" if pid.empty?
+        mounts[Pathname.new(info[:local]).expand_path] = {
+          local: info[:local],
+          remote: info[:remote],
+          options: info[:options],
+          pid: pid,
+          str: "#{info[:remote]} on #{info[:local]} (PID: #{pid})",
+        }
+      end
+    end
+  end
+
+  # Fails if the mount-path is already in use.
+  def dupe_check!(mount_name, params)
+    local = Pathname.new(params[:local]).expand_path
+    dupe = active_mounts[local]
+    return if dupe.nil?
+    raise "\"#{mount_name}\" already mounted?\n* #{dupe[:str]}"
+  end
+
+  #
+  # Create Mount-point Directory
+  #
+  def mkmountpoint(name)
+    local = Pathname.new(name).expand_path
+    if !local.exist?
+      STDERR.puts "Creating mount-point directory #{local}"
+      local.mkpath
+    elsif !local.directory
+      raise "Mount point #{local} exists and is not a directory"
+    elsif !local.empty?
+      raise "Mount point #{local} already exists and is not empty"
+    elsif @verbose
+      STDERR.puts "Mount-point directory #{local} already exists and is empty"
+    end
+    local
+  end
+
+  #
+  # Delete mount-point directory
+  #
+  def rmmountpoint(name)
+    local = Pathname.new(name).expand_path
+    if !local.exist?
+      STDERR.puts "Mount-point directory not found" if @verbose
+    elsif !local.directory?
+      raise "Mount point #{local} is not a directory"
+    elsif !local.empty?
+      raise "Mount-point directory #{local} is not empty"
+    else
+      STDERR.puts "Deleting mount-point directory #{local}"
+      local.rmdir
+      return true
+    end
+  end
+
+  #
+  # Mount an SSHFS volume
+  #
+  def mount(mount_name, params)
+    dupe_check!(mount_name, params)
+    local = mkmountpoint(params[:local])
+    volname = params[:volname] || mount_name
+    cmd = "#{sshfs_cmd} " \
+          "#{Shellwords.escape(params[:remote])} " \
+          "#{Shellwords.escape(local)} " \
+          "-o volname=\"#{Shellwords.escape(volname)}\" " \
+          "#{SSHFS_FLAGS.join(' ')} " \
+          "-p #{(params[:port] || 22).to_i}"
+    puts "Mounting \"#{mount_name}\"\n" \
+      " * #{params[:remote]} on #{local} as \"#{volname}\""
+    STDERR.puts "> #{cmd}" if @verbose
+    system(cmd)
+  end
+
+  #
+  # Unmount an SSHFS volume
+  #
+  def unmount(mount_name, params)
+    local = Pathname.new(params[:local]).expand_path
+    info = active_mounts[local]
+    raise "No active mount-point found for #{local}" if info.nil?
+    STDERR.puts "No active SSHFS process found for #{local}" if info[:pid] == "None found"
+    cmd = "umount #{Shellwords.escape(local)}"
+    puts "Unmounting \"#{mount_name}\" (#{local})"
+    STDERR.puts "> #{cmd}" if @verbose
+    raise "Unmount error, skipping removal of mount-point." unless system(cmd)
+    rmmountpoint(local)
+  end
 end

data/lib/sshfsmount/cli.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "gli"
+
+module Sshfsmount
+  module CLI
+    extend GLI::App
+    #
+    # GLI command-line app definition
+    #
+    program_desc "A simple front-end CLI to SSHFS"
+    version Sshfsmount::VERSION
+
+    switch %i[u unmount], desc: "Unmount the volume", negatable: false
+    switch %i[v verbose], desc: "Show verbose output", negatable: false
+
+    desc "List active SSHFS processes"
+    command :active do |c|
+      c.action do
+        Sshfsmount.active_mounts.each_value do |data|
+          puts "* #{data[:str]}"
+        end
+      end
+    end
+
+    config = Sshfsmount.config
+
+    #
+    # Define commands from data-file
+    #
+    extant_commands = commands.keys
+    config.reject { |name, _| extant_commands.include?(name) }.each do |mount_name, params|
+      desc "mount #{params[:remote]} to #{params[:local]}"
+      command mount_name do |c|
+        c.switch %i[u unmount], desc: "Unmount the volume", negatable: false
+        c.switch %i[v verbose], desc: "Show verbose output", negatable: false
+        c.action do |global_options, cmd_options|
+          Sshfsmount.verbose = global_options[:v] || cmd_options[:v]
+          if global_options[:u] || cmd_options[:u]
+            Sshfsmount.unmount(mount_name, params)
+          else
+            Sshfsmount.mount(mount_name, params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sshfsmount/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sshfsmount
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sshfsmount
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Tim Bellefleur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - bin/setup
 - exe/sshfsmount
 - lib/sshfsmount.rb
+- lib/sshfsmount/cli.rb
 - lib/sshfsmount/version.rb
 - sshfsmount.gemspec
 homepage: https://github.com/nomoon/sshfsmount