configuration_service 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d695abf3843bb642d1bfed73e61ad6be4675007f
-  data.tar.gz: 23ff9de0ec5d4911aa5f83a96919527ed53f115a
+  metadata.gz: 5547c75cb69883e74a7327fe86914d6b9294b3db
+  data.tar.gz: b53686e2e3557309781fa691081fbbde1682b2c7
 SHA512:
-  metadata.gz: 958979a72b6b19483a5983b8da46e1e6c01ce9febd67c0fac74c0a42128117d7218bcfd178a443fcadd3b214b4dc4d34e059e5f5183ffc23ee14b6632be28132
-  data.tar.gz: dec28262702b779b8ec85b453f1441dcb006475e68b859182772074f92ebbc6d2d0e47229659f7b17cccb9f706570ca229d649935b0b625b4e7dc05c5a76e4f5
+  metadata.gz: f925edffb72981b4d10ebfb4330d89ff4065361a9091bf41f8aa05107a25c602c7ef22a2598cae704c2d40c55e9aedf06d7ce94e606b4ca98fe91ce6d3549425
+  data.tar.gz: bd35e4fdf79ea9cfe602c51b74a3fa24dca6318fd9975b2e61a2728bd8441ea13df555fd47ce1d3b2d91bf212265d985cc9cf747af57067239e4abc4d29c01a3

data/.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.1'
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "cucumber", "~> 2.0"

data/.travis.yml

@@ -1,6 +1,5 @@
 ---
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.2.3
+  - 2.1.5
+  - 2.3.0

data/lib/configuration_service/factory/context.rb

@@ -69,12 +69,24 @@ module ConfigurationService
       end
 
       ##
-      # Does nothing
+      # Deletes the internal copy of the +source+
       #
-      # The source is assumed to be secure. Sources such as the process +ENV+ and (on JRuby) system properties
+      # Called by the {ConfigurationService::Factory} after the client is created,
+      # to prevent in-process compromise of the context (e.g. by an exception handler
+      # that dumps the environment in a web application).
+      #
+      # The original +source+ remains untouched. It is assumed to be secure. However, subclasses such as
+      # {ConfigurationService::Factory::EnvironmentContext} should scrub sources as well.
+      #
+      # Sources such as the process +ENV+ and (on JRuby) system properties
       # should not be used with this class; instead, they should be accessed through {ConfigurationService::Factory::EnvironmentContext}.
+      # Temporary YAML file sources should be accessed through {ConfigurationService::Factory::YamlFileContext}.
+      #
+      # Attempts to read context properties after scrubbing will raise a +SecurityError+.
       #
       def scrub!
+        @env = Hash.new { raise SecurityError, "can't access scrubbed environment context" }
+        nil
       end
 
     end

data/lib/configuration_service/factory/environment_context.rb

@@ -1,4 +1,5 @@
-require_relative "environment_context/backward_compatibility"
+require "configuration_service/factory/context"
+require "configuration_service/factory/environment_context_backward_compatibility"
 
 module ConfigurationService
 
@@ -13,12 +14,12 @@ module ConfigurationService
     #
     # Prior to version 2.2.0, this class provided factory functionality.
     # Use of this class as a factory is deprecated, supported through the
-    # {ConfigurationService::Factory::EnvironmentContext::BackwardCompatibility} module.
+    # {ConfigurationService::Factory::EnvironmentContextBackwardCompatibility} module.
     # Consumers should use {ConfigurationService::Factory} instead.
     #
-    class EnvironmentContext
+    class EnvironmentContext < Context
 
-      include BackwardCompatibility
+      include EnvironmentContextBackwardCompatibility
 
       attr_reader :prefix
 
@@ -51,44 +52,40 @@ module ConfigurationService
       # the environment variable is preferred.
       #
       def initialize(sources = default_sources, prefix = DEFAULT_PREFIX)
-        @env = EnvDict.new(sources, prefix)
-      end
-
-      ##
-      # @see ConfigurationService::Factory::Context#identifier
-      def identifier
-        @env[:identifier]
-      end
-
-      ##
-      # @see ConfigurationService::Factory::Context#token
-      def token
-        @env[:token]
-      end
-
-      ##
-      # @see ConfigurationService::Factory::Context#provider_id
-      def provider_id
-        @env[:provider]
-      end
-
-      ##
-      # @see ConfigurationService::Factory::Context#provider_config
-      def provider_config
-        @env.subslice(:provider)
+        @sources = [sources].flatten
+        @prefix = prefix
+        @scrub_keys = []
+        env = Hash.new { |_, k| raise KeyError, "missing environment variable #{k}" }
+
+        merged_sources = @sources.inject { |m, e| m.merge(e) }
+        {
+          to_envvar("IDENTIFIER") => :identifier,
+          to_envvar("TOKEN") => :token,
+          to_envvar("PROVIDER") => :provider_id
+        }.each do |envvar, key|
+          env[key] = merged_sources[envvar]
+          @scrub_keys << envvar
+        end
+        config_prefix = to_envvar("PROVIDER_")
+        env[:provider_config] = merged_sources
+          .select { |envvar| envvar.start_with?(config_prefix) && @scrub_keys << envvar }
+          .map { |envvar, value| [envvar.sub(config_prefix, "").downcase.intern, value] }
+          .to_h
+        @env = SymbolicAccessWrapper.new(env)
       end
 
       ##
-      # Scrub sources
-      #
-      # Called by the {ConfigurationService::Factory} after the client is created,
-      # to prevent in-process compromise of the context (e.g. by an exception handler
-      # that dumps the environment in a web application).
+      # Scrub +sources+
       #
       # Every property that matches the prefix is removed from all sources.
       #
+      # @see ConfigurationService::Factory::Context#scrub!
+      #
       def scrub!
-        @env.scrub!
+        @scrub_keys.each do |k|
+          @sources.each { |s| s.delete(k) }
+        end
+        super
       end
 
       private
@@ -97,6 +94,12 @@ module ConfigurationService
           (RUBY_PLATFORM == "java" ? [java.lang.System.properties, ENV] : ENV)
         end
 
+        def to_envvar(k = "")
+          s = k.to_s.upcase
+          (@prefix and @prefix.size > 0) ? "#{@prefix}_#{s}" : s
+        end
+
+
     end
 
   end

data/lib/configuration_service/factory/environment_context_backward_compatibility.rb

@@ -0,0 +1,75 @@
+module ConfigurationService
+
+  module Factory
+
+    ##
+    # Support {ConfigurationService::Factory::EnvironmentContext}'s deprecated use as a factory
+    #
+    # New code should use {ConfigurationService::Factory} instead.
+    #
+    module EnvironmentContextBackwardCompatibility
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      ##
+      # Create a configuration service bootstrapped with environmental configuration
+      #
+      # The environment is scanned for {EnvironmentContext#prefix} matches, within which the following variables are used:
+      #
+      # [IDENTIFIER] the unique identity of the configuration data
+      #              (see {ConfigurationService::Base#initialize})
+      # [TOKEN]      authorization token for the identified configuration data
+      #              (see {ConfigurationService::Base#initialize})
+      # [PROVIDER]   the unique identity of the service provider
+      #              (see {ConfigurationService::ProviderRegistry})
+      # [PROVIDER_*] configuration options for the service provider
+      #              (see service provider documentation)
+      #
+      # On JRuby, system properties are also scanned. Where a system property and environment variable of the
+      # same name exist, the environment variable is preferred.
+      #
+      # The service provider class is fetched from the {ConfigurationService::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 {ConfigurationService::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). On JRuby, system properties are scrubbed of variables used as well,
+      # regardless of whether they were overridden by environment variables.
+      #
+      # @return [ConfigurationService::Base] the configuration service instance created
+      # @raise [ProviderNotFoundError] if no service provider has been registered with the name given by +PROVIDER+
+      #
+      # @deprecated Use {ConfigurationService::Factory} instead.
+      #
+      def create
+        $stderr.puts "warning: ConfigurationService::Factory::EnvironmentContext#create is deprecated: use ConfigurationService::Factory instead"
+        ConfigurationService::Factory.create_client(self)
+      end
+
+      module ClassMethods
+
+        ##
+        # Return a configuration service bootstrapped with environmental configuration
+        #
+        # Instantiates a new factory with the process +ENV+ and the {EnvironmentContext::DEFAULT_PREFIX}
+        # and uses it to create a configuration service.
+        #
+        # @see ConfigurationService::Factory::EnvironmentContextBackwardCompatibility#create
+        #
+        # @deprecated Use {ConfigurationService::Factory} instead.
+        #
+        def create
+          new.create
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/factory/yaml_file_context.rb

@@ -0,0 +1,39 @@
+require "yaml"
+
+require "configuration_service/factory/context"
+
+module ConfigurationService
+
+  module Factory
+
+    class YamlFileContext < Context
+
+      ##
+      # A factory context for a YAML file
+      #
+      # Note that {#scrub!} deletes the file. This context is intended to be used with
+      # a temporary file created by a bootstrapper.
+      #
+      # For a context for the process +ENV+ and (on JRuby) system properties,
+      # see {ConfigurationService::Factory::EnvironmentContext}.
+      #
+      def initialize(filename)
+        @filename = File.expand_path(filename)
+        @env = SymbolicAccessWrapper.new(YAML.load_file(@filename))
+      end
+
+      ##
+      # Delete +filename+
+      #
+      # @see ConfigurationService::Factory::Context#scrub!
+      #
+      def scrub!
+        File.unlink(@filename) if File.exist?(@filename)
+        super
+      end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/version.rb

@@ -1,5 +1,5 @@
 module ConfigurationService
 
-  VERSION = "2.2.0"
+  VERSION = "2.3.1"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configuration_service
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,8 +115,8 @@ files:
 - lib/configuration_service/factory/context.rb
 - lib/configuration_service/factory/context/symbolic_access_wrapper.rb
 - lib/configuration_service/factory/environment_context.rb
-- lib/configuration_service/factory/environment_context/backward_compatibility.rb
-- lib/configuration_service/factory/environment_context/env_dict.rb
+- lib/configuration_service/factory/environment_context_backward_compatibility.rb
+- lib/configuration_service/factory/yaml_file_context.rb
 - lib/configuration_service/provider.rb
 - lib/configuration_service/provider/broken.rb
 - lib/configuration_service/provider/stub.rb
@@ -142,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -155,3 +155,4 @@ signing_key:
 specification_version: 4
 summary: Configuration service
 test_files: []
+has_rdoc: 

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

@@ -1,89 +0,0 @@
-module ConfigurationService
-
-  module Factory
-
-    class EnvironmentContext
-
-      ##
-      # Support {ConfigurationService::Factory::EnvironmentContext}'s deprecated use as a factory
-      #
-      # New code should use {ConfigurationService::Factory} instead.
-      #
-      module BackwardCompatibility
-
-        def self.included(base)
-          base.extend(ClassMethods)
-        end
-
-        ##
-        # Create a configuration service 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 {ConfigurationService::Base#initialize})
-        # [TOKEN]      authorization token for the identified configuration data
-        #              (see {ConfigurationService::Base#initialize})
-        # [PROVIDER]   the unique identity of the service provider
-        #              (see {ConfigurationService::ProviderRegistry})
-        # [PROVIDER_*] configuration options for the service provider
-        #              (see service provider documentation)
-        #
-        # On JRuby, system properties are also scanned. Where a system property and environment variable of the
-        # same name exist, the environment variable is preferred.
-        #
-        # The service provider class is fetched from the {ConfigurationService::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 {ConfigurationService::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). On JRuby, system properties are scrubbed of variables used as well,
-        # regardless of whether they were overridden by environment variables.
-        #
-        # @return [ConfigurationService::Base] the configuration service instance created
-        # @raise [ProviderNotFoundError] if no service provider has been registered with the name given by +PROVIDER+
-        #
-        # @deprecated Use {ConfigurationService::Factory} instead.
-        #
-        def create
-          ConfigurationService.new(@env[:identifier], @env[:token], provider).tap do
-            scrub!
-          end
-        end
-
-        module ClassMethods
-
-          ##
-          # Return a configuration service bootstrapped with environmental configuration
-          #
-          # Instantiates a new factory with the process +ENV+ and the {DEFAULT_PREFIX} and uses it to create a configuration service.
-          #
-          # @see ConfigurationService::Factory::EnvironmentContext::BackwardCompatibility#create
-          #
-          # @deprecated Use {ConfigurationService::Factory} instead.
-          #
-          def create
-            new.create
-          end
-
-        end
-
-        private
-
-          def provider
-            provider_id = @env[:provider]
-            provider_config = @env.subslice(:provider)
-            provider_class = ConfigurationService::ProviderRegistry.instance.lookup(provider_id)
-            provider_class or raise ProviderNotFoundError, "provider not registered: #{provider_id}"
-            provider_class.new(provider_config)
-          end
-
-      end
-
-    end
-
-  end
-
-end

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

@@ -1,108 +0,0 @@
-module ConfigurationService
-
-  module Factory
-
-    class EnvironmentContext
-
-      class EnvDict < Hash
-
-        def initialize(sources, *path)
-          @sources = sources.is_a?(Array) ? sources : [ sources ]
-          @env = @sources.inject { |m, e| m.merge(e) }
-          @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 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 = @env)
-            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 assert_not_scrubbed!
-            !@scrubbed or raise SecurityError, "can't access scrubbed environment dictionary"
-          end
-
-          def scrub_env!
-            @sources.each do |env|
-              env_keys(env).each { |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