ec2-host 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f749471944700121c781943703aa72e8b8a07d9
-  data.tar.gz: 9db09c8155b61efb38851d579740fb809ce30aab
+  metadata.gz: ad6de8f55b767b6131c58d34025197f7d50b5bf9
+  data.tar.gz: '0586edf0954b7480db15634a168ae2eced6a0acf'
 SHA512:
-  metadata.gz: 7b1098d2a578af8b30dab95e87ebe1f4b89e23bfab7f8bf51370549051413c75756ce38f210e98fcabb28f325a01f5be399e0229922f11d5683b2a8079c3d016
-  data.tar.gz: e5a6fe2fae9935252dc4af230c3726fec9a43bb1824e7e11cae1615f6d03be85499b0e397f5dc19b4bb9e603ff2d219c0b78e90e065b1f4a09bfb469b3fbdb12
+  metadata.gz: 5353b0fe64005d1f69f3197ac767d87058aafe0a03f9d101859491d6486c4d828761b1969571bffd69c9d4714b7e1267dad0971cfebccbca409defaac2d66fc6
+  data.tar.gz: b6576721559e850cf1db0abe94aaf1bbb83272a7be7e562957df7cfab0e5d09fa7c19190db2e5428571de28943c3c6a1bff3ac66abfa2d59cfd57fea77ae1ae3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.0.2 (2019/02/05)
+
+Enhancements:
+
+* Support AWS\_SHARED\_CREDENTIALS\_FILE environment variable.
+* Support ~/.aws/config with instance profile.
+* Remove dependency on aws\_config gem.
+
 # 1.0.1 (2019/02/05)
 
 Enhancements:

data/docs/EC2/Host/Config.html

@@ -134,7 +134,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#aws_credential_file-class_method" title="aws_credential_file (class method)">.<strong>aws_credential_file</strong>  &#x21d2; Object </a>
+      <a href="#aws_credentials_file-class_method" title="aws_credentials_file (class method)">.<strong>aws_credentials_file</strong>  &#x21d2; Object </a>
     
 
     
@@ -658,11 +658,11 @@
 </div>
     
       
-      <span id="aws_credential_file=-class_method"></span>
+      <span id="aws_credentials_file=-class_method"></span>
       <div class="method_details ">
-  <h3 class="signature " id="aws_credential_file-class_method">
+  <h3 class="signature " id="aws_credentials_file-class_method">
   
-    .<strong>aws_credential_file</strong>  &#x21d2; <tt>Object</tt> 
+    .<strong>aws_credentials_file</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -684,8 +684,8 @@
     <td>
       <pre class="code"><span class="info file"># File 'lib/ec2/host/config.rb', line 55</span>
 
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_aws_credential_file'>aws_credential_file</span>
-  <span class='ivar'>@aws_credential_file</span> <span class='op'>||=</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_aws_credentials_file'>aws_credentials_file</span>
+  <span class='ivar'>@aws_credentials_file</span> <span class='op'>||=</span>
     <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AWS_CREDENTIALS_FILE</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AWS_CREDENTIALS_FILE</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='op'>||</span>
     <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AWS_CREDENTIAL_FILE</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AWS_CREDENTIAL_FILE</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='comment'># ref. aws cli (supported lately)
 </span>    <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~/.aws/credentials</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -1373,4 +1373,4 @@
 
     </div>
   </body>
-</html>
+</html>

data/docs/file.README.html

@@ -322,4 +322,4 @@ $ env $(cat .env) terraform apply</code></pre>
 
     </div>
   </body>
-</html>
+</html>

data/docs/index.html

@@ -322,4 +322,4 @@ $ env $(cat .env) terraform apply</code></pre>
 
     </div>
   </body>
-</html>
+</html>

data/docs/method_list.html

@@ -94,7 +94,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EC2/Host/Config.html#aws_credential_file-class_method" title="EC2::Host::Config.aws_credential_file (method)">aws_credential_file</a></span>
+      <span class='object_link'><a href="EC2/Host/Config.html#aws_credentials_file-class_method" title="EC2::Host::Config.aws_credentials_file (method)">aws_credentials_file</a></span>
       <small>EC2::Host::Config</small>
     </div>
   </li>

data/ec2-host.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'aws-sdk-ec2'
   gem.add_runtime_dependency 'dotenv'
-  gem.add_runtime_dependency 'aws_config'
+  gem.add_runtime_dependency 'inifile'
 
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'rdoc'

data/lib/ec2/host/config.rb

@@ -1,5 +1,5 @@
 require 'dotenv'
-require 'aws_config'
+require 'inifile'
 Dotenv.load
 
 class EC2
@@ -11,7 +11,7 @@ class EC2
           :aws_profile,
           :aws_access_key_id,
           :aws_secret_access_key,
-          :aws_credential_file,
+          :aws_credentials_file,
           :log_level,
           :hostname_tag,
           :roles_tag,
