symmetric-encryption 4.0.0 → 4.0.1

data/test/cipher_test.rb

@@ -3,7 +3,7 @@ require_relative 'test_helper'
 # Tests for SymmetricEncryption::Cipher
 class CipherTest < Minitest::Test
   ['aes-128-cbc'].each do |cipher_name|
-    #['aes-128-cbc', 'aes-128-gcm'].each do |cipher_name|
+    # ['aes-128-cbc', 'aes-128-gcm'].each do |cipher_name|
     describe "Cipher: #{cipher_name}" do
       describe 'standalone' do
         it 'allows setting the cipher_name' do
@@ -41,7 +41,7 @@ class CipherTest < Minitest::Test
       end
 
       [false, true].each do |always_add_header|
-        [:none, :base64, :base64strict, :base16].each do |encoding|
+        %i[none base64 base64strict base16].each do |encoding|
           describe "encoding: #{encoding} with#{'out' unless always_add_header} header" do
             before do
               @social_security_number = '987654321'
@@ -62,7 +62,7 @@ class CipherTest < Minitest::Test
                   none:         {
                     header:    "@EnC\x00\x00\xC97\x8B\x8E\xC1\xD3k\xCC\xA4\xA0\xEFy+B\x90\x9A",
                     no_header: "\xC97\x8B\x8E\xC1\xD3k\xCC\xA4\xA0\xEFy+B\x90\x9A"
-                  },
+                  }
                 },
                 # 'aes-128-gcm' => {
                 #   base64:       {
@@ -173,8 +173,15 @@ class CipherTest < Minitest::Test
 
           it 'build and parse header' do
             key = SymmetricEncryption::Key.new(cipher_name: 'aes-128-cbc')
-            assert binary_header = SymmetricEncryption::Cipher.build_header(SymmetricEncryption.cipher.version, true, key.iv, key.key, key.cipher_name)
-            header = SymmetricEncryption::Header.new
+            # Test Deprecated method
+            binary_header = SymmetricEncryption::Cipher.build_header(
+              SymmetricEncryption.cipher.version,
+              true,
+              key.iv,
+              key.key,
+              key.cipher_name
+            )
+            header        = SymmetricEncryption::Header.new
             header.parse(binary_header)
             assert_equal true, header.compressed?
             assert random_cipher = SymmetricEncryption::Cipher.new(iv: key.iv, key: key.key, cipher_name: key.cipher_name)
@@ -204,7 +211,6 @@ class CipherTest < Minitest::Test
           end
         end
       end
-
     end
   end
 end

data/test/encoder_test.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 require_relative 'test_helper'
 
 # Unit Test for SymmetricEncryption
 #
 class EncoderTest < Minitest::Test
   describe SymmetricEncryption::Encoder do
-    [:none, :base64, :base64strict, :base16].each do |encoding|
+    %i[none base64 base64strict base16].each do |encoding|
       describe "encoding: #{encoding}" do
         before do
           @data         = '987654321'
@@ -57,5 +56,4 @@ class EncoderTest < Minitest::Test
       end
     end
   end
-
 end

data/test/header_test.rb

@@ -92,7 +92,6 @@ class CipherTest < Minitest::Test
           assert header.compressed?
         end
       end
-
     end
 
     describe '#to_s' do
@@ -138,7 +137,6 @@ class CipherTest < Minitest::Test
             assert header.compressed?
           end
         end
-
       end
     end
 
@@ -212,7 +210,5 @@ class CipherTest < Minitest::Test
         end
       end
     end
-
   end
 end
-

data/test/key_test.rb

@@ -233,8 +233,6 @@ class KeyTest < Minitest::Test
           assert_equal 'aes-256-cbc', config_key.cipher_name
         end
       end
-
     end
-
   end
 end

data/test/keystore/environment_test.rb

@@ -16,10 +16,10 @@ module SymmetricEncryption
 
         let :keystore_config do
           SymmetricEncryption::Keystore::Environment.new_key_config(
-            cipher_name:        'aes-256-cbc',
-            app_name:           'tester',
-            environment:        'test',
-            version:            version
+            cipher_name: 'aes-256-cbc',
+            app_name:    'tester',
+            environment: 'test',
+            version:     version
           )
         end
 
@@ -48,7 +48,7 @@ module SymmetricEncryption
         end
 
         it 'retains the env var name' do
-          assert_equal "TESTER_TEST_V11", keystore_config[:key_env_var]
+          assert_equal 'TESTER_TEST_V11', keystore_config[:key_env_var]
         end
 
         it 'retains cipher_name' do
@@ -58,7 +58,7 @@ module SymmetricEncryption
 
       describe '.new_config' do
         let :environments do
-          %i(development test acceptance preprod production)
+          %i[development test acceptance preprod production]
         end
 
         let :config do
