blinkist-config 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f124d3763ba77723dd15b742f34059417f04e669
-  data.tar.gz: 9d83b0e2e91c7f4f8dee43f31d678e8ad29b7ae9
+  metadata.gz: e3ced4954f00dac9ba41bf8942eadd20ed04c355
+  data.tar.gz: 7dc2ca9ab278f071dec3417f8f0ca82ccc317e2c
 SHA512:
-  metadata.gz: 357f0e51ee0a058243a548e0f2a5a150554b3d3d022146d96c4850e280f6065279b305f918263b9f7d04e5906dadc301956db83a798e623c4dac525ca6436aae
-  data.tar.gz: 8c3352a6add14f838b3a10da3bacdf08304775e25a79304a1dbb1154e8de8b1703e2f457cc8d18cdc5cc9b9b1d22e864c18f71de8b48838d42ab5f44804d40bf
+  metadata.gz: d463681c830d3e57f99eec95bb6ed456ac304ea246db4926cb0c4765d469aa0e129f132edeab14346e15b2bf5d898fc1b3602441e46717ae6f2da9513216090e
+  data.tar.gz: f090fa2cb1c05855b9b5dc22bd544c0bcec5b509a8a8cd7f9f3d553c5ed20b269c58be1998f6c59458263981480469d5fc4b4b48f88e18473a6baf0a05ce9510

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

@@ -74,6 +74,35 @@ my_config_value = Blinkist::Config.get! "another/config", scope: "global"
 # 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
 

data/Rakefile

@@ -3,10 +3,10 @@ require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new do |task|
-  task.options = %w[-a]
+  task.options = %w(-a)
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
 task(:default).clear
-task default: %i[rubocop spec]
+task default: %i(rubocop spec)

data/blinkist-config.gemspec

@@ -15,11 +15,12 @@ Gem::Specification.new do |spec|
   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.require_paths = %w(lib)
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_runtime_dependency "diplomat", "~> 1"
+  spec.add_runtime_dependency "aws-sdk-ssm", "~> 1.3.0"
 end

data/lib/blinkist/config.rb

@@ -9,6 +9,7 @@ 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
@@ -20,6 +21,10 @@ module Blinkist
         get!(key, default, scope: scope)
       end
 
+      def preload(scope: nil)
+        adapter.preload scope: scope
+      end
+
       extend Gem::Deprecate
       deprecate :get, "get!", 2017, 12
 

data/lib/blinkist/config/adapters.rb

@@ -3,7 +3,8 @@ module Blinkist
     module Adapters
       BUILT_IN = {
         env: EnvAdapter,
-        diplomat: DiplomatAdapter
+        diplomat: DiplomatAdapter,
+        aws_ssm: AwsSsmAdapter
       }.freeze
     end
   end

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

@@ -10,6 +10,10 @@ module Blinkist
         raise NotImplementedError
       end
 
+      def preload(**)
+        # nothing to do
+      end
+
       class << self
         def instance_for(type, env, app_name)
           Factory.new("Blinkist::Adapter.for", Adapters::BUILT_IN, env, app_name).call(type)

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

@@ -0,0 +1,56 @@
+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)
+        @client.get_parameters_by_path(
+          path: prefix,
+          recursive: true,
+          with_decryption: true
+        ).parameters.map do |parameter|
+          @items_cache[parameter.name] = parameter.value
+        end
+      end
+    end
+  end
+end

data/lib/blinkist/config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blinkist-config
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sebastian Schleicher, Blinks Labs GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 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
@@ -91,6 +105,7 @@ files:
 - 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