complex_config 0.13.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 11714f3ba3ed9b55517d48387bd4b8a92e6eb3a8448b911b4892275adfe6d13c
-  data.tar.gz: ce4b19cb078404e1eb2e82805782bea3e3818e114f9e82f25b2a543dfd68ece6
+SHA1:
+  metadata.gz: 6801d4be41f9717643e5d2c8c3a6579fe2f74af9
+  data.tar.gz: 15c87e5fccfe600f5e775d996feac8ee5c6c174e
 SHA512:
-  metadata.gz: b5a6ae82c387a3866fc4eb4bdc834cf6c2dc87b4eee0c5df5d41632efcc5017230e13dd7d60a51997ad6318b2c3d42ab5ac314b6e873b3ab8ba282d7e8e98ef5
-  data.tar.gz: '079795e2114767896a3a362847b8079bc7b20fbe9f146872bba8a21af61b0ba8e698c4a00080e5013f3946c20566f222e993c26629527818d473334efe2357a7'
+  metadata.gz: 578bc404bf7d30fd04865fc0855c719e6f9285d0e7031bf9040b66a3be8667ae4ed5850902e86fe8a77b517851b7cca90423907aca6de1e75d1bbf9f963e8b4f
+  data.tar.gz: 52b81ccae832406d4cfd652baff4434c5a72ecb6cfd884edcabe899ad6755b220a2cbf3dd56ccc20570ea43f2fc2840bfde462e8b110f905d4460eb4ae4b5c3c

data/VERSION

@@ -1 +1 @@
-0.13.1
+0.13.2

data/complex_config.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.13.1 ruby lib
+# stub: complex_config 0.13.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config".freeze
-  s.version = "0.13.1"
+  s.version = "0.13.2"
 
   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 = "2018-02-09"
+  s.date = "2018-02-23"
   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/without-key-file.yml.enc".freeze, "spec/spec_helper.rb".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/key_source.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/key_source.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/key_source_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/master.key".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.7.3".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]
+  s.test_files = ["spec/complex_config/config_spec.rb".freeze, "spec/complex_config/encryption_spec.rb".freeze, "spec/complex_config/key_source_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]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/complex_config.rb

@@ -8,6 +8,7 @@ require 'complex_config/errors'
 require 'complex_config/proxy'
 require 'complex_config/settings'
 require 'complex_config/config'
+require 'complex_config/key_source'
 require 'complex_config/provider/shortcuts'
 require 'complex_config/provider'
 require 'complex_config/encryption'

data/lib/complex_config/key_source.rb

@@ -0,0 +1,33 @@
+class ComplexConfig::KeySource
+  def initialize(pathname: nil, env_var: nil, var: nil, master_key_pathname: nil)
+    settings = [ pathname, env_var, var, master_key_pathname ].compact.size
+    if settings > 1
+      raise ArgumentError, 'only one setting at most possible'
+    end
+    pathname and pathname = pathname.to_s
+    master_key_pathname and master_key_pathname = master_key_pathname.to_s
+    @pathname, @env_var, @var, @master_key_pathname =
+      pathname, env_var, var, master_key_pathname
+  end
+
+  def master_key?
+    !!@master_key_pathname
+  end
+
+  def key
+    if @var
+      @var.ask_and_send(:chomp)
+    elsif @env_var
+      ENV[@env_var].ask_and_send(:chomp)
+    elsif master_key?
+      IO.binread(@master_key_pathname).chomp
+    elsif @pathname
+      IO.binread(@pathname + '.key').chomp
+    end
+  rescue Errno::ENOENT
+  end
+
+  def key_bytes
+    [ key ].pack('H*')
+  end
+end

data/lib/complex_config/provider.rb

@@ -10,8 +10,18 @@ class ComplexConfig::Provider
   include ComplexConfig::Provider::Shortcuts
 
   def initialize
-    @plugins     = Set.new
-    @deep_freeze = true
+    @plugins             = Set.new
+    @deep_freeze         = true
+  end
+
+  attr_writer :master_key_pathname
+
+  def master_key_pathname
+    if @master_key_pathname
+      @master_key_pathname
+    else
+      config_dir + 'master.key'
+    end
   end
 
   def configure_with(config)
@@ -67,12 +77,11 @@ class ComplexConfig::Provider
     if File.exist?(pathname)
       datas << IO.binread(pathname)
     end
-    if enc_pathname = pathname.to_s + '.enc' and
-      File.exist?(enc_pathname) and
-      my_key = key_as_bytes(enc_pathname)
-    then
+    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)
-      datas << ComplexConfig::Encryption.new(my_key).decrypt(text)
+      datas << ComplexConfig::Encryption.new(my_ks.key_bytes).decrypt(text)
     end
     datas.empty? and raise ComplexConfig::ConfigurationFileMissing,
       "configuration file #{pathname.to_s.inspect} is missing"
