complex_config 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 860f5c79218ff3f9dc9c479f53522895d5eb9606
-  data.tar.gz: 9cc6fad757632f00543711857740c1831745ed25
+  metadata.gz: 9d1f7d933962f507ac718b852309d72585130723
+  data.tar.gz: 91ec39308815be851342140df5a4c3f7618e2ab8
 SHA512:
-  metadata.gz: 26c3c653a850a1de3f43d4f04ed8d5f466e1c3cc1fa738dae837715b778da2e94454617ef0b9ff74231eed03d3960062f817ebdad47a26a75fc0a350f45dbb74
-  data.tar.gz: e8a4606df8009be3e3140981329db9bac1bc69d8d6afca2af0d55d3f5fbae24931b702d0328417f167dc1ea24feeccaf16b6f620246428069bd7ddc9f219793c
+  metadata.gz: 9f05aa30b6ba2763e73b73cf9d9b27ef21ba3f8a4c68930f2c80aaeb4a9842e99f35bae7bc2a337d6444d01d66f8c83e2d0dd2aff21b440ad170848e0c48145d
+  data.tar.gz: 9c7d6845a920b6e1099d8c7ba588361f173e8e4eeac13c07761c262c31442e1ca8402ab1b564dd3e6857998b343933bc8d769ca8218aa1af1c1d7e00f85c3ea4

data/README.md

@@ -144,6 +144,10 @@ Here is the `ComplexConfig::Plugins::MONEY` plugin for example:
 
 ## Changes
 
+* 2018-01-26 Release 0.13.0
+  Improve `write_config` interface and more tests
+* 2017-11-17 Release 0.12.2
+  Output string keys on top level configs, Rails don't like it otherwise.
 * 2017-11-17 Release 0.12.1
   Do not output newlines when writing encrypted configs, Rails don't like it.
 * 2017-11-16 Release 0.12.0

data/VERSION

@@ -1 +1 @@
-0.12.1
+0.13.0

data/complex_config.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.12.1 ruby lib
+# stub: complex_config 0.13.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config".freeze
-  s.version = "0.12.1"
+  s.version = "0.13.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 = "2017-11-17"
+  s.date = "2018-01-26"
   s.description = "This library allows you to access configuration files via a simple interface".freeze
   s.email = "flori@ping.de".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/complex_config.rb".freeze, "lib/complex_config/config.rb".freeze, "lib/complex_config/encryption.rb".freeze, "lib/complex_config/errors.rb".freeze, "lib/complex_config/plugins.rb".freeze, "lib/complex_config/plugins/enable.rb".freeze, "lib/complex_config/plugins/money.rb".freeze, "lib/complex_config/plugins/uri.rb".freeze, "lib/complex_config/provider.rb".freeze, "lib/complex_config/provider/shortcuts.rb".freeze, "lib/complex_config/proxy.rb".freeze, "lib/complex_config/railtie.rb".freeze, "lib/complex_config/rude.rb".freeze, "lib/complex_config/settings.rb".freeze, "lib/complex_config/shortcuts.rb".freeze, "lib/complex_config/version.rb".freeze]
-  s.files = [".gitignore".freeze, ".rspec".freeze, ".travis.yml".freeze, ".utilsrc".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "complex_config.gemspec".freeze, "config/products.yml".freeze, "lib/complex_config.rb".freeze, "lib/complex_config/config.rb".freeze, "lib/complex_config/encryption.rb".freeze, "lib/complex_config/errors.rb".freeze, "lib/complex_config/plugins.rb".freeze, "lib/complex_config/plugins/enable.rb".freeze, "lib/complex_config/plugins/money.rb".freeze, "lib/complex_config/plugins/uri.rb".freeze, "lib/complex_config/provider.rb".freeze, "lib/complex_config/provider/shortcuts.rb".freeze, "lib/complex_config/proxy.rb".freeze, "lib/complex_config/railtie.rb".freeze, "lib/complex_config/rude.rb".freeze, "lib/complex_config/settings.rb".freeze, "lib/complex_config/shortcuts.rb".freeze, "lib/complex_config/version.rb".freeze, "spec/complex_config/config_spec.rb".freeze, "spec/complex_config/encryption_spec.rb".freeze, "spec/complex_config/plugins_spec.rb".freeze, "spec/complex_config/provider_spec.rb".freeze, "spec/complex_config/settings_spec.rb".freeze, "spec/complex_config/shortcuts_spec.rb".freeze, "spec/config/broken_config.yml".freeze, "spec/config/config.yml".freeze, "spec/config/with-key-file.yml.enc".freeze, "spec/config/with-key-file.yml.key".freeze, "spec/config/with-shell-script.yml.enc".freeze, "spec/config/without-key-file.yml.enc".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".gitignore".freeze, ".rspec".freeze, ".travis.yml".freeze, ".utilsrc".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "complex_config.gemspec".freeze, "config/products.yml".freeze, "lib/complex_config.rb".freeze, "lib/complex_config/config.rb".freeze, "lib/complex_config/encryption.rb".freeze, "lib/complex_config/errors.rb".freeze, "lib/complex_config/plugins.rb".freeze, "lib/complex_config/plugins/enable.rb".freeze, "lib/complex_config/plugins/money.rb".freeze, "lib/complex_config/plugins/uri.rb".freeze, "lib/complex_config/provider.rb".freeze, "lib/complex_config/provider/shortcuts.rb".freeze, "lib/complex_config/proxy.rb".freeze, "lib/complex_config/railtie.rb".freeze, "lib/complex_config/rude.rb".freeze, "lib/complex_config/settings.rb".freeze, "lib/complex_config/shortcuts.rb".freeze, "lib/complex_config/version.rb".freeze, "spec/complex_config/config_spec.rb".freeze, "spec/complex_config/encryption_spec.rb".freeze, "spec/complex_config/plugins_spec.rb".freeze, "spec/complex_config/provider_spec.rb".freeze, "spec/complex_config/settings_spec.rb".freeze, "spec/complex_config/shortcuts_spec.rb".freeze, "spec/config/broken_config.yml".freeze, "spec/config/config.yml".freeze, "spec/config/with-key-file.yml.enc".freeze, "spec/config/with-key-file.yml.key".freeze, "spec/config/without-key-file.yml.enc".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "https://github.com/flori/complex_config".freeze
   s.licenses = ["Apache-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "ComplexConfig -- configuration library".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "2.6.13".freeze
+  s.rubygems_version = "2.6.14".freeze
   s.summary = "configuration library".freeze
   s.test_files = ["spec/complex_config/config_spec.rb".freeze, "spec/complex_config/encryption_spec.rb".freeze, "spec/complex_config/plugins_spec.rb".freeze, "spec/complex_config/provider_spec.rb".freeze, "spec/complex_config/settings_spec.rb".freeze, "spec/complex_config/shortcuts_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 

data/lib/complex_config/provider.rb

@@ -68,7 +68,7 @@ class ComplexConfig::Provider
       datas << IO.binread(pathname)
     end
     if enc_pathname = pathname.to_s + '.enc' and
-      File.exist?(enc_pathname) and my_key = key(pathname)
+      File.exist?(enc_pathname) and my_key = key_as_bytes(pathname)
     then
       text = IO.binread(enc_pathname)
       datas << ComplexConfig::Encryption.new(my_key).decrypt(text)
@@ -98,39 +98,35 @@ class ComplexConfig::Provider
   end
   memoize method: :[]
 
-  def write_config(name, value, encrypt: false, store_key: false)
+  def write_config(name, value: nil, encrypt: false, store_key: false)
+    name, value = interpret_name_value(name, value)
     config_pathname = pathname(name).to_s
-    key = case encrypt
-          when :random
-            SecureRandom.random_bytes(16)
-          when true
-            key(config_pathname)
-          when String
-            encrypt
-          end
-    hex_key = nil
-    settings = ComplexConfig::Settings[value]
     if encrypt
-      key or raise ComplexConfig::EncryptionKeyInvalid,
-        "encryption key is missing"
-      key.size != 16 and raise ComplexConfig::EncryptionKeyInvalid,
-        "encryption keys has to be of 16 bytes lenght"
+      key = provide_key(config_pathname, encrypt)
+      kb = key_to_bytes(key)
       File.secure_write(config_pathname + '.enc') do |out|
-        out.write ComplexConfig::Encryption.new(key).encrypt(settings.to_yaml)
+        out.write ComplexConfig::Encryption.new(kb).encrypt(prepare_output(value))
       end
-      hex_key = key.unpack('H*').first
       if store_key
         File.secure_write(config_pathname + '.key') do |out|
-          out.write hex_key
+          out.write key
         end
       end
+      key
     else
       File.secure_write(config_pathname) do |out|
-        out.puts settings.to_yaml
+        out.puts prepare_output(value)
       end
+      true
     end
+  ensure
     flush_cache
-    hex_key
+  end
+
+  def prepare_output(value)
+    value.each_with_object({}) do |(k, v), h|
+      h[k.to_s] = v
+    end.to_yaml
   end
 
   def exist?(name)
@@ -162,21 +158,62 @@ class ComplexConfig::Provider
   attr_writer :env
 
   def key(pathname = nil)
-    key = [
+    [
       @key,
       read_key_from_file(pathname),
       ENV['COMPLEX_CONFIG_KEY'],
       ENV['RAILS_MASTER_KEY'],
-    ].compact[0, 1].map(&:strip)
-    unless key.empty?
-      key.pack('H*')
-    end
+    ].compact[0, 1].map(&:strip).first
+  end
+
+  def key_as_bytes(pathname = nil)
+    k = key(pathname) or
+      raise ComplexConfig::EncryptionKeyInvalid, "encryption key is missing"
+    key_to_bytes(k)
   end
 
   attr_writer :key
 
   private
 
+  def interpret_name_value(name, value)
+    if ComplexConfig::Settings === name
+      if value
+        name = name.name_prefix
+      else
+        value = name.to_h
+        name  = name.name_prefix
+      end
+    elsif name.respond_to?(:to_sym)
+      value = value.to_h
+    else
+      raise ArgumentError, "name has to be either string/symbol or ComplexConfig::Settings"
+    end
+    return name, value
+  end
+
+  def provide_key(pathname, encrypt)
+    key = case encrypt
+    when :random
+      SecureRandom.hex(16)
+    when true
+      key(pathname)
+    when String
+      if encrypt =~ /\A\h{32}\z/
+        encrypt
+      else
+        raise ComplexConfig::EncryptionKeyInvalid,
+          "encryption key has wrong format, has to be hex number of length "\
+          "32, was #{encrypt.inspect}"
+      end
+    end
+    key or raise ComplexConfig::EncryptionKeyInvalid, "encryption key is missing"
+  end
+
+  def key_to_bytes(key)
+    [ key ].pack('H*')
+  end
+
   def read_key_from_file(pathname)
     if pathname
       IO.binread(pathname.to_s + '.key')

data/lib/complex_config/version.rb

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

data/spec/complex_config/provider_spec.rb

@@ -9,6 +9,8 @@ RSpec.describe ComplexConfig::Provider do
   reset_new_config = -> * {
     provider.config_dir = Pathname.new(__FILE__).dirname.dirname + 'config'
     provider.key = nil
+    ENV['COMPLEX_CONFIG_KEY'] = nil
+    ENV['RAILS_MASTER_KEY'] = nil
     FileUtils.rm_f(provider.config_dir + 'new_config.yml')
     FileUtils.rm_f(provider.config_dir + 'new_config.yml.enc')
     FileUtils.rm_f(provider.config_dir + 'new_config.yml.key')
@@ -112,14 +114,14 @@ RSpec.describe ComplexConfig::Provider do
     end
 
     it 'can be written' do
-      provider.write_config('new_config', config)
+      provider.write_config('new_config', value: config)
       expect(provider.config(asset('new_config.yml'))).to eq config
     end
 
     it 'can be changed and written' do
       provider.deep_freeze = false
       config.development.config.baz = 'something else'
-      provider.write_config('new_config', config)
+      provider.write_config('new_config', value: config)
       expect(provider.config(asset('new_config.yml')).development.config.baz).to eq 'something else'
     end
   end
@@ -141,15 +143,12 @@ RSpec.describe ComplexConfig::Provider do
     it 'can read when key is in ENV var' do
       ENV['RAILS_MASTER_KEY'] = key
       expect(provider['without-key-file'].development.foo.bar).to eq 'baz'
+      ENV['RAILS_MASTER_KEY'] = nil
     end
 
     it 'can read when key is stored in file' do
       expect(provider['with-key-file'].development.foo.bar).to eq 'baz'
     end
-
-    it 'can read when key is obtained by calling shell script' do
-      expect(provider['with-shell-script'].development.foo.bar).to eq 'baz'
-    end
   end
 
   context 'writing encrypted configurations' do
@@ -163,31 +162,57 @@ RSpec.describe ComplexConfig::Provider do
     end
 
     it 'can be written with random key' do
-      key = provider.write_config('new_config', config, encrypt: :random, store_key: false)
+      key = provider.write_config('new_config', value: config, encrypt: :random, store_key: false)
       provider.key = key
       expect(provider.config(asset('new_config.yml'))).to eq config
     end
 
     it 'can be written with random key and store key' do
-      provider.write_config('new_config', config, encrypt: :random, store_key: true)
+      provider.write_config('new_config', value: config, encrypt: :random, store_key: true)
       expect(provider.config(asset('new_config.yml'))).to eq config
     end
 
     it 'can be written with passed key' do
-      provider.write_config('new_config', config)
+      key = SecureRandom.hex(16)
+      provider.write_config('new_config', value: config, encrypt: key)
+      provider.key = key
       expect(provider.config(asset('new_config.yml'))).to eq config
     end
 
     it 'can be written with configured key' do
-      provider.write_config('new_config', config)
+      provider.write_config('new_config', value: config)
+      expect(provider.config(asset('new_config.yml'))).to eq config
+    end
+
+    it 'can be written with COMPLEX_CONFIG_KEY key' do
+      ENV['COMPLEX_CONFIG_KEY'] = SecureRandom.hex(16)
+      k = provider.write_config('new_config', value: config, encrypt: true)
+      expect(k).to eq ENV['COMPLEX_CONFIG_KEY']
+      expect(provider.config(asset('new_config.yml'))).to eq config
+    end
+
+    it 'can be written with RAILS_MASTER_KEY key' do
+      ENV['RAILS_MASTER_KEY'] = SecureRandom.hex(16)
+      k = provider.write_config('new_config', value: config, encrypt: true)
+      expect(k).to eq ENV['RAILS_MASTER_KEY']
       expect(provider.config(asset('new_config.yml'))).to eq config
     end
 
     it 'can be changed and written' do
       provider.deep_freeze = false
+      expect(provider.config(asset('config.yml')).development.config.baz).to eq 'something'
       config.development.config.baz = 'something else'
-      provider.write_config('new_config', config)
+      provider.write_config('new_config', value: config)
       expect(provider.config(asset('new_config.yml')).development.config.baz).to eq 'something else'
+      #
+      new_config = provider.config(asset('new_config.yml'), :new_config)
+      new_config.development.config.baz = 'something else else'
+      provider.write_config new_config
+      expect(provider.config(asset('new_config.yml')).development.config.baz).to eq 'something else else'
+      #
+      new_config = provider.config(asset('new_config.yml'), :new_config)
+      provider.write_config(new_config, value: { development: { config: { baz: 'even more else' } } })
+      #expect(provider.config(asset('new_config.yml')).development.config.baz).to eq 'something else else'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -189,7 +189,6 @@ files:
 - spec/config/config.yml
 - spec/config/with-key-file.yml.enc
 - spec/config/with-key-file.yml.key
-- spec/config/with-shell-script.yml.enc
 - spec/config/without-key-file.yml.enc
 - spec/spec_helper.rb
 homepage: https://github.com/flori/complex_config
@@ -216,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: configuration library

data/spec/config/with-shell-script.yml.enc

@@ -1 +0,0 @@
-0MKZ0eU56L2MCkL143wST6kchDW/hnyGq7xm3O2NUMY1xa0PoEnZutzR3+LVGu/eWtk=--zhIiqrnKQu422P/V--p0v54ziCv+LBHmg3GYk16Q==