ec2ssh 2.0.0 → 2.0.1

data/ChangeLog.md

@@ -1,4 +1,8 @@
 # Change Log
+## 2.0.1
+
+* Fix bugs around initializing dotfile.
+
 ## 2.0.0
 
 * Add dotfile (.ec2ssh); supports multiple aws keys with `$ ec2ssh update --aws-key keyname` option.

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/mirakui/ec2ssh.png?branch=master)](https://travis-ci.org/mirakui/ec2ssh)
+
 # Introduction
 ec2ssh is a ssh_config manager for amazonaws ec2.
 `ec2ssh` command adds `Host` descriptions to ssh_config (~/.ssh/config default). 'Name' tag of instances are used as `Host` descriptions.
@@ -51,12 +53,29 @@ $ ec2ssh update       # Update ec2 hosts list in ssh_config
 $ ec2ssh remove       # Remove ec2ssh mark from ssh_config
 ```
 
-Each command can use `--path` option to set ssh_config path. The default is "~/.ssh/config"
+## Options
+### --path
+Each command can use `--path` option to set ssh_config path. `~/.ssh/config` is default.
+
+```
+$ ec2ssh init --path /path/to/ssh_config
+```
+
+### --dotfile
+Each command can use `--dotfile` option to set dotfile (.ec2ssh) path. `~/.ec2ssh` is default.
 
 ```
-$ ec2ssh init --path=/path/to/ssh_config
+$ ec2ssh init --dotfile /path/to/ssh_config
 ```
 
+### --aws-key
+`ec2ssh update` allows `--aws-key` option. If you have multiple aws keys, you can choose from them as you like using this option. See Dotfile section for details.
+
+```
+$ ec2ssh update --aws-key my_key1
+```
+
+
 # ssh_config and mark lines
 `ec2ssh init` command inserts mark lines your `.ssh/config` such as:
 
@@ -86,6 +105,61 @@ Host db-server-1.ap-southeast-1
 
 `ec2ssh remove` command removes the mark lines.
 
+# Dotfile (.ec2ssh)
+Dotfile (`.ec2ssh`) is a feature which is released at v2.0.0. A template of `.ec2ssh` is created when you execute `ec2ssh init`.
+
+```
+$ ec2ssh init
+$ cat ~/.ec2ssh
+---
+path: /home/yourname/.ssh/config
+aws_keys:
+  default:
+    access_key_id: ...(Filled by ENV['AMAZON_ACCESS_KEY_ID']
+    secret_access_key: ...(Filled by ENV['AMAZON_SECRET_ACCESS_KEY'])
+regions:
+- ap-northeast-1
+```
+
+## multiple aws keys
+You can use multiple aws keys at `ec2ssh update` with `--aws-key` option.
+
+```
+$ cat ~/.ec2ssh
+---
+path: /home/yourname/.ssh/config
+aws_keys:
+  default:
+    access_key_id: ...
+    secret_access_key: ...
+  my_key1:
+    access_key_id: ...
+    secret_access_key: ...
+regions:
+- ap-northeast-1
+```
+
+Updating ssh_config by 'default' aws key:
+
+```
+$ ec2ssh update
+```
+
+Updates ssh_config by 'my_key1' aws key:
+
+```
+$ ec2ssh update --aws-key my_key1
+```
+
+# How to upgrade from 1.x to 2.x
+If you have used ec2ssh-1.x, it seems that you may not have '~/.ec2ssh'.
+So you need execute `ec2ssh init` once to create `~/.ec2ssh`, and edit it as you like.
+
+```
+$ ec2ssh init
+$ vi ~/.ec2ssh
+```
+
 # Notice
 `ec2ssh` command updates your `.ssh/config` file default. You should make a backup of it.
 

data/lib/ec2ssh/cli.rb

@@ -18,7 +18,7 @@ module Ec2ssh
         config.append_mark!
         green "Added mark to #{config_path}"
       end
-      dotfile = Dotfile.update_or_create(options.dotfile, 'path' => options.path)
+      dotfile = Dotfile.update_or_create(options.dotfile, 'path' => config_path)
       yellow "Please check and edit #{options.dotfile} before run `ec2ssh update`"
     end
 
@@ -63,11 +63,17 @@ Host #{h[:host]}
       end
 
       def dotfile
-        @dotfile ||= Dotfile.load(options.dotfile)
+        @dotfile ||= begin
+          if File.exist?(options.dotfile)
+            Dotfile.load(options.dotfile)
+          else
+            Dotfile.new
+          end
+        end
       end
 
       def config_path
-        options.path || dotfile['path'] || "#{$ENV['HOME']}/.ssh/config"
+        options.path || dotfile['path'] || "#{ENV['HOME']}/.ssh/config"
       end
 
       [:red,:green,:yellow].each do |col|

data/lib/ec2ssh/dotfile.rb

@@ -5,7 +5,7 @@ module Ec2ssh
   class Dotfile
     def initialize(config={})
       @config = {
-        'path' => "~/.ssh/config",
+        'path' => "#{ENV['HOME']}/.ssh/config",
         'aws_keys' => {
           'default' => {
             'access_key_id' => ENV['AMAZON_ACCESS_KEY_ID'],

data/lib/ec2ssh/ssh_config.rb

@@ -1,3 +1,4 @@
+require 'time'
 require 'pathname'
 
 module Ec2ssh

data/lib/ec2ssh/version.rb

@@ -1,3 +1,3 @@
 module Ec2ssh
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/spec/lib/ec2ssh/cli_spec.rb

@@ -15,6 +15,9 @@ describe Ec2ssh::CLI do
       end
     end
   end
+  before do
+    File.delete(dotfile_path) if File.exist?(dotfile_path)
+  end
   let(:cli) { described_class }
   let(:ssh_config_path) do
     path = tmp_dir.join('ssh_config')
@@ -33,7 +36,7 @@ Host foo.bar.com
     tz = ENV['TZ']
     ENV['TZ'] = 'UTC'
     Timecop.freeze(Time.local(2013,1,1,0,0,0)) { example.call }
-    ENV['TZ'] = 'tz'
+    ENV['TZ'] = tz
   end
 
   subject { ssh_config_string }

metadata

@@ -1,78 +1,72 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ec2ssh
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 2.0.1
   prerelease: 
-  segments: 
-  - 2
-  - 0
-  - 0
-  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Issei Naruta
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 14
-        - 6
+      - !ruby/object:Gem::Version
         version: 0.14.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: highline
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: aws-sdk
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 8
-        version: "1.8"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: ec2ssh is a ssh_config manager for AWS EC2
-email: 
+email:
 - mimitako@gmail.com
-executables: 
+executables:
 - ec2ssh
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .rvmrc
@@ -95,37 +89,28 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/mirakui/ec2ssh
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: ec2ssh
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A ssh_config manager for AWS EC2
-test_files: 
+test_files:
 - spec/lib/ec2ssh/cli_spec.rb
 - spec/spec_helper.rb