rubyconfig-vault 0.1.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6472a1998cf169f1dca30ea8106dc75b21f2faf9a480ee1bf382d324e2c79c19
-  data.tar.gz: d25f00cd1684191891ae98689db23e3aace676d9188b26e6ad09a2a199e04d82
+  metadata.gz: 63279ad2f29fabd8006dd8bdf3a69e49dabd2a1d5e3f89c1c695c9e6528f5154
+  data.tar.gz: 734327aae2db0747633a5a06101e2c2117ad54b0b441011bf4d58348da871c46
 SHA512:
-  metadata.gz: d07012ba1f5d6e89a29ff6797c6cbbb94277e9766d1771f051a7ba408ae929dbd58ea8bf82cc1dd6e348352a9d8df0d68dd8bf227a329e2b55775278bace5077
-  data.tar.gz: 6881a30a2b2a9cddf3d0c7753f744eef1b809d72fa669cbf89f4347234a44be47c150e404754e54ced347d449ff6e5467c260f185ac1d4226ce7a90946d8f26e
+  metadata.gz: 4b6aac24bcb3781bae89ef0bc3e77fe5da3f5ada28308c711e5f8117e193cedcf12aaf5a6576ab080521f138325052c16c5e2246011fb086b38c7407cd32a839
+  data.tar.gz: 8455068a25f114a7a9a430e8daf25421c253f39788c673bcfd996ba208bfee086f7c5fb7d3dfd0c2f93c7349eb6792d4851b082c0753b60ebf729c04db2f2379

data/lib/config/vault/vault_source.rb

@@ -2,31 +2,82 @@ require 'vault'
 
 module Config
   module Sources
+    # A vault source for Config
     class VaultSource
       attr_accessor :kv, :root
       attr_reader :paths, :client
 
+      # 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 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)
+        @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
 
-      def add_path(path)
-        @paths << path
+      # Add a path to Config source
+      #
+      # @example Use glob operators
+      #   source.add_path('secrets/**/test/*')
+      #   source.load #=> { secrets: { some_key: { test: { secret_data: 2 } } } }
+      #
+      # @param path [String]
+      # @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
       def clear_paths
         @paths = []
       end
 
+      # Load data from source into hash
+      #
+      # @return [Hash]
       def load
-        process_paths
+        Vault.with_retries(Vault::HTTPError,
+                           attempts: @attempts,
+                           base: @base,
+                           max_wait: @max_wait) do
+          process_paths
+        end
       end
 
-      def client
+      private
+
+      def client_ops
         unless kv.empty?
           @client.kv(@kv)
         else
@@ -34,8 +85,6 @@ module Config
         end
       end
 
-      private
-
       def process_paths
         root = {}
         parsed_paths = @paths.map { |p| process_path(p) }
@@ -46,7 +95,7 @@ module Config
 
       def process_path(path)
         root = {}
-        subpaths = path.split('/')
+        subpaths = path.first.split('/')
         stack = []
         stack.push([nil, 0, root])
 
@@ -54,13 +103,14 @@ 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 || {})
+            data = client_ops.read(query_path)&.data || {}
+            parent.merge!(data)
+            parent.transform_keys! { |key| @map[key] || key }
             parent.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
@@ -77,7 +127,8 @@ module Config
           end
         end
 
-        if @root
+        root = root.flatten if @flatten
+        if path.last
           { @root => root }
         else
           root

data/lib/config/vault/version.rb

@@ -1,5 +1,5 @@
-module Rubyconfig
+module Config
   module Vault
-    VERSION = "0.1.2"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyconfig-vault
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.2
 platform: ruby
 authors:
 - David Young
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vault
@@ -96,6 +96,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   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: 
 rdoc_options: []
 require_paths: