awssh 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7813fbd643c47e30330aa13e8df8c830694833a2
-  data.tar.gz: fa612f8c10bfc39b2b111ff8c89e702594c61071
+  metadata.gz: bf4f811b2deee46c61931cb776834d68384ae7d6
+  data.tar.gz: 79bc526ecf91a64b45a690b1914902be7f84547d
 SHA512:
-  metadata.gz: bc4a46a8e7e69672c8165af90b92ea1c5f9b7dcfc3c76bbeac97737318ca60424dc27fd1a4ee12011bae3b63aaa8e394d1411e4453ce5fb45893638a6bc8cd80
-  data.tar.gz: 77f3cd627766fe012459567f412ee9f6030ecb01501cd1ded42fa1c121435b92a80b5fc088522609040beb4062c45305b690bc1f2160bcc5a422d21fba466b35
+  metadata.gz: d4601030e632b861310b8a8874b866f4a395cd17e16f86fbd7c7299472389f9144ac0deaafac09c3d4ac0eee1320b2029d3a070935a9986ff3cb62e4565b6d83
+  data.tar.gz: c3a5e9d1abfc33514afcdf9a940fe16ecb4dffd4fa33e049dcf2dd6ba4f1e711bf0293afacb43f050cc2c46cd9fc144cc48608bedf7419284d66e0b266e55a9e

data/README.md

@@ -4,10 +4,15 @@ Hacky way to handle ssh to AWS servers
 
 - Searches for servers based on AWS tag Name.
 - Provides the ability to use single ssh and multiple ssh access.
-- Multiple can use cssh or csshX (configurable)
+- Use cssh or csshX (configurable) for mulit-server access
+- caches list of servers, to minimize calls to AWS (primarily for speed).
 
 ## Installation
 
+Generally, you will install this directly:
+
+    $ gem install awssh
+
 Add this line to your application's Gemfile:
 
     gem 'awssh'
@@ -16,10 +21,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install awssh
-
 ## Usage
 
 ```
@@ -30,17 +31,45 @@ Search Terms:
   positive check for each entry
     name =~ /term/
   negative check if the term starts with ^
-    name !~ /term/ if term[0] == "^"
+    name !~ /term/
 
 Options:
+    -V, --version                    print version
+    -i, --init                       initialize config
+
+    -l, --list                       just list servers
     -n, --test                       just output ssh command
     -v, --[no-]verbose               Run verbosely
-    -V, --version                    print version
-    -c, --config                     config file (default: ~/.awssh)
+
+    -U, --update                     just update the cache
+        --no-cache                   disable cache for this run
+
     -m, --[no-]multi                 connect to multiple servers
-    -i, --init                       initialize config
+    -c, --config                     override config file (default: ~/.awssh)
+    -u, --user                       override user setting
+
 ```
 
+## Config
+```
+---
+multi: csshX                   # multi ssh program: csshX or cssh
+single: ssh                    # ssh program, allows for common configs
+region: us-east-1              # ec2 region
+user:                          # username to ssh as
+key: AWS ACCESS KEY ID         # AWS key
+secret: AWS SECRET ACCESS KEY  # AWS secret
+domain: example.com            # append domain to server names
+cache: "~/.awssh.cache"        # cache file location
+expires: 86400                 # cache expiration time (in seconds)
+```
+
+## Caching
+
+Maintains a simple cache with expiration (default: 1 day)
+The cache just contains the list of servers' names.
+You can disable the cache by setting the cache value to false in the config file.
+
 ## Shell Alias
 
 To get around using multiple RVM's and still have access to awssh command
@@ -48,7 +77,7 @@ To get around using multiple RVM's and still have access to awssh command
 alias awssh='rvm <rvm version> do awssh'
 
 When you install awssh into your default ruby, then change to a project ruby,
-the awssh gem is not longer available. This allows you to use the awssh gem
+the awssh gem is no longer available. This allows you to use the awssh gem
 from ruby. Just specify the default rvm version in <rvm verison> above.
 
 alias awssh='rvm 2.1.2 do awssh'

data/lib/awssh/command.rb

@@ -21,7 +21,7 @@ module Awssh
       }.stringify_keys
 
       @config_file = File.expand_path(@options[:config])
-      @config.merge!(YAML.load_file(@config_file)) if File.exists?(@config_file)
+      @config.merge!(YAML.load_file(@config_file)||{}) if File.exists?(@config_file)
 
       OptionParser.new do |opts|
         opts.banner = "Usage: awssh [options] [search terms]"
@@ -32,43 +32,49 @@ module Awssh
         opts.separator '  positive check for each entry'
         opts.separator '    name =~ /term/'
         opts.separator '  negative check if the term starts with ^'
-        opts.separator '    name !~ /term/ if term[0] == "^"'
+        opts.separator '    name !~ /term/'
         opts.separator ''
         opts.separator 'Options:'
-
-        opts.on('-n', '--test', 'just output ssh command') do |n|
-          @options[:test] = n
-        end
-        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-          @options[:verbose] = v
-        end
         opts.on('-V', '--version', 'print version') do |v|
           puts "awssh version: #{Awssh::Version::STRING}"
           exit 0
         end
-        opts.on('-c', "--config", "config file (default: ~/.awssh)") do |c|
-          @options[:config] = c
-        end
-        opts.on('-m', '--[no-]multi', 'connect to multiple servers') do |m|
-          @options[:multi] = m
-        end
         opts.on('-i', '--init', 'initialize config') do |i|
           path = File.expand_path("~/.awssh")
-          File.open(path, "w+") { |f| f.write config.to_yaml }
+          File.open(path, "w+") { |f| f.write @config.to_yaml }
           puts "created config file: #{path}"
           exit 0
         end
-        opts.on('-u', '--user', 'override user setting') do |u|
-          @config['user'] = u
-        end
+        opts.separator ''
         opts.on('-l', '--list', 'just list servers') do |l|
           @options[:list] = true
         end
+        opts.on('-n', '--test', 'just output ssh command') do |n|
+          @options[:test] = n
+        end
+        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+          @options[:verbose] = v
+        end
+
+        opts.separator ''
         opts.on('-U', '--update', 'just update the cache') do |u|
           @options[:update] = true
           get_servers
           exit 0
         end
+        opts.on('--no-cache', 'disable cache for this run') do |u|
+          @config['cache'] = false
+        end
+        opts.separator ''
+        opts.on('-m', '--[no-]multi', 'connect to multiple servers') do |m|
+          @options[:multi] = m
+        end
+        opts.on('-c', "--config", "override config file (default: ~/.awssh)") do |c|
+          @options[:config] = c
+        end
+        opts.on('-u', '--user', 'override user setting') do |u|
+          @config['user'] = u
+        end
       end.parse!(argv)
 
       @search = argv

data/lib/awssh/version.rb

@@ -2,7 +2,7 @@ module Awssh
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY  = 6
+    TINY  = 7
     TAG   = nil
     LIST  = [MAJOR, MINOR, TINY, TAG].compact
     STRING = LIST.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awssh
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Shawn Catanzarite