configuration_service 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4a468a73fdaa5ac4d860611af3fe7f60bbb8533
-  data.tar.gz: 1c7cd9e09bf66113b28950938b00299a420d0cc4
+  metadata.gz: 9022efdb20bd55a2a9f466600df663186ef5e068
+  data.tar.gz: f4050743be268be3f4c2127da10446209d5bdda2
 SHA512:
-  metadata.gz: 7475e17b49bd4430c01850923eebd2ad3e4d1b5cf764e2c1f16d21552cefd5d854cf1c963edf2942568ad42b2d9917db052e0bf223f149fe27815878c97f90fc
-  data.tar.gz: f024394e9df43fb5dfdc026c5cef4132f1529a85ae075af7c8205a264acb8d119f64eda80d646fc20e5950e5a5d9917276efcc5e88a0a9527c9320ca98711a2d
+  metadata.gz: 30da71e127b2c489218cf8b8b9aa0e95f4ad8784870cf1fda4fac1fdd123e2437e2c1604fd069a43ee7877127e02139e1d1494cfb7873fc8e1c1b3dbc3ab8b39
+  data.tar.gz: e56102407e1a649e409dffddc1a19483d48147336454ada41633f27967158fa02e1005c91b693e601cbe1ecaae4b6f67ead1ab81e9ac8e0a5e5ee24d87f2e03a

data/README.rdoc

@@ -7,7 +7,7 @@ The configuration service provides
 of identified configuration data with metadata.
 The service supports {file:features/bootstrapping.feature bootstrapping}.
 
-A pluggable Ruby API is provided in {ConfigurationService::Base}.
+A pluggable Ruby API is provided in {ConfigurationService::Client}.
 
 The declarative specification of the service is implemented with cucumber, using a pluggable imperative orchestration providers.
 This allows for implementations that are not providers to the Ruby API.
@@ -87,7 +87,7 @@ In practice, the administrative context would most likely come from the configur
 
 In the following example, the {ConfigurationService::Factory} defaults to using the
 {ConfigurationService::Factory::EnvironmentContext EnvironmentContext} to acquire application configuration
-from a non-administrative {ConfigurationService::Base} client.
+from a non-administrative {ConfigurationService::Client} client.
 Part of the application configuration is then used as the context for an administrative {ConfigurationService::AdminClient},
 which is used as a model in the application.
 
@@ -127,7 +127,7 @@ If this configuration data was stored under the configuration identifier "acme",
 
 So this application would use the token "0b2...4af" to access its configuration data
 under the identifier "acme"
-with a non-administrative {ConfigurationService::Base} client.
+with a non-administrative {ConfigurationService::Client} client.
 Part of its configuration data, in this case under the key "cs_config",
 provides {ConfigurationService::Factory::Context} for creating an administrative {ConfigurationService::AdminClient},
 which it would then use the token "c39...48a" to operate over multiple configuration identifiers on behalf of users.

data/lib/configuration_service/client.rb

@@ -11,23 +11,30 @@ module ConfigurationService
     #   Interpretation of the credentials is provider-dependent; it is opaque to the API and client.
     # @param [Object] provider 
     #   a configured service provider instance, to which requests will be delegated.
-    # @return [ConfigurationService::Client] client to interact with Configuration::Service
+    # @param [String] identifier 
+    #   unique configuration identifier (optional). If omitted, instance methods will require the +identifier+ argument.
     #
-    def initialize(credentials, provider)
+    def initialize(credentials: nil, provider: nil, identifier: nil)
+      #raise(ArgumentError, "missing argument credentials") unless credentials
+      raise(ArgumentError, "missing argument provider") unless provider
       @credentials = credentials 
       @provider = provider
+      @identifier = identifier
     end
 
     ##
     # Requests the configuration data and metadata
     # Delegates the request to the configured +provider+.
     #
-    # @param [String] identifier unique identifier of configuration
+    # @param [String] identifier
+    #   unique identifier of configuration. Required if the instance was initialized with a context that provided no +identifier+.
     # @return [ConfigurationService::Configuration] object containing the configuration data, metadata and identifier
-    # @raise [ConfigurationService::ConfigurationNotFoundError] if no configuration was found for the configured +identifier+
+    # @raise [ConfigurationService::ConfigurationNotFoundError] if no configuration was found for the +identifier+
+    # @raise [ConfigurationService::Error] if no +identifier+ is given as an argument or supplied in the initialized context.
     # @raise [ConfigurationService::Error] if the request failed
     #
-    def request_configuration(identifier)
+    def request_configuration(identifier: nil)
+      identifier = identifier_argument_or_instance_variable(identifier)
       @provider.request_configuration(identifier, @credentials) or 
         raise ConfigurationNotFoundError, "configuration not found for identifier: #{identifier}"
     end
@@ -46,15 +53,17 @@ module ConfigurationService
     # and that values be limited to those that can be serialized to JSON.
     #
     # @param [String] identifier
-    #   unique configuration identifier
+    #   unique identifier of configuration. Required if the instance was initialized with a context that provided no +identifier+.
     # @param [Hash] data
     #   dictionary of probably sensitive configuration data intended for an application, which providers are expected to secure
     # @param [Hash] metadata 
     #   dictionary of data about the configuration data, which providers are not expected to secure
     # @return [ConfigurationService::Configuration] object containing the configuration data, decorated metadata and identifier
+    # @raise [ConfigurationService::Error] if no +identifier+ is given as an argument or supplied in the initialized context.
     # @raise [ConfigurationService::Error] if publication failed
     #
-    def publish_configuration(identifier, data, metadata = {})
+    def publish_configuration(identifier: nil, data: nil, metadata: {})
+      identifier = identifier_argument_or_instance_variable(identifier)
       Utils.dictionary?(data) or raise ConfigurationService::Error, "data must be a dictionary"
       Utils.dictionary?(metadata) or raise ConfigurationService::Error, "metadata must be a dictionary"
 
@@ -67,16 +76,26 @@ module ConfigurationService
     # Authorize consumption of a configuration ie. get credentials to consume configurations ie. get a token to consume configurations
     # 
     # @param [String] identifier
-    #   unique identifier of configuration
+    #   unique identifier of configuration. Required if the instance was initialized with a context that provided no +identifier+.
     # @return [String] credentials allowing consumption of the provided configuration
     # @raise [ConfigurationService::ConfigurationNotFoundError] if no configuration was found for the configured +identifier+
+    # @raise [ConfigurationService::Error] if no +identifier+ is given as an argument or supplied in the initialized context.
     # @raise [ConfigurationService::Error] if the request failed
     ##
-    def authorize_consumption(identifier)
+    def authorize_consumption(identifier: nil)
+      identifier = identifier_argument_or_instance_variable(identifier)
       @provider.authorize_consumption(identifier, @credentials) or
         raise ConfigurationNotFoundError, "configuration not found for identifier: #{identifier}"
     end
 
+    private
+
+    def identifier_argument_or_instance_variable(identifier)
+      identifier ||= @identifier
+      raise(ConfigurationService::Error, "missing argument identifier (required when initialized without identifier)") unless identifier
+      identifier
+    end
+
   end
 
 end

data/lib/configuration_service/configuration.rb

@@ -10,7 +10,7 @@ module ConfigurationService
   # @attr_reader [Hash] metadata
   #   dictionary of data about the configuration data, which providers are not expected to secure
   #
-  # @see ConfigurationService::Base#publish_configuration
+  # @see ConfigurationService::Client#publish_configuration
   #
   class Configuration
 

data/lib/configuration_service/factory/context.rb

@@ -7,11 +7,10 @@ module ConfigurationService
     ##
     # A factory context for static factory configuration
     #
-    # The typical use case for this class is in constructing an {ConfigurationService::AdminClient AdminClient}
+    # The typical use case for this class is in constructing a multi-identifier {ConfigurationService::Client Client}
     # using a data structure acquired from a secure source that does not need to be scrubbed.
     #
     # @see ConfigurationService::Factory.create_client
-    # @see ConfigurationService::Factory.create_admin_client
     #
     class Context
 
@@ -24,9 +23,9 @@ module ConfigurationService
       # The following keys are used by the {ConfigurationService::Factory}:
       #
       # [identifier]      the unique identity of the configuration data
-      #                   (see {ConfigurationService::Base#initialize})
+      #                   (see {ConfigurationService::Client#initialize})
       # [token]           authorization token for the identified configuration data
-      #                   (see {ConfigurationService::Base#initialize})
+      #                   (see {ConfigurationService::Client#initialize})
       # [provider_id]     the unique identity of the service provider
       #                   (see {ConfigurationService::ProviderRegistry})
       # [provider_config] configuration options for the service provider
@@ -39,12 +38,18 @@ module ConfigurationService
       ##
       # The unique identity of the configuration data
       #
-      # Required for {ConfigurationService::Base}. Not used by {ConfigurationService::AdminClient}.
-      #
       def identifier
         @env[:identifier]
       end
 
+      ##
+      #
+      # Whether the context includes an +identifier+
+      #
+      def identifier?
+        @env.include?(:identifier)
+      end
+
       ##
       # Authorization token for the identified configuration data
       #

data/lib/configuration_service/factory/environment_context.rb

@@ -39,9 +39,9 @@ module ConfigurationService
       # The sources are scanned for {#prefix} matches, within which the following variables are used:
       #
       # [IDENTIFIER] the unique identity of the configuration data
-      #              (see {ConfigurationService::Base#initialize})
+      #              (see {ConfigurationService::Client#initialize})
       # [TOKEN]      authorization token for the identified configuration data
-      #              (see {ConfigurationService::Base#initialize})
+      #              (see {ConfigurationService::Client#initialize})
       # [PROVIDER]   the unique identity of the service provider
       #              (see {ConfigurationService::ProviderRegistry})
       # [PROVIDER_*] configuration options for the service provider

data/lib/configuration_service/factory/environment_context_backward_compatibility.rb

@@ -19,9 +19,9 @@ module ConfigurationService
       # 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})
+      #              (see {ConfigurationService::Client#initialize})
       # [TOKEN]      authorization token for the identified configuration data
-      #              (see {ConfigurationService::Base#initialize})
+      #              (see {ConfigurationService::Client#initialize})
       # [PROVIDER]   the unique identity of the service provider
       #              (see {ConfigurationService::ProviderRegistry})
       # [PROVIDER_*] configuration options for the service provider
@@ -34,13 +34,13 @@ module ConfigurationService
       # 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.
+      # Then a service {ConfigurationService::Client} 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
+      # @return [ConfigurationService::Client] 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.

data/lib/configuration_service/factory.rb

@@ -33,15 +33,18 @@ module ConfigurationService
   #   configuraton = configuration_service.request_configuration
   #   AcmeApplication.new(configuration.data).run
   #
-  # @example Creating an {ConfigurationService::AdminClient AdminClient} with static bootstrap configuration
+  # @example Creating a multi-identifier client with static bootstrap configuration
   #
-  #   admin_client = ConfigurationService::Factory.create_admin_client(
+  #   admin_client = ConfigurationService::Factory.create_client(
   #     "token" => "c3935418-f621-40de-ada3-cc8169f1348a",
+  #     # Note: no identifier provided
   #     "provider_id" => "vault",
   #     "provider_config" => {
   #       "address" => "http://127.0.0.1:8200"
   #     }
   #   )
+  #   acme_config = admin_client.request_configuration(identifier: "acme")
+  #   wile_config = admin_client.request_configuration(identifier: "wile")
   #
   module Factory
 
@@ -50,19 +53,21 @@ module ConfigurationService
     #
     # @param [ConfigurationService::Factory::EnvironmentContext, ConfigurationService::Factory::Context, Hash] context
     #   the factory context
-    # @return [ConfigurationService::Base] the configuration service client created
+    # @return [ConfigurationService::Client] the configuration service client created
     #
     # When the +context+ is a Hash, it is wrapped in a {ConfigurationService::Factory::Context}, which does not scrub
     # sources after the configuration service client is created. For this reason, the process +ENV+ should never
     # be given as the +context+; rather give no +context+, so that the default {ConfigurationService::Factory::EnvironmentContext}
     # will be used to safely scrub the process +ENV+ and (on JRuby) system properties after the configuration service client is created.
     #
-    # The context must provide an +identifier+ property.
+    # If the context does not provide an +identifier+ property, the instance methods on the client object will require
+    # an +identifier+ argument.
     #
     def self.create_client(context = EnvironmentContext.new)
       context = Context.new(context) if context.is_a?(Hash)
       provider = create_provider(context)
-      ConfigurationService::Client.new(context.token, provider)
+      identifier = context.identifier? ? context.identifier : nil
+      ConfigurationService::Client.new(credentials: context.token, provider: provider, identifier: identifier)
     ensure
       context.scrub!
     end

data/lib/configuration_service/provider/broken.rb

@@ -3,7 +3,7 @@ module ConfigurationService
   module Provider
 
     ##
-    # A stub broken {ConfigurationService::Base} service provider
+    # A stub broken {ConfigurationService::Client} service provider
     #
     # Used to validate the test framework architecture.
     #

data/lib/configuration_service/provider/stub.rb

@@ -50,7 +50,7 @@ module ConfigurationService
       # @return [nil] if not found
       # @raise [ConfigurationService::AuthorizationError] if not authorized for the +:consumer+ role
       #
-      # @see ConfigurationService::Base#request_configuration
+      # @see ConfigurationService::Client#request_configuration
       #
       def request_configuration(identifier, credentials)
         authorize_request(:consumer, credentials)
@@ -71,7 +71,7 @@ module ConfigurationService
       # @return [ConfigurationService::Configuration] published configuration
       # @raise [ConfigurationService::Error] on failure.
       #
-      # @see ConfigurationService::Base#publish_configuration
+      # @see ConfigurationService::Client#publish_configuration
       #
       def publish_configuration(configuration, credentials)
         authorize_request(:publisher, credentials) 

data/lib/configuration_service/provider.rb

@@ -2,7 +2,7 @@ module ConfigurationService
 
   ##
   # A configuration service provider is an imperative implementation of the configuration service API,
-  # to be plugged into a {ConfigurationService::Base}.
+  # to be plugged into a {ConfigurationService::Client}.
   #
   # A {ConfigurationService::Provider::Stub} implementation is provided to validate the test framework architecture.
   #

data/lib/configuration_service/test/orchestration_provider.rb

@@ -11,7 +11,7 @@ module ConfigurationService
     #
     #   Extend this class if you want your test orchestration provider toconstrain your implementation's interface
     #   to work as a configuration service provider.
-    #   If you have no intention of plugging your implementation into {ConfigurationService::Base},
+    #   If you have no intention of plugging your implementation into {ConfigurationService::Client},
     #   build your own test orchestration provider from scratch, using {ConfigurationService::Test::Orchestrator}
     #   and {ConfigurationService::Test::StubOrchestrationProvider} as a guide.
     #
@@ -63,7 +63,7 @@ module ConfigurationService
       ##
       # The service provider under test
       #
-      # @return [Object] a provider to be plugged into {ConfigurationService::Base}
+      # @return [Object] a provider to be plugged into {ConfigurationService::Client}
       #
       def service_provider
         raise NotImplementedError, "#{self.class} must implement service_provider"
@@ -72,7 +72,7 @@ module ConfigurationService
       ##
       # A broken service provider
       #
-      # @return [Object] a provider to be plugged into {ConfigurationService::Base}.
+      # @return [Object] a provider to be plugged into {ConfigurationService::Client}.
       #                  The service provider's +publish_configuration+ and +request_configuration+ methods
       #                  must raise an {ConfigurationService::Error} other than {ConfigurationService::AuthorizationError}.
       #
@@ -175,11 +175,11 @@ module ConfigurationService
       #
       # @return [ConfigurationService::Test::Response]
       #
-      # @see ConfigurationService::Base#request_configuration
+      # @see ConfigurationService::Client#request_configuration
       #
       def request_configuration
         wrap_response do
-          @requested_configuration = service.request_configuration(@identifier)
+          @requested_configuration = service.request_configuration(identifier: @identifier)
         end
       end
 
@@ -189,7 +189,7 @@ module ConfigurationService
       # @return [String] credentials allowing consumption of a configuration
       ##
       def authorize_consumption
-        @credentials = service.authorize_consumption(@identifier)
+        @credentials = service.authorize_consumption(identifier: @identifier)
       end
 
       def credentials_allow_consumption?
@@ -210,14 +210,14 @@ module ConfigurationService
       #
       # @return [ConfigurationService::Test::Response]
       #
-      # @see ConfigurationService::Base#publish_configuration
+      # @see ConfigurationService::Client#publish_configuration
       #
       def publish_configuration
         wrap_response do
           if @metadata
-            service.publish_configuration(@identifier, configuration, @metadata)
+            service.publish_configuration(identifier: @identifier, data: configuration, metadata: @metadata)
           else
-            service.publish_configuration(@identifier, configuration)
+            service.publish_configuration(identifier: @identifier, data: configuration)
           end
         end
       end
@@ -272,7 +272,7 @@ module ConfigurationService
           provider = broken_service_provider
         end
     
-        ConfigurationService::Client.new(@credentials, provider)
+        ConfigurationService::Client.new(credentials: @credentials, provider: provider)
       end
 
       def authorized_as(role)

data/lib/configuration_service/test/orchestrator.rb

@@ -14,11 +14,11 @@ module ConfigurationService
     # It keeps no domain state, because that would couple it to the
     # service implementation. By making no assumptions at all about the API
     # or data, it allows implementors to produce service implementations
-    # that do not adhere to the anticipated {ConfigurationService::Base} API,
+    # that do not adhere to the anticipated {ConfigurationService::Client} API,
     # by writing their own test orchestration provider from scratch
     # instead of extending {ConfigurationService::Test::OrchestrationProvider}.
     #
-    # However, implementors who are trying to produce {ConfigurationService::Base}
+    # However, implementors who are trying to produce {ConfigurationService::Client}
     # providers should extend {ConfigurationService::Test::OrchestrationProvider},
     # which anticipates a compatible provider API.
     #
@@ -280,7 +280,7 @@ module ConfigurationService
       #
       def bootstrapped_configuration_service_functional?
         response = begin
-                     ConfigurationService::Test::Response::Success.new(@service.request_configuration('test'))
+                     ConfigurationService::Test::Response::Success.new(@service.request_configuration(identifier: 'test'))
                    rescue ConfigurationService::Error => e
                      ConfigurationService::Test::Response::Failure.new(e)
                    end

data/lib/configuration_service/version.rb

@@ -1,5 +1,5 @@
 module ConfigurationService
 
-  VERSION = "3.0.0"
+  VERSION = "4.0.0"
 
 end

data/lib/configuration_service.rb

@@ -15,6 +15,7 @@ module ConfigurationService
   # Creates a new {ConfigurationService::Base}
   #
   # @see ConfigurationService::Base#initialize
+  # @deprecated use ConfigurationService::Client instead
   #
   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: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,3 +158,4 @@ signing_key:
 specification_version: 4
 summary: Configuration service
 test_files: []
+has_rdoc: