configuration_service 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c1d020e9ee176a21a78ca58785734d98ebda535
-  data.tar.gz: 5401e260c0d0a9da6ca31029b847b49fdaa8e6c7
+  metadata.gz: 013e070f4e04c050a8fdd8232cac7fb22cb652b1
+  data.tar.gz: 3d329fe8548014c9e43e1553a1e506d5438c6a7f
 SHA512:
-  metadata.gz: 842390201eb9dc49e9fc37c7a9f9913a6f08ea28fc710000ae220245d53f7503f27a9b2df3446cc74b54acc68492b889159b7485d2282fdf0a42ca22e738262f
-  data.tar.gz: cc8bdbf31cbaed9751562d69295a521ac0c089c65c3da176fb2b74a521d7e08221c58ad61954c4d00a33f10a7682b855259ed80fb1a2f63613404d6c1db5312b
+  metadata.gz: 226d8f3472c3a62716ced933186f5f926388575f29ab8ce91527d8b6ef19d5f9080409519dd8ecf37e405854705c17f7942ad6f994d8d4c76690866cc3438be9
+  data.tar.gz: df846414184710ca2d20903e017f1712897e4df8c97dc569f3296eb8bf1ce5a5224586ed531dc8e00985822f42e4405020b89232e54e9b59ba2171ba8f3f2754

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       = "0.0.1"
+  spec.version       = "1.0.0"
   spec.authors       = ["Sheldon Hearn"]
   spec.email         = ["sheldonh@starjuice.net"]
 

data/lib/configuration_service/base.rb

@@ -12,32 +12,44 @@ module ConfigurationService
   class Base
 
     ##
-    # Creates a new API instance for the +provider+
+    # Creates a new API instance for the service +provider+
     #
-    def initialize(provider)
+    # The +identifier+ is a string that uniquely identifies some configuration data and associated metadata.
+    # It might be the name of a service or service component. It might include an environment label (e.g.
+    # production, staging, etc.) For example:
+    #
+    # * billing.acme.com
+    # * billing-web1.acme.com
+    # * billing/production/web1
+    #
+    # The +token+ is a string that authorizes the client to access the configuration data and associated metadata.
+    # Interpretation of the +token+ is provider-dependent; it is opaque to the API and client.
+    #
+    # The +provider+ is a configured service provider instance.
+    #
+    def initialize(identifier, token, provider)
+      @identifier = identifier
+      @token = token
       @provider = provider
     end
 
     ##
-    # Requests configuration data and metadata
+    # Requests the configuration data and metadata for the +identifier+
     #
-    # Delegates the request to the provider. An optional +metadata_filter+
-    # may be supplied to restrict access to, for example, a specific revision
-    # of the configuration.
+    # Delegates the request to the provider.
     #
     # Returns a Configuration object or raises an Error on failure.
     # Returns +nil+ if no matching configuration was found.
     #
-    def request_configuration(metadata_filter = {})
-      @provider.request_configuration(metadata_filter)
+    def request_configuration
+      @provider.request_configuration(@identifier, @token)
     end
 
     ##
     # Publishes configuration +data+ and optional +metadata+
     #
-    # Delegates the publication to the provider. The +data+ and the +metadata+ (if specified)
-    # must be dictionaries (responding to #to_hash or #to_h). The provider receives a
-    # copy of the +metadata+ decorated with the following keys:
+    # The +data+ and the +metadata+ (if specified) must be dictionaries (responding to #to_hash or #to_h).
+    # The provider receives a a Configuration object, whose +metadata+ is decorated with the following keys:
     #
     # * "timestamp" - the current UTC time in ISO8601 format
     # * "revision"  - a UUID for this publication
@@ -50,19 +62,9 @@ module ConfigurationService
       dictionary?(data) or raise ConfigurationService::Error, "data must be a dictionary"
       dictionary?(metadata) or raise ConfigurationService::Error, "metadata must be a dictionary"
 
-      @provider.publish_configuration(data, decorate(metadata))
-    end
-
-    ##
-    # True if the +metadata+ matches the +metadata_filter+
-    #
-    # The +metadata+ matches the +metadata_filter+ if every key in the +metadata_filter+
-    # is present in the +metadata+, and the values of both keys are equal (==).
-    #
-    # This is a utility method intended for use by providers.
-    #
-    def self.metadata_matches_filter?(metadata, metadata_filter)
-      metadata_filter.all? { |k, v| v == metadata[k] }
+      metadata = decorate(metadata)
+      configuration = Configuration.new(@identifier, data, metadata)
+      @provider.publish_configuration(configuration, @token)
     end
 
     private

data/lib/configuration_service/configuration.rb

@@ -3,6 +3,7 @@ module ConfigurationService
   ##
   # Encapsulates configuration +data+ and its +metadata+
   #
+  # * +identifier is the string identifier of the data and metadata.
   # * +data+ is a dictionary of (possibly sensitive) configuration data,
   #   which providers are expected to secure.
   # * +metadata+ is a dictionary of data about the configuration data,
