secret_config 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc04a5e5fea8efc7195b797bb23347e6a87eaa9a5b0eef6e8fa2e8e1882cdc1
-  data.tar.gz: 287576509e9a80f0407771d53409efd00b28a2ce59e880719e1722a78eb85039
+  metadata.gz: 41c6e3154517787c40c77442238b3d4f62d03503924f51db586ff562a0975d2f
+  data.tar.gz: 985e416b9d9e480c8dc83e5988d896605329a93f5c854d0a05331209fb1e6fd7
 SHA512:
-  metadata.gz: 2c40c7e1f92ef57be28cb714e3713169b4950abc2cc115d7dd73ea16e2e4aaf748911336bfba01c5d244ae4363f3f52d6676f240c3bdb365f6f7805684459610
-  data.tar.gz: 860ad65cc9ab5ffe34ef5506c69158d3c5107e8f8b5c1e44a09011da11d018f3c1ed23a73f66e98cf4064955c071cd7cc89dcaee780dfc1c43e2ec0c2575a469
+  metadata.gz: 417a5673810b55d39c9ae17c144da9528724ebf142a46ccdc5b02abf60a69bc6fe4ed8455007583d4bdada03fd2d27dc6e03207649df42495b84718c7bb84bd0
+  data.tar.gz: 3adae9bd474b45b0d4cc4b4780b3aaef41cdb5a52ea7dff2f4ea0261d34198f3ac7b8158dabe765b366b6a83d7e6dcc5c1a3fc798f7bec11c2366efa141ce012

data/README.md

@@ -5,11 +5,9 @@ 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,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/setting_interpolator.rb

@@ -4,16 +4,19 @@ 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.
 module SecretConfig
   class SettingInterpolator < StringInterpolator
     def date(format = "%Y%m%d")
@@ -24,8 +27,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)

data/lib/secret_config/version.rb

@@ -1,3 +1,3 @@
 module SecretConfig
-  VERSION = "0.10.2".freeze
+  VERSION = "0.10.3".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

@@ -96,6 +96,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
 

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: 0.10.3
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - reidmo@gmail.com
 executables:
@@ -63,7 +63,7 @@ homepage: https://github.com/rocketjob/secret_config
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,17 +78,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.2.3
+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