awshark 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 944b9d2229c69abfd14fae195f1ba6ffad83e48b1f8a6d8b250ba1958a600330
-  data.tar.gz: d1b9886e347b3eb551f765f1788e556751aca04b17ae95e034d9b4ffbd83936b
+  metadata.gz: 9243bfae1f80dc2a4ca0b2da531aca71d0adf817d4614c97ac4572a862723273
+  data.tar.gz: 1c16327dfcc7d641e6405c9acedbe1dde0edb037b1bd783367dc924f9f021c3c
 SHA512:
-  metadata.gz: 348b4502d6989094798ad96470f219d2207bbf1acaeef6aeaffde67ae1d25a10efc371f6bf9c7f00a0ba64b5c0fc137bf40379bb49b547792038eee73baec9b5
-  data.tar.gz: 3b014bab2c44409f4c1c25f3359f7fc8f4ce6d00e7b1c0fcc9ac286f287e91b3309e0b51b3c29720a32668fdae636fb53e94c618e2507b3086b6e47710afa2cd
+  metadata.gz: 7b71799356977e4a517c902c260d48e2a7f404472bdff3da16b912ac06d083621f6d732a9fbdc3dc388d74730c1fc0d45bd3c916c960aa2f31d0f1393553e47e
+  data.tar.gz: 0370e335a254ea453ac7abeb17e3d9c9fb618facbf8ba667bdfa9064b7e20ec9f4a83b89ab6edf63b619fcb5b00d1218acf7ac34fd6e61d4342dc899d2dcc8d5

data/.rubocop.yml

@@ -4,7 +4,7 @@
 # See https://docs.rubocop.org/rubocop/configuration
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   Exclude:
     - 'bin/*'
     - 'tmp/*'

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 ## Changelog
 
+#### 1.5.1
+- [new] `awshark cf [command] --bucket` option allows S3 path prefix
+
+#### 1.5.0
+- [new] add `awshark ssm list` to list AWS Parameter Store secrets
+- [new] add `awshark ssm deploy` to update AWS Parameter Store secrets
+
 #### 1.4.0
-- [new] add `awshark cf save` to save Cloud Formation templates as file
+- [new] add `awshark cf save` to save AWS Cloud Formation templates as file
 
 #### 1.3.0
 - [new] add `awshark ec2 authorize` and `unauthorize`

data/awshark.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'aws-sdk-cloudformation'

data/lib/awshark/class_options.rb

@@ -11,7 +11,7 @@ module Awshark
         exit(0)
       end
 
-      setup_aws_credentials(options)
+      setup_aws_credentials(cli_options)
     end
 
     private

data/lib/awshark/cli.rb

@@ -7,6 +7,7 @@ require 'awshark/ec2/subcommand'
 require 'awshark/ecs/subcommand'
 require 'awshark/rds/subcommand'
 require 'awshark/s3/subcommand'
+require 'awshark/ssm/subcommand'
 
 module Awshark
   class Cli < Thor
@@ -15,6 +16,7 @@ module Awshark
     map '-v' => :version
 
     class_option :help, type: :boolean, desc: 'Prints this help'
+    class_option :region, type: :string, desc: 'AWS region'
 
     desc 'cf COMMAND', 'Run CloudFormation command'
     subcommand 'cf', Awshark::CloudFormation::Subcommand
@@ -31,6 +33,9 @@ module Awshark
     desc 's3 COMMAND', 'Run CloudFormation command'
     subcommand 's3', Awshark::S3::Subcommand
 
+    desc 'ssm COMMAND', 'Run SSM command'
+    subcommand 'ssm', Awshark::Ssm::Subcommand
+
     desc 'version', 'Displays current version of AwsShark'
     long_desc <<-LONGDESC
         Displays current version of AwsShark.

data/lib/awshark/cloud_formation/template.rb

@@ -11,7 +11,8 @@ module Awshark
       def initialize(path, options = {})
         @path = path
 
-        @bucket = options[:bucket]
+        @bucket_and_path = options[:bucket]
+        @bucket = (options[:bucket] || '').split('/')[0]
         @name = options[:name]
         @stage = options[:stage]
       end
@@ -77,8 +78,11 @@ module Awshark
       end
 
       def s3_key
-        # https://apidock.com/ruby/Time/strftime
-        @s3_key ||= "awshark/#{name}/#{Time.now.strftime('%Y-%m-%d')}.json"
+        return @s3_key if defined?(@s3_key)
+
+        _, *tail = @bucket_and_path.split('/')
+        prefix = [*tail, 'awshark', name].join('/')
+        @s3_key = "#{prefix}/#{Time.now.strftime('%Y-%m-%d')}.json"
       end
 
       def upload

