ec2ssh 3.0.3 → 3.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 427d803411f39f80c250748ed172af0f72308082
-  data.tar.gz: 0378e1f19cfd75db31a2441967b46e72f3abbd15
+  metadata.gz: 0fed04d98aec0c6bc32e228fec63e1a7040d7f3e
+  data.tar.gz: 778787d2041ac64d967d03a6bfd07515038308fd
 SHA512:
-  metadata.gz: f8e5de4f469dbbfc56f6061484932748b0e6387f72035b51d9a53ce453fa2b8ee4007ce06e253ef087073c61d05999991ac44c16959a86b84a35d384261e8556
-  data.tar.gz: a77fffdc9fec166647df4372238a277600bed4a8dbc8c4fa3935311de0a2b8f3712441ac6ec3f0bd4386a04d0b491ad976ef63797ddcf18bc1caf95f893678d9
+  metadata.gz: fac818f9832e2c5f51c754ddad8c6004a16714bd651913062c35874c1be3282cfccf17740a480069355551e71149bc4181f3179c4dece7e6e404b93af21966f7
+  data.tar.gz: 81122aef18a18b74f062e6f2b16aab5f1c84f5c275b82192307c40176823171c1b08ba58e7ad3cbc0097d0d70300cb6a47f6390bc6a8e01a13348b2fbf1a2a33

data/ChangeLog.md

@@ -1,4 +1,7 @@
 # Change Log
+## 3.1.0
+* Use credentials from `~/.aws/credentials` as default. Credential profiles are set as `profiles` in dotfile.
+
 ## 3.0.3
 * Use "%-" for ERB's trim\_mode at `host\_line` in dotfile (#29)
 * Add 'shellcomp' command: loading completion functions easily in bash/zsh (#27)

data/README.md

@@ -9,30 +9,39 @@ ec2ssh is a ssh_config manager for Amazon EC2.
 ### 1. Set 'Name' tag to your instances
 eg. Tag 'app-server-1' as 'Name' to an instance i-xxxxx in us-west-1 region.
 
-### 2. Install ec2ssh
+### 2. Write ~/.aws/credentials
+```
+# ~/.aws/credentials
+
+[default]
+aws_access_key_id=...
+aws_secret_access_key=...
+
+[myprofile]
+aws_access_key_id=...
+aws_secret_access_key=...
+```
+
+If you need more details about `~/.aws/credentials`, check [A New and Standardized Way to Manage Credentials in the AWS SDKs](http://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs)
+
+### 3. Install ec2ssh
 
 ```
 $ gem install ec2ssh
 ```
 
-### 3. Execute `ec2ssh init`
+### 4. Execute `ec2ssh init`
 
 ```
 $ ec2ssh init
 ```
 
-### 4. Edit `.ec2ssh`
+### 5. Edit `.ec2ssh`
 
 ```
 $ vi ~/.ec2ssh
 ---
-aws_keys(
-  default: {
-    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
-    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
-  },
-  # my_key1: { access_key_id: '...', secret_access_key: '...' }, ...
-)
+profiles 'default', 'myprofile'
 regions 'us-east-1'
 
 # Ignore unnamed instances
@@ -46,14 +55,14 @@ Host <%= tags['Name'] %>.<%= availability_zone %>
 END
 ```
 
-### 5. Execute `ec2ssh update`
+### 6. Execute `ec2ssh update`
 
 ```
 $ ec2ssh update
 ```
 Then host-names of your instances are generated and wrote to .ssh/config
 
-### 6. And you can ssh to your instances with your tagged name.
+### 7. And you can ssh to your instances with your tagged name.
 
 ```
 $ ssh app-server-1.us-east-1a

data/ec2ssh.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/mirakui/ec2ssh"
   s.summary     = %q{A ssh_config manager for AWS EC2}
   s.description = %q{ec2ssh is a ssh_config manager for AWS EC2}
+  s.required_ruby_version = ">= 2.0.0"
 
   s.rubyforge_project = "ec2ssh"
   s.add_dependency "thor", "~> 0.14"

data/example/example.ec2ssh

@@ -1,17 +1,9 @@
-path '~/.ssh/config'
-aws_keys(
-  {
-    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
-    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
-  },
-  #{
-  #  access_key_id: '...'
-  #  secret_access_key: '...'
-  #}
-)
+path "#{ENV['HOME']}/.ssh/config"
+profiles 'default', 'myprofile'
 regions 'ap-northeast-1', 'us-east-1'
 reject {|instance| instance.tags['Name'] =~ /.../ }
-host_lines <<END
+
+host_line <<END
 Host <%= tags['Name'] %>
   HostName <%= private_ip_address %>
 END

data/lib/ec2ssh/builder.rb

@@ -13,7 +13,7 @@ module Ec2ssh
 
     def build_host_lines
       out = StringIO.new
-      @container.aws_keys.each do |name, key|
+      aws_keys.each do |name, key|
         out.puts "# section: #{name}"
         ec2s.instances(name).each do |instance|
           bind = instance.instance_eval { binding }
@@ -26,7 +26,19 @@ module Ec2ssh
     end
 
     def ec2s
-      @ec2s ||= Ec2Instances.new @container.aws_keys, @container.regions
+      @ec2s ||= Ec2Instances.new aws_keys, @container.regions
+    end
+
+    def aws_keys
+      @aws_keys ||= if @container.profiles
+                      keys = {}
+                      @container.profiles.each do |profile_name|
+                        keys[profile_name] = Ec2Instances.expand_profile_name_to_credential profile_name
+                      end
+                      keys
+                    else
+                      @container.aws_keys
+                    end
     end
   end
 end

data/lib/ec2ssh/cli.rb

@@ -19,7 +19,6 @@ module Ec2ssh
     end
 
     desc 'update', 'Update ec2 hosts list in ssh_config'
-    method_option :aws_key, banner: 'aws key name', default: 'default'
     def update
       check_dotfile_existence
       check_dotfile_version

data/lib/ec2ssh/dsl.rb

@@ -12,6 +12,10 @@ module Ec2ssh
       @_result.aws_keys = keys
     end
 
+    def profiles(*profiles)
+      @_result.profiles = profiles
+    end
+
     def regions(*regions)
       @_result.regions = regions
     end
@@ -30,6 +34,7 @@ module Ec2ssh
 
     class Container < Struct.new(*%i[
       aws_keys
+      profiles
       regions
       host_line
       reject
@@ -41,7 +46,7 @@ module Ec2ssh
       def self.parse(dsl_str)
         dsl = Dsl.new
         dsl.instance_eval dsl_str
-        dsl._result
+        dsl._result.tap {|result| validate result }
       rescue SyntaxError => e
         raise DotfileSyntaxError, e.to_s
       end
@@ -50,6 +55,12 @@ module Ec2ssh
         raise DotfileNotFound, path.to_s unless File.exist?(path)
         parse File.read(path)
       end
+
+      def self.validate(result)
+        if result.aws_keys && result.profiles
+          raise DotfileValidationError, "`aws_keys` and `profiles` doesn't work together in dotfile."
+        end
+      end
     end
   end
 end

data/lib/ec2ssh/ec2_instances.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-v1'
 
 module Ec2ssh
   class Ec2Instances
@@ -34,5 +34,10 @@ module Ec2ssh
           sort_by {|ins| ins.tags['Name'].to_s }
       }.flatten
     end
+
+    def self.expand_profile_name_to_credential(profile_name)
+      provider = AWS::Core::CredentialProviders::SharedCredentialFileProvider.new(profile_name: profile_name)
+      provider.credentials
+    end
   end
 end

data/lib/ec2ssh/exceptions.rb

@@ -1,6 +1,7 @@
 module Ec2ssh
   class DotfileNotFound < StandardError; end
   class DotfileSyntaxError < StandardError; end
+  class DotfileValidationError < StandardError; end
   class ObsoleteDotfile < StandardError; end
   class InvalidDotfile < StandardError; end
   class MarkNotFound < StandardError; end

data/lib/ec2ssh/version.rb

@@ -1,3 +1,3 @@
 module Ec2ssh
-  VERSION = '3.0.3'
+  VERSION = '3.1.0.rc1'
 end

data/spec/lib/ec2ssh/dsl_spec.rb

@@ -2,7 +2,29 @@ require 'spec_helper'
 require 'ec2ssh/dsl'
 
 describe Ec2ssh::Dsl do
-  let(:dsl_str) do
+  context 'with profiles' do
+    let(:dsl_str) do
+<<-END
+profiles 'default', 'myprofile'
+regions 'ap-northeast-1', 'us-east-1'
+host_line 'host lines'
+reject {|instance| instance }
+path 'path'
+END
+    end
+
+    subject(:result) { Ec2ssh::Dsl::Parser.parse dsl_str }
+
+    its(:profiles) { should == ['default', 'myprofile'] }
+    its(:aws_keys) { should be_nil }
+    its(:regions) { should == ['ap-northeast-1', 'us-east-1'] }
+    its(:host_line) { should == 'host lines' }
+    it { expect(result.reject.call(123)).to eq(123) }
+    its(:path) { should == 'path' }
+  end
+
+  context 'with aws_keys' do
+    let(:dsl_str) do
 <<-END
 aws_keys(
   key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
@@ -13,18 +35,40 @@ host_line 'host lines'
 reject {|instance| instance }
 path 'path'
 END
+    end
+
+    subject(:result) { Ec2ssh::Dsl::Parser.parse dsl_str }
+
+    its(:profiles) { should be_nil }
+    its(:aws_keys) do
+      should == {
+        key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
+        key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
+      }
+    end
+    its(:regions) { should == ['ap-northeast-1', 'us-east-1'] }
+    its(:host_line) { should == 'host lines' }
+    it { expect(result.reject.call(123)).to eq(123) }
+    its(:path) { should == 'path' }
   end
 
-  subject(:result) { Ec2ssh::Dsl::Parser.parse dsl_str }
+  context 'with profiles and aws_keys both' do
+    let(:dsl_str) do
+<<-END
+aws_keys(
+  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
+  key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
+)
+profiles 'default', 'myprofile'
+regions 'ap-northeast-1', 'us-east-1'
+host_line 'host lines'
+reject {|instance| instance }
+path 'path'
+END
+    end
 
-  its(:aws_keys) do
-    should == {
-      key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
-      key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
-    }
+    it do
+      expect { Ec2ssh::Dsl::Parser.parse dsl_str }.to raise_error Ec2ssh::DotfileValidationError
+    end
   end
-  its(:regions) { should == ['ap-northeast-1', 'us-east-1'] }
-  its(:host_line) { should == 'host lines' }
-  it { expect(result.reject.call(123)).to eq(123) }
-  its(:path) { should == 'path' }
 end

data/spec/lib/ec2ssh/ec2_instances_spec.rb

@@ -12,7 +12,7 @@ describe Ec2ssh::Ec2Instances do
     }
 
     let(:mock) do
-      described_class.new(aws_keys='', regions=[region]).tap do |e|
+      described_class.new(profiles='', regions=[region]).tap do |e|
         allow(e).to receive(:ec2s) { ec2s }
         allow(e).to receive(:regions) { [region] }
       end
@@ -65,4 +65,4 @@ describe Ec2ssh::Ec2Instances do
     end
 
   end
-end
+end

data/zsh/_ec2ssh

@@ -25,7 +25,7 @@ _ec2ssh-update() {
 
     integer ret=1
     _arguments -C -S \
-               '--aws-key:aws key name' \
+               '--aws-key:aws key name:__ec2ssh_aws_keys' \
                '--dotfile:ec2ssh dotfile:_files' \
                '--verbose' && return
     return $ret
@@ -48,6 +48,37 @@ __ec2ssh_noarg_cmd() {
     return $ret
 }
 
+_ec2ssh-help() {
+    local curcontext context state line
+    declare -A opt_args
+
+    integer ret=1
+    _arguments -C -S \
+               '(-): :->commands' && return
+
+    case $state in
+        (commands)
+            _ec2ssh_commands && ret=0
+            ;;
+    esac
+
+    return $ret
+}
+
+
+__ec2ssh_aws_keys() {
+    local keys dotfile
+
+    if (( ind = ${words[(I)--dotfile]} )) && [ -f "${~words[ind+1]}" ]; then
+        dotfile=${~words[ind+1]}
+    else
+        dotfile="$HOME/.ec2ssh"
+    fi
+
+    keys=$(echo "$dotfile" | ruby -r ec2ssh/dsl -e 'puts Ec2ssh::Dsl::Parser.parse_file(STDIN.read.strip).aws_keys.keys' 2> /dev/null)
+    _values 'aws key name' $(echo $keys)
+}
+
 _ec2ssh() {
     local curcontext context state line
     declare -A opt_args

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ec2ssh
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0.rc1
 platform: ruby
 authors:
 - Issei Naruta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -109,12 +109,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: ec2ssh
 rubygems_version: 2.4.5