autossh 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 422069342456b2404cae7a17b2c5d295107406b2
+  data.tar.gz: 10a10355f20583451dcb018d657afb8ead2c7e9a
+SHA512:
+  metadata.gz: fe533461dd980868e15f4fadd8ed0eaf91b3b2eb8f9ed95d64e083aa8042f6e2fd7f91e01e471e8c00e79bdec68d947c9843f17457de83147951cfa277433967
+  data.tar.gz: 0daa89f3800cb89908093fe642e303bd1e62c386307540beeb253c8e91b69cd02164a0e3ede23a0d1bcd6edf963f2aa5e6a876422d50378b0c9b8718cc355925

data/.gitignore

@@ -0,0 +1,3 @@
+.idea/
+.assh-*
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'colorize'
+gem 'aws-sdk'

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (1.54.0)
+      aws-sdk-v1 (= 1.54.0)
+    aws-sdk-v1 (1.54.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+    colorize (0.7.3)
+    json (1.8.1)
+    mini_portile (0.6.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk
+  colorize

data/README.md

@@ -0,0 +1,30 @@
+Available on Rubygems at https://rubygems.org/gems/autossh
+
+Github repository at https://github.com/paul-ridgway/autossh
+
+To Install
+==========
+
+1. Clone the repository
+
+2. Ensure aash is available on the PATH:
+
+  ln -s /full/path/to/assh /usr/local/bin/assh
+
+
+To do
+=====
+
+1. Example configurations
+
+2. Safely handle no config (make dir, etc)
+
+3. Validate config files
+
+4. Gemify?
+
+5. Command line override config path (to test examples, and other uses)
+
+6. Decent logger/log levels, etc
+
+7. Tests

data/assh_completion.sh

@@ -0,0 +1,6 @@
+_foo()
+{
+    local cur=${COMP_WORDS[COMP_CWORD]}
+    COMPREPLY=( $(compgen -W "alpha beta bar baz" -- $cur) )
+}
+complete -F _foo foo

data/autossh.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'autossh'
+  s.version     = '0.0.3'
+  s.date        = '2015-02-01'
+  s.summary     = "AutoSSH"
+  s.description = "An SSH connection helper"
+  s.authors     = ["Paul Ridgway"]
+  s.email       = 'myself@paulridgway.co.uk'
+  s.homepage    = 'https://github.com/paul-ridgway/autossh'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+
+  s.executables << 'assh'
+end

data/bin/assh

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'autossh'
+
+Assh::Command.new(ARGV).execute!

data/examples/config.yml

@@ -0,0 +1,28 @@
+---
+
+Includes: [example_include.yml, example_aws.yml, random.yml]
+
+Port: 22
+IdentityFile: ~/.ssh/id_rsa
+
+Groups: 
+
+      - Group: Home
+        Port: 22
+        User: other
+        Hosts:
+             - Host: nas
+               HostName: 192.168.1.1
+
+      - Group: Personal
+        Port: 22
+        User: me
+        Hosts:
+             - Host: a1-vm
+               HostName: 1a-vm.example.com
+             - Host: 2b-vm
+               HostName: 2b-vm.example.com
+             - Host: 3c-vm
+               HostName: 3c-vm.example.com
+             - Host: 4d
+               HostName: 4d.example.com

data/examples/example_aws.yml

@@ -0,0 +1,8 @@
+---
+
+Provider: aws
+
+NameMatch: (.*?\..*?)\.
+
+AccessKeyId: someKey
+SecretAccessKey: someSecret

data/examples/example_include.yml

@@ -0,0 +1,43 @@
+---
+
+Groups: 
+      - Group: Blade Custer
+        Port: 2212
+        User: bladeuser
+        IdentityFile: ~/.ssh/blade_key
+        StrictHostKeyChecking: no
+        UserKnownHostsFile: /dev/null
+        LogLevel: quiet
+        Hosts:
+             - Host: node-01
+               HostName: 10.10.11.101
+             - Host: node-02
+               HostName: 10.10.11.102
+             - Host: node-03
+               HostName: 10.10.11.103
+             - Host: node-04
+               HostName: 10.10.11.104
+             - Host: node-05
+               HostName: 10.10.11.105
+             - Host: node-06
+               HostName: 10.10.11.106
+             - Host: node-07
+               HostName: 10.10.11.107
+             - Host: node-08
+               HostName: 10.10.11.108
+             - Host: node-09
+               HostName: 10.10.11.109
+             - Host: node-10
+               HostName: 10.10.11.110
+             - Host: node-11
+               HostName: 10.10.11.111
+             - Host: node-12
+               HostName: 10.10.11.112
+             - Host: node-13
+               HostName: 10.10.11.113
+             - Host: node-14
+               HostName: 10.10.11.114
+             - Host: node-15
+               HostName: 10.10.11.115
+             - Host: node-16
+               HostName: 10.10.11.116

data/examples/random.yml

@@ -0,0 +1,11 @@
+---
+
+Provider: Random
+
+Groups: 
+      - Group: Test
+        User: paul
+        IdentityFile: ~/Dropbox/.ssh/floow/id_rsa
+        Hosts:
+             - Host: test
+               HostName: 10.10.10.9

data/lib/autossh.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'colorize'
+
+require_relative 'helpers'
+require_relative 'configuration'
+require_relative 'provider'
+require_relative 'providers/file_provider'
+require_relative 'providers/random_provider'
+require_relative 'providers/aws_provider'
+require_relative 'command'
+require_relative 'generator'
+require_relative 'host'
+
+module Assh
+
+  ROOT = File.expand_path('~/.autossh')
+
+  GENERATED_CONFIG = "#{ROOT}/.assh-generated-config"
+  CONFIG_CACHE     = "#{ROOT}/.assh-config-cache"
+  CONFIG_CACHE_AT  = "#{ROOT}/.assh-config-cached-at"
+
+  VERSION = '0.0.3'
+
+end

data/lib/command.rb

@@ -0,0 +1,77 @@
+module Assh
+
+  class Command
+
+    def initialize(argv)
+      @args = argv
+      parse_arguments!
+
+      @configuration = Configuration.new
+
+      @generator = Generator.new
+
+      Provider.verbose! if @cmd_generate
+
+      if @configuration.needs_generating? || @cmd_generate
+        puts "Refreshing..."
+        Provider.load_configuration!(@configuration, 'config.yml')
+        @configuration.save_cache!
+      else
+        @configuration.load_cache!
+      end
+
+    end
+
+    def execute!
+      if @cmd_ls
+        puts "Host List (cached at #{Time.at(@configuration.generated_at)})".green
+        max_name = 0
+        @configuration.groups.each do |name, hosts|
+          hosts.each do |name, host|
+            max_name = name.size if name.size > max_name
+          end
+        end
+        @configuration.groups.each do |name, hosts|
+          puts "  #{name.yellow}"
+          hosts = Hash[hosts.sort]
+          hosts.each do |name, host|
+            padded_name = name + (" " * (max_name - name.size))
+            puts "    #{padded_name.light_white} #{"-".green} #{host.address.cyan}"
+          end
+        end
+      elsif @cmd_generate
+        puts "Generating config in #{@generator.output_file}"
+        generate!
+        puts "Done"
+      else
+        generate!
+        execute_default!
+      end
+    end
+
+    private
+    def parse_arguments!
+      return unless @args.size > 0
+      first_arg = @args[0].downcase
+      if first_arg == 'ls'
+        @cmd_ls = true
+      elsif first_arg == 'generate'
+        @cmd_generate = true
+      end
+    end
+
+    def generate!
+      #Generates up-to-date config
+      @generator.run!(@configuration.hosts)
+    end
+
+    def execute_default!
+      # Generates safe args and replaces assh process with ssh call
+      args = @args.map { |x| x.include?(' ') ? "\"#{x}\"" : x }.join(' ')
+      command = "ssh -F #{Assh::GENERATED_CONFIG} #{args}"
+      exec(command)
+    end
+
+  end
+
+end

data/lib/configuration.rb

@@ -0,0 +1,55 @@
+module Assh
+
+  class Configuration
+
+    attr_accessor :hosts, :groups
+
+    def initialize
+      @hosts = {}
+      @groups = {}
+    end
+
+    def add_host(group_name, host_name, host)
+      puts "WARNING: Duplicate host named: #{name}. Only latest host is included" if @hosts[host_name]
+
+      @groups[group_name] = {} unless @groups.has_key?(group_name)
+      @groups[group_name][host_name] = host
+      @hosts[host_name] = host
+    end
+
+    #TODO: Move generated-at to here and call config-cached-at
+
+    def save_cache!(config_file = File.expand_path(Assh::CONFIG_CACHE),
+                    timestamp_file = File.expand_path(Assh::CONFIG_CACHE_AT))
+      cache = {
+          hosts: @hosts,
+          groups: @groups
+      }
+      File.open(config_file, 'w') { |f| f << cache.to_yaml }
+      File.open(timestamp_file, 'w') { |f| f << current_time }
+
+    end
+
+    def load_cache!(config_file = File.expand_path(Assh::CONFIG_CACHE))
+      cache = YAML::load_file(config_file)
+      @hosts = cache[:hosts]
+      @groups = cache[:groups]
+    end
+
+    def needs_generating?(timestamp_file = File.expand_path(Assh::CONFIG_CACHE_AT))
+      (current_time - generated_at(timestamp_file)) > 72000
+    end
+
+    def generated_at(timestamp_file = File.expand_path(Assh::CONFIG_CACHE_AT))
+      return File.read(timestamp_file).to_i if File.exists?(timestamp_file)
+      0
+    end
+
+    private
+    def current_time
+      Time.now.to_i
+    end
+
+  end
+
+end

data/lib/generator.rb

@@ -0,0 +1,20 @@
+module Assh
+  class Generator
+
+    attr_accessor :output_file
+
+    def initialize(output_file = File.expand_path(Assh::GENERATED_CONFIG))
+      @output_file = output_file
+    end
+
+    def run!(hosts)
+      File.open(@output_file, 'w') do |f|
+        hosts.each do |_, host|
+          f << host.to_ssh_config
+        end
+      end
+    end
+
+  end
+
+end

data/lib/helpers.rb

@@ -0,0 +1,11 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr(" ", "-").
+        tr("(", "").
+        tr(")", "").
+        downcase
+  end
+end

data/lib/host.rb

@@ -0,0 +1,46 @@
+require_relative 'providers/file_provider'
+
+module Assh
+
+	class Host
+
+		PORT_KEY		= "Port"
+		HOST_KEY		= Assh::FileProvider::HOST_KEY	
+		HOSTNAME_KEY 	= "HostName"
+		HOSTS_KEY		= Assh::FileProvider::HOSTS_KEY	
+		GROUP_KEY		= Assh::FileProvider::GROUP_KEY	
+		GROUPS_KEY		= Assh::FileProvider::GROUPS_KEY	
+
+
+		attr_accessor :name, :hostname, :port
+
+		def initialize(params)
+			raise 'Unexpected params type' unless params.is_a? Hash
+			@name = params.delete(HOST_KEY)
+			@hostname = params.delete(HOSTNAME_KEY)
+			@port = params.delete(PORT_KEY) || 22
+			@params = params
+		end
+
+		def address
+			"#{hostname}:#{port}"
+		end
+
+		def to_s
+			"#{name} - #{hostname}:#{port}"
+		end
+
+		def to_ssh_config
+			f = ""
+			f << "Host #{name}\n"
+			f << "  Hostname #{hostname}\n"
+		    f << "  Port #{port}\n"
+		    @params.each do |k,v|
+		    	f << "  #{k} #{v}\n"
+		    end
+		    f
+		end
+
+	end
+
+end

data/lib/provider.rb

@@ -0,0 +1,61 @@
+module Assh
+
+  class Provider
+
+    @@verbose = false
+
+    @@providers ||= {}
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def self.load_configuration!(configuration, file)
+      status "Loading: #{file}"
+
+      config = YAML::load_file(File.expand_path(file, Assh::ROOT))
+
+      includes = config.delete(Assh::FileProvider::INCLUDES_KEY) || []
+
+      provider_name = (config.delete('Provider') || 'file').downcase
+      provider_class = @@providers[provider_name]
+      raise "Provider not found: #{provider_name}" unless provider_class
+
+      provider = provider_class.new(configuration)
+      provider.parse_config!(config)
+
+      includes.each do |inc|
+        Provider.load_configuration!(configuration, File.expand_path(inc, ROOT))
+      end
+
+      provider
+    end
+
+    def parse_config!(config)
+      raise 'parse_config! must be overridden'
+    end
+
+    def add_host(group_name, host_name, host)
+      @configuration.add_host(group_name, host_name, host)
+    end
+
+    def self.status(message = "", inline = false)
+      return unless @@verbose
+      if inline
+        print message
+      else
+        puts message
+      end
+    end
+
+    def self.verbose!
+      @@verbose = true
+    end
+
+    def self.register_provider!(name, clazz)
+      @@providers[name] = clazz
+    end
+
+  end
+
+end

data/lib/providers/aws_provider.rb

@@ -0,0 +1,67 @@
+require 'aws-sdk'
+
+module Assh
+
+  class AwsProvider < Assh::Provider
+
+    def initialize(configuration)
+      super(configuration)
+    end
+
+    def parse_config!(config)
+      return unless config
+      raise 'Unexpected config type' unless config.is_a? Hash
+
+      name_match = config.delete 'NameMatch'
+      access_key_id = config.delete 'AccessKeyId'
+      secret_access_key = config.delete 'SecretAccessKey'
+
+      AWS.config(
+          access_key_id: access_key_id,
+          secret_access_key: secret_access_key)
+
+
+      Provider::status "Downloading regions list..."
+
+      regions = AWS.ec2.regions.map { |r| r.name }
+
+      Provider::status "Downloading instances..."
+
+      regions.each do |region|
+
+        ec2 = AWS::EC2.new(
+            access_key_id: access_key_id,
+            secret_access_key: secret_access_key,
+            region: region)
+
+        hosts = {}
+        ec2.instances.each do |i|
+          Provider::status '.', true
+          name = (i.tags.Name || i.instance_id).underscore
+          ip = i.public_ip_address
+          hosts[name] = ip
+        end
+
+        hosts.each do |name, ip|
+
+          if name_match
+            m = Regexp.new(name_match).match(name)
+            if m
+              name = m.captures[0]
+            end
+          end
+
+          add_host(region, name, Host.new(config.merge({'Host' => name, 'HostName' => ip})))
+        end
+
+      end
+
+      Provider::status
+
+    end
+
+  end
+
+end
+
+Assh::Provider.register_provider!("aws", Assh::AwsProvider)

data/lib/providers/file_provider.rb

@@ -0,0 +1,54 @@
+require_relative '../provider'
+require 'yaml'
+
+module Assh
+
+	class FileProvider < Provider
+
+		ROOT = File.expand_path('~/.autossh')
+
+		INCLUDES_KEY = "Includes"
+		HOST_KEY	 = "Host"
+		HOSTS_KEY	 = "Hosts"
+		GROUP_KEY	 = "Group"
+		GROUPS_KEY	 = "Groups"
+
+    def initialize(configuration)
+      super(configuration)
+    end
+
+		def parse_config!(config)
+			return unless config
+			raise 'Unexpected config type' unless config.is_a? Hash
+
+			groups = config.delete(GROUPS_KEY)
+
+			if hosts = config.delete(HOSTS_KEY)
+				groups << {GROUP_KEY => 'ungrouped', HOSTS_KEY => hosts}
+			end
+			
+			groups.each { |g| parse_group!(config, g) }
+		end
+
+		private
+		def parse_group!(parent_config, group)
+			return unless group
+			parent_config ||= {}
+			name = group.delete(GROUP_KEY)
+			hosts = group.delete(HOSTS_KEY)
+			hosts.each { |h| parse_host!(name, parent_config.merge(group), h) }
+		end
+
+		def parse_host!(group_name, parent_config, host)
+			return unless host
+			parent_config ||= {}
+			name = host[HOST_KEY]
+
+			add_host(group_name, name, Host.new(parent_config.merge(host)))
+		end
+
+	end
+
+end
+
+Assh::Provider.register_provider!("file", Assh::FileProvider)

data/lib/providers/random_provider.rb

@@ -0,0 +1,23 @@
+require_relative '../provider'
+require 'yaml'
+
+module Assh
+
+	class RandomProvider < Provider
+
+    def initialize(configuration)
+      super(configuration)
+    end
+
+		def parse_config!(config)
+			return unless config
+			raise 'Unexpected config type' unless config.is_a? Hash
+
+        add_host('Random', 'rnd', Host.new({'Host' => 'rnd', 'HostName' => '123.1.2.3'}))
+		end
+
+	end
+
+end
+
+Assh::Provider.register_provider!("random", Assh::RandomProvider)

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: autossh
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Paul Ridgway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies: []
+description: An SSH connection helper
+email: myself@paulridgway.co.uk
+executables:
+- assh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- assh_completion.sh
+- autossh.gemspec
+- bin/assh
+- examples/config.yml
+- examples/example_aws.yml
+- examples/example_include.yml
+- examples/random.yml
+- lib/autossh.rb
+- lib/command.rb
+- lib/configuration.rb
+- lib/generator.rb
+- lib/helpers.rb
+- lib/host.rb
+- lib/provider.rb
+- lib/providers/aws_provider.rb
+- lib/providers/file_provider.rb
+- lib/providers/random_provider.rb
+homepage: https://github.com/paul-ridgway/autossh
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: AutoSSH
+test_files: []