@@ -103,17 +112,16 @@ class ComplexConfig::Provider
     name, value = interpret_name_value(name, value)
     config_pathname = pathname(name).to_s
     if encrypt
-      key = provide_key(config_pathname, encrypt)
-      kb = key_to_bytes(key)
+      ks = provide_key_source(config_pathname, encrypt)
       File.secure_write(config_pathname + '.enc') do |out|
-        out.write ComplexConfig::Encryption.new(kb).encrypt(prepare_output(value))
+        out.write ComplexConfig::Encryption.new(ks.key_bytes).encrypt(prepare_output(value))
       end
       if store_key
         File.secure_write(config_pathname + '.key') do |out|
-          out.write key
+          out.write ks.key
         end
       end
-      key
+      ks.key
     else
       File.secure_write(config_pathname) do |out|
         out.puts prepare_output(value)
@@ -158,26 +166,24 @@ class ComplexConfig::Provider
 
   attr_writer :env
 
-  def key(pathname = nil)
+  def key_source(pathname = nil)
     [
-      @key,
-      read_key_from_file(pathname),
-      ENV['COMPLEX_CONFIG_KEY'],
-      ENV['RAILS_MASTER_KEY'],
-    ].compact[0, 1].map(&:strip).first
+      ComplexConfig::KeySource.new(pathname: pathname),
+      ComplexConfig::KeySource.new(var: @key),
+      ComplexConfig::KeySource.new(env_var: 'COMPLEX_CONFIG_KEY'),
+      ComplexConfig::KeySource.new(env_var: 'RAILS_MASTER_KEY'),
+      ComplexConfig::KeySource.new(master_key_pathname: master_key_pathname),
+    ].find(&:key)
   end
 
-  def key_as_bytes(pathname)
-    if k = key(pathname.sub(/\.enc\z/, ''))
-      key_to_bytes(k)
-    else
-      warn "encryption key is missing for #{pathname.to_s.inspect} => Ignoring it!"
-      nil
-    end
+  def key(pathname = nil)
+    key_source(pathname).ask_and_send(:key)
   end
 
   attr_writer :key
 
+  attr_writer :master_key_pathname
+
   private
 
   def interpret_name_value(name, value)
@@ -196,33 +202,22 @@ class ComplexConfig::Provider
     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}"
+  def provide_key_source(pathname, encrypt)
+    ks =
+      case encrypt
+      when :random
+        ComplexConfig::KeySource.new(var: SecureRandom.hex(16))
+      when true
+        key_source(pathname)
+      when String
+        if encrypt =~ /\A\h{32}\z/
+          ComplexConfig::KeySource.new(var: encrypt)
+        else
+          raise ComplexConfig::EncryptionKeyInvalid,
+            "encryption key has wrong format, has to be hex number of length "\
+            "32, was #{encrypt.inspect}"
+        end
       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')
