blinkist-config 1.0.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8ea30ece0d13a1b1603254be36125c28709c77d2
-  data.tar.gz: 9c9bb44d87a2310bfceb28e2e21c1d2eb387e58f
+SHA256:
+  metadata.gz: 7868467c713d2e0e0b123ac62d14f02d3a56455bf9040739eb22f328a6f6f7d2
+  data.tar.gz: 53e8be79f97294c44fe95134a31d1658d526bf9ea7514f4310881ab261860341
 SHA512:
-  metadata.gz: 660c83fc9d879674dd268b90f63bf5398d6b0a470ecbf049844ce29c86d0bdc4b766d77c3e63728a3480025622f585a162d9984259e2f51b074ac70e2576b1a8
-  data.tar.gz: e5d1b4cd3db5f6522a622dfabbcd8d02ad5a15a69668579e33ab97de07db93e87c2fde7ce83880e5b673afa50cfc5029b493aeea13e364721cdbeebeb1352fc8
+  metadata.gz: 88d3c68372a36670303fb7d2268d8bd5b57fab6735310e49fa578f9bd4fb9e6326999cdff380f0739ceb09ab67605eba091b11d4eaf0a8f5761d0bc997dfd9b7
+  data.tar.gz: a45d7dc3d5f72a38cfa2e747ae3a6d4c06f3234bea9a0476d98d722d1367f03ae022be1acbc1866f786e223ddacfd4c7c7144933285da7b9a743db394975fe0b

data/.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/blinkist/blinkist-config
+    parallelism: 1
+    docker:
+    - image: cimg/ruby:2.7.3-browsers
+    steps:
+    - checkout
+    - restore_cache:
+        keys:
+          - gem-cache-{{ checksum "Gemfile.lock" }}
+          - gem-cache-
+    - run: 
+        name: Bundle Install
+        command: bundle install --jobs=4 --retry=3 --path=vendor/bundle
+    - save_cache:
+        key: gem-cache-{{ checksum "Gemfile.lock" }}
+        paths:
+          - vendor/bundle
+    - run:
+        name: RSpec
+        command: bundle exec rspec --format progress spec
+        environment:
+          RAILS_ENV: test
+          RACK_ENV: test

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.3.1-slim
+FROM ruby:2.5.1-slim
 
 ENV RAILS_ENV=test
 ENV LANG en_US.UTF-8
@@ -14,7 +14,7 @@ ADD . /tmp/tmpapp
 
 RUN echo 'gem: --no-document' >> ~/.gemrc && \
     apt-get clean && apt-get update -qq && apt-get install -y build-essential $RUNTIME_PACKAGES && \
-    gem install bundler --version 1.12.5 && \
+    gem install bundler --version 2.2.10 && \
     gem install gem-release && \
     bundle update && bundle install --jobs 20 --retry 5 && \
     rm -Rf /tmp/tmpapp/ && \
@@ -29,4 +29,4 @@ RUN bundle install -j1
 RUN chown -R nobody:nogroup /app
 RUN whoami
 USER nobody
-RUN whoami
+RUN whoami

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in blinkist-config.gemspec
 gemspec
 
-gem "rubocop", "~> 0"
-
 group :test do
   gem "codeclimate-test-reporter", "~> 1.0.0"
   gem "simplecov"

data/README.md

@@ -1,7 +1,6 @@
 # Blinkist::Config
 
 [![CircleCI](https://circleci.com/gh/blinkist/blinkist-config.svg?style=shield)](https://circleci.com/gh/blinkist/blinkist-config)
-[![Dependency Status](https://www.versioneye.com/user/projects/58abf0e4b4d2a20036950ef0/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/58abf0e4b4d2a20036950ef0)
 [![Code Climate](https://codeclimate.com/github/blinkist/blinkist-config/badges/gpa.svg)](https://codeclimate.com/github/blinkist/blinkist-config)
 
 This GEM allows you to access configuration stores with different adapters. Here're some examples of usage:
@@ -10,19 +9,41 @@ This GEM allows you to access configuration stores with different adapters. Here
 
 ```ruby
 # First setup the Config to use the ENV as config store
+
+Diplomat.configure do |config|
+  config.url = "http://172.17.0.1:8500"
+end
+
 Blinkist::Config.env = ENV["RAILS_ENV"]
 Blinkist::Config.app_name = "my_nice_app"
 Blinkist::Config.adapter_type = :env
+Blinkist::Config.error_handler = :strict
 
-my_config_value = Blinkist::Config.get "some/folder/config"
+my_config_value = Blinkist::Config.get! "some/folder/config"
 
 # This is being translated to ENV["SOME_FOLDER_CONFIG"]
 ```
 
+### Error handling
+
+When configured with `Blinkist::Config.error_handler = :strict` (as recommended)
+reading a configuration entry for which the value is missing 
+(for example missing enviroment variables) will cause
+`Blinkist::Config::ValueMissingError` to be raised.
+
+There is also an alternative mode `Blinkist::Config.error_handler = :heuristic` which
+will raise exceptions only when `Blinkist::Config.env == "production"`.
+
+This alternative mode is also the default for compatibility.
+
 ### Having a default value
 
+If you don't want `Blinkist::Config.get!` to scream at you for missing
+configuration entries then you canprovide a default value as a second
+paramter to `get!`:
+
 ```ruby
-my_config_value = Blinkist::Config.get "some/folder/config", "default value"
+my_config_value = Blinkist::Config.get! "some/folder/config", "default value"
 
 # If ENV["SOME_FOLDER_CONFIG"] is nil, "default value" will be returned
 ```
@@ -42,7 +63,7 @@ Blinkist::Config.env = ENV["RAILS_ENV"]
 Blinkist::Config.app_name = "my_nice_app"
 Blinkist::Config.adapter_type = ENV["CONSUL_AVAILABLE"] == "true" ? :diplomat : :env
 
-my_config_value = Blinkist::Config.get "some/folder/config"
+my_config_value = Blinkist::Config.get! "some/folder/config"
 
 # This is will try to get a value from Consul's KV store at "my_nice_app/some/folder/config"
 ```
@@ -51,12 +72,41 @@ my_config_value = Blinkist::Config.get "some/folder/config"
 ```ruby
 # Here we setting a scope outside of the app
 
-my_config_value = Blinkist::Config.get "another/config", scope: "global"
+my_config_value = Blinkist::Config.get! "another/config", scope: "global"
 
 # This will replace `my_nice_app` with `global` and try to resolve "global/another/config"
 # With :env the scope will simply be ignored
 ```
 
+### Using AWS SSM
+
+If you want to use EC2's key value store SSM, simply use our aws_ssm adapter. It'll automatically try to decrypt all keys.
+
+The GEM expects the code to run in an AWS environment with properly set up IAM.
+
+```ruby
+Blinkist::Config.env = ENV["RAILS_ENV"]
+Blinkist::Config.app_name = "my_nice_app"
+Blinkist::Config.adapter_type = ENV["SSM_AVAILABLE"] == "true" ? :aws_ssm : :env
+
+my_config_value = Blinkist::Config.get! "some/folder/config"
+
+# This is will try to get a parameter from SSM at "/application/my_nice_app/some/folder/config"
+
+# You can also preload all parameters to avoid later calls to SSM
+Blinkist::Config.preload
+Blinkist::Config.preload scope: "global" # in case you need also another scope being preloaded
+```
+
+### Using SSM with a folder scope
+```ruby
+# Here we setting a scope outside of the app
+
+my_config_value = Blinkist::Config.get! "another/config", scope: "global"
+
+# This will replace `my_nice_app` with `global` and try to resolve "/application/global/another/config"
+```
+
 
 ## Installation
 
@@ -112,10 +162,9 @@ You'll have to have proper rights to access rubygems.org
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blinkist-config.
+Bug reports and pull requests are welcome on GitHub at https://github.com/blinkist/blinkist-config.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/blinkist-config.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require_relative "lib/blinkist/config/version"
@@ -10,16 +10,17 @@ Gem::Specification.new do |spec|
   spec.email         = ["sj@blinkist.com"]
 
   spec.summary       = "Simple adapter based configuration handler (supports ENV and Consul/Diplomat)."
-  spec.description   = "This GEM allows you to keep your configuration class-based by calling Blinkist::Config.get(...) instead of accessing the ENV directly. You can set up different types of adapters to connect to various configuration systems like your ENV or Consul's key-value-store."
+  spec.description   = "This GEM allows you to keep your configuration class-based by calling Blinkist::Config.get!(...) instead of accessing the ENV directly. You can set up different types of adapters to connect to various configuration systems like your ENV or Consul's key-value-store."
   spec.homepage      = "https://github.com/blinkist/blinkist-config"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = %w(lib)
 
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "bundler", "~> 2.2.10"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency "diplomat", "~> 1"
+  spec.add_runtime_dependency "diplomat", "~> 2"
+  spec.add_runtime_dependency "aws-sdk-ssm", "~> 1"
 end

data/lib/blinkist/config/adapters/adapter.rb

@@ -10,17 +10,17 @@ module Blinkist
         raise NotImplementedError
       end
 
+      def preload(**)
+        # nothing to do
+      end
+
       class << self
         def instance_for(type, env, app_name)
-          case type
-          when :env
-            EnvAdapter.new env, app_name
-          when :diplomat
-            DiplomatAdapter.new env, app_name
-          else
-            raise NotImplementedError
-          end
+          Factory.new("Blinkist::Adapter.for", Adapters::BUILT_IN, env, app_name).call(type)
         end
+
+        extend Gem::Deprecate
+        deprecate :instance_for, :none, 2017, 12
       end
     end
   end

data/lib/blinkist/config/adapters/aws_ssm_adapter.rb

@@ -0,0 +1,70 @@
+require_relative "adapter"
+require "aws-sdk-ssm"
+
+module Blinkist
+  class Config
+    class AwsSsmAdapter < Adapter
+      DEFAULT_PREFIX = "/application/".freeze
+
+      def initialize(env, app_name)
+        super env, app_name
+
+        @items_cache = {}
+        @client = Aws::SSM::Client.new
+      end
+
+      def get(key, default=nil, scope: nil)
+        prefix = prefix_for(scope)
+
+        query_ssm_parameter prefix + key
+      rescue Aws::SSM::Errors::ParameterNotFound
+        default
+      end
+
+      def preload(scope: nil)
+        query_all_ssm_parameters prefix_for(scope)
+      end
+
+      private
+
+      def prefix_for(scope)
+        if scope.nil?
+          DEFAULT_PREFIX + @app_name + "/"
+        else
+          DEFAULT_PREFIX + scope + "/"
+        end
+      end
+
+      def query_ssm_parameter(name)
+        @items_cache[name] ||= @client.get_parameter(
+          name: name,
+          with_decryption: true
+        ).parameter.value
+      end
+
+      def query_all_ssm_parameters(prefix)
+        parameters = []
+        next_token = nil
+
+        # SSM limits the results and we need to loop
+        loop do
+          result = @client.get_parameters_by_path(
+            path: prefix,
+            recursive: true,
+            with_decryption: true,
+            next_token: next_token
+          )
+
+          parameters += result.parameters
+          next_token = result.next_token
+
+          break if next_token.nil?
+        end
+
+        parameters.map do |parameter|
+          @items_cache[parameter.name] = parameter.value
+        end
+      end
+    end
+  end
+end

data/lib/blinkist/config/adapters/diplomat_adapter.rb

@@ -8,10 +8,6 @@ module Blinkist
         super env, app_name
 
         @items_cache = {}
-
-        Diplomat.configure do |config|
-          config.url = "http://172.17.0.1:8500"
-        end
       end
 
       def get(key, default=nil, scope: nil)

data/lib/blinkist/config/adapters.rb

@@ -0,0 +1,11 @@
+module Blinkist
+  class Config
+    module Adapters
+      BUILT_IN = {
+        env: EnvAdapter,
+        diplomat: DiplomatAdapter,
+        aws_ssm: AwsSsmAdapter
+      }.freeze
+    end
+  end
+end

data/lib/blinkist/config/error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class Error < ::StandardError
+    end
+  end
+end

data/lib/blinkist/config/error_handlers/error_handler.rb

@@ -0,0 +1,14 @@
+module Blinkist
+  class Config
+    class ErrorHandler
+      def initialize(env, app_name)
+        @env = env
+        @app_name = app_name
+      end
+
+      def call(key, scope)
+        raise ValueMissingError, "Missing value for #{key} in the scope: #{scope || '<default>'} (Please check the configuration for missing keys)"
+      end
+    end
+  end
+end

data/lib/blinkist/config/error_handlers/production_only_error_handler.rb

@@ -0,0 +1,9 @@
+module Blinkist
+  class Config
+    class ProductionOnlyErrorHandler < ErrorHandler
+      def call(key, scope)
+        super(key, scope) if @env.to_s == "production"
+      end
+    end
+  end
+end

data/lib/blinkist/config/error_handlers.rb

@@ -0,0 +1,11 @@
+
+module Blinkist
+  class Config
+    module ErrorHandlers
+      BUILT_IN = {
+        strict: ErrorHandler,
+        heuristic: ProductionOnlyErrorHandler
+      }.freeze
+    end
+  end
+end

data/lib/blinkist/config/factory.rb

@@ -0,0 +1,30 @@
+module Blinkist
+  class Config
+    class Factory
+      def initialize(aspect, implementations, env=Blinkist::Config.env, app_name=Blinkist::Config.app_name)
+        @aspect = aspect
+        @implementations = implementations
+        @env = env
+        @app_name = app_name
+      end
+
+      def call(strategy)
+        case strategy
+        when Symbol
+          klass = @implementations[strategy] ||
+                  raise(NotImplementedError, "Unknown strategy #{strategy} for #{@aspect}")
+        when Class
+          klass = strategy
+        else
+          if strategy.respond_to?(:call)
+            return strategy
+          else
+            raise InvalidStrategyError
+          end
+        end
+
+        klass.new(@env, @app_name)
+      end
+    end
+  end
+end

data/lib/blinkist/config/invalid_strategy_error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class InvalidStrategyError < Error
+    end
+  end
+end

data/lib/blinkist/config/not_implemented_error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class NotImplementedError < Error
+    end
+  end
+end

data/lib/blinkist/config/value_missing_error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class ValueMissingError < Error
+    end
+  end
+end

data/lib/blinkist/config/version.rb

@@ -1,5 +1,5 @@
 module Blinkist
   class Config
-    VERSION = "1.0.2".freeze
+    VERSION = "1.3.1".freeze
   end
 end

data/lib/blinkist/config.rb

@@ -1,19 +1,68 @@
 require_relative "config/version"
+require_relative "config/error"
+require_relative "config/factory"
+require_relative "config/not_implemented_error"
+require_relative "config/invalid_strategy_error"
+require_relative "config/value_missing_error"
+require_relative "config/error_handlers/error_handler"
+require_relative "config/error_handlers/production_only_error_handler"
+require_relative "config/error_handlers"
 require_relative "config/adapters/env_adapter"
 require_relative "config/adapters/diplomat_adapter"
+require_relative "config/adapters/aws_ssm_adapter"
+require_relative "config/adapters"
 
 module Blinkist
   class Config
     class << self
-      attr_accessor :adapter_type, :logger, :env, :app_name
+      attr_accessor :adapter_type, :logger, :env, :app_name, :error_handler
 
       def get(key, default = nil, scope: nil)
-        adapter.get(key, scope: scope) || default
+        get!(key, default, scope: scope)
+      end
+
+      def preload(scope: nil)
+        adapter.preload scope: scope
+      end
+
+      extend Gem::Deprecate
+      deprecate :get, "get!", 2017, 12
+
+      def get!(key, *args, scope: nil)
+        # NOTE: we need to do this this way
+        # to handle 'nil' default correctly
+        case args.length
+        when 0
+          default = nil
+          bang    = true
+        when 1
+          default = args.first
+          bang    = false
+        else
+          raise ArgumentError, "wrong number of arguments (given #{args.length + 1}, expected 1..2)"
+        end
+
+        from_adapter = adapter.get(key, scope: scope)
+
+        if from_adapter.nil? && bang
+          handle_error(key, scope)
+        else
+          return from_adapter || default
+        end
       end
 
       def adapter
-        @adapter ||= Adapter.instance_for adapter_type, env, app_name
+        @adapter ||= Factory.new("Blinkist::Config.adapter_type", Adapters::BUILT_IN).call(adapter_type)
+      end
+
+      def handle_error(key, scope)
+        handler = Factory.new("Blinkist::Config.error_handler", ErrorHandlers::BUILT_IN).call(error_handler)
+        handler.call(key, scope)
       end
+
     end
+
+    # NOTE: default configuration goes here
+    self.error_handler = :heuristic
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blinkist-config
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Sebastian Schleicher, Blinks Labs GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,20 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 description: This GEM allows you to keep your configuration class-based by calling
-  Blinkist::Config.get(...) instead of accessing the ENV directly. You can set up
+  Blinkist::Config.get!(...) instead of accessing the ENV directly. You can set up
   different types of adapters to connect to various configuration systems like your
   ENV or Consul's key-value-store.
 email:
@@ -76,6 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Dockerfile
@@ -89,15 +104,25 @@ files:
 - blinkist-config.gemspec
 - docker-compose.yml
 - lib/blinkist/config.rb
+- lib/blinkist/config/adapters.rb
 - lib/blinkist/config/adapters/adapter.rb
+- lib/blinkist/config/adapters/aws_ssm_adapter.rb
 - lib/blinkist/config/adapters/diplomat_adapter.rb
 - lib/blinkist/config/adapters/env_adapter.rb
+- lib/blinkist/config/error.rb
+- lib/blinkist/config/error_handlers.rb
+- lib/blinkist/config/error_handlers/error_handler.rb
+- lib/blinkist/config/error_handlers/production_only_error_handler.rb
+- lib/blinkist/config/factory.rb
+- lib/blinkist/config/invalid_strategy_error.rb
+- lib/blinkist/config/not_implemented_error.rb
+- lib/blinkist/config/value_missing_error.rb
 - lib/blinkist/config/version.rb
 homepage: https://github.com/blinkist/blinkist-config
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Simple adapter based configuration handler (supports ENV and Consul/Diplomat).
 test_files: []