crypt_keeper 0.22.0 → 1.0.0.beta1

data/spec/spec_helper.rb

@@ -11,7 +11,6 @@ ENCRYPTION_PASSWORD = "supermadsecretstring"
 Dir[SPEC_ROOT.join('support/*.rb')].each{|f| require f }
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

data/spec/support/encryptors.rb

@@ -1,7 +1,13 @@
 module CryptKeeper
   module Provider
     # A fake class that does no encryption
-    class FakeEncryptor
+    class InvalidEncryptor
+      def initialize(*args)
+      end
+    end
+
+    # A fake class that does no encryption
+    class FakeEncryptor < Base
       def initialize(*args)
       end
 
@@ -14,7 +20,7 @@ module CryptKeeper
       end
     end
 
-    class SearchEncryptor
+    class SearchEncryptor < Base
       def initialize(*args)
       end
 
@@ -34,7 +40,7 @@ module CryptKeeper
 
     # This class embeds the passphrase in the beginning of the string
     # and then reverses the 'plaintext'
-    class Encryptor
+    class Encryptor < Base
       def initialize(options = {})
         @passphrase = options[:passphrase]
       end

data/spec/support/logging.rb

@@ -0,0 +1,92 @@
+# This module is used to verify CryptKeeper log subscribers work as expected.
+#
+# Examples
+#
+# The following test will verify that the `input` query is scrubbed so it
+# matches the `output` query.
+#
+#   specify do
+#     should_log_scrubbed_query \
+#       input:  "SELECT pgp_sym_encrypt('val', 'key')"
+#       output: "SELECT encrypt([FILTERED])"
+#   end
+#
+# The following test will verify that the `input` query was not logged at all
+# (eg: CryptKeeper.silence_logs is enabled).
+#
+#   specify do
+#     CryptKeeper.silence_logs = true
+#
+#     should_not_log_query input: "SELECT pgp_sym_encrypt('val', 'key')"
+#   end
+require "active_record/log_subscriber"
+
+module CryptKeeper
+  module Testing
+    module Logging
+      class TestDebugLogSubscriber < ActiveRecord::LogSubscriber
+        attr_reader :debugs
+
+        def initialize
+          @debugs = []
+          super
+        end
+
+        def debug(message)
+          @debugs << message
+        end
+      end
+
+      # Public: Verifies that the given input query was scrubbed and the
+      # output query was logged.
+      #
+      # input - Input SQL query to be scrubbed
+      # output - Expected output SQL query after scrubbing
+      #
+      # Returns nothing.
+      def should_log_scrubbed_query(input:, output:)
+        queries = sql(input)
+
+        valid_input = queries.none? { |line| line.include? input }
+        expect(valid_input).to eq(true), "found unscrubbed SQL query logged!"
+
+        valid_output = queries.any? { |line| line.include? output }
+        expect(valid_output).to eq(true), "output query was not logged!"
+      end
+
+      # Public: Verifies that the given input query was not logged.
+      #
+      # input - SQL query
+      #
+      # Returns nothing.
+      def should_not_log_query(input)
+        queries = sql(input)
+
+        expect(queries).to be_empty
+
+        valid_output = sql("SELECT 1").any? { |line| line.include? "SELECT 1" }
+
+        expect(valid_output).to eq(true)
+      end
+
+      private
+
+      # Private: Triggers ActiveRecord::LogSubscriber#sql for the given query.
+      #
+      # query - SQL query
+      #
+      # Returns an Array.
+      def sql(query)
+        event = ActiveSupport::Notifications::Event.new(:sql, 1, 1, 1, { sql: query })
+
+        subscriber = TestDebugLogSubscriber.new
+        subscriber.sql event
+        subscriber.debugs
+      end
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include CryptKeeper::Testing::Logging
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crypt_keeper
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Justin Mazzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: aes
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -168,14 +168,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -196,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -221,8 +221,7 @@ dependencies:
 description: Transparent ActiveRecord encryption
 email:
 - jmazzi@gmail.com
-executables:
-- crypt_keeper
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -235,39 +234,34 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/crypt_keeper
 - crypt_keeper.gemspec
-- gemfiles/activerecord_4_1.gemfile
-- gemfiles/activerecord_4_1.gemfile.lock
 - gemfiles/activerecord_4_2.gemfile
-- gemfiles/activerecord_4_2.gemfile.lock
+- gemfiles/activerecord_5_0.gemfile
 - lib/crypt_keeper.rb
 - lib/crypt_keeper/helper.rb
 - lib/crypt_keeper/log_subscriber/mysql_aes.rb
 - lib/crypt_keeper/log_subscriber/postgres_pgp.rb
 - lib/crypt_keeper/model.rb
-- lib/crypt_keeper/provider/aes.rb
 - lib/crypt_keeper/provider/aes_new.rb
-- lib/crypt_keeper/provider/mysql_aes.rb
+- lib/crypt_keeper/provider/base.rb
 - lib/crypt_keeper/provider/mysql_aes_new.rb
 - lib/crypt_keeper/provider/postgres_pgp.rb
 - lib/crypt_keeper/provider/postgres_pgp_public_key.rb
 - lib/crypt_keeper/version.rb