-    end
-  rescue Errno::ENOENT
+    ks or raise ComplexConfig::EncryptionKeyInvalid, "encryption key is missing"
   end
 end
-

data/lib/complex_config/proxy.rb

@@ -35,10 +35,8 @@ module ComplexConfig
         config = ::ComplexConfig::Provider[name]
         (class << self; self; end).class_eval do
           define_method(name) do |env = nil|
-            if env
-              config[env]
-            elsif @env
-              config[@env]
+            if env ||= @env
+              config[env] || ::ComplexConfig::Settings.new
             else
               config
             end

data/lib/complex_config/version.rb

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

data/spec/complex_config/key_source_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe ComplexConfig::KeySource do
+  it 'should provide key from pathname' do
+    ks = described_class.new(pathname: asset('with-key-file.yml'))
+    expect(ks.key).to eq '90ec1139596f9dfdb51e72277735ce9a'
+  end
+
+  it 'should provide key from env_var' do
+    ENV['THE_KEY'] = '41424344'
+    ks = described_class.new(env_var: 'THE_KEY')
+    expect(ks.key_bytes).to eq "ABCD"
+    ENV['THE_KEY'] = nil
+  end
+
+  it 'should provide key from var' do
+    ks = described_class.new(var: 'deadbeef')
+    expect(ks.key).to eq 'deadbeef'
+  end
+
+  it 'should provide key from master_key_pathname' do
+    ks = described_class.new(master_key_pathname: asset('master.key'))
+    expect(ks.key).to eq '90ec1139596f9dfdb51e72277735ce9a'
+  end
+
+  it 'can return key as bytes' do
+    ks = described_class.new(var: '41424344')
+    expect(ks.key_bytes).to eq "ABCD"
+  end
+
+  it 'cannot use more than one setting' do
+    expect {
+      described_class.new(var: 'deadbeef', env_var: 'FOO')
+    }.to raise_error ArgumentError
+  end
+end

data/spec/complex_config/provider_spec.rb

@@ -69,6 +69,16 @@ RSpec.describe ComplexConfig::Provider do
     it 'falls back to current working directory by default' do
       expect(provider.config_dir).to eq Pathname.pwd + 'config'
     end
+
+    it 'can derive master_key_pathname' do
+      expect(provider.master_key_pathname).to eq\
+      Pathname.pwd.join('config/master.key')
+    end
+
+    it 'can set master_key_pathname' do
+      provider.master_key_pathname = 'foo'
+      expect(provider.master_key_pathname).to eq 'foo'
+    end
   end
 
   context 'reading configurations' do
@@ -137,6 +147,7 @@ RSpec.describe ComplexConfig::Provider do
 
     it 'can read when key is set by accessor' do
       provider.key = key
+      expect(provider.key).to eq key.chomp
       expect(provider['without-key-file'].development.foo.bar).to eq 'baz'
     end
 
@@ -229,7 +240,7 @@ RSpec.describe ComplexConfig::Provider do
       expect {
         expect(provider['config']).to be_a ComplexConfig::Settings
       }.to change {
-        provider.instance.__send__(:__mize_cache__).__send__(:size)
+        provider.instance.__send__(:__mize_cache__).instance_variable_get(:@data).size
       }.by(1)
       expect(provider).not_to receive(:config)
       expect(provider['config']).to be_a ComplexConfig::Settings
@@ -241,7 +252,7 @@ RSpec.describe ComplexConfig::Provider do
       expect {
         result = provider.flush_cache
       }.to change {
-        provider.instance.__send__(:__mize_cache__).__send__(:size)
+        provider.instance.__send__(:__mize_cache__).instance_variable_get(:@data).size
       }.by(-1)
       expect(result).to be_a ComplexConfig::Provider
     end
@@ -282,5 +293,17 @@ RSpec.describe ComplexConfig::Provider do
     it 'falls back to "development" as a default' do
       expect(provider.env).to eq 'development'
     end
