sshfsmount 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15c81068a30c8ed5a61b3fcc19d7a6503036762d
+  data.tar.gz: '0943c0fbd855d60f5c349c29cba4fd209ab89e03'
+SHA512:
+  metadata.gz: fdc671ab26209081bd02081aba7515a56c7fecbc6ea6e4162cc5866678e9323abe8db71d0d208f7dc6c426e72c329632c7652a989d58f3157db31a5c0e644fc2
+  data.tar.gz: a2a64b1d2500f7889fd46646f7e0e46c7a1c529a059fb8fcca7a456d987504766e5209c0d4c032ff169906c4615ea9ef9542a90aefb4d60922fcb038fbda03ec

data/.gitignore

@@ -0,0 +1,8 @@
+coverage
+doc
+pkg
+.DS_Store
+.yardoc
+.ruby-gemset
+.ruby-version
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+
+# Metrics
+Metrics/AbcSize:
+  Enabled: true
+  Max: 22
+
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 4
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 250
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 30
+
+Metrics/ModuleLength:
+  Enabled: true
+  Max: 250
+
+Metrics/ParameterLists:
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+
+# Style
+Style/AsciiComments:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+  - 2.3.4
+  - 2.2.7
+before_install: gem install bundler -v "~> 1.15"
+script: bundle exec rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nomoon@phoebus.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sshfsmount.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tim Bellefleur
+
+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,43 @@
+# SSHFSmount
+
+[![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)
+
+A simple front-end CLI to SSHFS.
+
+*Currently unstable and only tested on OSX.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sshfsmount"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sshfsmount
+
+## Usage
+
+For usage information, execute:
+
+    $ sshfsmount help
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nomoon/sshfsmount. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sshfsmount project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nomoon/sshfsmount/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i[rubocop test]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sshfsmount"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sshfsmount

@@ -0,0 +1,156 @@
+#!/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
+
+# Run the GLI app
+exit run(ARGV)

data/lib/sshfsmount.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "sshfsmount/version"
+
+module Sshfsmount
+  # Your code goes here...
+end

data/lib/sshfsmount/version.rb

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

data/sshfsmount.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sshfsmount/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sshfsmount"
+  spec.version       = Sshfsmount::VERSION
+  spec.authors       = ["Tim Bellefleur"]
+  spec.email         = ["nomoon@phoebus.ca"]
+
+  spec.summary       = "A simple front-end CLI to SSHFS"
+  spec.homepage      = "https://github.com/nomoon/sshfsmount"
+  spec.license       = "MIT"
+  spec.required_ruby_version = "~> 2.2"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|Gemfile\.lock|\.)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+
+  spec.add_runtime_dependency "gli", "~> 2.16"
+  spec.add_runtime_dependency "json", "~> 2.0"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: sshfsmount
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Bellefleur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- nomoon@phoebus.ca
+executables:
+- sshfsmount
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sshfsmount
+- lib/sshfsmount.rb
+- lib/sshfsmount/version.rb
+- sshfsmount.gemspec
+homepage: https://github.com/nomoon/sshfsmount
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A simple front-end CLI to SSHFS
+test_files: []