+- spec/crypt_keeper/log_subscriber/mysql_aes_spec.rb
+- spec/crypt_keeper/log_subscriber/postgres_pgp_spec.rb
+- spec/crypt_keeper/model_spec.rb
+- spec/crypt_keeper/provider/aes_new_spec.rb
+- spec/crypt_keeper/provider/mysql_aes_new_spec.rb
+- spec/crypt_keeper/provider/postgres_pgp_public_key_spec.rb
+- spec/crypt_keeper/provider/postgres_pgp_spec.rb
 - spec/default.database.yml
 - spec/fixtures/private.asc
 - spec/fixtures/public.asc
-- spec/log_subscriber/mysql_aes_spec.rb
-- spec/log_subscriber/postgres_pgp_spec.rb
-- spec/model_spec.rb
-- spec/provider/aes_new_spec.rb
-- spec/provider/aes_spec.rb
-- spec/provider/mysql_aes_new_spec.rb
-- spec/provider/mysql_aes_spec.rb
-- spec/provider/postgres_pgp_public_key_spec.rb
-- spec/provider/postgres_pgp_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 - spec/support/encryptors.rb
+- spec/support/logging.rb
 homepage: http://jmazzi.github.com/crypt_keeper/
 licenses:
 - MIT
@@ -283,9 +277,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
@@ -293,18 +287,17 @@ signing_key:
 specification_version: 4
 summary: Transparent ActiveRecord encryption
 test_files:
+- spec/crypt_keeper/log_subscriber/mysql_aes_spec.rb
+- spec/crypt_keeper/log_subscriber/postgres_pgp_spec.rb
+- spec/crypt_keeper/model_spec.rb
+- spec/crypt_keeper/provider/aes_new_spec.rb
+- spec/crypt_keeper/provider/mysql_aes_new_spec.rb
+- spec/crypt_keeper/provider/postgres_pgp_public_key_spec.rb
+- spec/crypt_keeper/provider/postgres_pgp_spec.rb
 - spec/default.database.yml
 - spec/fixtures/private.asc
 - spec/fixtures/public.asc
-- spec/log_subscriber/mysql_aes_spec.rb
-- spec/log_subscriber/postgres_pgp_spec.rb
-- spec/model_spec.rb
-- spec/provider/aes_new_spec.rb
-- spec/provider/aes_spec.rb
-- spec/provider/mysql_aes_new_spec.rb
-- spec/provider/mysql_aes_spec.rb
-- spec/provider/postgres_pgp_public_key_spec.rb
-- spec/provider/postgres_pgp_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 - spec/support/encryptors.rb
+- spec/support/logging.rb

data/gemfiles/activerecord_4_1.gemfile.lock

@@ -1,120 +0,0 @@
-PATH
-  remote: ../
-  specs:
-    crypt_keeper (0.21.0)
-      activerecord (>= 3.1, < 4.3)
-      activesupport (>= 3.1, < 4.3)
-      aes (~> 0.5.0)
-      armor (~> 0.0.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (4.1.14.2)
-      activesupport (= 4.1.14.2)
-      builder (~> 3.1)
-    activerecord (4.1.14.2)
-      activemodel (= 4.1.14.2)
-      activesupport (= 4.1.14.2)
-      arel (~> 5.0.0)
-    activesupport (4.1.14.2)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.1)
-      tzinfo (~> 1.1)
-    aes (0.5.0)
-    appraisal (1.0.3)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (5.0.1.20140414130214)
-    armor (0.0.3)
-    builder (3.2.2)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    coderay (1.1.1)
-    coveralls (0.8.13)
-      json (~> 1.8)
-      simplecov (~> 0.11.0)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-      tins (~> 1.6.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    ffi (1.9.10)
-    formatador (0.2.5)
-    guard (2.6.1)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-rspec (4.2.10)
-      guard (~> 2.1)
-      rspec (>= 2.14, < 4.0)
-    hitimes (1.2.4)
-    i18n (0.7.0)
-    json (1.8.3)
-    listen (2.10.1)
-      celluloid (~> 0.16.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.10)
-    method_source (0.8.2)
-    minitest (5.9.0)
-    mysql2 (0.3.21)
-    pg (0.17.1)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.3.2)
-    rb-fsevent (0.9.7)
-    rb-inotify (0.9.7)
-      ffi (>= 0.5.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    simplecov (0.11.2)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    sqlite3 (1.3.11)
-    term-ansicolor (1.3.2)
-      tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    timers (4.0.4)
-      hitimes
-    tins (1.6.0)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 4.1.0)
-  activesupport (~> 4.1.0)
-  appraisal (~> 1.0.0)
-  coveralls
-  crypt_keeper!
-  guard (~> 2.6.1)
-  guard-rspec (~> 4.2.9)
-  mysql2 (~> 0.3.11)
-  pg (~> 0.17.1)
-  rake (~> 10.3.1)
-  rb-fsevent (~> 0.9.1)
-  rspec (~> 2.14.0)
-  sqlite3
-
-BUNDLED WITH
-   1.12.5