secret_config 0.10.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc04a5e5fea8efc7195b797bb23347e6a87eaa9a5b0eef6e8fa2e8e1882cdc1
-  data.tar.gz: 287576509e9a80f0407771d53409efd00b28a2ce59e880719e1722a78eb85039
+  metadata.gz: f6aad3d7382cdcfce816fb2f045f134cfd8235df19ff66eb35e50030141cd864
+  data.tar.gz: c8538b3208265fa99ea8d6cd26b1e39da4ea26ed8919af56c3e2658811690b12
 SHA512:
-  metadata.gz: 2c40c7e1f92ef57be28cb714e3713169b4950abc2cc115d7dd73ea16e2e4aaf748911336bfba01c5d244ae4363f3f52d6676f240c3bdb365f6f7805684459610
-  data.tar.gz: 860ad65cc9ab5ffe34ef5506c69158d3c5107e8f8b5c1e44a09011da11d018f3c1ed23a73f66e98cf4064955c071cd7cc89dcaee780dfc1c43e2ec0c2575a469
+  metadata.gz: 40c6e537b1098a0f977c73ffce4ddada21dd415053789861a4ab5489118cd86b912d6a4444250e7b5eefe5997079b36a0f12d127e743572958fe816afaf85dce
+  data.tar.gz: 59423883acb034d91392d79e512513a9d058e5bff590fe16b8e9385c76f6371bfe491483f2c273d9f70efc73abaae6e06aa177be94a87b37a48db85de9ab9b15

data/README.md

@@ -1,15 +1,13 @@
 # Secret Config
-[![Gem Version](https://img.shields.io/gem/v/secret_config.svg)](https://rubygems.org/gems/secret_config) [![Build Status](https://travis-ci.org/rocketjob/secret_config.svg?branch=master)](https://travis-ci.org/rocketjob/secret_config) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
+[![Gem Version](https://img.shields.io/gem/v/secret_config.svg)](https://rubygems.org/gems/secret_config) [![Build Status](https://github.com/rocketjob/secret_config/workflows/build/badge.svg)](https://github.com/rocketjob/secret_config/actions?query=workflow%3Abuild) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
 
 Centralized Configuration and Secrets Management for Ruby and Rails applications.
 
 Securely store configuration information centrally, supporting multiple tenants of the same application.
 
-Checkout https://config.rocketjob.io/
-
 ## Documentation
 
-* [Guide](https://config.rocketjob.io/)
+* [Secret Config](https://config.rocketjob.io/)
 
 ## Support
 

data/lib/secret_config/cli.rb

@@ -359,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

@@ -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,19 +23,25 @@ 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
 
       def fetch_path(path)
-        config = YAML.load(ERB.new(::File.new(file_name).read).result)
+        config = load_yaml(ERB.new(::File.new(file_name).read).result)
 
         paths = path.sub(%r{\A/*}, "").sub(%r{/*\Z}, "").split("/")
         config.dig(*paths)
       end
+
+      def load_yaml(src)
+        return YAML.safe_load(src, permitted_classes: [Symbol], aliases: true) if Psych::VERSION > "4.0"
+
+        YAML.load(src)
+      end
     end
   end
 end

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
@@ -154,7 +154,7 @@ module SecretConfig
     def convert_type(type, value)
       case type
       when :string
-        value.to_s
+        value.nil? ? nil : value.to_s
       when :integer
         value.to_i
       when :float

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/version.rb

@@ -1,3 +1,3 @@
 module SecretConfig
-  VERSION = "0.10.2".freeze
+  VERSION = "1.0.0".freeze
 end

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

@@ -47,6 +47,14 @@ class SecretConfigTest < Minitest::Test
         assert_equal "secret_config_test", SecretConfig.fetch("mysql/database")
       end
 
+      it "fetches with default" do
+        assert_equal "default", SecretConfig.fetch("mysql/unknown", default: "default")
+      end
+
+      it "fetches with default of nil" do
+        assert_nil SecretConfig.fetch("mysql/unknown", default: nil)
+      end
+
       it "can be overridden by an environment variable" do
         ENV["MYSQL_DATABASE"] = "other"
 
@@ -96,6 +104,5 @@ class SecretConfigTest < Minitest::Test
         assert_equal true, database
       end
     end
-
   end
 end

data/test/setting_interpolator_test.rb

@@ -101,8 +101,15 @@ module SecretConfig
 
         it "handles missing ENV var" do
           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
 
@@ -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

data/test/test_helper.rb

@@ -4,6 +4,6 @@ require "yaml"
 require "minitest/autorun"
 require "minitest/reporters"
 require "secret_config"
-require "awesome_print"
+require "amazing_print"
 
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret_config
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,9 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
-- reidmo@gmail.com
 executables:
 - secret-config
 extensions: []
@@ -59,11 +58,11 @@ files:
 - test/setting_interpolator_test.rb
 - test/test_helper.rb
 - test/utils_test.rb
-homepage: https://github.com/rocketjob/secret_config
+homepage: https://config.rocketjob.io
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,17 +77,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Centralized Configuration and Secrets Management for Ruby and Rails applications.
 test_files:
 - test/config/application.yml
-- test/providers/ssm_test.rb
+- test/parser_test.rb
 - test/providers/file_test.rb
+- test/providers/ssm_test.rb
 - test/registry_test.rb
+- test/secret_config_test.rb
 - test/setting_interpolator_test.rb
-- test/parser_test.rb
 - test/test_helper.rb
 - test/utils_test.rb
-- test/secret_config_test.rb