@@ -33,7 +33,7 @@ class EC2
         @aws_region ||=
           ENV['AWS_REGION'] || config.fetch('AWS_REGION', nil) || # ref. old aws cli
           ENV['AWS_DEFAULT_REGION'] || config.fetch('AWS_DEFAULT_REGION', nil) || # ref. aws cli and terraform
-          aws_config['region'] || raise('AWS_REGION nor AWS_DEFAULT_REGION is not set')
+          aws_config['region'] || raise('AWS_REGION nor AWS_DEFAULT_REGION nor reagion in ~/.aws/config is not set')
       end
 
       def self.aws_profile
@@ -52,12 +52,16 @@ class EC2
         @aws_secret_access_key ||= ENV['AWS_SECRET_ACCESS_KEY'] || config.fetch('AWS_SECRET_ACCESS_KEY', nil)
       end
 
-      def self.aws_credential_file
-        @aws_credential_file ||=
-          ENV['AWS_CREDENTIALS_FILE'] || config.fetch('AWS_CREDENTIALS_FILE', nil) ||
-          ENV['AWS_CREDENTIAL_FILE'] || config.fetch('AWS_CREDENTIAL_FILE', nil) || # ref. aws cli (supported lately)
+      def self.aws_credentials_file
+        @aws_credentials_file ||=
+          ENV['AWS_CREDENTIALS_FILE'] || config.fetch('AWS_CREDENTIALS_FILE', nil) || # old
+          ENV['AWS_CREDENTIAL_FILE'] || config.fetch('AWS_CREDENTIAL_FILE', nil) || # old
+          ENV['AWS_SHARED_CREDENTIALS_FILE'] || config.fetch('AWS_SHARED_CREDENTIALS_FILE', nil) || # ref. https://docs.aws.amazon.com/ja_jp/cli/latest/userguide/cli-configure-envvars.html
           File.expand_path('~/.aws/credentials')
       end
+      class << self
+        alias_method :aws_credential_file, :aws_credentials_file # for backward compatibility
+      end
 
       def self.aws_config_file
         @aws_config_file ||= ENV['AWS_CONFIG_FILE'] || config.fetch('AWS_CONFIG_FILE', nil) || File.expand_path('~/.aws/config')
@@ -65,10 +69,13 @@ class EC2
 
       def self.aws_config
         return @aws_config if @aws_config
-        if File.readable?(aws_config_file) && File.readable?(aws_credential_file)
-          AWSConfig.config_file = aws_config_file
-          AWSConfig.credentials_file = aws_credential_file
-          @aws_config = AWSConfig[aws_profile]
+        if File.readable?(aws_config_file)
+          ini = IniFile.load(aws_config_file).to_h
+          if aws_profile == 'default'
+            @aws_config = ini['default']
+          else
+            @aws_config = ini["profile #{aws_profile}"]
+          end
         end
         @aws_config ||= {}
       end

data/lib/ec2/host/ec2_client.rb

@@ -35,25 +35,32 @@ class EC2
         @ec2 ||= Aws::EC2::Client.new(region: Config.aws_region, credentials: credentials)
       end
 
-      def credentials
-        if Config.aws_access_key_id and Config.aws_secret_access_key
+      def ec2_instance?
+        (not instance_id.nil?) rescue false
+      end
+
+      def raw_credentials
+        if Config.aws_config['credential_source'] == 'Ec2InstanceMetadata'
+          Aws::InstanceProfileCredentials.new
+        elsif Config.aws_access_key_id and Config.aws_secret_access_key
           Aws::Credentials.new(Config.aws_access_key_id, Config.aws_secret_access_key)
+        elsif File.readable?(Config.aws_credentials_file)
+          Aws::SharedCredentials.new(profile_name: Config.aws_profile, path: Config.aws_credentials_file)
+        elsif ec2_instance? # fallback to instance profile
+          Aws::InstanceProfileCredentials.new
+        end
+      end
+
+      def credentials
+        if Config.aws_config['role_arn']
+          # wrapped by assume role if necessary
+          Aws::AssumeRoleCredentials.new(
+            client: Aws::STS::Client.new(raw_credentials),
+            role_arn: Config.aws_config['role_arn'],
+            role_session_name: "ec2-host-session-#{Time.now.to_i}"
+          )
         else
-          aws_config = Config.aws_config
-          if aws_config[:role_arn]
-            Aws::AssumeRoleCredentials.new(
-              client: Aws::STS::Client.new(aws_config.config_hash),
-              role_arn: aws_config[:role_arn],
-              role_session_name: "ec2-host-session-#{Time.now.to_i}"
-            )
-          elsif aws_config[:credential_source] == "Ec2InstanceMetadata"
-            Aws::InstanceProfileCredentials.new
-          else
-            Aws::SharedCredentials.new(
-              profile_name: Config.aws_profile,
-              path: Config.aws_credential_file
-            )
-          end
+          raw_credentials
         end
       end
 

data/lib/ec2/host/version.rb

@@ -1,5 +1,5 @@
 class EC2
   class Host
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ec2-host
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Naotoshi Seo
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws_config
+  name: inifile
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="