rubyconfig-vault 0.1.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e60f9ebe0674cae5f146780f320f0a330c537191184c5b58fcb2c65a4ddc88e
-  data.tar.gz: '08376b32e903d4a003708b0ca8589793ad828e54997ec298bb707319fcc88c64'
+  metadata.gz: 46de173dcd36067470c87796ac1767b87b0dfa8a45deccab555e3f4e46f27eba
+  data.tar.gz: a46241218beef3db50686fdd504804c0996b3a773dc7d5fdf0c6cffe2250ae8e
 SHA512:
-  metadata.gz: 056cfd2e9f03fce33a880365e5142d3c57e79c02197be0cf6b5c13120a76cc0b14231f48de60b5426fa4ddacf536e7332d9749808cc0018e69db38051e8a9141
-  data.tar.gz: 4937f17752231b1b943984d3712a23ba02ec2f4ef9416b1c1005ecc6ff89b486449ab93adbde720b50ba0ad2d421a8de1c2d32be08aa72a62d6d4baa87369903
+  metadata.gz: 2714a2880f99e0adfa77bbcdfb1b0bc00fe26ecc087846d47dce9d1c644f37c39ce459c1474810f4d6b9200094b197dab593f80e26023643854eb27d3b828859
+  data.tar.gz: d31a1275c69520b68ed8d3c7bb6bb68fbd852ac50e8337899ab310114c76d4086697407067cfb13d6c391b98bb3f96fbcf40202bb7a8a322a13a4176c35962b5

data/lib/config/vault/vault_source.rb

@@ -2,31 +2,74 @@ 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)
+        @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
 
+      # 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 +77,6 @@ module Config
         end
       end
 
-      private
-
       def process_paths
         root = {}
         parsed_paths = @paths.map { |p| process_path(p) }
@@ -46,7 +87,7 @@ module Config
 
       def process_path(path)
         root = {}
-        subpaths = path.split('/')
+        subpaths = path.first.split('/')
         stack = []
         stack.push([nil, 0, root])
 
@@ -54,13 +95,13 @@ module Config
           query_path, idx, parent = stack.pop
           sp = subpaths[idx]
           if sp.nil? || sp.eql?('*')
-            data = client.read(query_path)&.data
+            data = client_ops.read(query_path)&.data
             parent.merge!(data || {})
             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 +118,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.1"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyconfig-vault
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.1
 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: