firespring_dev_commands 2.1.1.pre.alpha.5 → 2.1.2.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e54929040a40491ff1d2b36af03da9c718e2770a507cf29f62ab7b24993b8d8
-  data.tar.gz: da2feb3080c1864f22b988b9898a08408c874e29251be018b7f82f7290d5a922
+  metadata.gz: a3db1999f6439e25498a7a5dc84b96d7191cea3be8210382d8302502d07cae3d
+  data.tar.gz: 4be9c55b74b4bfcee808d4ce888a39ba9bb8db3598ae0421a67bf86628bf5983
 SHA512:
-  metadata.gz: bd65f5fb950c89f42cbb761c39241a0f6fd414f99c22e3b8ae6800bc1361ba46b104dd70e1a890477789db04750d14ab8529db53be96e8917f16d4424b2daa46
-  data.tar.gz: 85dd595b1e98265d75c41d24d3a98e72dbafa4d1fd112a04849d37061441251e5018a8295ab38486ccc78622052af98c0e111c0fc3498bf221d06072703be3b7
+  metadata.gz: c4221e8f43391c3e7db66a6e46bf4b60baa7d4524cc4e0706529f18599c29ec69490be451339a45926ff0d26200d517d2af25451c5535c92ff91515c135e9c57
+  data.tar.gz: 2874a653490e414a00a0e6ff94c12bb1ce7e29d65218b1b7e90b04cebaa801bf7dde1fe53bdb2d0770bb15dfc6dc815cdaa4fe069a62d861a2dec7e7032fca46

data/lib/firespring_dev_commands/aws/account.rb

@@ -23,6 +23,7 @@ module Dev
       # The name of the file containing the Aws settings
       CONFIG_FILE = "#{Dev::Aws::CONFIG_DIR}/config".freeze
 
+      # Returns the config ini file associated with this object
       def self.config_ini
         IniFile.new(filename: CONFIG_FILE, default: 'default')
       end

data/lib/firespring_dev_commands/aws/credentials.rb

@@ -11,6 +11,7 @@ module Dev
       # The local file where temporary credentials are stored
       CONFIG_FILE = "#{Dev::Aws::CONFIG_DIR}/credentials".freeze
 
+      # Returns the config ini file associated with this object
       def self.config_ini
         IniFile.new(filename: CONFIG_FILE, default: 'default')
       end

data/lib/firespring_dev_commands/common.rb

@@ -89,8 +89,8 @@ module Dev
       true
     end
 
-    # Remove all leading non '{' characters
-    # Remove all trailing non '}' characters
+    # Remove all leading non left-curly-brace characters
+    # Remove all trailing non right-curly-brace characters
     def strip_non_json(str)
       str.sub(/\A[^{]*{/m, '{').sub(/}[^}]*\z/m, '}')
     end

data/lib/firespring_dev_commands/slack/global.rb

@@ -3,21 +3,26 @@ require 'dotenv'
 
 module Dev
   class Slack
+    # A class to manage slack global configuration settings
     class Global
       # The filename where we store the local auth information
       CONFIG_FILE = "#{Dir.home}/.env.slack".freeze
 
+      # The name of the environmental setting which holds the slack token
       SLACK_API_TOKEN = 'SLACK_API_TOKEN'.freeze
 
+      # Method to load the slack config file and then configure slack
       def configure
         # Always load the env slack auth
         Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
 
         ::Slack.configure do |c|
-          c.token = ENV.fetch('SLACK_API_TOKEN', nil)
+          c.token = ENV.fetch(SLACK_API_TOKEN, nil)
           c.logger = LOG if ENV['ENABLE_SLACK_DEBUG'].to_s.strip == 'true'
         end
       end
+
+      # Run the configure when creating this class to load any existing settings
       new.configure
 
       # Write the new slack auth value to the env file

data/lib/firespring_dev_commands/slack.rb

@@ -1,18 +1,23 @@
 require 'slack'
 
 module Dev
+  # The main slack class for posting/uploading messages
   class Slack
+    # The attribute which contains the underlying slack web client object
     attr_accessor :client
 
+    # Create a new slack web client and make sure it has valid credentials
     def initialize
       @client = ::Slack::Web::Client.new
       @client.auth_test
     end
 
+    # Post the text to the given channel
     def post(channel:, text:)
       client.chat_postMessage(channel:, text:)
     end
 
+    # Upload the text to the give channel as a text file
     def upload_text(channel:, text:, title: 'Text File', filename: 'file.txt')
       raise 'text should be a string' unless text.is_a?(String)
 

data/lib/firespring_dev_commands/templates/config.rb

@@ -6,11 +6,14 @@ module Dev
     class Application
       # Contains rake tasks for displaying and setting application variables in parameter store
       class Config < Dev::Template::ApplicationInterface
-        attr_reader :path
+        attr_reader :path_prefix, :key_parameter_path
+
+        # Allow for custom config path_prefix for the application
+        # Allow for custom key parameter path (otherwise base it off the path prefix)
+        def initialize(name, path_prefix, key_parameter_path: nil, exclude: [])
+          @path_prefix = path_prefix
+          @key_parameter_path = key_parameter_path || "#{path_prefix}/kms/id"
 
-        # Allow for custom config path for the application
-        def initialize(name, path, exclude: [])
-          @path = path
           super(name, exclude:)
         end
 
@@ -18,7 +21,7 @@ module Dev
         def create_list_task!
           # Have to set a local variable to be accessible inside of the instance_eval block
           application = @name
-          path = @path
+          path_prefix = @path_prefix
           exclude = @exclude
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -29,7 +32,7 @@ module Dev
                 desc "List all #{application} configs"
                 task list: %w(init) do
                   puts
-                  Dev::Aws::Parameter.new.list(path).each do |it|
+                  Dev::Aws::Parameter.new.list(path_prefix).each do |it|
                     puts "  #{it.name} => #{it.value} (#{it.type})"
                   end
                   puts
@@ -44,7 +47,8 @@ module Dev
         def create_set_task!
           # Have to set a local variable to be accessible inside of the instance_eval block
           application = @name
-          path = @path
+          path_prefix = @path_prefix
+          key_parameter_path = @key_parameter_path
           exclude = @exclude
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -58,7 +62,7 @@ module Dev
                      "\n\toptionally specify ENCRYPT=true to change a String type to a SecureString type"
                 task set: %w(ensure_aws_credentials) do
                   raise 'NAME is required' if ENV['NAME'].to_s.strip.blank?
-                  raise 'NAME is not found in this apps parameters' if Dev::Aws::Parameter.new.list(path).none? { |it| it.name == ENV['NAME'] }
+                  raise 'NAME is not found in this apps parameters' if Dev::Aws::Parameter.new.list(path_prefix).none? { |it| it.name == ENV['NAME'] }
                   raise 'VALUE is required' if ENV['VALUE'].to_s.strip.blank?
 
                   param_path = ENV.fetch('NAME', nil)
@@ -68,7 +72,7 @@ module Dev
                   params = {type: 'String'}
                   if ENV['ENCRYPT'].to_s.strip == 'true' || old_value.type == 'SecureString'
                     params[:type] = 'SecureString'
-                    params[:key_id] = Dev::Aws::Parameter.new.get_value("#{path}/kms/id")
+                    params[:key_id] = Dev::Aws::Parameter.new.get_value(key_parameter_path)
                   end
 
                   message = 'This will change '.light_green +

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.1.1.pre.alpha.5'.freeze
+    VERSION = '2.1.2.pre.alpha.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.1.pre.alpha.5
+  version: 2.1.2.pre.alpha.1
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport