cloud-config 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5d99c6f38f07031a7da456fa285c345a87ed6f124a534d2b5fe004540743e85
-  data.tar.gz: cba8c49a6fcc40d3cfac3f451826a3fddaaf6a0d8a7271033fbc7e833dc47cbb
+  metadata.gz: 4f4463471bbbffc8cdfcda8361581f051804c106523c0fa86838f5e62de59a6e
+  data.tar.gz: 8c31a0844247d7e210e219099170f8bda4212fca7e2e61ab323872a8d68f8ed7
 SHA512:
-  metadata.gz: b883d58ca786602fe85135a77a31959c00dcd7d3af7534e63889320fb7d1d739285bb048fa6f2c72fb309c8ecf9ed4bc95da513be39a9d073a14ec768c4cb7c7
-  data.tar.gz: 0d61a08ecbba70c9ae743cf8fa84c68772da1a6a3566716fb9f17ed564472150ef5c6dcbc38e0f6b9722437327feef6cac85c6aca02e1bcd2c49ab0812c003fb
+  metadata.gz: 75a640f3415c4ae1b66e1d9260f1e02c77b5d4a692ef1de609ef3fbef5afcd6e858120a74ca15ef3a8a77259cce702bf856d60c1bac3d549cad1c32f24f2343e
+  data.tar.gz: 9e033c6fa3481c798ff064666f419478a5ff150e05cce1fe0bd6a44a235601b7a28f54fc7e37fa95bed89ddb38a2fb97b9e4587f1375a2531084cfbd55aad9e3

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [Released]
+
+## [0.2.1] - 2023-05-21
+
+Enhancements:
+
+- Allow options to be passed when fetching configuration from the provider
+
+
 ## [0.2.0] - 2023-05-20
 
 Bug fixes:
@@ -11,7 +20,6 @@ Enhancements:
 - Reset cache for single key
 - Lookup providers by configuration key
 
-## [Released]
 
 ## [0.1.0] - 2023-05-17
 

data/README.md

@@ -4,7 +4,7 @@ A library to modernise the way applications fetch configuration. Typically an ap
 
 A modern approach stores configuration remotely, often using key/value databases. Storing configurations in a single database, separately from the codebase reduces infrastructure dependency. Configuration updates can automatically sync with any application, without requiring redeployments. Security risk is greatly reduced, since configurations can be securely stored. Another goal with this approach is creating an environmentless codebase. The application no longer needs to know which environment it's running in, since all the configuration is handled by the infrastucture.
 
-Another common problem is password rotation. A typical application will need to be restarted or even redeployed when the configuration settings change, such as rotating passwords. CloudConfig can handle this elegantly, improving the uptime and resilience of the application.
+Another common problem is password rotation. A typical application will need to be restarted or even redeployed when the configuration settings change. CloudConfig can handle this elegantly, improving application uptime and resilience.
 
 ## Installation
 
@@ -75,6 +75,11 @@ CloudConfig.configure do
   provider :in_memory do
     setting :key1, cache: 60 # 60 seconds
   end