data/lib/awshark/ssm/client.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Awshark
+  module Ssm
+    class Client
+      def list_secrets(application:)
+        response = client.get_parameters_by_path({
+                                                   path: application,
+                                                   recursive: true,
+                                                   with_decryption: true
+                                                 })
+        response.parameters
+      end
+
+      def update_secrets(application:, secrets:)
+        flat_secrets = flatten_hash(secrets)
+
+        flat_secrets.each_pair do |key, value|
+          params = {
+            name: "/#{application}/#{key.downcase}",
+            value: value,
+            type: 'SecureString', # accepts String, StringList, SecureString
+            tier: 'Standard' # accepts Standard, Advanced, Intelligent-Tiering
+          }
+
+          loop do
+            client.put_parameter(params.merge(overwrite: true))
+            puts "Updated secrets for: #{params[:name]}"
+
+            break
+          rescue Aws::SSM::Errors::ThrottlingException
+            puts 'Aws::SSM::Errors::ThrottlingException... retrying'
+            sleep 1
+          end
+        end
+      end
+
+      private
+
+      def client
+        @client ||= Aws::SSM::Client.new
+      end
+
+      # helper function
+      def flatten_hash(hash, prefix = nil)
+        hash.each_with_object({}) do |(key, value), rslt|
+          if value.is_a?(Hash)
+            rslt.merge!(flatten_hash(value, "#{prefix}#{key}_"))
+          else
+            rslt["#{prefix}#{key}"] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/awshark/ssm/subcommand.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-ssm'
+
+require 'awshark/ssm/client'
+
+module Awshark
+  module Ssm
+    class Subcommand < Thor
+      include Awshark::ClassOptions
+
+      class_option :stage, type: :string, desc: 'Stage of the configuration'
+
+      desc 'list', 'Lists Parameter Store secrets'
+      long_desc <<-LONGDESC
+        List AWS Parameter Store secrets of specific path.
+
+        awshark ssm list PARAMETER_PATH
+
+        Examples:
+
+          awshark ssm list /ticketing-api
+      LONGDESC
+      def list(parameter_path)
+        process_class_options
+
+        raise GracefulFail, 'PARAMETER_PATH must begin with a "/"' if parameter_path[0] != '/'
+
+        puts "Parameter Store #{parameter_path.inspect} in #{::Aws.config[:region]}:"
+
+        parameters = ssm_client.list_secrets(application: parameter_path)
+
+        parameters.each do |param|
+          printf " %-60<name>s %<value>s\n", { name: param.name, value: param.value }
+        end
+      rescue GracefulFail => e
+        puts e.message
+      end
+
+      desc 'deploy', 'Updates Parameter Store secrets'
+      long_desc <<-LONGDESC
+        Updates AWS Parameter Store secrets from a file "secrets.yml".
+        It assumes the directory is the name of the application.
+
+        awshark ssm deploy DIRECTORY --stage=STAGE
+
+        Examples:
+
+          awshark ssm deploy aws/ticketing-api --stage=staging
+      LONGDESC
+      def deploy(directory)
+        process_class_options
+
+        secrets_path = File.join(directory, 'secrets.yml')
+        raise GracefulFail, "File #{secrets_path} does not exist." unless File.exist?(secrets_path)
+
+        app_name = directory.split('/').last
+        stage = options['stage']
+
+        secrets = YAML.load_file(secrets_path)[stage]
+        raise GracefulFail, "No secrets found for stage '#{stage}' in #{secrets_path}." if secrets.nil?
+
+        ssm_client.update_secrets(application: "#{app_name}-#{stage}", secrets: secrets)
+      rescue GracefulFail => e
+        puts e.message
+      end
+
+      private
+
+      def ssm_client
+        @ssm_client ||= Awshark::Ssm::Client.new
+      end
+    end
+  end
+end

data/lib/awshark/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Awshark
-  VERSION = '1.4.0'
+  VERSION = '1.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awshark
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -283,6 +283,8 @@ files:
 - lib/awshark/s3/configuration.rb
 - lib/awshark/s3/manager.rb
 - lib/awshark/s3/subcommand.rb
+- lib/awshark/ssm/client.rb
+- lib/awshark/ssm/subcommand.rb
 - lib/awshark/sts/configuration.rb
 - lib/awshark/version.rb
 homepage: https://github.com/jdahlke/awshark
@@ -300,14 +302,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Custom CLI for for AWS related tasks