chamber 2.13.0 → 3.0.0rc1

data/lib/chamber/commands/securable.rb

@@ -2,19 +2,22 @@
 
 require 'shellwords'
 require 'chamber/instance'
+require 'chamber/refinements/hash'
 
 module  Chamber
 module  Commands
 module  Securable
-  def initialize(options = {})
-    super
-
-    ignored_settings_options        = options.
-                                        merge(files: ignored_settings_filepaths).
-                                        reject { |k, _v| k == 'basepath' }
-    self.ignored_settings_instance  = Chamber::Instance.new(ignored_settings_options)
-    self.current_settings_instance  = Chamber::Instance.new(options)
-    self.only_sensitive             = options[:only_sensitive]
+  using ::Chamber::Refinements::Hash
+
+  def initialize(only_sensitive: nil, **args)
+    super(**args)
+
+    ignored_settings_options        = args
+                                        .deep_merge(files: ignored_settings_filepaths)
+                                        .reject { |k, _v| k == 'basepath' }
+    self.ignored_settings_instance  = Chamber::Instance.new(**ignored_settings_options)
+    self.current_settings_instance  = Chamber::Instance.new(**args)
+    self.only_sensitive             = only_sensitive
   end
 
   protected

data/lib/chamber/commands/secure.rb

@@ -8,8 +8,8 @@ module  Commands
 class   Secure < Chamber::Commands::Base
   include Chamber::Commands::Securable
 
-  def initialize(options = {})
-    super(options.merge(namespaces: ['*']))
+  def initialize(**args)
+    super(**args.merge(namespaces: ['*']))
   end
 
   def call

data/lib/chamber/commands/show.rb

@@ -9,21 +9,21 @@ class   Show < Chamber::Commands::Base
   attr_accessor :as_env,
                 :only_sensitive
 
-  def initialize(options = {})
-    super
+  def initialize(as_env: nil, only_sensitive: nil, **args)
+    super(**args)
 
-    self.as_env         = options[:as_env]
-    self.only_sensitive = options[:only_sensitive]
+    self.as_env         = as_env
+    self.only_sensitive = only_sensitive
   end
 
   def call
     if as_env
       settings.to_s(pair_separator: "\n")
     else
-      PP.
-        pp(settings.to_hash, StringIO.new, 60).
-        string.
-        chomp
+      PP
+        .pp(settings.to_hash, StringIO.new, 60)
+        .string
+        .chomp
     end
   end
 

data/lib/chamber/commands/sign.rb

@@ -5,8 +5,8 @@ require 'chamber/commands/base'
 module  Chamber
 module  Commands
 class   Sign < Chamber::Commands::Base
-  def initialize(options = {})
-    super(options.merge(namespaces: ['*']))
+  def initialize(**args)
+    super(**args.merge(namespaces: ['*']))
   end
 
   def call

data/lib/chamber/commands/verify.rb

@@ -5,8 +5,8 @@ require 'chamber/commands/base'
 module  Chamber
 module  Commands
 class   Verify < Chamber::Commands::Base
-  def initialize(options = {})
-    super(options.merge(namespaces: ['*']))
+  def initialize(**args)
+    super(**args.merge(namespaces: ['*']))
   end
 
   def call

data/lib/chamber/configuration.rb

@@ -9,10 +9,11 @@ class   Configuration
                 :encryption_keys,
                 :files,
                 :namespaces,
-                :rootpath
+                :rootpath,
+                :signature_name
 
-  def initialize(options = {})
-    options              = ContextResolver.resolve(options)
+  def initialize(**args)
+    options              = ContextResolver.resolve(**args)
 
     self.basepath        = options.fetch(:basepath)
     self.namespaces      = options.fetch(:namespaces)
@@ -20,6 +21,7 @@ class   Configuration
     self.encryption_keys = options.fetch(:encryption_keys)
     self.files           = options.fetch(:files)
     self.rootpath        = options.fetch(:rootpath)
+    self.signature_name  = options.fetch(:signature_name)
   end
 
   def to_hash
@@ -29,6 +31,7 @@ class   Configuration
       encryption_keys: encryption_keys,
       files:           files,
       namespaces:      namespaces,
