rubyconfig-vault 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6472a1998cf169f1dca30ea8106dc75b21f2faf9a480ee1bf382d324e2c79c19
-  data.tar.gz: d25f00cd1684191891ae98689db23e3aace676d9188b26e6ad09a2a199e04d82
+  metadata.gz: b468333af49d93bac42b51514158c5d3867604ca9aa7c64ac7a6ce02421821b9
+  data.tar.gz: ea5200b58941e1dab0fdf9cc09fa7532fda3b054702994d0b28081b259be0a5f
 SHA512:
-  metadata.gz: d07012ba1f5d6e89a29ff6797c6cbbb94277e9766d1771f051a7ba408ae929dbd58ea8bf82cc1dd6e348352a9d8df0d68dd8bf227a329e2b55775278bace5077
-  data.tar.gz: 6881a30a2b2a9cddf3d0c7753f744eef1b809d72fa669cbf89f4347234a44be47c150e404754e54ced347d449ff6e5467c260f185ac1d4226ce7a90946d8f26e
+  metadata.gz: 7a06193b680915812e77b1632ca04c54aaedea10d99b3894f36737f97028f5321c2e844f5030746285b9bfea08e97c1ee9272764c97b896de546a8485a63c5e3
+  data.tar.gz: 756beb031fcc04827054e8ddc8b3c8077cb86d9cd5488bed1021f0994bf3477717370650c23f65512e3b880fef9dd9b8d8dd29afa09babfddc79470b313ae46f

data/lib/config/vault/vault_source.rb

@@ -2,10 +2,17 @@ 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
+      #
+      # @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
       def initialize(opts = {})
         client_opts = opts.clone
         @kv = client_opts.delete(:kv) || ''
@@ -14,18 +21,32 @@ module Config
         @client = Vault::Client.new(client_opts)
       end
 
+      # 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]
       def add_path(path)
         @paths << path
       end
 
+      # Remove added paths
       def clear_paths
         @paths = []
       end
 
+      # Load data from source into hash
+      #
+      # @return [Hash]
       def load
         process_paths
       end
 
+      # Client reference for quick operations
+      #
+      # @return [Vault::KV, Vault:Logical]
       def client
         unless kv.empty?
           @client.kv(@kv)

data/lib/config/vault/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyconfig-vault
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - David Young
@@ -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: