secret_config 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47df861628f00f577131640a7d0be5ba01684714e1705b9e322458d662f89eb6
-  data.tar.gz: 0fc3d93a9a56e2796deb3db4bc5876e4b388592ce7e2afc22aa18bf4753908cf
+  metadata.gz: 12a8839c538b55ac74ff2db06cf2f25e1f711d005fd31f55f1308389c5224875
+  data.tar.gz: 630667a4ff3ad4bf2a8e61786454fc2375c575235ea78aabac5743575f00a966
 SHA512:
-  metadata.gz: '08d5f6570918343c09031e25563ac03766225fab11ab552dc394faede32bde0c460528d7783a86920bcdd131fddc490f7dbbd9485def2e0d7beb8f0c6d53563f'
-  data.tar.gz: e8b67724ac73e0ab8a9fcc235b514d74ba3a5c70481a7355cbddafbf97d5a5f416895c528183a95a038d71797c9ef0eb10c75dd76613ca3184eeb41c67edb4f1
+  metadata.gz: 43b4fe728607bb924254839bc437d2a3615b532725d6a95d78be8adb44e6edb637ca8ff7f2011f031344163b7d7f838e976dde432c37bff3aec0ce6ca7fe8ff2
+  data.tar.gz: 7b5e7496f1e3a78766903ab4a5cbb319c4bfb411b2d61b09c15d65720cf0f80ce68fd95146e87c68779c43f9ba468b0af3a8dae0312dfc94e57a6c1f2598e067

data/README.md

@@ -99,6 +99,7 @@ The following types are supported:
     `:string`
     `:boolean`
     `:symbol`
+    `:json`
 
 ~~~ruby
 # Without type conversion:

data/lib/secret_config.rb

@@ -30,6 +30,7 @@ module SecretConfig
     def_delegator :registry, :key?
     def_delegator :registry, :fetch
     def_delegator :registry, :set
+    def_delegator :registry, :delete
     def_delegator :registry, :refresh!
   end
 

data/lib/secret_config/cli.rb

@@ -11,6 +11,7 @@ module SecretConfig
     attr_reader :path, :region, :provider,
                 :export, :no_filter,
                 :import, :key_id, :key_alias, :random_size, :prune, :overwrite,
+                :diff_path, :import_path,
                 :fetch_key, :delete_key, :set_key, :set_value, :delete_path,
                 :copy_path, :diff,
                 :console,
@@ -43,6 +44,8 @@ module SecretConfig
       @fetch_key    = nil
       @delete_key   = nil
       @delete_path  = nil
+      @diff_path    = nil
+      @import_path  = nil
 
       if argv.empty?
         puts parser
@@ -58,15 +61,15 @@ module SecretConfig
       elsif console
         run_console
       elsif export
-        run_export(export, filtered: !no_filter)
-      elsif import && prune
-        run_import_and_prune(import)
+        run_export(export, path, filtered: !no_filter)
       elsif import
-        run_import(import)
-      elsif copy_path
-        run_copy(copy_path, path)
+        run_import(import, path, prune)
+      elsif import_path
+        run_import_path(import_path, path, prune)
       elsif diff
-        run_diff(diff)
+        run_diff(diff, path)
+      elsif diff_path
+        run_diff_path(diff, path)
       elsif set_key
         run_set(set_key, set_value)
       elsif fetch_key
@@ -90,22 +93,26 @@ module SecretConfig
           secret_config [options]
         BANNER
 
-        opts.on "-e", "--export [FILE_NAME]", "Export configuration to a file or stdout if no file_name supplied." do |file_name|
+        opts.on "-e", "--export [FILE_NAME]", "Export configuration to a file or stdout if no file_name supplied. --path SOURCE_PATH is required." do |file_name|
           @export = file_name || STDOUT
         end
 
-        opts.on "-i", "--import [FILE_NAME]", "Import configuration from a file or stdin if no file_name supplied." do |file_name|
+        opts.on "-i", "--import [FILE_NAME]", "Import configuration from a file or stdin if no file_name supplied. --path TARGET_PATH is required." do |file_name|
           @import = file_name || STDIN
         end
 
-        opts.on "--copy SOURCE_PATH", "Import configuration from a file or stdin if no file_name supplied." do |path|
-          @copy_path = path
+        opts.on "--import-path SOURCE_PATH", "Import configuration from the configuration on another path. --path TARGET_PATH is required." do |path|
+          @import_path = path
         end
 
-        opts.on "--diff [FILE_NAME]", "Compare configuration from a file or stdin if no file_name supplied." do |file_name|
+        opts.on "--diff [FILE_NAME]", "Compare configuration from a file or stdin if no file_name supplied. --path TARGET_PATH is required." do |file_name|
           @diff = file_name
         end
 
+        opts.on "--diff-path SOURCE_PATH", "Diff configuration with the configuration on another path. --path TARGET_PATH is required." do |path|
+          @diff_path = path
+        end
+
         opts.on "-s", "--set KEY=VALUE", "Set one key to value. Example: --set mysql/database=localhost" do |param|
           @set_key, @set_value = param.split("=")
           unless @set_key && @set_value
@@ -129,7 +136,7 @@ module SecretConfig
           @console = true
         end
 
-        opts.on "-p", "--path PATH", "Path to import from / export to." do |path|
+        opts.on "-p", "--path PATH", "Path in central configuration to use." do |path|
           @path = path
         end
 
@@ -141,7 +148,7 @@ module SecretConfig
           @no_filter = true
         end
 
-        opts.on "--prune", "During import delete all existing keys for which there is no key in the import file." do
+        opts.on "--prune", "During import delete all existing keys for which there is no key in the import file. Only applies to --import and --import-path." do
           @prune = true
         end
 
@@ -185,71 +192,57 @@ module SecretConfig
       end
     end
 
-    def run_export(file_name, filtered: true)
+    def run_export(file_name, path, filtered: true)
+      raise(ArgumentError, "Missing required option --path") unless path
+
       config = fetch_config(path, filtered: filtered)
       write_config_file(file_name, config)
 
       puts("Exported #{path} from #{provider} to #{file_name}") if file_name.is_a?(String)
     end
 
-    def run_import(file_name)
-      config = read_config_file(file_name)
+    def run_import(file_name, path, prune = false)
+      raise(ArgumentError, "Missing required option --path") unless path
 
-      set_config(config, path, current_values)
+      config = read_config_file(file_name)
+      import_config(config, path, prune)
 
-      puts("Imported #{file_name} to #{provider} at #{path}") if file_name.is_a?(String)
+      puts("Imported #{file_name} to #{path} on provider: #{provider}") if file_name.is_a?(String)
     end
 
-    def run_import_and_prune(file_name)
-      config      = read_config_file(file_name)
-      delete_keys = current_values.keys - Utils.flatten(config, path).keys
+    def run_import_path(source_path, path, prune = false)
+      raise(ArgumentError, "Missing required option --path") unless path
 
-      unless delete_keys.empty?
-        puts "Going to delete the following keys:"
-        delete_keys.each { |key| puts "  #{key}" }
-        sleep(5)
-      end
-
-      set_config(config, path, current_values)
-
-      delete_keys.each do |key|
-        puts "Deleting: #{key}"
-        provider_instance.delete(key)
-      end
-
-      puts("Imported #{file_name} to #{provider} at #{path}") if file_name.is_a?(String)
-    end
-
-    def run_copy(source_path, target_path)
       config = fetch_config(source_path, filtered: false)
+      import_config(config, path, prune)
 
-      set_config(config, target_path, current_values)
-
-      puts "Copied #{source_path} to #{target_path} using #{provider}"
+      puts("Imported #{source_path} to #{path} on provider: #{provider}")
     end
 
-    def run_diff(file_name)
+    def run_diff(file_name, path)
+      raise(ArgumentError, "Missing required option --path") unless path
+
       file_config = read_config_file(file_name)
       file        = Utils.flatten(file_config, path)
 
       registry_config = fetch_config(path, filtered: false)
       registry        = Utils.flatten(registry_config, path)
 
-      (file.keys + registry.keys).sort.uniq.each do |key|
-        if registry.key?(key)
-          if file.key?(key)
-            value = file[key].to_s
-            # Ignore filtered values
-            puts "* #{key}: #{registry[key]} => #{file[key]}" if (value != registry[key].to_s) && (value != FILTERED)
-          else
-            puts "- #{key}"
-          end
-        elsif file.key?(key)
-          puts "+ #{key}: #{file[key]}"
-        end
-      end
+      puts("Comparing #{file_name} to #{path} on provider: #{provider}") if file_name.is_a?(String)
+      diff_config(file, registry)
+    end
+
+    def run_diff_path(source_path, path)
+      raise(ArgumentError, "Missing required option --path") unless path
+
+      source_config = fetch_config(source_path, filtered: false)
+      source        = Utils.flatten(source_config, path)
+
+      target_config = fetch_config(path, filtered: false)
+      target        = Utils.flatten(target_config, path)
 
-      puts("Compared #{file_name} to #{provider} at #{path}") if file_name.is_a?(String)
+      puts("Comparing #{source_path} to #{path} on provider: #{provider}")
+      diff_config(source, target)
     end
 
     def run_console
@@ -309,6 +302,42 @@ module SecretConfig
       sort_hash_by_key!(config)
     end
 
+    # Diffs two configs and displays the results
+    def diff_config(source, target)
+      (source.keys + target.keys).sort.uniq.each do |key|
+        if target.key?(key)
+          if source.key?(key)
+            value = source[key].to_s
+            # Ignore filtered values
+            puts "* #{key}: #{target[key]} => #{source[key]}" if (value != target[key].to_s) && (value != FILTERED)
+          else
+            puts "- #{key}"
+          end
+        elsif source.key?(key)
+          puts "+ #{key}: #{source[key]}"
+        end
+      end
+    end
+
+    def import_config(config, path, prune = false)
+      raise(ArgumentError, "Missing required option --path") unless path
+
+      delete_keys = prune ? current_values.keys - Utils.flatten(config, path).keys : []
+
+      unless delete_keys.empty?
+        puts "Going to delete the following keys:"
+        delete_keys.each { |key| puts "  #{key}" }
+        sleep(5)
+      end
+
+      set_config(config, path, current_values)
+
+      delete_keys.each do |key|
+        puts "Deleting: #{key}"
+        provider_instance.delete(key)
+      end
+    end
+
     def read_file(file_name_or_io)
       return file_name_or_io.read unless file_name_or_io.is_a?(String)
 

data/lib/secret_config/registry.rb

@@ -41,10 +41,10 @@ module SecretConfig
     end
 
     # Returns [String] configuration value for the supplied key
-    def fetch(key, default: nil, type: :string, encoding: nil)
+    def fetch(key, default: :no_default_supplied, type: :string, encoding: nil)
       value = self[key]
       if value.nil?
-        raise(MissingMandatoryKey, "Missing configuration value for #{path}/#{key}") if default.nil?
+        raise(MissingMandatoryKey, "Missing configuration value for #{path}/#{key}") if default == :no_default_supplied
 
         value = default.respond_to?(:call) ? default.call : default
       end
@@ -138,6 +138,10 @@ module SecretConfig
         %w[true 1 t].include?(value.to_s.downcase)
       when :symbol
         value.to_sym unless value.nil? || value.to_s.strip == ""
+      when :json
+        value.nil? ? nil : JSON.parse(value)
+      else
+        raise(ArgumentError, "Unrecognized type:#{type}")
       end
     end
 

data/lib/secret_config/version.rb

@@ -1,3 +1,3 @@
 module SecretConfig
-  VERSION = "0.6.1".freeze
+  VERSION = "0.6.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret_config
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby