configuration_service 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 013e070f4e04c050a8fdd8232cac7fb22cb652b1
-  data.tar.gz: 3d329fe8548014c9e43e1553a1e506d5438c6a7f
+  metadata.gz: fc898eb1373d71883928bb492b533ffadc0e895c
+  data.tar.gz: ec3e54e1a4768122bd1f0e14f77cfc8e6da36bed
 SHA512:
-  metadata.gz: 226d8f3472c3a62716ced933186f5f926388575f29ab8ce91527d8b6ef19d5f9080409519dd8ecf37e405854705c17f7942ad6f994d8d4c76690866cc3438be9
-  data.tar.gz: df846414184710ca2d20903e017f1712897e4df8c97dc569f3296eb8bf1ce5a5224586ed531dc8e00985822f42e4405020b89232e54e9b59ba2171ba8f3f2754
+  metadata.gz: 978bd8e5c8bd45ff27550378d5052bdadca16c72d4787fd88c5e5aca4a691b2906074b145e7123597cf5278a1e09932c5f33915857435b7c847ea6a2f6c51f4d
+  data.tar.gz: 4cbd165b89b7f76886333c3ec414391cf8db0254e00e50e6ac67cdb77367d28324a5963b9eae22b5a49eff198c836e0fbafec10a1747df0808662c20e3e8531f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configuration_service (1.0.0)
+    configuration_service (1.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -22,9 +22,18 @@ GEM
     multi_json (1.11.2)
     multi_test (0.1.2)
     rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
     rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
 
 PLATFORMS
@@ -35,6 +44,7 @@ DEPENDENCIES
   configuration_service!
   cucumber (~> 2.0)
   rake (~> 10.0)
+  rspec (~> 3.3)
   rspec-expectations (~> 3.3)
 
 BUNDLED WITH

data/Rakefile

@@ -1,8 +1,11 @@
 require "bundler/gem_tasks"
 require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
 
 desc "Test the stub test orchestrator"
-task :test do
+task :test => :spec do
   sh %{TEST_ORCHESTRATION_PROVIDER=stub bundle exec cucumber}
 end
 

data/configuration_service.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "configuration_service"
-  spec.version       = "1.0.0"
+  spec.version       = "1.1.1"
   spec.authors       = ["Sheldon Hearn"]
   spec.email         = ["sheldonh@starjuice.net"]
 
@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "cucumber", "~> 2.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "rspec-expectations", "~> 3.3"
 end

data/lib/configuration_service/base.rb

@@ -9,6 +9,9 @@ module ConfigurationService
   # {consumption}[link:features/consuming_feature.html]
   # of identified configuration data with metadata.
   #
+  # It is recommended that consumers use a Factory to create
+  # and configure the service.
+  #
   class Base
 
     ##

data/lib/configuration_service/factory/environment_context/env_dict.rb

@@ -0,0 +1,120 @@
+module ConfigurationService
+
+  module Factory
+
+    class EnvironmentContext
+
+      class EnvDict < Hash # :nodoc: all
+
+        def initialize(env, *path)
+          @env = env
+          @path = build_path(*path)
+
+          env_keys.each do |k|
+            self.store(symbolic_key(k), @env[k])
+          end
+
+          self.default_proc = envdict_default_proc
+        end
+
+        def subslice(key)
+          EnvDict.new(@env, @path, key).tap do |s|
+            (@slices ||= []) << s
+          end
+        end
+
+        def subslice!(key)
+          delete_keys_prefixed_with!(key)
+          subslice(key)
+        end
+
+        def scrub!
+          @path or raise RuntimeError, "refusing to scrub without path"
+
+          scrub_env!
+          scrub_slices!
+          scrub_self!
+
+          @scrubbed = true
+        end
+
+        private
+
+          def envdict_default_proc
+            proc do |_, key|
+              assert_not_scrubbed!
+              try_string(key) or raise_key_error(key)
+            end
+          end
+
+          def try_string(k)
+            if (skey = k.intern rescue false) and self.include?(skey)
+              self.fetch(skey)
+            end
+          end
+
+          def raise_key_error(k)
+            envar = build_path(@path, k.to_s).upcase
+            raise KeyError, "missing environment variable #{envar}"
+          end
+
+          def env_keys
+            @env.keys.select { |k| under_path?(k) }
+          end
+
+          def under_path?(k)
+            !!symbolic_key(k)
+          end
+
+          def symbolic_key(k)
+            prefix = build_path(@path, "")
+            s = k.downcase
+            if s.slice!(prefix) and !s.empty?
+              s.intern
+            end
+          end
+
+          def build_path(*path)
+            path = path.compact
+            if path.empty?
+              nil
+            else
+              path.map { |p| p.to_s.downcase }.join("_")
+            end
+          end
+
+          def delete_keys_prefixed_with!(key)
+            self.keys.each do |k|
+              if k.to_s.start_with?("#{key}_")
+                self.delete(k)
+              end
+            end
+          end
+
+          def assert_not_scrubbed!
+            !@scrubbed or raise SecurityError, "can't access scrubbed environment dictionary"
+          end
+
+          def scrub_env!
+            env_keys.each do |k|
+              @env.delete(k)
+            end
+          end
+
+          def scrub_slices!
+            @slices.each { |s| s.scrub! } if @slices
+          end
+
+          def scrub_self!
+            self.keys.each do |k|
+              self.delete(k)
+            end
+          end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/factory/environment_context.rb

@@ -0,0 +1,106 @@
+module ConfigurationService
+
+  module Factory
+
+    ##
+    # Creates a Base bootstrapped with environmental configuration
+    #
+    #   # With the following in the environment:
+    #   #
+    #   # CFGSRV_IDENTIFIER="acme"
+    #   # CFGSRV_TOKEN="0b2a80f4-54ce-45f4-8267-f6558fee64af"
+    #   # CFGSRV_PROVIDER="vault"
+    #   # CFGSRV_PROVIDER_ADDRESS="http://127.0.0.1:8200"
+    #
+    #   service = ConfigurationService::Factory::EnvironmentContext.create
+    #   configuraton = service.request_configuration
+    #   AcmeApplication.new(configuration.data).run
+    #
+    class EnvironmentContext
+
+      ##
+      # The prefix for matching environment variable names
+      #
+      # Names match if they begin with the prefix and an underscore.
+      #
+      attr_reader :prefix
+
+      ##
+      # The default prefix for matching environment variable names
+      #
+      DEFAULT_PREFIX = "CFGSRV" unless defined?(DEFAULT_PREFIX)
+
+      ##
+      # Returns a new factory
+      #
+      # The +env+ defaults to the process ENV and the +prefix+ defaults
+      # to the DEFAULT_PREFIX.
+      #
+      # Most consumers will not need to call this method; they can use
+      # .create which instantiates a factory with default +env+ and +prefix+
+      # and uses that internally.
+      #
+      def initialize(env = ENV, prefix = DEFAULT_PREFIX)
+        @env = EnvDict.new(env, prefix)
+      end
+
+      ##
+      # Return a Base bootstrapped with environmental configuration
+      #
+      # The environment is scanned for #prefix matches, within which
+      # the following variables are used:
+      #
+      # [IDENTIFIER] the unique identity of the configuration data
+      #              (see Base#initialize)
+      # [TOKEN]      authorization token for the identified configuration data
+      #              (see Base#initialize)
+      # [PROVIDER]   the unique identity of the service provider
+      #              (see ProviderRegistry)
+      # [PROVIDER_*] configuration options for the service provider
+      #              (see provider documentation)
+      #
+      # The service provider class is fetched from the ProviderRegistry using
+      # +PROVIDER+. A service provider instance is then constructed with a
+      # dictionary of the +PROVIDER_*+ variables, in which the keys are the
+      # name of the variable without +PROVIDER_+, downcased and intern'd.
+      #
+      # Then a service Base is constructed with the +IDENTIFIER+, +TOKEN+
+      # and service provider instance.
+      #
+      # And finally, the environment is scrubbed of the variables used, to
+      # protect them from accidental exposure (e.g. in an exception handler
+      # that prints the environment).
+      #
+      # Returns the constructed service Base.
+      #
+      def create
+        ConfigurationService.new(@env[:identifier], @env[:token], provider).tap do
+          @env.scrub! # TODO mandates that scrub not try to mutate the strings given to provider
+        end
+      end
+
+      ##
+      # Return a Base bootstrapped with environmental configuration
+      #
+      # See #create.
+      #
+      # Uses the process ENV and the DEFAULT_PREFIX.
+      #
+      def self.create
+        new.create
+      end
+
+      private
+
+        def provider
+          provider_id = @env[:provider]
+          provider_config = @env.subslice(:provider)
+          provider_class = ConfigurationService::ProviderRegistry.instance.lookup(provider_id)
+          provider_class.new(provider_config) # TODO mandates keyword arguments or options hash
+        end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/factory.rb

@@ -0,0 +1,16 @@
+Dir.glob(File.expand_path("../factory/**/*.rb", __FILE__), &method(:require))
+
+module ConfigurationService
+
+  ##
+  # Module containing configuration service factory classes
+  #
+  # Current implementations provided by this package:
+  #
+  # * EnvironmentContext
+  #
+  module Factory
+
+  end
+
+end

data/lib/configuration_service/provider/stub.rb

@@ -14,6 +14,8 @@ module ConfigurationService
     #
     # Used to validate the test framework architecture.
     #
+    # Registered into the ProviderRegistry with identifier "stub".
+    #
     class Stub
 
       ##
@@ -28,7 +30,11 @@ module ConfigurationService
       ##
       # Returns a new Stub
       #
-      def initialize
+      # It requires an arbitrary +name+, used solely for testing factory
+      # methods.
+      #
+      def initialize(name:)
+        @name = name or raise ArgumentError, "missing required argument: name"
         @configurations = StubStore.instance
       end
 
@@ -79,3 +85,5 @@ module ConfigurationService
   end
 
 end
+
+ConfigurationService::ProviderRegistry.instance.register("stub", ConfigurationService::Provider::Stub)

data/lib/configuration_service/provider_registry.rb

@@ -0,0 +1,50 @@
+require 'singleton'
+
+module ConfigurationService
+
+  unless defined?(ProviderRegistry)
+
+    ##
+    # A singleton registry of uniquely identified service provider classes
+    #
+    # Provider classes are registered and looked up by unique string identifier.
+    #
+    class ProviderRegistry
+
+      include Singleton
+
+        def initialize ## :nodoc:
+          @providers = {}
+        end
+
+        ##
+        # Register a +provider+ identified by the string +identifier+
+        #
+        # The +provider+ should be a class with a keyword argument
+        # constructor.
+        #
+        def register(identifier, provider)
+          @providers[identifier] = provider
+        end
+
+        ##
+        # Return the +provider+ identified by the string +identifier+
+        #
+        # The +provider+ must already have been registered with #register,
+        # and should be a class with a keyword argument constructor.
+        #
+        # Returns +nil+ if no provider has been registered with the given
+        # +identifier+.
+        #
+        def lookup(identifier)
+          @providers[identifier]
+        end
+
+        ##
+        # Return the singleton registry instance
+        # :singleton-method: instance
+    end
+
+  end
+
+end

data/lib/configuration_service/test/orchestration_provider.rb

@@ -14,8 +14,14 @@ module ConfigurationService
     # implementation into ConfigurationService::Base, build your own test
     # orchestration provider from scratch, using Orchestrator as a guide.
     #
-    # Extensions should implement #service_provider, #broken_service_provider,
-    # #token_for and #delete_configuration.
+    # Extensions should implement:
+    #
+    # * #service_provider_id
+    # * #service_provider_configuration
+    # * #service_provider
+    # * #broken_service_provider
+    # * #token_for
+    # * #delete_configuration
     #
     class OrchestrationProvider
 
@@ -45,6 +51,26 @@ module ConfigurationService
         @identifier = "acme"
       end
 
+      ##
+      # Returns the string identifier of the service provider
+      #
+      # This should be the +identifier+ with which the service provider
+      # registers into the ProviderRegistry.
+      #
+      def service_provider_id
+        raise NotImplementedError, "#{self.class} must implement service_provider_id"
+      end
+
+      ##
+      # Return configuration for the service provider
+      #
+      # The configuration should be a dictionary of keyword arguments that can
+      # be passed to the constructor of the service provider class.
+      #
+      def service_provider_configuration # :doc:
+        raise NotImplementedError, "#{self.class} must implement service_provider_configuration"
+      end
+
       ##
       # See Orchestrator#authorize
       #

data/lib/configuration_service/test/orchestrator.rb

@@ -46,6 +46,7 @@ module ConfigurationService
 
       ##
       # Arrange a published configuration fixture
+      #
       def given_existing_configuration
         @provider.given_existing_configuration
       end
@@ -203,6 +204,63 @@ module ConfigurationService
         @provider.fail_next_request
       end
 
+      ##
+      # Arrange environmental service configuration
+      #
+      # Environmental service configuration is configuration for bootstrapping
+      # a configuration service and provider.
+      #
+      # TODO This method is imperative
+      #
+      def given_environmental_service_configuration
+        sp_env = @provider.service_provider_configuration.inject({}) do |m, (k, v)|
+          m["CFGSRV_PROVIDER_#{k.to_s.upcase}"] = v
+          m
+        end
+        @env = {
+          "CFGSRV_IDENTIFIER" => "acme",
+          "CFGSRV_TOKEN" => "ea81cbfb-221c-41ad-826e-d3eff6342345",
+          "CFGSRV_PROVIDER" => @provider.service_provider_id,
+        }.merge(sp_env)
+      end
+
+      ##
+      # Bootstrap a configuration service environmentally
+      #
+      # Environmental service configuration (as arranged by
+      # #given_environmental_service_configuration) is given to an
+      # EnvironmentContext factory to create a service configuration instance.
+      #
+      # TODO This method is imperative
+      #
+      def bootstrap_configuration_service_environmentally
+        factory = ConfigurationService::Factory::EnvironmentContext.new(@env, "CFGSRV")
+        @service = factory.create
+      end
+
+      ##
+      # Tests that a bootstrapped configuration service is functional
+      #
+      # TODO This method is imperative
+      #
+      def bootstrapped_configuration_service_functional?
+        response = begin
+          ConfigurationService::Test::Response::Success.new(@service.request_configuration)
+        rescue ConfigurationService::Error => e
+          ConfigurationService::Test::Response::Failure.new(e)
+        end
+        !response.failed?
+      end
+
+      ##
+      # Tests that environmental service configuration is scrubbed
+      #
+      # TODO This method is imperative
+      #
+      def environmental_service_configuration_scrubbed?
+        !@env.include?("CFGSRV_TOKEN")
+      end
+
       private
 
         def role_for(activity)

data/lib/configuration_service/test/stub_orchestration_provider.rb

@@ -13,13 +13,24 @@ module ConfigurationService
     #
     class StubOrchestrationProvider < OrchestrationProvider
 
+      def service_provider_id
+        "stub"
+      end
+
+      ##
+      # Return configuration for a Stub
+      #
+      def service_provider_configuration # :doc:
+        {name: "Stub configuration service provider"}
+      end
+
       private
 
         ##
         # Returns a new Stub
         #
         def service_provider # :doc:
-          ConfigurationService::Provider::Stub.new
+          ConfigurationService::Provider::Stub.new(service_provider_configuration)
         end
 
         ##

data/lib/configuration_service.rb

@@ -1,6 +1,8 @@
 require "configuration_service/base"
 require "configuration_service/configuration"
 require "configuration_service/errors"
+require "configuration_service/factory"
+require "configuration_service/provider_registry"
 
 ##
 # See ConfigurationService::Base.
@@ -10,7 +12,7 @@ module ConfigurationService
   ##
   # Creates a new ConfigurationService::Base for the +provider+
   #
-  # See ConfigurationService::Base#initialize.
+  # See Base.new.
   #
   def self.new(identifier, token, provider)
     ConfigurationService::Base.new(identifier, token, provider)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configuration_service
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -84,10 +99,14 @@ files:
 - lib/configuration_service/base.rb
 - lib/configuration_service/configuration.rb
 - lib/configuration_service/errors.rb
+- lib/configuration_service/factory.rb
+- lib/configuration_service/factory/environment_context.rb
+- lib/configuration_service/factory/environment_context/env_dict.rb
 - lib/configuration_service/provider.rb
 - lib/configuration_service/provider/broken.rb
 - lib/configuration_service/provider/stub.rb
 - lib/configuration_service/provider/stub_store.rb
+- lib/configuration_service/provider_registry.rb
 - lib/configuration_service/test.rb
 - lib/configuration_service/test/orchestration_provider.rb
 - lib/configuration_service/test/orchestration_provider_registry.rb