rubyconfig-vault 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b468333af49d93bac42b51514158c5d3867604ca9aa7c64ac7a6ce02421821b9
-  data.tar.gz: ea5200b58941e1dab0fdf9cc09fa7532fda3b054702994d0b28081b259be0a5f
+  metadata.gz: 0a737c714f6c9e6cdff7bc6ea5ad1cdb864929ea00552b49c0a711bf7985571e
+  data.tar.gz: 54d1b1055a1272b021c3b9411fefd41c2c6ee2e6ec2469fec1382e7becbd4502
 SHA512:
-  metadata.gz: 7a06193b680915812e77b1632ca04c54aaedea10d99b3894f36737f97028f5321c2e844f5030746285b9bfea08e97c1ee9272764c97b896de546a8485a63c5e3
-  data.tar.gz: 756beb031fcc04827054e8ddc8b3c8077cb86d9cd5488bed1021f0994bf3477717370650c23f65512e3b880fef9dd9b8d8dd29afa09babfddc79470b313ae46f
+  metadata.gz: d6810e8ed8954833fd7de46c76f1ff0102ab8240d7c25b9eed16eee421bd73703c1ae2b6ac75b1a5b36b25c5857e763ef7c73c8641a6aa305702b9716f3ba1ca
+  data.tar.gz: f4b0a4031bff1d623978064ddef59656b60ae9cf7071ee0a2e31665d7397b4c15ed63462a9a356b5ee7e82b2b671d2daf6a94b2969f24fb3c7e402f85e005cd6

data/lib/config/vault/vault_source.rb

@@ -4,21 +4,38 @@ module Config
   module Sources
     # A vault source for Config
     class VaultSource
-      attr_accessor :kv, :root
+      attr_accessor :kv, :root, :flatten
       attr_reader :paths, :client
 
-      # Create a new Config source
+      # Create a new Config source, all Vault::Client parameters supported
       #
       # @param [Hash] opts
       # @option opts [String, nil] :kv mount point for operations
       # @option opts [Array<String>, nil] :paths paths for vault secrets
-      # @option opts [String, Symbol, nil] :root root key for data provided by source
+      # @option opts [String, Symbol, nil] :root default root key for data provided by source
+      # @option opts [Integer] :attempts number of attempts to try and resolve Vault::HTTPError
+      # @option opts [Number] :base interval for exponential backoff
+      # @option opts [Number] :max_wait maximum weight time for exponential backoff
+      # @option opts [Boolean] :flatten flatten the resulting hash. Preserves root option
       def initialize(opts = {})
         client_opts = opts.clone
         @kv = client_opts.delete(:kv) || ''
-        @paths = client_opts.delete(:paths) || []
+        @paths = []
+        @attempts = client_opts.delete(:attempts) || 5
+        @base = client_opts.delete(:base) || 0.5
+        @max_wait = client_opts.delete(:max_wait) || 2.5
         @root = client_opts.delete(:root)
-        @client = Vault::Client.new(client_opts)
+        @flatten = client_opts.delete(:flatten)
+        @paths << client_opts.delete(:paths) if client_opts.key?(:paths)
+        @map = {}
+        @paths.map! do |p|
+          if p.is_a?(Array)
+            p
+          else
+            [p, @root]
+          end
+        end
+        @client = ::Vault::Client.new(client_opts)
       end
 
       # Add a path to Config source
@@ -28,8 +45,17 @@ module Config
       #   source.load #=> { secrets: { some_key: { test: { secret_data: 2 } } } }
       #
       # @param path [String]
-      def add_path(path)
-        @paths << path
+      # @param root [String] optional root
+      def add_path(path, root = nil)
+        root ||= @root
+        @paths << [path, root]
+      end
+
+      # Re-map individual key names
+      #
+      # @param hsh [Hash] mappings for keys
+      def map(hsh)
+        @map = hsh
       end
 
       # Remove added paths
@@ -41,13 +67,17 @@ module Config
       #
       # @return [Hash]
       def load
-        process_paths
+        Vault.with_retries(Vault::HTTPError,
+                           attempts: @attempts,
+                           base: @base,
+                           max_wait: @max_wait) do
+          process_paths
+        end
       end
 
-      # Client reference for quick operations
-      #
-      # @return [Vault::KV, Vault:Logical]
-      def client
+      private
+
+      def client_ops
         unless kv.empty?
           @client.kv(@kv)
         else
@@ -55,8 +85,6 @@ module Config
         end
       end
 
-      private
-
       def process_paths
         root = {}
         parsed_paths = @paths.map { |p| process_path(p) }
@@ -67,7 +95,7 @@ module Config
 
       def process_path(path)
         root = {}
-        subpaths = path.split('/')
+        subpaths = path.first.split('/')
         stack = []
         stack.push([nil, 0, root])
 
@@ -75,30 +103,33 @@ module Config
           query_path, idx, parent = stack.pop
           sp = subpaths[idx]
           if sp.nil? || sp.eql?('*')
-            data = client.read(query_path)&.data
-            parent.merge!(data || {})
-            parent.compact!
+            data = client_ops.read(query_path)&.data || {}
+            node = root if @flatten
+            node = parent unless @flatten
+            node.merge!(data)
+            node.transform_keys! { |key| @map[key] || key }
+            node.compact!
           end
 
           if sp.eql?('**') || sp.eql?('*')
-            subtrees = client.list(query_path)
+            subtrees = client_ops.list(query_path)
             subtrees.each do |st|
               new_parent = {}
               new_key = st.split('/').last.downcase.to_sym
               new_query_path = [query_path, st].join('/')
-              parent[new_key] = new_parent
+              parent[new_key] = new_parent unless @flatten
               stack.push([new_query_path, idx + 1, new_parent])
             end
           elsif sp
             query_path = [query_path, sp].compact.join('/')
             idx += 1
             new_parent = {}
-            parent[sp.downcase.to_sym] = new_parent
+            parent[sp.downcase.to_sym] = new_parent unless @flatten
             stack.push([query_path, idx, new_parent])
           end
         end
 
-        if @root
+        if path.last
           { @root => root }
         else
           root

data/lib/config/vault/version.rb

@@ -1,5 +1,5 @@
 module Config
   module Vault
-    VERSION = "1.0.0"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyconfig-vault
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - David Young
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vault
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - da.young@f5.com
 executables: []
@@ -97,7 +97,7 @@ metadata:
   homepage_uri: https://github.com/CrunchwrapSupreme/rubyconfig-vault
   source_code_uri: https://github.com/CrunchwrapSupreme/rubyconfig-vault
   documentation_uri: https://www.rubydoc.info/gems/rubyconfig-vault/index
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Implements a ruby config source from vault
 test_files: []