ssm_params_loader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8a68deb19396ec5e6408a733d2a279d499b9c71adba02fa75f7f3b4d812f4ce
+  data.tar.gz: 023eb7cce06eb9de920f90e0ea504fd66a764bc8a55c6f0bf92c4513588e95d9
+SHA512:
+  metadata.gz: a5e8eb20335f4443fcf1410ab51679c67a0b1f3f63f6d26ccfe74f2f2cda33439a010983462922fdc75529a660dc6f41479cfc65d6ad171cb096453f05477ac8
+  data.tar.gz: 1202103d4d03b52059df4c126d48f0c87d5f3119d9696a6f461d542202903b75e220745bff551b0ef2c4e9687a6526dcb92f92699baa0a30528e047ceec422ac

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2006-2024 Olseksii Samoliuk
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/ssm_params_loader

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+# In a future, maybe :)
+puts "hi :)"

data/lib/generators/ssm_params_loader/install_generator.rb

@@ -0,0 +1,25 @@
+module SsmParamsLoader
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Generates the SSM Params Loader config file."
+
+      def self.source_root
+        @_config_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def copy_settings
+        template "config.yml", "config/ssm_params_loader.yml"
+      end
+
+      def modify_gitignore
+        create_file '.gitignore' unless File.exist? '.gitignore'
+
+        append_to_file '.gitignore' do
+          "\n" +
+            "# Ignore SSM Params Loader config file\n" +
+            "config/ssm_params_loader.yml\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/ssm_params_loader/templates/config.yml

@@ -0,0 +1,9 @@
+# Path to a SSM parameters
+ssm_store_path: '' # Ex: /MyApp/production
+
+# Additional static secrets list
+# If a name is equal to a name obtained from the SSM, the value from the SSM
+# is overwritten by a value from this list.
+additional_vars: [ ]
+#  - name: secrets_attachment_scan_host
+#    value: zzzz

data/lib/ssm_params_loader/load.rb

@@ -0,0 +1,74 @@
+require 'aws-sdk-ssm'
+
+module SsmParamsLoader
+  def self.fetch_params(config_file = nil)
+
+    config_file = config_file || default_config_file
+
+    unless File.exist?(config_file)
+      # puts "SSM Params Loader config file #{config_file} not found"
+      return
+    end
+
+    config = YAML.safe_load_file(config_file).with_indifferent_access
+
+    ssm_path = config[:ssm_store_path] || nil
+    additional = config[:additional_vars] || nil
+
+    # Get secrets and set environment variables
+    environments = load_secrets(ssm_path, additional)
+    environments.each { |secret| ENV["SSM_#{secret[:name].gsub('-', '_').upcase}"] = secret[:value] }
+  end
+
+  private
+
+  # Setup the default path to the config file
+  def self.default_config_file
+    ::Rails.root.join('config/ssm_params_loader.yml')
+  end
+
+  # Get a hash array of secrets
+  def self.load_secrets(ssm_path, additional)
+    secrets = []
+
+    unless ssm_path.nil?
+      secrets += from_ssm(ssm_path)
+    end
+
+    unless additional.nil?
+      secrets += additional_variables(additional)
+    end
+
+    secrets
+  end
+
+  # Get a hash array of secrets from the SSM
+  def self.from_ssm(ssm_path)
+    ssm_data = []
+    ssm = Aws::SSM::Client.new
+    ssm.get_parameters_by_path(
+      path: ssm_path,
+      with_decryption: true
+    ).each do |response|
+      ssm_data.push(*response['parameters'])
+    end
+
+    variables = []
+
+    ssm_data.each do |secret|
+      variables << { :name => secret.name.split('/')[-1], :value => secret.value }
+    end
+
+    variables
+  end
+
+  # Get a hash array of secrets from the config file (the `additional` section)
+  def self.additional_variables(additional_variables)
+    variables = []
+    additional_variables.each do |var|
+      variables << { :name => var['name'], :value => var['value'] }
+    end
+
+    variables
+  end
+end

data/lib/ssm_params_loader/version.rb

@@ -0,0 +1,3 @@
+module SsmParamsLoader
+  VERSION = '0.0.1'
+end

data/lib/ssm_params_loader.rb

@@ -0,0 +1,13 @@
+require_relative 'ssm_params_loader/load'
+
+module SsmParamsLoader
+  module Rails
+    class Railtie < ::Rails::Railtie
+      def setup_environment_variables
+        SsmParamsLoader.fetch_params
+      end
+
+      config.before_initialize { setup_environment_variables }
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ssm_params_loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oleksii Samoliuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.165.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.165.0
+description: Preloads AWS SSM parameters as an environment variables
+email:
+- work@yousysadmin.com
+executables:
+- ssm_params_loader
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bin/ssm_params_loader
+- lib/generators/ssm_params_loader/install_generator.rb
+- lib/generators/ssm_params_loader/templates/config.yml
+- lib/ssm_params_loader.rb
+- lib/ssm_params_loader/load.rb
+- lib/ssm_params_loader/version.rb
+homepage: https://github.com/yousysadmin/rails_ssm_params_loader
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+  github_repo: https://github.com/yousysadmin/rails_ssm_params_loader
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Rails application parameters preloader
+test_files: []