@@ -13,12 +14,14 @@ module ConfigurationService
   #
   class Configuration
 
-    attr_reader :data, :metadata, :revision # :nodoc:
+    # TODO consider removing :revision as an attr
+    attr_reader :identifier, :data, :metadata, :revision # :nodoc:
 
     ##
     # Returns a new Configuration
     #
-    def initialize(data, metadata)
+    def initialize(identifier, data, metadata)
+      @identifier = identifier
       @data = data
       @metadata = metadata
       @revision = metadata["revision"]

data/lib/configuration_service/provider/broken.rb

@@ -12,14 +12,14 @@ module ConfigurationService
       ##
       # Raises Error
       #
-      def publish_configuration(data, metadata)
+      def publish_configuration(configuration, token)
         raise ConfigurationService::Error, "error requested by test"
       end
 
       ##
       # Raises Error
       #
-      def request_configuration(metadata_filter = {})
+      def request_configuration(identifier, token)
         raise ConfigurationService::Error, "error requested by test"
       end
 

data/lib/configuration_service/provider/stub.rb

@@ -3,7 +3,6 @@ require "securerandom"
 
 require "configuration_service"
 
-require_relative "broken"
 require_relative "stub_store"
 
 module ConfigurationService
@@ -29,12 +28,7 @@ module ConfigurationService
       ##
       # Returns a new Stub
       #
-      # The object is initialized with a configuration +identifier+ and an
-      # authorization +token+ and holds a reference to the singleton StubStore.
-      #
-      def initialize(identifier, token)
-        @identifier = identifier
-        @token = token
+      def initialize
         @configurations = StubStore.instance
       end
 
@@ -43,50 +37,41 @@ module ConfigurationService
       #
       # See Base#request_configuration.
       #
-      # The configured +identifier+ is used to fetch the data from the StubStore.
-      #
-      # An optional +metadata_filter+ may be supplied to restrict access to, for
-      # example, a specific revision of the configuration.
+      # Fetches configuration from the singleton StubStore.
       #
       # Returns a Configuration object or raises AuthorizationError if the
-      # configured +token+ is not for the +:consumer+ role.
-      # Returns +nil+ if no matching configuration was found.
+      # +token+ is not for the +:consumer+ role.
       #
-      def request_configuration(metadata_filter)
-        authorize_request(:consumer)
-        data, metadata = @configurations.fetch(@identifier)
-        if Base.metadata_matches_filter?(metadata, metadata_filter)
-          Configuration.new(data, metadata)
-        end
+      # Returns +nil+ if no configuration was found for the +identifier+.
+      #
+      def request_configuration(identifier, token)
+        authorize_request(:consumer, token)
+        data, metadata = @configurations.fetch(identifier)
+        Configuration.new(identifier, data, metadata)
       rescue KeyError
         nil
       end
 
       ##
-      # Publishes configuration +data+ and optional +metadata+
+      # Publishes configuration
       #
       # See Base#publish_configuration.
       #
-      # The +data+ and the +metadata+ (if specified) must be dictionaries
-      # (responding to #to_hash or #to_h). The provider receives a copy of the
-      # +metadata+ decorated with the following keys:
-      #
-      # * "timestamp" - the current UTC time in ISO8601 format
-      # * "revision"  - a UUID for this publication
+      # +configuration+ should be a Configuration object or similar.
       #
       # Returns a Configuration object or raises an Error on failure.
       #
-      def publish_configuration(data, metadata)
-        authorize_request(:publisher)
-        @configurations.store(@identifier, data, metadata)
-        Configuration.new(data, metadata)
+      def publish_configuration(configuration, token)
+        authorize_request(:publisher, token)
+        @configurations.store(configuration.identifier, configuration.data, configuration.metadata)
+        configuration
       end
 
       private
 
-        def authorize_request(role)
-          raise AuthorizationError.new("missing token") unless @token
-          raise AuthorizationError.new("authorization failed") unless @token == BUILTIN_TOKENS[role]
+        def authorize_request(role, token)
+          raise AuthorizationError.new("missing token") unless token
+          raise AuthorizationError.new("authorization failed") unless token == BUILTIN_TOKENS[role]
         end
 
     end

data/lib/configuration_service/test/orchestration_provider.rb

@@ -1,3 +1,4 @@
+require 'cucumber/errors'
 require 'configuration_service'
 
 module ConfigurationService
@@ -65,13 +66,6 @@ module ConfigurationService
         @metadata = {"version" => "1.0"}
       end
 
-      ##
-      # See Orchestrator#given_metadata_filter
-      #
-      def given_metadata_filter
-        @metadata_filter = {"revision" => "d4d40eab-cf66-4af5-9a77-d956a11682de"}
-      end
-
       ##
       # See Orchestrator#given_existing_configuration
       #
@@ -98,22 +92,6 @@ module ConfigurationService
         end
       end
 
-      ##
-      # See Orchestrator#given_existing_configuration_matching_metadata_filter
-      #
-      def given_existing_configuration_matching_metadata_filter
-        @metadata_matching_filter = (@metadata || {}).merge(@metadata_filter)
-        given_existing_configuration
-      end
-
-      ##
-      # See Orchestrator#given_existing_configuration_not_matching_metadata_filter
-      #
-      def given_existing_configuration_not_matching_metadata_filter
-        @metadata_matching_filter = {}
-        given_existing_configuration
-      end
-
       ##
       # See Orchestrator#existing_configuration
       #
@@ -135,11 +113,7 @@ module ConfigurationService
       #
       def request_configuration
         wrap_response do
-          if @metadata_filter
-            service.request_configuration(@metadata_filter)
-          else
-            service.request_configuration
-          end
+          service.request_configuration
         end
       end
 
@@ -152,8 +126,6 @@ module ConfigurationService
         wrap_response do
           if @metadata
             service.publish_configuration(configuration, @metadata)
-          elsif @metadata_matching_filter
-            service.publish_configuration(configuration, @metadata_matching_filter)
           else
             service.publish_configuration(configuration)
           end
@@ -216,17 +188,31 @@ module ConfigurationService
           raise NotImplementedError, "#{self.class} must implement token_for(role)"
         end
 
+        ##
+        # Raise a Cucumber::Pending exception
+        #
+        # This allows incomplete implementations to mark features as pending
+        #
+        def pending(message = nil) # :doc:
+          if message
+            raise Cucumber::Pending, message
+          else
+            raise Cucumber::Pending
+          end
+        end
+
         def configuration
           @configuration ||= {"verbose" => true}
         end
 
         def service
-          if @fail_next
-            @fail_next = false
-            ConfigurationService.new(broken_service_provider)
-          else
-            ConfigurationService.new(service_provider)
-          end
+          provider = if @fail_next
+                       @fail_next = false
+                       broken_service_provider
+                     else
+                       service_provider
+                     end
+          ConfigurationService.new(@identifier, @token, provider)
         end
 
         def authorized_as(role)

data/lib/configuration_service/test/orchestration_provider_registry.rb

@@ -29,7 +29,7 @@ module ConfigurationService
         ##
         # Return the +provider+ identified by the string +identifier+
         #
-        # The +provider must already have been registered with #register,
+        # The +provider+ must already have been registered with #register,
         # and should be a class with a default (nullary) constructor.
         #
         # Returns +nil+ if no provider has been registered with the given

data/lib/configuration_service/test/orchestrator.rb

@@ -44,13 +44,6 @@ module ConfigurationService
         @provider.given_metadata
       end
 
-      ##
-      # Include a metadata filter in the next consuming operation
-      #
-      def given_metadata_filter
-        @provider.given_metadata_filter
-      end
-
       ##
       # Arrange a published configuration fixture
       def given_existing_configuration
@@ -71,24 +64,6 @@ module ConfigurationService
         @provider.given_missing_configuration
       end
 
-      ##
-      # Arrange a published configuration fixture
-      #
-      # Use a metadata filter that matches the fixture's metadata in the next consuming operation.
-      #
-      def given_existing_configuration_matching_metadata_filter
-        @provider.given_existing_configuration_matching_metadata_filter
-      end
-
-      ##
-      # Arrange a published configuration fixture
-      #
-      # Use a metadata filter that does not match the fixture's metadata in the next consuming operation.
-      #
-      def given_existing_configuration_not_matching_metadata_filter
-        @provider.given_existing_configuration_not_matching_metadata_filter
-      end
-
       ##
       # Return a published configuration fixture
       #

data/lib/configuration_service/test/stub_orchestration_provider.rb

@@ -1,3 +1,4 @@
+require "configuration_service/provider/broken"
 require "configuration_service/provider/stub"
 require "configuration_service/test"
 
@@ -17,11 +18,8 @@ module ConfigurationService
         ##
         # Returns a new Stub
         #
-        # The object is initialized with the currently #authorize'd +token+
-        # and consistently used configuration +identifier+.
-        #
         def service_provider # :doc:
-          ConfigurationService::Provider::Stub.new(@identifier, @token)
+          ConfigurationService::Provider::Stub.new
         end
 
         ##

data/lib/configuration_service.rb

@@ -10,8 +10,10 @@ module ConfigurationService
   ##
   # Creates a new ConfigurationService::Base for the +provider+
   #
-  def self.new(provider)
-    ConfigurationService::Base.new(provider)
+  # See ConfigurationService::Base#initialize.
+  #
+  def self.new(identifier, token, provider)
+    ConfigurationService::Base.new(identifier, token, provider)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configuration_service
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,3 +119,4 @@ signing_key:
 specification_version: 4
 summary: Configuration service
 test_files: []
+has_rdoc: