configuration_service-provider-vault 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbd2f8fa57732ffc8593b11fa2525435272804c2
-  data.tar.gz: c756b1da1cc358126f7c9c96cbedaddf11033fc8
+  metadata.gz: 308555a5fbb41084a4993fff7e606b0d3ecaaa94
+  data.tar.gz: f31b038011e7af7e90e440f27357a7e3a6f715f0
 SHA512:
-  metadata.gz: 01be9f302992db424027c82ee746d0e227fd1c34a041f598a37747450bd48edeaa32ddcea622759bdedfa549a9623474051e81103550e16163f57eb1bcfae788
-  data.tar.gz: 65da9cea27cea1d94c20def2542abe96321995e3264da70f6fbf462f6a8906c1f1ea9bacec8be4b063c2b204d9fde8c00c76907a64bfa376d1755d8d3cd44529
+  metadata.gz: a3a365096aa3acd90582d00b5496124e7657703a73ff711651736f10059710f57225731d73e1a5164967d3db292e3e12523cc77e2ecf79f9503c79a6cdf130b1
+  data.tar.gz: 42f59961c487c15e69ad9b6e618a7f7b5b8286b71876532e999602a43f80afb42f66f931c5dd2fd7126293e5b4221edc64abeb844755324c917e2f90df698675

data/README.md

@@ -21,11 +21,8 @@ require 'bundler'
 Bundler.require(:default)
 
 service = ConfigurationService::Factory::EnvironmentContext.create
-if configuraton = service.request_configuration
-  AcmeApplication.new(configuration.data).run
-else
-  raise "configuration not found"
-end
+configuraton = service.request_configuration
+AcmeApplication.new(configuration.data).run
 ```
 
 This relies on a [bundler](http://bundler.io) Gemfile to provide the
@@ -69,9 +66,5 @@ service = ConfigurationService.new(
     address: "http://127.0.0.1:8200"
   )
 )
-if configuraton = service.request_configuration
-  AcmeApplication.new(configuration.data).run
-else
-  raise "configuration not found"
-end
-```
+configuraton = service.request_configuration
+AcmeApplication.new(configuration.data).run

data/lib/configuration_service/provider/vault.rb

@@ -9,12 +9,25 @@ module ConfigurationService
 
   module Provider
 
+    ##
+    # Vault provider for the configuration service
+    #
+    # Instances of this class are intended to be composed into a ConfigurationService::Base,
+    # usually by a ConfigurationService::Factory.
+    #
     class Vault
 
       def initialize(address:)
         @vault = ::Vault::Client.new(address: address)
       end
 
+      ##
+      # Request configuration from Vault
+      #
+      # The Vault secret path is composed by IndexHelper, using the +identifier+ and the string "latest".
+      #
+      # See #publish_configuration.
+      #
       def request_configuration(identifier, token)
         authenticate(token)
 
@@ -29,6 +42,18 @@ module ConfigurationService
         end
       end
 
+      ##
+      # Publish configuration to Vault
+      #
+      # The configuration is written to a Vault path composed by IndexHelper, using the configuration's
+      # +identifier+ and metadata +revision+ as the path. That path is then written to another path,
+      # also composed by IndexHelper, using +identifier+ and the string "latest".
+      #
+      # This allows the current configuration to always be retrieved from a predictable path in Vault,
+      # but preserves revision history of configuration.
+      #
+      # TODO make revision history queryable (blocked by https://github.com/hashicorp/vault/issues/111)
+      #
       def publish_configuration(configuration, token)
         authenticate(token)
 
@@ -43,10 +68,6 @@ module ConfigurationService
         end
       end
 
-      def key(identifier)
-        self.class.key(identifier)
-      end
-
       private
 
         # We explicitly disallow a nil token to defeat ::Vault::Client's default behaviour

data/lib/configuration_service/provider/vault/index_helper.rb

@@ -4,14 +4,34 @@ module ConfigurationService
 
     class Vault
 
+      ##
+      # Utility module for creating Vault paths
+      #
+      # The module supports:
+      #
+      # * versioning paths to support backward-incompatible changes to the
+      #   pathing and data schemes;
+      # * composing the configuration identifier into the path, and
+      # * composing a revision (or "latest") into the path, to support
+      #   revision history.
+      #
       module IndexHelper
 
-        PREFIX = "secret/config/v1"
+        PREFIX = "secret/config/v1" unless defined?(PREFIX)
 
+        ##
+        # Returns the path for the given +revision+ of +identifier+
+        #
         def self.index(identifier, revision = "latest")
           "#{policy_index(identifier)}/#{revision}"
         end
 
+        ##
+        # Returns the policy path for the given +identifier+
+        #
+        # Since policies must apply to all revisions of the identified configuration,
+        # the policy path is necessarily broad.
+        #
         def self.policy_index(identifier)
           "#{PREFIX}/#{identifier}"
         end

data/lib/configuration_service/provider/vault/version.rb

@@ -4,7 +4,7 @@ module ConfigurationService
 
     class Vault
 
-      VERSION = "2.0.0"
+      VERSION = "2.0.1"
 
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configuration_service-provider-vault
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Sheldon Hearn