configuration_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c1d020e9ee176a21a78ca58785734d98ebda535
+  data.tar.gz: 5401e260c0d0a9da6ca31029b847b49fdaa8e6c7
+SHA512:
+  metadata.gz: 842390201eb9dc49e9fc37c7a9f9913a6f08ea28fc710000ae220245d53f7503f27a9b2df3446cc74b54acc68492b889159b7485d2282fdf0a42ca22e738262f
+  data.tar.gz: cc8bdbf31cbaed9751562d69295a521ac0c089c65c3da176fb2b74a521d7e08221c58ad61954c4d00a33f10a7682b855259ed80fb1a2f63613404d6c1db5312b

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multicuke-blue.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    configuration_service (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    cucumber (2.0.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.2.0)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.2.0)
+      gherkin (~> 2.12.0)
+    diff-lcs (1.2.5)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    rake (10.4.2)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  configuration_service!
+  cucumber (~> 2.0)
+  rake (~> 10.0)
+  rspec-expectations (~> 3.3)
+
+BUNDLED WITH
+   1.10.3

data/README.md

@@ -0,0 +1,30 @@
+# Configuration service
+
+The configuration service provides authorized publication and consumption of identified configuration data with metadata.
+
+## Documentation
+
+Comprehensive rdoc documentation is available:
+
+```shell
+git clone git@github.com:hetznerZA/configuration_service.git
+cd configuration_service
+bundle install
+bundle exec rake doc
+xdg-open html/index.html
+```
+
+OSX users may need to use `open` instead of `xdg-open`.
+
+## Testing
+
+Test as follows:
+
+```shell
+git clone git@github.com:hetznerZA/configuration_service.git
+cd configuration_service
+bundle install
+bundle exec rake test
+```
+
+Note that the tests are applied to a stub service provider. This just tests the test framework architecture.

data/README.rdoc

@@ -0,0 +1,17 @@
+= Configuration service
+
+The configuration service provides
+{authorized}[link:features/authorization_feature.html]
+{publication}[link:features/publishing_feature.html] and
+{consumption}[link:features/consuming_feature.html]
+of identified configuration data with metadata.
+
+A pluggable Ruby API is provided in ConfigurationService::Base.
+
+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.
+See ConfigurationService::Test.
+
+A stub service provider is provided in
+ConfigurationService::Provider::Stub.

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rdoc/task'
+
+desc "Test the stub test orchestrator"
+task :test do
+  sh %{TEST_ORCHESTRATION_PROVIDER=stub bundle exec cucumber}
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.title = "Configuration service"
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = "rdoc"
+end
+
+desc "Regenerate documentation"
+task :doc => :rerdoc

data/configuration_service.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "configuration_service"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Configuration service}
+  spec.description   = %q{Configuration service}
+  spec.homepage      = "https://github.com/hetznerZA/configuration_service"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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-expectations", "~> 3.3"
+end

data/lib/configuration_service/base.rb

@@ -0,0 +1,82 @@
+module ConfigurationService
+
+  ##
+  # The configuration service API
+  #
+  # The service provides
+  # {authorized}[link:features/authorization_feature.html]
+  # {publication}[link:features/publishing_feature.html] and
+  # {consumption}[link:features/consuming_feature.html]
+  # of identified configuration data with metadata.
+  #
+  class Base
+
+    ##
+    # Creates a new API instance for the +provider+
+    #
+    def initialize(provider)
+      @provider = provider
+    end
+
+    ##
+    # Requests configuration data and metadata
+    #
+    # 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.
+    #
+    # 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)
+    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:
+    #
+    # * "timestamp" - the current UTC time in ISO8601 format
+    # * "revision"  - a UUID for this publication
+    #
+    # Returns a Configuration object or raises an Error on failure. When a Configuration object
+    # is returned, its +metadata+ is the decorated copy, allowing access to additional metadata
+    # added by the API or the provider.
+    #
+    def publish_configuration(data, metadata = {})
+      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] }
+    end
+
+    private
+
+      def dictionary?(o)
+        o.respond_to?(:to_hash) or o.respond_to?(:to_h)
+      end
+
+      def decorate(metadata)
+        revision = SecureRandom.uuid
+        metadata = metadata.merge("revision" => revision) unless metadata["revision"]
+        metadata = metadata.merge("timestamp" => Time.now.utc.iso8601) unless metadata["timestamp"]
+      end
+
+  end
+
+end

data/lib/configuration_service/configuration.rb

@@ -0,0 +1,29 @@
+module ConfigurationService
+
+  ##
+  # Encapsulates configuration +data+ and its +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,
+  #   which providers are not expected to secure.
+  #
+  # It is recommended that both dictionaries use strings as keys, and that
+  # values be limited to those that can be serialized to JSON.
+  #
+  class Configuration
+
+    attr_reader :data, :metadata, :revision # :nodoc:
+
+    ##
+    # Returns a new Configuration
+    #
+    def initialize(data, metadata)
+      @data = data
+      @metadata = metadata
+      @revision = metadata["revision"]
+    end
+
+  end
+
+end

data/lib/configuration_service/errors.rb

@@ -0,0 +1,18 @@
+module ConfigurationService
+
+  ##
+  # The base of the configuration service exception tree
+  #
+  # * Error
+  # * AuthorizationError
+  #
+  class Error < StandardError
+  end
+
+  ##
+  # A configuration service authorization Error
+  #
+  class AuthorizationError < Error
+  end
+
+end

data/lib/configuration_service/provider/broken.rb

@@ -0,0 +1,30 @@
+module ConfigurationService
+
+  module Provider
+
+    ##
+    # A stub broken ConfigurationService::Base service provider
+    #
+    # Used to validate the test framework architecture.
+    #
+    class Broken
+
+      ##
+      # Raises Error
+      #
+      def publish_configuration(data, metadata)
+        raise ConfigurationService::Error, "error requested by test"
+      end
+
+      ##
+      # Raises Error
+      #
+      def request_configuration(metadata_filter = {})
+        raise ConfigurationService::Error, "error requested by test"
+      end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/provider/stub.rb

@@ -0,0 +1,96 @@
+require "time"
+require "securerandom"
+
+require "configuration_service"
+
+require_relative "broken"
+require_relative "stub_store"
+
+module ConfigurationService
+
+  module Provider
+
+    ##
+    # A stub ConfigurationService::Base service provider
+    #
+    # Used to validate the test framework architecture.
+    #
+    class Stub
+
+      ##
+      # Maps roles to authorization tokens
+      #
+      BUILTIN_TOKENS = {
+        :consumer  => '64867ebd-6364-0bd3-3fda-81-requestor',
+        :publisher => 'f53606cb-7f3c-4432-afe8-44-publisher',
+        :nothing   => '2972abd7-b055-4841-8ad1-4a34-nothing',
+      } unless defined?(BUILTIN_TOKENS)
+
+      ##
+      # 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
+        @configurations = StubStore.instance
+      end
+
+      ##
+      # Requests configuration data and metadata
+      #
+      # 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.
+      #
+      # 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.
+      #
+      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
+      rescue KeyError
+        nil
+      end
+
+      ##
+      # Publishes configuration +data+ and optional +metadata+
+      #
+      # 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
+      #
+      # 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)
+      end
+
+      private
+
+        def authorize_request(role)
+          raise AuthorizationError.new("missing token") unless @token
+          raise AuthorizationError.new("authorization failed") unless @token == BUILTIN_TOKENS[role]
+        end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/provider/stub_store.rb

@@ -0,0 +1,58 @@
+require "singleton"
+
+unless defined?(ConfigurationService::Provider::StubStore)
+
+  module ConfigurationService
+
+    module Provider
+
+      ##
+      # A singleton store for the Stub service provider
+      #
+      class StubStore
+
+        include Singleton
+
+        def initialize # :nodoc:
+          @configurations = {}
+        end
+
+        ##
+        # Returns the configuration data and metadata for +identifier+
+        #
+        # The dictionaries are returned as an array, to be used as follows:
+        #
+        #   data, metadata = StubStore.instance.fetch("acme")
+        #
+        def fetch(identifier)
+          @configurations.fetch(identifier)
+        end
+
+        ##
+        # Stores the +data+ and +metadata associated with the +identifier+
+        #
+        def store(identifier, data, metadata)
+          @configurations.store(identifier, [data, metadata])
+        end
+
+        ##
+        # Deletes the data and metadata associated with the +identifier+
+        #
+        # It is not an error to delete a non-existent +identifier+
+        #
+        def delete(identifier)
+          @configurations.delete(identifier)
+          nil
+        end
+
+        ##
+        # Return the singleton store instance
+        # :singleton-method: instance
+
+      end
+
+    end
+
+  end
+
+end

data/lib/configuration_service/provider.rb

@@ -0,0 +1,13 @@
+module ConfigurationService
+
+  ##
+  # A configuration service provider is an imperative implementation
+  # of the ConfigurationService API, to be plugged into a
+  # ConfigurationService::Base.
+  #
+  # A Stub implementation is provided to validate the test framework architecture.
+  #
+  module Provider
+  end
+
+end