ssh_bookmarker 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andreas Fuchs
+
+MIT License
+
+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,29 @@
+# Automatically create OS X bookmark files (.webloc) from your SSH config
+
+This set of scripts allows you to automatically create bookmarks for
+all hosts that your SSH knows about. The really cool part is that it
+also includes a LaunchAgent script that re-runs this every time your
+SSH config changes. Include the output dir in your LaunchBar /
+QuickSilver / Alfred config, and you can SSH into hosts without even
+opening Terminal (to type SSH)!
+
+## Installation
+
+You have to install it under the system ruby, so run:
+
+    $ sudo env RBENV_VERSION=system RVM_VERSION=system gem install ssh_bookmarker
+
+## Usage
+
+You can either use `create-ssh-bookmarks` as a one-off script to
+generate SSH bookmarks in a specific directory, or, if you have found
+a set of command line args that works for you, use those same args
+with `generate-ssh-bookmark-launchagent`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add 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/create-ssh-bookmarks

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ssh_bookmarker'
+
+cli = SSHBookmarker::CLI.new
+cli.parse_options
+cli.run

data/bin/generate-ssh-bookmark-launchagent

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'ssh_bookmarker'
+
+class LaunchAgentCreator
+  def run(args)
+    cli = SSHBookmarker::CLI.new
+    cli.banner = <<-USAGE
+Usage: #{$0} [options] output_dir
+
+This script writes a LaunchAgent configuration file that will run
+create-ssh-bookmarks with all the options you pass it, whenever any of
+the SSH known_hosts or config files changes.
+
+When create-ssh-bookmarks is run, the resulting files will be written
+to output_dir.
+USAGE
+    cli.parse_options(args.dup)
+
+    sanity_checks
+
+    filename = File.expand_path("~/Library/LaunchAgents/net.boinkor.ssh-bookmarker.plist")
+    File.open(filename, 'w') do |f|
+      f.write <<-PLIST
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+        <key>Label</key>
+        <string>net.boinkor.ssh-bookmarker</string>
+        <key>ProgramArguments</key>
+        <array>#{program_arguments(args)}</array>
+        <key>QueueDirectories</key>
+        <array/>
+        <key>RunAtLoad</key>
+        <true/>
+        <key>StartCalendarInterval</key>
+        <dict>
+                <key>Hour</key>
+                <integer>0</integer>
+                <key>Minute</key>
+                <integer>0</integer>
+        </dict>
+        <key>WatchPaths</key>
+        <array>#{watch_paths(cli)}</array>
+</dict>
+</plist>
+PLIST
+    end
+    puts <<-STATUS
+Wrote #{filename}
+
+Now run:
+
+    launchctl unload #{filename}
+    launchctl load #{filename}
+STATUS
+  end
+
+  def sanity_checks
+    if (ENV['RBENV_VERSION'] && ENV['RBENV_VERSION'] != 'system') ||
+      (ENV['RVM_VERSION'] && ENV['RVM_VERSION'] != 'system')
+      $stderr.puts "#{$0} must be run under the 'system' ruby, sorry."
+      exit(1)
+    end
+  end
+
+  def make_string_array(elements)
+    '<string>' + elements.join("</string>\n<string>") + '</string>'
+  end
+
+  def program_arguments(args)
+    script_path = File.expand_path('../create-ssh-bookmarks', __FILE__)
+    make_string_array([script_path] + args)
+  end
+
+  def watch_paths(cli)
+    make_string_array(cli.hosts_files + cli.config_files)
+  end
+end
+
+LaunchAgentCreator.new.run(ARGV)# if $0 == __FILE__

data/lib/ssh_bookmarker.rb

@@ -0,0 +1,125 @@
+require "ssh_bookmarker/version"
+require "ssh_bookmarker/cli"
+require 'logger'
+require 'fileutils'
+
+module SSHBookmarker
+  class Parser
+    def initialize(locations_dir)
+      @locations_dir = locations_dir
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def logger
+      @logger ||= begin
+                    Logger.new(STDERR)
+                  end
+    end
+
+    def protocol_override=(block)
+      @protocol_override = block
+    end
+
+    DEFAULT_CONFIG_FILES=['/etc/ssh/ssh_config', File.expand_path('~/.ssh/config')]
+    DEFAULT_KNOWN_HOSTS_FILES=['/etc/ssh/known_hosts', File.expand_path('~/.ssh/known_hosts')]
+
+    def process_files(ssh_config_files=DEFAULT_CONFIG_FILES, known_host_files=DEFAULT_KNOWN_HOSTS_FILES)
+      ssh_config_files.each do |path|
+        if File.exists?(path)
+          logger.info("Parsing SSH config file #{path}")
+        else
+          logger.info("Skipping missing SSH config file #{path}")
+          next
+        end
+        parse_ssh_config(path) do |hostname, url_scheme|
+          if @protocol_override
+            (@protocol_override.call(hostname, url_scheme) || [url_scheme]).each do |scheme|
+              make_webloc(hostname, nil, scheme)
+            end
+          else
+            make_webloc(hostname, nil, url_scheme)
+          end
+        end
+      end
+
+      known_host_files.each do |path|
+        if File.exists?(path)
+          logger.info("Parsing known_hosts file #{path}")
+        else
+          logger.info("Skipping missing known_hosts file #{path}")
+          next
+        end
+        parse_known_hosts_file(path) do |hostname, port|
+          make_webloc(hostname, port)
+        end
+      end
+    end
+
+    def parse_known_hosts_file(path)
+      File.open(path).each_line do |line|
+        line = line.split(' ')[0]
+        hostname = line.split(',').each do |hostname|
+          if ported_host_match = hostname.match(/\[(\S*[a-zA-Z]+\S*)\]:([0-9]+)/)
+            host = ported_host_match[1]
+            port = ported_host_match[2]
+            yield(host, port)
+          else
+            yield(hostname) unless hostname.match(/ /) || hostname.match(/^[\[]/)  || hostname.match(/^[0-9\.]+$/) || hostname.match(/^[a-f0-9\:]+(%.*)?$/)
+          end
+        end
+      end
+    rescue Errno::ENOENT => e
+      puts "Can't open #{path}: #{e}" if $debug
+    end
+
+    def parse_ssh_config(path)
+      File.open(path).each do |line|
+        if line.match /^\s*Host\s+([^#]+)\s*(#.+)?$/i
+          host_spec = $1
+          url_schemes = extract_url_scheme($2)
+          hosts = host_spec.split(/\s+/)
+          logger.debug("Got hosts #{hosts.inspect}")
+          hosts.each do |host|
+            url_schemes.each do |url_scheme|
+              yield(host, nil, url_scheme) unless host.match /\*/
+            end
+          end
+        end
+      end
+    rescue Errno::ENOENT => e
+    end
+
+    def make_webloc(hostname, port, url_scheme=nil)
+      url_scheme ||= 'ssh'
+      logger.debug "Making host entry for #{url_scheme}://#{hostname}:#{port}"
+      loc_filename = File.join(@locations_dir, "#{hostname} (#{url_scheme}).webloc")
+      begin
+        File.open(loc_filename, 'w') do |file|
+          file.write <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+            <key>URL</key>
+            <string>#{url_scheme || 'ssh'}://#{hostname}#{port && ":#{port}"}</string>
+        </dict>
+        </plist>
+      XML
+        end
+      rescue Exception => e
+        logger.error "Can't write webloc file #{loc_filename} for host #{hostname}: #{e}"
+      end
+    end
+
+    def extract_url_scheme(scheme_comment)
+      if scheme_comment && scheme_comment =~ /^#:(.*)$/
+        $1.split(',')
+      else
+        ["ssh"]
+      end
+    end
+  end
+end

data/lib/ssh_bookmarker/cli.rb

@@ -0,0 +1,96 @@
+require 'logger'
+require 'optparse'
+
+module SSHBookmarker
+  class CLI
+    attr_accessor :hosts_files
+    attr_accessor :config_files
+    attr_accessor :dir
+
+    def initialize
+      @hosts_files = SSHBookmarker::Parser::DEFAULT_KNOWN_HOSTS_FILES
+      @config_files = SSHBookmarker::Parser::DEFAULT_CONFIG_FILES
+
+      @mosh_positive_domain_patterns = []
+      @mosh_negative_domain_patterns = []
+
+      @debug_level = Logger::WARN
+    end
+
+    attr_writer :banner
+    def banner
+      @banner || <<-USAGE
+Usage: #{$0} [options] output_dir
+
+This script generates SSH (and, optionally, mosh) bookmarks in
+output_dir.
+
+(Note that patterns can be either substring matches or regexes, if wrapped in //)
+USAGE
+    end
+
+    def parse_options(args=ARGV)
+      optparse = OptionParser.new do |opts|
+        opts.banner = banner
+        opts.on('-k', '--known_hosts=FILE', 'Add file to list of known hosts') do |file|
+          @hosts_files << file
+        end
+
+        opts.on('-c', '--ssh_config=FILE', 'Add file to list of ssh config files') do |file|
+          @config_files << file
+        end
+
+        opts.on('-m PATTERN', '--mosh=PATTERN', 'Emit a mosh bookmark for host names matching PATTERN') do |pattern|
+          @mosh_positive_domain_patterns << to_match_expr(pattern)
+        end
+
+        opts.on('-M PATTERN', '--prevent-mosh=PATTERN', 'Prevent emitting a mosh bookmark for host names matching PATTERN') do |pattern|
+          @mosh_negative_domain_patterns << to_match_expr(pattern)
+        end
+        opts.on('-v', '--verbose', 'More debug chunder') do
+          @debug_level -= 1
+        end
+      end
+      optparse.parse!(args)
+      if args.length != 1
+        $stderr.puts optparse
+        exit 1
+      end
+      @dir = args.first
+      self
+    end
+
+    def to_match_expr(str)
+      if str.match(%r{\A/(.*)/\z})
+        Regexp.new($1)
+      else
+        str
+      end
+    end
+
+    def parser
+      parser = SSHBookmarker::Parser.new(@dir)
+
+      logger = Logger.new(STDERR)
+      logger.level = @debug_level
+      parser.logger = logger
+
+      if @mosh_positive_domain_patterns.length > 0
+        parser.protocol_override = proc do |hostname, url_scheme|
+          if @mosh_positive_domain_patterns.find {|pattern| hostname.match(pattern)} &&
+              !@mosh_negative_domain_patterns.find {|pattern| hostname.match(pattern)}
+            ['mosh']
+          end
+        end
+      end
+
+      parser
+    end
+
+    def run
+      Dir[File.join(@dir, '*.webloc')].each {|f| File.unlink(f)}
+      FileUtils.mkdir_p(@dir)
+      parser.process_files(@config_files, @hosts_files)
+    end
+  end
+end

data/lib/ssh_bookmarker/version.rb

@@ -0,0 +1,3 @@
+module SSHBookmarker
+  VERSION = "0.0.1"
+end

data/ssh_bookmarker.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ssh_bookmarker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssh_bookmarker"
+  spec.version       = SSHBookmarker::VERSION
+  spec.authors       = ["Andreas Fuchs"]
+  spec.email         = ["asf@boinkor.net"]
+  spec.description   = %q{A tool that lets you automatically generate SSH bookmarks}
+  spec.summary       = %q{This gem installs a script that lets you generate SSH bookmarks from the (non-wildcard) entries in your SSH config and known_hosts files. It supports Mosh, too!}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ssh_bookmarker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andreas Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool that lets you automatically generate SSH bookmarks
+email:
+- asf@boinkor.net
+executables:
+- create-ssh-bookmarks
+- generate-ssh-bookmark-launchagent
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/create-ssh-bookmarks
+- bin/generate-ssh-bookmark-launchagent
+- lib/ssh_bookmarker.rb
+- lib/ssh_bookmarker/cli.rb
+- lib/ssh_bookmarker/version.rb
+- ssh_bookmarker.gemspec
+homepage: ''
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: This gem installs a script that lets you generate SSH bookmarks from the
+  (non-wildcard) entries in your SSH config and known_hosts files. It supports Mosh,
+  too!
+test_files: []
+has_rdoc: