secret_config 0.9.1 → 0.10.4

data/lib/secret_config.rb

@@ -97,5 +97,5 @@ module SecretConfig
   end
 
   @check_env_var = true
-  @filters       = [/password/i, /key\Z/i, /passphrase/i]
+  @filters       = [/password/i, /key\Z/i, /passphrase/i, /secret/i, /pwd\Z/i]
 end

data/lib/secret_config/cli.rb

@@ -210,7 +210,13 @@ module SecretConfig
         begin
           case provider
           when :ssm
-            Providers::Ssm.new(key_id: key_id, key_alias: key_alias)
+            if key_alias
+              Providers::Ssm.new(key_alias: key_alias)
+            elsif key_id
+              Providers::Ssm.new(key_id: key_id)
+            else
+              Providers::Ssm.new
+            end
           else
             raise ArgumentError, "Invalid provider: #{provider}"
           end
@@ -353,16 +359,16 @@ module SecretConfig
             # Ignore filtered values
             if (value != target[key].to_s) && (value != FILTERED)
               puts "#{Colors::KEY}#{key}:"
-              puts "#{Colors::REMOVE}#{prefix_lines("- ", target[key])}"
-              puts "#{Colors::ADD}#{prefix_lines("+ ", source[key])}#{Colors::CLEAR}\n\n"
+              puts "#{Colors::REMOVE}#{prefix_lines('- ', target[key])}"
+              puts "#{Colors::ADD}#{prefix_lines('+ ', source[key])}#{Colors::CLEAR}\n\n"
             end
           else
             puts "#{Colors::KEY}#{key}:"
-            puts "#{Colors::REMOVE}#{prefix_lines("- ", target[key])}\n\n"
+            puts "#{Colors::REMOVE}#{prefix_lines('- ', target[key])}\n\n"
           end
         elsif source.key?(key)
           puts "#{Colors::KEY}#{key}:"
-          puts "#{Colors::ADD}#{prefix_lines("+ ", source[key])}#{Colors::CLEAR}\n\n"
+          puts "#{Colors::ADD}#{prefix_lines('+ ', source[key])}#{Colors::CLEAR}\n\n"
         end
       end
     end

data/lib/secret_config/config.rb

@@ -5,31 +5,45 @@ module SecretConfig
     def_delegator :registry, :refresh!
 
     def initialize(path, registry)
+      raise(ArgumentError, "path cannot be nil") if path.nil?
+
       @path     = path
       @registry = registry
     end
 
     def fetch(sub_path, **options)
+      raise(ArgumentError, "sub_path cannot be nil") if sub_path.nil?
+
       registry.fetch(join_path(sub_path), **options)
     end
 
     def [](sub_path)
+      raise(ArgumentError, "sub_path cannot be nil") if sub_path.nil?
+
       registry[join_path(sub_path)]
     end
 
     def []=(sub_path, value)
+      raise(ArgumentError, "sub_path cannot be nil") if sub_path.nil?
+
       registry[join_path(sub_path)] = value
     end
 
     def key?(sub_path)
+      raise(ArgumentError, "sub_path cannot be nil") if sub_path.nil?
+
       registry.key?(join_path(sub_path))
     end
 
     def set(sub_path, value)
+      raise(ArgumentError, "sub_path cannot be nil") if sub_path.nil?
+
       registry.set(join_path(sub_path), value)
     end
 
     def delete(sub_path)
+      raise(ArgumentError, "sub_path cannot be nil") if sub_path.nil?
+
       registry.delete(join_path(sub_path))
     end
 

data/lib/secret_config/errors.rb

@@ -5,6 +5,9 @@ module SecretConfig
   class MissingMandatoryKey < Error
   end
 
+  class MissingEnvironmentVariable < Error
+  end
+
   class UndefinedRootError < Error
   end
 

data/lib/secret_config/parser.rb

@@ -15,7 +15,7 @@ module SecretConfig
     # Keys are returned with path names relative to the supplied path.
     def parse(key, value)
       relative_key       = relative_key?(key) ? key : key.sub("#{path}/", "")
-      value              = interpolator.parse(value) if interpolator && value.is_a?(String) && value.include?("%{")
+      value              = interpolator.parse(value) if interpolator && value.is_a?(String) && value.include?("${")
       tree[relative_key] = value
     end
 
@@ -38,11 +38,11 @@ module SecretConfig
     # - Imports cannot reference other imports at this time.
     def apply_imports
       tree.keys.each do |key|