+
+  # If the datastore has configurable options
+  provider :aws_parameter_store do
+    setting :key1, with_decryption: true
+  end
 end
 ```
 
@@ -109,7 +114,7 @@ class CustomProvider
   def initialize(params = {}); end
 
   # Define `get` for fetching keys from the remote datastore
-  def get(key); end
+  def get(key, opts = {}); end
 
   # Define `set` for storing keys in the remote datastore
   def set(key, value); end

data/examples/001_parameter_store.rb

@@ -14,12 +14,13 @@ end
 require 'benchmark'
 require 'cloud-config/providers/aws_parameter_store'
 
+# @note: Make sure the `parameter_store_example` key is set in the parameter store
 CloudConfig.configure do
   provider :aws_parameter_store do
     setting :parameter_store_example
   end
 end
 
-puts 'Fetching key parameter_store_example'
+puts 'Fetching key: parameter_store_example'
 value = CloudConfig.get(:parameter_store_example)
-puts "Fetched value #{value}"
+puts "Fetched value: #{value}"

data/examples/002_parameter_store_with_cache.rb

@@ -15,6 +15,7 @@ require 'benchmark'
 require 'cloud-config/cache/in_memory'
 require 'cloud-config/providers/aws_parameter_store'
 
+# @note: Make sure the `parameter_store_example` key is set in the parameter store
 CloudConfig.configure do
   cache_client CloudConfig::Cache::InMemory.new
 
@@ -25,16 +26,20 @@ end
 
 value = nil
 
-puts 'Fetching key parameter_store_example'
+puts 'Fetching key; parameter_store_example'
 time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
-puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+puts "Fetched value: #{value} in #{time.real.round(5)} seconds"
+
+puts
 
-puts 'Fetching key parameter_store_example (cached)'
+puts 'Fetching key: parameter_store_example (cached)'
 time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
-puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+puts "Fetched value: #{value} in #{time.real.round(5)} seconds"
 
 sleep 5
 
+puts
+
 puts 'Fetching key parameter_store_example'
 time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
 puts "Fetched value #{value} in #{time.real.round(5)} seconds"

data/examples/003_parameter_store_with_preload.rb

@@ -15,6 +15,7 @@ require 'benchmark'
 require 'cloud-config/cache/in_memory'
 require 'cloud-config/providers/aws_parameter_store'
 
+# @note: Make sure the `parameter_store_example` key is set in the parameter store
 CloudConfig.configure do
   cache_client CloudConfig::Cache::InMemory.new
 
@@ -27,12 +28,14 @@ CloudConfig.preload
 
 value = nil
 
-puts 'Fetching key parameter_store_example (cached)'
+puts 'Fetching key: parameter_store_example (cached)'
 time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
-puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+puts "Fetched value: #{value} in #{time.real.round(5)} seconds"
 
 sleep 5
 
-puts 'Fetching key parameter_store_example'
+puts
+
+puts 'Fetching key: parameter_store_example'
 time = Benchmark.measure { value = CloudConfig.get(:parameter_store_example) }
-puts "Fetched value #{value} in #{time.real.round(5)} seconds"
+puts "Fetched value: #{value} in #{time.real.round(5)} seconds"

data/examples/004_handling_configuration_changes.rb

@@ -41,5 +41,7 @@ rescue Faraday::ServerError
 
   sleep 1
 
+  puts
+
   retry
 end

data/examples/005_parameter_store_encrypted_key.rb

@@ -0,0 +1,40 @@
+#! /usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'nokogiri'
+  gem 'aws-sdk-ssm'
+
+  gem 'cloud-config', path: '..'
+end
+
+require 'benchmark'
+require 'cloud-config/providers/aws_parameter_store'
+
+# @note: Make sure the `encrypted_key` key is set in the parameter store
+CloudConfig.configure do
+  provider :aws_parameter_store do
+    setting :encrypted_key
+  end
+end
+
+puts 'Fetching key: encrypted_key'
+value = CloudConfig.get(:encrypted_key)
+puts "Fetched value: #{value}"
+
+puts
+
+CloudConfig.reset!
+
+CloudConfig.configure do
+  provider :aws_parameter_store do
+    setting :encrypted_key, with_decryption: true
+  end
+end
+
+puts 'Fetching key: encrypted_key (decrypt)'
+value = CloudConfig.get(:encrypted_key)
+puts "Fetched value: #{value}"

data/lib/cloud-config/providers/aws_parameter_store.rb

@@ -13,18 +13,31 @@ module CloudConfig
       #   @return [Aws::SSM::Client]
       attr_reader :client
 
+      # @!attribute [r] Whether parameters need to be decrypted
+      #   @return [Boolean]
+      attr_reader :with_decryption
+
       # Create a new instance of {AwsParameterStore}.
-      def initialize(_params = {})
+      #
+      # @param [Hash] opts Parameter store options
+      # @option opts [Boolean] :with_decryption Whether all keys need to be decrypted
+      def initialize(opts = {})
         @client = Aws::SSM::Client.new
+
+        @with_decryption = opts.fetch(:with_decryption, false)
       end
 
       # Fetch the value of the key
       #
       # @param key [String,Symbol] Key to fetch
+      # @param [Hash] opts for fetching the key
+      # @option opts [Boolean] :with_decryption Whether the key needs decrypting
       #
       # @return [String] Value of the key
-      def get(key)
-        client.get_parameter(name: key).parameter.value
+      def get(key, opts = {})
+        decrypt = opts.fetch(:with_decryption) { with_decryption }
+
+        client.get_parameter(name: key, with_decryption: decrypt).parameter.value
       end
 
       # Set the value of the key

data/lib/cloud-config/providers/in_memory.rb

@@ -14,7 +14,7 @@ module CloudConfig
       attr_reader :settings
 
       # Create an instance of {InMemory}
-      def initialize(_params = {})
+      def initialize(_opts = {})
         @settings = {}
       end
 
@@ -23,7 +23,7 @@ module CloudConfig
       # @param key [String,Symbol] Key to fetch
       #
       # @return [Object] Value of the key
-      def get(key)
+      def get(key, _opts = {})
         settings[key]
       end
 

data/lib/cloud-config/providers/yaml_file.rb

@@ -15,9 +15,10 @@ module CloudConfig
 
       # Create an instance of {YamlFile}
       #
-      # @option params [Hash] :filename Name of the YAML file
-      def initialize(params = {})
-        @contents = YAML.load_file(params[:filename]) || {}
+      # @param [Hash] opts Yaml file options
+      # @option opts [String] :filename Name of the YAML file
+      def initialize(opts = {})
+        @contents = YAML.load_file(opts[:filename]) || {}
       end
 
       # Fetch the value of the key
@@ -25,7 +26,7 @@ module CloudConfig
       # @param key [String,Symbol] Key to fetch
       #
       # @return [Object] Value of the key
-      def get(key)
+      def get(key, _opts = {})
         contents[key]
       end
 

data/lib/cloud-config/version.rb

@@ -2,5 +2,5 @@
 
 module CloudConfig
   # Version of CloudConfig
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/cloud-config.rb

@@ -90,7 +90,7 @@ module CloudConfig
   # @return [Object] Value of the key
   def load_key(provider_config, key, reset_cache: false)
     with_cache(key, reset_cache:, expire_in: provider_config.settings[key][:cache]) do
-      provider_config.provider.get(key)
+      provider_config.provider.get(key, provider_config.settings[key])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud-config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - hypernova2002
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -231,6 +231,7 @@ files:
 - examples/002_parameter_store_with_cache.rb
 - examples/003_parameter_store_with_preload.rb
 - examples/004_handling_configuration_changes.rb
+- examples/005_parameter_store_encrypted_key.rb
 - lib/cloud-config.rb
 - lib/cloud-config/cache.rb
 - lib/cloud-config/cache/in_memory.rb