+
+  end
+
+  context 'shared' do
+    before do
+      provider.config_dir = Pathname.new(__FILE__).dirname.dirname + 'config'
+    end
+
+    it 'can share values' do
+      expect(provider['config'].development.shared).to eq true
+      expect(provider['config'].test.shared).to eq true
+    end
   end
 end

data/spec/complex_config/settings_spec.rb

@@ -104,6 +104,16 @@ EOT
     settings.pretty_print(q)
   end
 
+  it 'can be converted into YAML' do
+    expect(settings.to_yaml).to eq <<EOT
+---
+:foo:
+  :bar:
+    :baz: true
+  :qux: quux
+EOT
+  end
+
   it 'raises exception if expected attribute is missing' do
     expect { settings.nix }.to raise_error(ComplexConfig::AttributeMissing)
   end

data/spec/complex_config/shortcuts_spec.rb

@@ -8,6 +8,8 @@ RSpec.describe 'shortcuts' do
 
   before do
     provider.config_dir = Pathname.new(__FILE__).dirname.dirname + 'config'
+    allow(ENV).to receive(:[]).with('COMPLEX_CONFIG_KEY')
+    allow(ENV).to receive(:[]).with('RAILS_MASTER_KEY')
     allow(ENV).to receive(:[]).with('RAILS_ENV').and_return('development')
   end
 
@@ -37,6 +39,11 @@ RSpec.describe 'shortcuts' do
     expect(settings.config.baz).to eq 'something else'
   end
 
+  it 'complex_config_with_env "shortcut" returns empty settings for non existant envs' do
+    settings = complex_config_with_env.config('nix')
+    expect(settings).to be_a ComplexConfig::Settings
+  end
+
   it 'has the alias cc for complex_config_with_env' do
     settings = cc.config(:development)
     expect(settings).to be_a ComplexConfig::Settings

data/spec/config/config.yml

@@ -1,3 +1,6 @@
+shared:
+  shared: true
+
 development:
   config:
     foo: true

data/spec/config/master.key

@@ -0,0 +1 @@
+90ec1139596f9dfdb51e72277735ce9a

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.13.2
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -138,6 +138,7 @@ extra_rdoc_files:
 - lib/complex_config/config.rb
 - lib/complex_config/encryption.rb
 - lib/complex_config/errors.rb
+- lib/complex_config/key_source.rb
 - lib/complex_config/plugins.rb
 - lib/complex_config/plugins/enable.rb
 - lib/complex_config/plugins/money.rb
@@ -167,6 +168,7 @@ files:
 - lib/complex_config/config.rb
 - lib/complex_config/encryption.rb
 - lib/complex_config/errors.rb
+- lib/complex_config/key_source.rb
 - lib/complex_config/plugins.rb
 - lib/complex_config/plugins/enable.rb
 - lib/complex_config/plugins/money.rb
@@ -181,12 +183,14 @@ files:
 - lib/complex_config/version.rb
 - spec/complex_config/config_spec.rb
 - spec/complex_config/encryption_spec.rb
+- spec/complex_config/key_source_spec.rb
 - spec/complex_config/plugins_spec.rb
 - spec/complex_config/provider_spec.rb
 - spec/complex_config/settings_spec.rb
 - spec/complex_config/shortcuts_spec.rb
 - spec/config/broken_config.yml
 - spec/config/config.yml
+- spec/config/master.key
 - spec/config/with-key-file.yml.enc
 - spec/config/with-key-file.yml.key
 - spec/config/without-key-file.yml.enc
@@ -215,13 +219,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: configuration library
 test_files:
 - spec/complex_config/config_spec.rb
 - spec/complex_config/encryption_spec.rb
+- spec/complex_config/key_source_spec.rb
 - spec/complex_config/plugins_spec.rb
 - spec/complex_config/provider_spec.rb
 - spec/complex_config/settings_spec.rb