rubyconfig-vault 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d90484b02d5150c6c0b8904b0a4900b3a0bb1d7e83a53f863c5aee656976ea1
-  data.tar.gz: f81e33ba21ff66e46ac33d9ec0fbb5a0cb6a795798dd4966d45be0945b9a1aa4
+  metadata.gz: b468333af49d93bac42b51514158c5d3867604ca9aa7c64ac7a6ce02421821b9
+  data.tar.gz: ea5200b58941e1dab0fdf9cc09fa7532fda3b054702994d0b28081b259be0a5f
 SHA512:
-  metadata.gz: 804d3baeb799ca7880a2dc8d2bfa818c48b56cec25f183ff00fb55a08c2b04bd17b50b0f74127de7368cdb15a8b3aa1334a283b3fcc7b3e56777c4c2aac3f1c3
-  data.tar.gz: 1eacd15b46baba5f31449f083f7454057e0d63faffaf7df4a2484968cb5e4240e8b713a6f132be171d663b99472408f98f49ce519484250efe8ecdf2e48805c7
+  metadata.gz: 7a06193b680915812e77b1632ca04c54aaedea10d99b3894f36737f97028f5321c2e844f5030746285b9bfea08e97c1ee9272764c97b896de546a8485a63c5e3
+  data.tar.gz: 756beb031fcc04827054e8ddc8b3c8077cb86d9cd5488bed1021f0994bf3477717370650c23f65512e3b880fef9dd9b8d8dd29afa09babfddc79470b313ae46f

data/lib/{rubyconfig → config}/vault/vault_source.rb

@@ -2,29 +2,51 @@ require 'vault'
 
 module Config
   module Sources
+    # A vault source for Config
     class VaultSource
-      attr_accessor :kv
+      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) || ''
         @paths = client_opts.delete(:paths) || []
+        @root = client_opts.delete(:root)
         @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)
@@ -76,7 +98,11 @@ module Config
           end
         end
 
-        root
+        if @root
+          { @root => root }
+        else
+          root
+        end
       end
 
     end

data/lib/config/vault/version.rb

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

data/lib/config/vault.rb

@@ -0,0 +1,2 @@
+require "config/vault/version"
+require "config/vault/vault_source"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyconfig-vault
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Young
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - da.young@f5.com
@@ -31,15 +87,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rubyconfig/vault.rb
-- lib/rubyconfig/vault/vault_source.rb
-- lib/rubyconfig/vault/version.rb
+- lib/config/vault.rb
+- lib/config/vault/vault_source.rb
+- lib/config/vault/version.rb
 homepage: https://github.com/CrunchwrapSupreme/rubyconfig-vault
 licenses: []
 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:
@@ -48,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rubyconfig/vault/version.rb

@@ -1,5 +0,0 @@
-module Rubyconfig
-  module Vault
-    VERSION = "0.1.0"
-  end
-end

data/lib/rubyconfig/vault.rb

@@ -1,2 +0,0 @@
-require "rubyconfig/vault/version"
-require "rubyconfig/vault/vault_source"