complex_config 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 114e86c26b5932221df1aa2ae61c248697a40162db12aac16673f2a204597a08
-  data.tar.gz: cc4847658eff087770fa628015f2edb8e27f61fce248ba82e5087671ceb1cdd8
+  metadata.gz: 6a62d35017801f81211c900cfd841264193155e1f89ebc27c387b7649da6dbcc
+  data.tar.gz: 96cdc260febe8d2dff2f479421dcf7e94e61de4dacf77ee2ca30372c069e390c
 SHA512:
-  metadata.gz: aa4c8feae89efd54ad866f0ad98d68479b383a9fbce025de01f0db160a95210a7e894973ca5bd29a1491a146a7d611e1caa3398255203ac8fc8c0678e41a3608
-  data.tar.gz: 047cd0f7ca2c59daaa8fd3ea03e978e8c2c06dcd14dd447762a4cad771b190533563d3dbf3e74d67682cada3c2ce0b17beb4abbceab8ff4267e2a03c67931b28
+  metadata.gz: aae99c356a7467495f3311dd0aaca592078164458183076aae3fd3688d65d7d0e0b37bf209cb6b0873715240b9d6b1105e04dbbd60ce80d0d53566e5a67a07a5
+  data.tar.gz: a63690e1401e3df9bdc29cc6f9441812521bad478fb43ee4ed6be79d7bc39a220a56c90de3862b8d4510cd9ad04d48d534a92bcb0769500b8b7cb16c900f0328

data/README.md

@@ -144,6 +144,8 @@ Here is the `ComplexConfig::Plugins::MONEY` plugin for example:
 
 ## Changes
 
+* 2019-03-18 Release 0.17.0
+  * Improve error message for missing encryption key
 * 2019-03-14 Release 0.16.0
   * Enable `- trim_mode` for ERB in yml files
   * Allow `to_json` calls on settings

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.17.0

data/complex_config.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.16.0 ruby lib
+# stub: complex_config 0.17.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config".freeze
-  s.version = "0.16.0"
+  s.version = "0.17.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2019-03-14"
+  s.date = "2019-03-18"
   s.description = "This library allows you to access configuration files via a simple interface".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["complex_config".freeze]

data/lib/complex_config/errors.rb

@@ -23,6 +23,9 @@ module ComplexConfig
   class EncryptionKeyInvalid < EncryptionError
   end
 
+  class EncryptionKeyMissing < EncryptionError
+  end
+
   class DecryptionFailed < EncryptionError
   end
 end

data/lib/complex_config/provider.rb

@@ -73,12 +73,7 @@ class ComplexConfig::Provider
   end
 
   def decrypt_config(pathname)
-    enc_pathname = pathname.to_s + '.enc'
-    my_ks        = key_source(pathname)
-    if File.exist?(enc_pathname) && my_ks.ask_and_send(:key)
-      text = IO.binread(enc_pathname)
-      ComplexConfig::Encryption.new(my_ks.key_bytes).decrypt(text)
-    end
+    decrypt_config_case(pathname).first
   end
 
   def encrypt_config(pathname, config)
@@ -88,14 +83,21 @@ class ComplexConfig::Provider
 
   def config(pathname, name = nil)
     datas = []
-    if File.exist?(pathname)
+    path_exist = File.exist?(pathname)
+    if path_exist
       datas << IO.binread(pathname)
     end
-    if decrypted = decrypt_config(pathname)
+    decrypted, reason, enc_pathname = decrypt_config_case(pathname)
+    case reason
+    when :ok
       datas << decrypted
+    when :key_missing
+      datas.empty? and raise ComplexConfig::EncryptionKeyMissing,
+        "encryption key for #{enc_pathname.to_s.inspect} is missing"
+    when :file_missing
+      datas.empty? and raise ComplexConfig::ConfigurationFileMissing,
+        "configuration file #{pathname.to_s.inspect} is missing"
     end
-    datas.empty? and raise ComplexConfig::ConfigurationFileMissing,
-      "configuration file #{pathname.to_s.inspect} is missing"
     results = datas.map { |d| evaluate(pathname, d) }
     hashes = results.map { |r| ::YAML.load(r, pathname) }
     settings = ComplexConfig::Settings.build(name, hashes.shift)
@@ -153,7 +155,7 @@ class ComplexConfig::Provider
 
   def exist?(name)
     !!config(pathname(name), name)
-  rescue ComplexConfig::ConfigurationFileMissing
+  rescue ComplexConfig::ConfigurationFileMissing, ComplexConfig::EncryptionKeyMissing
     false
   end
 
@@ -211,6 +213,21 @@ class ComplexConfig::Provider
 
   private
 
+  def decrypt_config_case(pathname)
+    enc_pathname = pathname.to_s + '.enc'
+    my_ks        = key_source(pathname)
+    if File.exist?(enc_pathname)
+      if my_ks.ask_and_send(:key)
+        text = IO.binread(enc_pathname)
+        decrypted = ComplexConfig::Encryption.new(my_ks.key_bytes).decrypt(text)
+        return decrypted, :ok, enc_pathname
+      else
+        return nil, :key_missing, enc_pathname
+      end
+    end
+    return nil, :file_missing, enc_pathname
+  end
+
   def interpret_name_value(name, value)
     if ComplexConfig::Settings === name
       if value

data/lib/complex_config/version.rb

@@ -1,6 +1,6 @@
 module ComplexConfig
   # ComplexConfig version
-  VERSION         = '0.16.0'
+  VERSION         = '0.17.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar