complex_config 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a30efbe0003ba98aded93c617b1802b6f0f9c023
-  data.tar.gz: 695341b002c6b75e5fd42aa6776977c9783c526f
+SHA256:
+  metadata.gz: c28ccee05d5a9ac6940f0b73babaca1a93c21e0f55f048bbc77ec000ccabb9f9
+  data.tar.gz: 053fca226196c715755fa82921eb43602d176faa3eb402b783b49d1b7113705e
 SHA512:
-  metadata.gz: 0a9364ac60919da664a58ff68edfce039809981938a984a218ced78e842393f93c1dfbfee86bd587f07a69a7adfc38a495f7a1e3826cc9e4942a86c874a80d67
-  data.tar.gz: 21731f876190780615611b2fbf48f564ebac28778fecd6048959050e6d1e6f018ad4ada85fc4547bd11beedcfc4c1f916d9f7972588e9267b5c7ed82b444bf9d
+  metadata.gz: 7ba5fa43f39da3bef7c836a3ce6df235e1876a47981adb845139b7361118641780b62c5defc1610aa6b5f27d6a1027f337e10e426b8e184fb07363e74ec98449
+  data.tar.gz: 2551fe15c77f3442f99240d86097f3b28b2968e91ca36116ff51517caf12c66ddb096c0136aa968d091e79bc01947c70f3b9656b0ae13d9751c92b77c202d3a8

data/Gemfile

@@ -3,5 +3,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem "byebug", group: :development, platform: :mri

data/Rakefile

@@ -9,6 +9,7 @@ GemHadar do
   homepage    "https://github.com/flori/#{name}"
   summary     'configuration library'
   description 'This library allows you to access configuration files via a simple interface'
+  executables 'complex_config'
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
     '.AppleDouble', '.DS_Store', '.byebug_history', 'errors.lst'

data/VERSION

@@ -1 +1 @@
-0.13.3
+0.14.0

data/bin/complex_config

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+require 'complex_config/rude'
+require 'tins/xt'
+include Tins::GO
+require 'tempfile'
+
+$opts = go 'h'
+
+def usage(msg: 'Displaying help', rc: 0)
+  puts <<~end
+    #{msg}
+
+    Usage: #$0 COMMAND [OPTIONS] [FILENAME]"
+
+    Commands are
+      edit      edit encrypted file FILENAME (suffix .enc)
+      encrypt   encrypt file FILENAME (suffix not .enc)
+      decrypt   decrypt file FILENAME (suffix .enc)
+      display   decrypt and display encrypted file FILENAME (suffix .enc)
+
+    Options are
+
+      -c CONFIG_DIR  set CONFIG_DIR (default: "./config")
+      -h             this help
+
+  end
+  exit rc
+end
+
+def fetch_filename(suffix: true)
+  fn = ARGV.shift.dup or usage msg: "config filename required", rc: 1
+  if suffix
+    unless fn.end_with?('.enc')
+      usage msg: "config filename needs suffix .enc", rc: 1
+    end
+  else
+    if fn.end_with?('.enc')
+      usage msg: "config filename seems to be already encrypted with suffix .enc", rc: 1
+    end
+  end
+  File.exist?(fn) or usage msg: "config filename #{fn} doesn't exist", rc: 1
+  suffix and fn.sub!(/\.enc\z/, '')
+  fn
+end
+
+$opts[?h] and usage
+ComplexConfig::Provider.config_dir = File.expand_path($opts[?c] || './config')
+
+case command = ARGV.shift
+when 'edit'
+  fn = fetch_filename
+  did_not_change = Class.new(StandardError)
+  begin
+    File.secure_write(fn + '.enc') do |f|
+      Tempfile.open('complex_config') do |t|
+        config = ComplexConfig::Provider.decrypt_config(fn)
+        t.write config
+        t.flush
+        system ENV.fetch('EDITOR', 'vi'), t.path
+        new_config = IO.binread(t.path)
+        if config == new_config
+          puts "Configuration hasn't been changed."
+          raise did_not_change
+        else
+          f.write ComplexConfig::Provider.encrypt_config(fn, new_config)
+          puts "New configuration has been written."
+        end
+      end
+    end
+  rescue did_not_change
+  end
+when 'decrypt'
+  fn = fetch_filename
+  File.exist?(fn) and usage msg: "decrypted config #{fn.inspect} already exists", rc: 1
+  File.secure_write(fn) do |f|
+    f.write ComplexConfig::Provider.decrypt_config(fn)
+  end
+  puts "File was decrypted to #{fn.inspect}. You can remove #{(fn + '.enc').inspect} now."
+when 'display'
+  puts ComplexConfig::Provider.decrypt_config(fetch_filename)
+when 'encrypt'
+  fn = fetch_filename suffix: false
+  File.exist?(fn + '.enc') and usage msg: "encrypted config #{(fn + '.enc').inspect} already exists", rc: 1
+  File.secure_write(fn + '.enc') do |f|
+    f.write ComplexConfig::Provider.encrypt_config(fn, IO.binread(fn))
+  end
+  puts "File was encrypted to #{(fn + '.enc').inspect}. You can remove #{fn.inspect} now."
+else
+  usage msg: "Unknown command #{command.inspect}", rc: 1
+end
+

data/complex_config.gemspec

@@ -1,22 +1,23 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.13.3 ruby lib
+# stub: complex_config 0.14.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config".freeze
-  s.version = "0.13.3"
+  s.version = "0.14.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 = "2018-02-23"
+  s.date = "2018-06-07"
   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]
   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.files = [".gitignore".freeze, ".rspec".freeze, ".travis.yml".freeze, ".utilsrc".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "bin/complex_config".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.6.14".freeze
+  s.rubygems_version = "2.7.6".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/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]
 

data/lib/complex_config/provider.rb

@@ -72,16 +72,27 @@ class ComplexConfig::Provider
     config_dir + "#{name}.yml"
   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
+  end
+
+  def encrypt_config(pathname, config)
+    ks = key_source(pathname)
+    ComplexConfig::Encryption.new(ks.key_bytes).encrypt(config)
+  end
+
   def config(pathname, name = nil)
     datas = []
     if File.exist?(pathname)
       datas << IO.binread(pathname)
     end
-    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_ks.key_bytes).decrypt(text)
+    if decrypted = decrypt_config(pathname)
+      datas << decrypted
     end
     datas.empty? and raise ComplexConfig::ConfigurationFileMissing,
       "configuration file #{pathname.to_s.inspect} is missing"

data/lib/complex_config/version.rb

@@ -1,6 +1,6 @@
 module ComplexConfig
   # ComplexConfig version
-  VERSION         = '0.13.3'
+  VERSION         = '0.14.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

@@ -209,6 +209,16 @@ RSpec.describe ComplexConfig::Provider do
       expect(provider.config(asset('new_config.yml'))).to eq config
     end
 
+    it 'can encrypt file content with RAILS_MASTER_KEY key' do
+      ENV['RAILS_MASTER_KEY'] = SecureRandom.hex(16)
+      encrypted = provider.encrypt_config(asset('new_config.yml'), 'test')
+      expect(encrypted).not_to be_empty
+      ks = ComplexConfig::KeySource.new(env_var: 'RAILS_MASTER_KEY')
+      expect(
+        ComplexConfig::Encryption.new(ks.key_bytes).decrypt(encrypted)
+      ).to eq 'test'
+    end
+
     it 'can be changed and written' do
       provider.deep_freeze = false
       expect(provider.config(asset('config.yml')).development.config.baz).to eq 'something'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -130,7 +130,8 @@ dependencies:
         version: 0.3.4
 description: This library allows you to access configuration files via a simple interface
 email: flori@ping.de
-executables: []
+executables:
+- complex_config
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -162,6 +163,7 @@ files:
 - Rakefile
 - TODO.md
 - VERSION
+- bin/complex_config
 - complex_config.gemspec
 - config/products.yml
 - lib/complex_config.rb
@@ -219,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: configuration library