-        next unless (key =~ /\/__import__\Z/) || (key == "__import__")
+        next unless (key =~ %r{/__import__\Z}) || (key == "__import__")
 
         import_key = tree.delete(key)
-        key, _     = ::File.split(key)
-        key        = nil if key == "."
+        key, = ::File.split(key)
+        key = nil if key == "."
 
         # binding.irb
 
@@ -51,7 +51,7 @@ module SecretConfig
 
         if relative_key?(import_key)
           tree.keys.each do |current_key|
-            match = current_key.match(/\A#{import_key}\/(.*)/)
+            match = current_key.match(%r{\A#{import_key}/(.*)})
             next unless match
 
             imported_key       = key.nil? ? match[1] : ::File.join(key, match[1])
@@ -71,6 +71,5 @@ module SecretConfig
     def relative_key?(key)
       !key.start_with?("/")
     end
-
   end
 end

data/lib/secret_config/providers/file.rb

@@ -23,9 +23,9 @@ module SecretConfig
       end
 
       # Returns the value or `nil` if not found
-      def fetch(key)
+      def fetch(_key)
         values = fetch_path(path)
-        value.is_a?(Hash) ? nil : value
+        values.is_a?(Hash) ? nil : values
       end
 
       private

data/lib/secret_config/registry.rb

@@ -98,7 +98,7 @@ module SecretConfig
       end
 
       # Remove keys deleted from the central registry.
-      (existing_keys - updated_keys).each { |key| provider.delete(key) }
+      (existing_keys - updated_keys).each { |key| cache.delete(key) }
 
       true
     end

data/lib/secret_config/setting_interpolator.rb

@@ -4,16 +4,22 @@ require "securerandom"
 # * SecretConfig Interpolations
 #
 # Expanding values inline for date, time, hostname, pid and random values.
-#   %{date}           # Current date in the format of "%Y%m%d" (CCYYMMDD)
-#   %{date:format}    # Current date in the supplied format. See strftime
-#   %{time}           # Current date and time down to ms in the format of "%Y%m%d%Y%H%M%S%L" (CCYYMMDDHHMMSSmmm)
-#   %{time:format}    # Current date and time in the supplied format. See strftime
-#   %{env:name}       # Extract value from the named environment value.
-#   %{hostname}       # Full name of this host.
-#   %{hostname:short} # Short name of this host. Everything up to the first period.
-#   %{pid}            # Process Id for this process.
-#   %{random}         # URL safe Random 32 byte value.
-#   %{random:size}    # URL safe Random value of `size` bytes.
+#   ${date}             # Current date in the format of "%Y%m%d" (CCYYMMDD)
+#   ${date:format}      # Current date in the supplied format. See strftime
+#   ${time}             # Current date and time down to ms in the format of "%Y%m%d%Y%H%M%S%L" (CCYYMMDDHHMMSSmmm)
+#   ${time:format}      # Current date and time in the supplied format. See strftime
+#   ${env:name}         # Extract value from the named environment value.
+#                       #   Raises SecretConfig::MissingEnvironmentVariable when the env var is not defined.
+#   ${env:name,default} # Extract value from the named environment value.
+#                       #   Returns the supplied default value when the env var is not defined.
+#   ${hostname}         # Full name of this host.
+#   ${hostname:short}   # Short name of this host. Everything up to the first period.
+#   ${pid}              # Process Id for this process.
+#   ${random}           # URL safe Random 32 byte value.
+#   ${random:size}      # URL safe Random value of `size` bytes.
+#   ${select:a,b,c,d}   # Randomly select one of the supplied values. A new new value is selected on restart or refresh.
+#                       # Values are separated by `,` and cannot include `,` in their values.
+#                       # Values are stripped of leading and trailing spaces.
 module SecretConfig
   class SettingInterpolator < StringInterpolator
     def date(format = "%Y%m%d")
@@ -24,8 +30,12 @@ module SecretConfig
       Time.now.strftime(format)
     end
 
-    def env(name)
-      ENV[name]
+    def env(name, default = :no_default_supplied)
+      return ENV[name] if ENV.key?(name)
+
+      return default unless default == :no_default_supplied
+
+      raise(MissingEnvironmentVariable, "Missing mandatory environment variable: #{name}")
     end
 
     def hostname(format = nil)
@@ -41,5 +51,14 @@ module SecretConfig
     def random(size = 32)
       SecureRandom.urlsafe_base64(size)
     end
+
+    # Empty values return nil which removes the key entirely from the config
+    def select(*values)
+      if values.size < 2
+        raise(ConfigurationError, "Must supply at least 2 options when using select: #{values.inspect}")
+      end
+
+      values[SecureRandom.random_number(values.count)]
+    end
   end
 end

data/lib/secret_config/string_interpolator.rb

@@ -1,4 +1,4 @@
-# Parse strings containing %{key:value1,value2,value3}
+# Parse strings containing ${key:value1,value2,value3}
 # Where `key` is a method implemented by a class inheriting from this class
 #
 # The following `key`s are reserved:
@@ -6,20 +6,20 @@
 # * initialize
 #
 # Notes:
-# * To prevent interpolation use %%{...}
-# * %% is not touched, only %{...} is identified.
+# * To prevent interpolation use $${...}
+# * $$ is not touched, only ${...} is identified.
 module SecretConfig
   class StringInterpolator
     def initialize(pattern = nil)
-      @pattern = pattern || /%{1,2}\{([^}]+)\}/
+      @pattern = pattern || /\${1,2}\{([^}]+)\}/
     end
 
     def parse(string)
-      string.gsub(/%{1,2}\{([^}]+)\}/) do |match|
-        if match.start_with?("%%")
+      string.gsub(/\${1,2}\{([^}]+)\}/) do |match|
+        if match.start_with?("$$")
           match[1..-1]
         else
-          expr          = Regexp.last_match(1) || Regexp.last_match(2) || match.tr("%{}", "")
+          expr          = Regexp.last_match(1) || Regexp.last_match(2) || match.tr("${}", "")
           key, args_str = expr.split(":")
           key           = key.strip.to_sym
           arguments     = args_str&.split(",")&.map { |v| v.strip == "" ? nil : v.strip } || []

data/lib/secret_config/utils.rb

@@ -7,7 +7,7 @@ module SecretConfig
         if key == NODE_KEY
           yield(path, value)
         else
-          name = path.nil? ? key : "#{path}/#{key}"
+          name = path.nil? ? key : File.join(path, key)
           value.is_a?(Hash) ? flatten_each(value, name, &block) : yield(name, value)
         end
       end

data/lib/secret_config/version.rb

@@ -1,3 +1,3 @@
 module SecretConfig
-  VERSION = "0.9.1".freeze
+  VERSION = "0.10.4".freeze
 end

data/test/config/application.yml

@@ -45,7 +45,7 @@ test:
     mongo:
       database:   secret_config_test
       primary:    127.0.0.1:27017
-      secondary:  "%{hostname}:27018"
+      secondary:  "${hostname}:27018"
 
     secrets:
       secret_key_base: somereallylongteststring
@@ -59,15 +59,15 @@ test:
         key:     key0
 
     mysql:
-#      database:   "%{fetch: /test/my_application/mysql/database }"
+#      database:   "${fetch: /test/my_application/mysql/database }"
       username:   other
       password:   otherrules
-      host:       "%{hostname}"
+      host:       "${hostname}"
 
     mongo:
       database:   secret_config_test
       primary:    localhost:27017
-      secondary:  "%{hostname}:27018"
+      secondary:  "${hostname}:27018"
 
     mongo2:
       __import__: mongo

data/test/parser_test.rb

@@ -26,7 +26,7 @@ class ParserTest < Minitest::Test
     #
     # Retrieve values elsewhere in the registry.
     # Paths can be relative to the current root, or absolute paths outside the current root.
-    #   %{fetch:key}      # Fetches a single value from a relative or absolute path
+    #   ${fetch:key}      # Fetches a single value from a relative or absolute path
     # Return the value of the supplied key.
     #
     # With a relative key, look for the value in the current registry.
@@ -47,7 +47,7 @@ class ParserTest < Minitest::Test
     #   end
     # end
 
-    #   %{import:path}    # Imports a path of keys and values into the current path
+    #   ${import:path}    # Imports a path of keys and values into the current path
     # Replace the current value with a tree of values with the supplied path.
     #
     describe "#import" do

data/test/providers/file_test.rb

@@ -15,7 +15,7 @@ module Providers
         {
           "/test/my_application/mongo/database"               => "secret_config_test",
           "/test/my_application/mongo/primary"                => "127.0.0.1:27017",
-          "/test/my_application/mongo/secondary"              => "%{hostname}:27018",
+          "/test/my_application/mongo/secondary"              => "${hostname}:27018",
           "/test/my_application/mysql/database"               => "secret_config_test",
           "/test/my_application/mysql/password"               => "secret_configrules",
           "/test/my_application/mysql/username"               => "secret_config",

data/test/providers/ssm_test.rb

@@ -15,7 +15,7 @@ module Providers
         {
           "/test/my_application/mongo/database"               => "secret_config_test",
           "/test/my_application/mongo/primary"                => "127.0.0.1:27017",
-          "/test/my_application/mongo/secondary"              => "%{hostname}:27018",
+          "/test/my_application/mongo/secondary"              => "${hostname}:27018",
           "/test/my_application/mysql/database"               => "secret_config_test",
           "/test/my_application/mysql/password"               => "secret_configrules",
           "/test/my_application/mysql/username"               => "secret_config",

data/test/registry_test.rb

@@ -132,12 +132,12 @@ class RegistryTest < Minitest::Test
 
         it "of integers" do
           value = registry.fetch("mysql/ports", type: :integer, separator: ",")
-          assert_equal([12345, 5343, 26815], value)
+          assert_equal([12_345, 5343, 26_815], value)
         end
 
         it "of integers with spaces" do
           value = registry.fetch("mysql/ports2", type: :integer, separator: ",")
-          assert_equal([12345, 5343, 26815], value)
+          assert_equal([12_345, 5343, 26_815], value)
         end
 
         it "accepts a default without requiring conversion" do

data/test/secret_config_test.rb

@@ -96,6 +96,5 @@ class SecretConfigTest < Minitest::Test
         assert_equal true, database
       end
     end
-
   end
 end

data/test/setting_interpolator_test.rb

@@ -6,23 +6,23 @@ module SecretConfig
 
       describe "#parse" do
         it "handles good key" do
-          string   = "Set a date of %{date} here."
-          expected = string.gsub("%{date}", Date.today.strftime("%Y%m%d"))
+          string   = "Set a date of ${date} here."
+          expected = string.gsub("${date}", Date.today.strftime("%Y%m%d"))
           actual   = interpolator.parse(string)
           assert_equal expected, actual, string
         end
 
         it "handles multiple keys" do
-          string   = "%{pid}: Set a date of %{date} here and a %{time:%H%M} here and for luck %{pid}"
-          expected = string.gsub("%{date}", Date.today.strftime("%Y%m%d"))
-          expected = expected.gsub("%{time:%H%M}", Time.now.strftime("%H%M"))
-          expected = expected.gsub("%{pid}", $$.to_s)
+          string   = "${pid}: Set a date of ${date} here and a ${time:%H%M} here and for luck ${pid}"
+          expected = string.gsub("${date}", Date.today.strftime("%Y%m%d"))
+          expected = expected.gsub("${time:%H%M}", Time.now.strftime("%H%M"))
+          expected = expected.gsub("${pid}", $$.to_s)
           actual   = interpolator.parse(string)
           assert_equal expected, actual, string
         end
 
         it "handles bad key" do
-          string = "Set a date of %{blah} here."
+          string = "Set a date of ${blah} here."
           assert_raises InvalidInterpolation do
             interpolator.parse(string)
           end
@@ -31,22 +31,22 @@ module SecretConfig
 
       describe "#date" do
         it "interpolates date only" do
-          string   = "%{date}"
+          string   = "${date}"
           expected = Date.today.strftime("%Y%m%d")
           actual   = interpolator.parse(string)
           assert_equal expected, actual, string
         end
 
         it "interpolates date" do
-          string   = "Set a date of %{date} here."
-          expected = string.gsub("%{date}", Date.today.strftime("%Y%m%d"))
+          string   = "Set a date of ${date} here."
+          expected = string.gsub("${date}", Date.today.strftime("%Y%m%d"))
           actual   = interpolator.parse(string)
           assert_equal expected, actual, string
         end
 
         it "interpolates date with custom format" do
-          string   = "Set a custom %{date:%m%d%Y} here."
-          expected = string.gsub("%{date:%m%d%Y}", Date.today.strftime("%m%d%Y"))
+          string   = "Set a custom ${date:%m%d%Y} here."
+          expected = string.gsub("${date:%m%d%Y}", Date.today.strftime("%m%d%Y"))
           actual   = interpolator.parse(string)
           assert_equal expected, actual, string
         end
@@ -54,7 +54,7 @@ module SecretConfig
 
       describe "#time" do
         it "interpolates time only" do
-          string = "%{time}"
+          string = "${time}"
           time   = Time.now
           Time.stub(:now, time) do
             expected = Time.now.strftime("%Y%m%d%H%M%S%L")
@@ -64,18 +64,18 @@ module SecretConfig
         end
 
         it "interpolates time" do
-          string = "Set a time of %{time} here."
+          string = "Set a time of ${time} here."
           time   = Time.now
           Time.stub(:now, time) do
-            expected = string.gsub("%{time}", Time.now.strftime("%Y%m%d%H%M%S%L"))
+            expected = string.gsub("${time}", Time.now.strftime("%Y%m%d%H%M%S%L"))
             actual   = interpolator.parse(string)
             assert_equal expected, actual, string
           end
         end
 
         it "interpolates time with custom format" do
-          string   = "Set a custom time of %{time:%H%M} here."
-          expected = string.gsub("%{time:%H%M}", Time.now.strftime("%H%M"))
+          string   = "Set a custom time of ${time:%H%M} here."
+          expected = string.gsub("${time:%H%M}", Time.now.strftime("%H%M"))
           actual   = interpolator.parse(string)
           assert_equal expected, actual, string
         end
@@ -87,34 +87,41 @@ module SecretConfig
         end
 
         it "fetches existing ENV var" do
-          string = "%{env:TEST_SETTING}"
+          string = "${env:TEST_SETTING}"
           actual = interpolator.parse(string)
           assert_equal "Secret", actual, string
         end
 
         it "fetches existing ENV var into a larger string" do
-          string   = "Hello %{env:TEST_SETTING}. How are you?"
+          string   = "Hello ${env:TEST_SETTING}. How are you?"
           actual   = interpolator.parse(string)
-          expected = string.gsub("%{env:TEST_SETTING}", "Secret")
+          expected = string.gsub("${env:TEST_SETTING}", "Secret")
           assert_equal expected, actual, string
         end
 
         it "handles missing ENV var" do
-          string = "%{env:OTHER_TEST_SETTING}"
+          string = "${env:OTHER_TEST_SETTING}"
+          assert_raises SecretConfig::MissingEnvironmentVariable do
+            interpolator.parse(string)
+          end
+        end
+
+        it "uses default value for missing ENV var" do
+          string = "${env:OTHER_TEST_SETTING,My default value}"
           actual = interpolator.parse(string)
-          assert_equal "", actual, string
+          assert_equal "My default value", actual, string
         end
       end
 
       describe "#hostname" do
         it "returns hostname" do
-          string = "%{hostname}"
+          string = "${hostname}"
           actual = interpolator.parse(string)
           assert_equal Socket.gethostname, actual, string
         end
 
         it "returns short hostname" do
-          string = "%{hostname:short}"
+          string = "${hostname:short}"
           actual = interpolator.parse(string)
           assert_equal Socket.gethostname.split(".")[0], actual, string
         end
@@ -122,7 +129,7 @@ module SecretConfig
 
       describe "#pid" do
         it "returns process id" do
-          string = "%{pid}"
+          string = "${pid}"
           actual = interpolator.parse(string)
           assert_equal $$.to_s, actual, string
         end
@@ -130,7 +137,7 @@ module SecretConfig
 
       describe "#random" do
         it "interpolates random 32 byte string" do
-          string = "%{random}"
+          string = "${random}"
           random = SecureRandom.urlsafe_base64(32)
           SecureRandom.stub(:urlsafe_base64, random) do
             actual = interpolator.parse(string)
@@ -139,7 +146,7 @@ module SecretConfig
         end
 
         it "interpolates custom length random string" do
-          string = "%{random:64}"
+          string = "${random:64}"
           random = SecureRandom.urlsafe_base64(64)
           SecureRandom.stub(:urlsafe_base64, random) do
             actual = interpolator.parse(string)
@@ -147,6 +154,28 @@ module SecretConfig
           end
         end
       end
+
+      describe "#select" do
+        it "randomly selects one of the supplied values" do
+          string = "${select:one, two,three}"
+          actual = interpolator.parse(string)
+          assert %w[one two three].include?(actual), actual
+        end
+
+        it "fails when less than 2 options are supplied" do
+          string = "${select:one}"
+          assert_raises ConfigurationError do
+            interpolator.parse(string)
+          end
+        end
+
+        it "fails when no options are supplied" do
+          string = "${select}"
+          assert_raises ConfigurationError do
+            interpolator.parse(string)
+          end
+        end
+      end
     end
   end
 end