+      signature_name:  signature_name,
     }
   end
 end

data/lib/chamber/context_resolver.rb

@@ -3,7 +3,6 @@
 require 'pathname'
 require 'socket'
 
-require 'chamber/core_ext/hash'
 require 'chamber/keys/decryption'
 require 'chamber/keys/encryption'
 
@@ -11,11 +10,11 @@ module  Chamber
 class   ContextResolver
   attr_accessor :options
 
-  def initialize(options = {})
-    self.options = options.transform_keys(&:to_sym)
+  def initialize(**args)
+    self.options = args
   end
 
-  # rubocop:disable Metrics/AbcSize, Metrics/LineLength
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Layout/LineLength
   def resolve
     options[:rootpath]   ||= Pathname.pwd
     options[:rootpath]     = Pathname.new(options[:rootpath])
@@ -42,13 +41,14 @@ class   ContextResolver
                                     options[:basepath] + 'settings*.yml',
                                     options[:basepath] + 'settings',
                                   ]
+    options[:signature_name]    = options[:signature_name]
 
     options
   end
-  # rubocop:enable Metrics/AbcSize, Metrics/LineLength
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Layout/LineLength
 
-  def self.resolve(options = {})
-    new(options).resolve
+  def self.resolve(**args)
+    new(**args).resolve
   end
 
   protected

data/lib/chamber/encryption_methods/ssl.rb

@@ -5,7 +5,7 @@ require 'base64'
 module  Chamber
 module  EncryptionMethods
 class   Ssl
-  BASE64_STRING_PATTERN     = %r{[A-Za-z0-9\+\/#]*\={0,2}}.freeze
+  BASE64_STRING_PATTERN     = %r{[A-Za-z0-9+/#]*={0,2}}.freeze
   LARGE_DATA_STRING_PATTERN = /
                                 \A
                                 (#{BASE64_STRING_PATTERN})
@@ -16,12 +16,12 @@ class   Ssl
                                 \z
                               /x.freeze
 
-  def self.encrypt(_key, value, encryption_keys)
-    value = YAML.dump(value)
-    cipher = OpenSSL::Cipher.new('AES-128-CBC')
+  def self.encrypt(_key, value, encryption_keys) # rubocop:disable Metrics/AbcSize
+    value         = YAML.dump(value)
+    cipher        = OpenSSL::Cipher.new('AES-128-CBC')
     cipher.encrypt
     symmetric_key = cipher.random_key
-    iv = cipher.random_iv
+    iv            = cipher.random_iv
 
     # encrypt all data with this key and iv
     encrypted_data = cipher.update(value) + cipher.final
@@ -35,24 +35,24 @@ class   Ssl
     Base64.strict_encode64(encrypted_data)
   end
 
-  def self.decrypt(key, value, decryption_keys)
+  def self.decrypt(key, value, decryption_keys) # rubocop:disable Metrics/AbcSize
     if decryption_keys.nil?
       value
     else
-      key, iv, decoded_string = value.
-                                  match(LARGE_DATA_STRING_PATTERN).
-                                  captures.
-                                  map do |part|
+      key, iv, decoded_string = value
+                                  .match(LARGE_DATA_STRING_PATTERN)
+                                  .captures
+                                  .map do |part|
         Base64.strict_decode64(part)
       end
-      key = decryption_keys.private_decrypt(key)
+      key                     = decryption_keys.private_decrypt(key)
 
       cipher_dec = OpenSSL::Cipher.new('AES-128-CBC')
 
       cipher_dec.decrypt
 
       cipher_dec.key = key
-      cipher_dec.iv = iv
+      cipher_dec.iv  = iv
 
       begin
         unencrypted_value = cipher_dec.update(decoded_string) + cipher_dec.final

data/lib/chamber/file.rb

@@ -4,6 +4,7 @@ require 'pathname'
 require 'yaml'
 require 'erb'
 require 'chamber/files/signature'
+require 'chamber/refinements/hash'
 
 ###
 # Internal: Represents a single file containing settings information in a given
@@ -11,9 +12,12 @@ require 'chamber/files/signature'
 #
 module  Chamber
 class   File < Pathname
+  using ::Chamber::Refinements::Hash
+
   attr_accessor :namespaces,
                 :decryption_keys,
-                :encryption_keys
+                :encryption_keys,
+                :signature_name
 
   ###
   # Internal: Creates a settings file representing a path to a file on the
@@ -42,12 +46,13 @@ class   File < Pathname
   #   Chamber::File.new path: '/tmp/settings.yml'
   #   # => <Chamber::File>
   #
-  def initialize(options = {})
-    self.namespaces      = options[:namespaces]      || {}
-    self.decryption_keys = options[:decryption_keys] || {}
-    self.encryption_keys = options[:encryption_keys] || {}
+  def initialize(path:, namespaces: {}, decryption_keys: {}, encryption_keys: {}, signature_name: nil)
+    self.namespaces      = namespaces
+    self.decryption_keys = decryption_keys
+    self.encryption_keys = encryption_keys
+    self.signature_name  = signature_name
 
-    super options.fetch(:path)
+    super path
   end
 
   ###
@@ -76,7 +81,7 @@ class   File < Pathname
                                   encryption_keys: encryption_keys)
   end
 
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength, Metrics/AbcSize
   def secure
     insecure_settings = to_settings.insecure.to_flattened_name_hash
     secure_settings   = to_settings.insecure.secure.to_flattened_name_hash
@@ -88,14 +93,14 @@ class   File < Pathname
       escaped_name  = Regexp.escape(name_pieces.last)
       escaped_value = Regexp.escape(value)
 
-      file_contents.
-        sub!(
+      file_contents
+        .sub!(
           /^(\s*)#{secure_prefix_pattern}#{escaped_name}(\s*):(\s*)['"]?#{escaped_value}['"]?$/,
           "\\1#{secure_prefix}#{name_pieces.last}\\2:\\3#{secure_value}",
         )
 
-      file_contents.
-        sub!(
+      file_contents
+        .sub!(
           /^(\s*)#{secure_prefix_pattern}#{escaped_name}(\s*):(\s*)\|((?:\n\1\s{2}.*)+)/,
           "\\1#{secure_prefix}#{name_pieces.last}\\2:\\3#{secure_value}",
         )
@@ -103,7 +108,7 @@ class   File < Pathname
 
     write(file_contents)
   end
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength, Metrics/AbcSize
 
   def sign
     signature_key_contents = decryption_keys[:signature]
@@ -111,7 +116,7 @@ class   File < Pathname
     fail ArgumentError, 'You asked to sign your settings files but no signature key was found.  Run `chamber init --signature` to generate one.' \
       unless signature_key_contents
 
-    signature = Files::Signature.new(to_s, read, signature_key_contents)
+    signature = Files::Signature.new(to_s, read, signature_key_contents, signature_name)
 
     signature.write
   end
@@ -122,7 +127,7 @@ class   File < Pathname
     fail ArgumentError, 'You asked to verify your settings files but no signature key was found.  Run `chamber init --signature` to generate one.' \
       unless signature_key_contents
 
-    signature = Files::Signature.new(to_s, read, signature_key_contents)
+    signature = Files::Signature.new(to_s, read, signature_key_contents, signature_name)
 
     signature.verify
   end
@@ -141,7 +146,7 @@ class   File < Pathname
     file_contents = read
     erb_result    = ERB.new(file_contents).result
 
-    YAML.load(erb_result) || {}
+    (YAML.load(erb_result) || {}).deep_transform_keys(&:to_s)
   rescue Errno::ENOENT
     {}
   end

data/lib/chamber/file_set.rb

@@ -114,17 +114,26 @@ module  Chamber
 class   FileSet
   attr_accessor :decryption_keys,
                 :encryption_keys,
-                :basepath
+                :basepath,
+                :signature_name
   attr_reader   :namespaces,
                 :paths
 
-  def initialize(options = {})
-    self.namespaces      = options[:namespaces] || {}
-    self.decryption_keys = options[:decryption_keys]
-    self.encryption_keys = options[:encryption_keys]
-    self.paths           = options.fetch(:files)
-    self.basepath        = options[:basepath]
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(files:,
+                 basepath:        nil,
+                 decryption_keys: nil,
+                 encryption_keys: nil,
+                 namespaces:      {},
+                 signature_name:  nil)
+    self.basepath        = basepath
+    self.decryption_keys = decryption_keys
+    self.encryption_keys = encryption_keys
+    self.namespaces      = namespaces
+    self.paths           = files
+    self.signature_name  = signature_name
   end
+  # rubocop:enable Metrics/ParameterLists
 
   ###
   # Internal: Returns an Array of the ordered list of files that was processed
@@ -234,7 +243,8 @@ class   FileSet
           File.new(path:            file,
                    namespaces:      namespaces,
                    decryption_keys: decryption_keys,
-                   encryption_keys: encryption_keys)
+                   encryption_keys: encryption_keys,
+                   signature_name:  signature_name)
         end
 
         sorted_relevant_files += relevant_glob_files

data/lib/chamber/files/signature.rb

@@ -8,9 +8,9 @@ module Chamber
 module Files
 class  Signature
   SIGNATURE_HEADER          = '-----BEGIN CHAMBER SIGNATURE-----'
-  SIGNATURE_HEADER_PATTERN  = /\-\-\-\-\-BEGIN\sCHAMBER\sSIGNATURE\-\-\-\-\-/.freeze
+  SIGNATURE_HEADER_PATTERN  = /-----BEGIN\sCHAMBER\sSIGNATURE-----/.freeze
   SIGNATURE_FOOTER          = '-----END CHAMBER SIGNATURE-----'
-  SIGNATURE_FOOTER_PATTERN  = /\-\-\-\-\-END\sCHAMBER\sSIGNATURE\-\-\-\-\-/.freeze
+  SIGNATURE_FOOTER_PATTERN  = /-----END\sCHAMBER\sSIGNATURE-----/.freeze
   SIGNATURE_IN_FILE_PATTERN = /
                                 #{SIGNATURE_HEADER_PATTERN}\n # Header
                                 (.*)\n                        # Signature Body
@@ -18,14 +18,16 @@ class  Signature
                               /x.freeze
 
   attr_accessor :settings_content,
-                :settings_filename
+                :settings_filename,
+                :signature_name
 
   attr_reader   :signature_key
 
-  def initialize(settings_filename, settings_content, signature_key)
+  def initialize(settings_filename, settings_content, signature_key, signature_name)
     self.signature_key     = signature_key
     self.settings_content  = settings_content
     self.settings_filename = Pathname.new(settings_filename)
+    self.signature_name    = signature_name
   end
 
   def signature_key=(keyish)
@@ -41,7 +43,7 @@ class  Signature
 
   def write
     signature_filename.write(<<-HEREDOC, 0, mode: 'w+')
-Signed By: #{`git config --get 'user.name'`.chomp}
+Signed By: #{signature_name}
 Signed At: #{Time.now.utc.iso8601}
 
 #{SIGNATURE_HEADER}
@@ -61,20 +63,20 @@ Signed At: #{Time.now.utc.iso8601}
   end
 
   def raw_signature
-    @raw_signature ||= signature_key.
-                         sign(digest, settings_content)
+    @raw_signature ||= signature_key
+                         .sign(digest, settings_content)
   end
 
   def signature_filename
-    @signature_filename ||= settings_filename.
-                              sub('.yml', '.sig').
-                              sub('.erb', '')
+    @signature_filename ||= settings_filename
+                              .sub('.yml', '.sig')
+                              .sub('.erb', '')
   end
 
   def encoded_signature_content
-    @encoded_signature_content ||= signature_filename.
-                                     read.
-                                     match(SIGNATURE_IN_FILE_PATTERN) do |match|
+    @encoded_signature_content ||= signature_filename
+                                     .read
+                                     .match(SIGNATURE_IN_FILE_PATTERN) do |match|
       match[1]
     end
   end
@@ -84,7 +86,7 @@ Signed At: #{Time.now.utc.iso8601}
   end
 
   def digest
-    @digest ||= OpenSSL::Digest::SHA512.new
+    @digest ||= OpenSSL::Digest.new('SHA512')
   end
 end
 end