@@ -79,7 +79,7 @@ module SymmetricEncryption
         end
 
         it 'each non test environment has a key encryption key' do
-          (environments - %i(development test)).each do |env|
+          (environments - %i[development test]).each do |env|
             assert config[env][:ciphers].first[:key_encrypting_key], "Environment #{env} is missing the key encryption key"
           end
         end
@@ -92,9 +92,9 @@ module SymmetricEncryption
         end
 
         it 'creates an encrypted key file for all non-test environments' do
-          (environments - %i(development test)).each do |env|
+          (environments - %i[development test]).each do |env|
             assert ciphers = config[env][:ciphers], "Environment #{env} is missing ciphers: #{config[env].inspect}"
-            assert file_name = ciphers.first[:key_env_var], "Environment #{env} is missing key_env_var: #{ciphers.inspect}"
+            assert ciphers.first[:key_env_var], "Environment #{env} is missing key_env_var: #{ciphers.inspect}"
           end
         end
       end
@@ -109,11 +109,10 @@ module SymmetricEncryption
         end
 
         it 'reads the key' do
-          ENV["TESTER_ENV_VAR"] = Base64.strict_encode64(key.encrypt('TEST'))
+          ENV['TESTER_ENV_VAR'] = Base64.strict_encode64(key.encrypt('TEST'))
           assert_equal 'TEST', keystore.read
         end
       end
-
     end
   end
 end

data/test/keystore/file_test.rb

@@ -16,11 +16,11 @@ module SymmetricEncryption
 
         let :key_config do
           SymmetricEncryption::Keystore::File.new_key_config(
-            key_path:           'tmp',
-            cipher_name:        'aes-256-cbc',
-            app_name:           'tester',
-            environment:        'test',
-            version:            version
+            key_path:    'tmp',
+            cipher_name: 'aes-256-cbc',
+            app_name:    'tester',
+            environment: 'test',
+            version:     version
           )
         end
 
@@ -60,13 +60,13 @@ module SymmetricEncryption
 
         it 'is readable by Key.from_config' do
           key_config.delete(:version)
-          assert key = SymmetricEncryption::Key.from_config(key_config)
+          assert SymmetricEncryption::Key.from_config(key_config)
         end
       end
 
       describe '.new_config' do
         let :environments do
-          %i(development test acceptance preprod production)
+          %i[development test acceptance preprod production]
         end
 
         let :config do
@@ -88,7 +88,7 @@ module SymmetricEncryption
         end
 
         it 'each non test environment has a key encryption key' do
-          (environments - %i(development test)).each do |env|
+          (environments - %i[development test]).each do |env|
             assert config[env][:ciphers].first[:key_encrypting_key], "Environment #{env} is missing the key encryption key"
           end
         end
@@ -101,7 +101,7 @@ module SymmetricEncryption
         end
 
         it 'creates an encrypted key file for all non-test environments' do
-          (environments - %i(development test)).each do |env|
+          (environments - %i[development test]).each do |env|
             assert ciphers = config[env][:ciphers], "Environment #{env} is missing ciphers: #{config[env].inspect}"
             assert file_name = ciphers.first[:key_filename], "Environment #{env} is missing key_filename: #{ciphers.inspect}"
             assert File.exist?(file_name)
@@ -119,7 +119,6 @@ module SymmetricEncryption
           assert_equal 'TEST', keystore.read
         end
       end
-
     end
   end
 end

data/test/keystore_test.rb

@@ -14,7 +14,7 @@ module SymmetricEncryption
 
       describe '.rotate_keys' do
         let :environments do
-          %i(development test acceptance preprod production)
+          %i[development test acceptance preprod production]
         end
 
         let :config do
@@ -40,7 +40,7 @@ module SymmetricEncryption
         end
 
         it 'creates an encrypted key file for all non-test environments' do
-          (environments - %i(development test)).each do |env|
+          (environments - %i[development test]).each do |env|
             assert key_rotation
             assert key_rotation[env.to_sym], key_rotation
             assert key_rotation[env.to_sym][:ciphers]
@@ -53,7 +53,6 @@ module SymmetricEncryption
           end
         end
       end
-
     end
   end
 end

data/test/mongoid_test.rb

@@ -6,7 +6,7 @@ begin
 
   Mongoid.load!('test/config/mongoid.yml')
 
-  #@formatter:off
+  # @formatter:off
   class MongoidUser
     include Mongoid::Document
 
@@ -42,11 +42,11 @@ begin
     validates_uniqueness_of :encrypted_username, allow_blank: true, if: :encrypted_username_changed?
 
     validates :username,
-      length:      {in: 3..20},
-      format:      {with: /\A[\w\-]+\z/},
-      allow_blank: true
+              length:      {in: 3..20},
+              format:      {with: /\A[\w\-]+\z/},
+              allow_blank: true
   end
-  #@formatter:on
+  # @formatter:on
 
   #
   # Unit Tests for field encrypted and validation aspects of SymmetricEncryption
@@ -60,7 +60,7 @@ begin
         @social_security_number           = '987654321'
         @social_security_number_encrypted = 'QEVuQwIAS+8X1NRrqdfEIQyFHVPuVA=='
 
-        @integer           = 32768
+        @integer           = 32_768
         @integer_encrypted = 'FA3smFQEKqB/ITv+A0xACg=='
 
         @float           = 0.9867
@@ -74,10 +74,10 @@ begin
 
         @integer_value  = 12
         @float_value    = 88.12345
-        @decimal_value  = BigDecimal.new('22.51')
-        @datetime_value = DateTime.new(2001, 11, 26, 20, 55, 54, "-5")
-        @time_value     = Time.new(2013, 01, 01, 22, 30, 00, "-04:00")
-        @date_value     = Date.new(1927, 04, 02)
+        @decimal_value  = BigDecimal('22.51')
+        @datetime_value = DateTime.new(2001, 11, 26, 20, 55, 54, '-5')
+        @time_value     = Time.new(2013, 0o1, 0o1, 22, 30, 0o0, '-04:00')
+        @date_value     = Date.new(1927, 0o4, 0o2)
         @h              = {a: 'A', b: 'B'}
 
         @user = MongoidUser.new(
@@ -182,14 +182,14 @@ begin
         assert_equal @bank_account_number_encrypted, @user.encrypted_social_security_number
       end
 
-      it "all paths it lead to the same result, check uninitialized" do
+      it 'all paths it lead to the same result, check uninitialized' do
         user = MongoidUser.new
         assert_nil user.social_security_number
         assert_equal @bank_account_number, (user.social_security_number = @bank_account_number)
         assert_equal @bank_account_number, user.social_security_number
         assert_equal @bank_account_number_encrypted, user.encrypted_social_security_number
 
-        assert_nil (user.social_security_number = nil)
+        user.social_security_number = nil
         assert_nil user.social_security_number
         assert_nil user.encrypted_social_security_number
       end
@@ -216,7 +216,7 @@ begin
         end
 
         after do
-          @user.destroy if @user
+          @user&.destroy
         end
 
         it 'return false if it was not changed' do
@@ -238,7 +238,7 @@ begin
         end
 
         after do
-          @user.destroy if @user
+          @user&.destroy
         end
 
         describe 'aliased fields' do
@@ -251,13 +251,13 @@ begin
         describe 'integer values' do
           it 'return correct data type' do
             assert_equal @integer_value, @user_clone.integer_value
-            assert @user.clone.integer_value.kind_of?(Integer)
+            assert @user.clone.integer_value.is_a?(Integer)
           end
 
           it 'coerce data type before save' do
             u = MongoidUser.new(integer_value: '5')
             assert_equal 5, u.integer_value
-            assert u.integer_value.kind_of?(Integer)
+            assert u.integer_value.is_a?(Integer)
           end
 
           it 'permit replacing value with nil' do
@@ -282,13 +282,13 @@ begin
         describe 'float values' do
           it 'return correct data type' do
             assert_equal @float_value, @user_clone.float_value
-            assert @user.clone.float_value.kind_of?(Float)
+            assert @user.clone.float_value.is_a?(Float)
           end
 
           it 'coerce data type before save' do
             u = MongoidUser.new(float_value: '5.6')
             assert_equal 5.6, u.float_value
-            assert u.float_value.kind_of?(Float)
+            assert u.float_value.is_a?(Float)
           end
 
           it 'permit replacing value with nil' do
@@ -313,13 +313,13 @@ begin
         describe 'decimal values' do
           it 'return correct data type' do
             assert_equal @decimal_value, @user_clone.decimal_value
-            assert @user.clone.decimal_value.kind_of?(BigDecimal)
+            assert @user.clone.decimal_value.is_a?(BigDecimal)
           end
 
           it 'coerce data type before save' do
             u = MongoidUser.new(decimal_value: '99.95')
-            assert_equal BigDecimal.new('99.95'), u.decimal_value
-            assert u.decimal_value.kind_of?(BigDecimal)
+            assert_equal BigDecimal('99.95'), u.decimal_value
+            assert u.decimal_value.is_a?(BigDecimal)
           end
 
           it 'permit replacing value with nil' do
@@ -332,7 +332,7 @@ begin
           end
 
           it 'permit replacing value' do
-            new_decimal_value         = BigDecimal.new('99.95')
+            new_decimal_value         = BigDecimal('99.95')
             @user_clone.decimal_value = new_decimal_value
             @user_clone.save!
 
@@ -344,14 +344,14 @@ begin
         describe 'datetime values' do
           it 'return correct data type' do
             assert_equal @datetime_value, @user_clone.datetime_value
-            assert @user.clone.datetime_value.kind_of?(DateTime)
+            assert @user.clone.datetime_value.is_a?(DateTime)
           end
 
           it 'coerce data type before save' do
             now = Time.now
             u   = MongoidUser.new(datetime_value: now)
             assert_equal now, u.datetime_value
-            assert u.datetime_value.kind_of?(DateTime)
+            assert u.datetime_value.is_a?(DateTime)
           end
 
           it 'permit replacing value with nil' do
@@ -376,14 +376,14 @@ begin
         describe 'time values' do
           it 'return correct data type' do
             assert_equal @time_value, @user_clone.time_value.dup
-            assert @user.clone.time_value.kind_of?(Time)
+            assert @user.clone.time_value.is_a?(Time)
           end
 
           it 'coerce data type before save' do
             now = Time.now
             u   = MongoidUser.new(time_value: now)
             assert_equal now, u.time_value.dup
-            assert u.time_value.kind_of?(Time)
+            assert u.time_value.is_a?(Time)
           end
 
           it 'permit replacing value with nil' do
@@ -408,14 +408,14 @@ begin
         describe 'date values' do
           it 'return correct data type' do
             assert_equal @date_value, @user_clone.date_value
-            assert @user.clone.date_value.kind_of?(Date)
+            assert @user.clone.date_value.is_a?(Date)
           end
 
           it 'coerce data type before save' do
             now = Time.now
             u   = MongoidUser.new(date_value: now)
             assert_equal now.to_date, u.date_value
-            assert u.date_value.kind_of?(Date)
+            assert u.date_value.is_a?(Date)
           end
 
           it 'permit replacing value with nil' do
@@ -440,13 +440,13 @@ begin
         describe 'true values' do
           it 'return correct data type' do
             assert_equal true, @user_clone.true_value
-            assert @user.clone.true_value.kind_of?(TrueClass)
+            assert @user.clone.true_value.is_a?(TrueClass)
           end
 
           it 'coerce data type before save' do
             u = MongoidUser.new(true_value: '1')
             assert_equal true, u.true_value
-            assert u.true_value.kind_of?(TrueClass)
+            assert u.true_value.is_a?(TrueClass)
           end
 
           it 'permit replacing value with nil' do
@@ -471,13 +471,13 @@ begin
         describe 'false values' do
           it 'return correct data type' do
             assert_equal false, @user_clone.false_value
-            assert @user.clone.false_value.kind_of?(FalseClass)
+            assert @user.clone.false_value.is_a?(FalseClass)
           end
 
           it 'coerce data type before save' do
             u = MongoidUser.new(false_value: '0')
             assert_equal false, u.false_value
-            assert u.false_value.kind_of?(FalseClass)
+            assert u.false_value.is_a?(FalseClass)
           end
 
           it 'permit replacing value with nil' do
@@ -511,13 +511,13 @@ begin
 
           it 'return correct data type' do
             assert_equal @h, @user_clone.data_json
-            assert @user.clone.data_json.kind_of?(Hash)
+            assert @user.clone.data_json.is_a?(Hash)
           end
 
           it 'not coerce data type (leaves as hash) before save' do
             u = MongoidUser.new(data_json: @h)
             assert_equal @h, u.data_json
-            assert u.data_json.kind_of?(Hash)
+            assert u.data_json.is_a?(Hash)
           end
 
           it 'permit replacing value with nil' do
@@ -543,13 +543,13 @@ begin
         describe 'YAML Serialization' do
           it 'return correct data type' do
             assert_equal @h, @user_clone.data_yaml
-            assert @user.clone.data_yaml.kind_of?(Hash)
+            assert @user.clone.data_yaml.is_a?(Hash)
           end
 
           it 'not coerce data type (leaves as hash) before save' do
             u = MongoidUser.new(data_yaml: @h)
             assert_equal @h, u.data_yaml
-            assert u.data_yaml.kind_of?(Hash)
+            assert u.data_yaml.is_a?(Hash)
           end
 
           it 'permit replacing value with nil' do
@@ -571,7 +571,6 @@ begin
             assert_equal new_value, @user.data_yaml
           end
         end
-
       end
 
       describe 'uniqueness' do
@@ -589,10 +588,8 @@ begin
           assert_equal 'is already taken', duplicate.errors.messages[:encrypted_email].first
         end
       end
-
     end
   end
-
 rescue LoadError
-  puts "Not running Mongoid tests because mongoid gem is not installed!!!"
+  puts 'Not running Mongoid tests because mongoid gem is not installed!!!'
 end