crypt_keeper 0.12.0 → 0.13.0

data/README.md

@@ -99,6 +99,7 @@ There are two included encryptors.
     `CREATE EXTENSION IF NOT EXISTS pgcrypto`
   * ActiveRecord logs are [automatically](https://github.com/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/log_subscriber/postgres_pgp.rb)
     filtered for you to protect senitive data from being logged.
+  * Custom options can be set through the `:pgcrypto_options`. E.g. `crypt_keeper :field, encryptor: :postgres_pgp, pgcrypto_options: 'compress-level=9'
 
 ## Requirements
 

data/lib/crypt_keeper/provider/postgres_pgp.rb

@@ -5,6 +5,7 @@ module CryptKeeper
     class PostgresPgp
       include CryptKeeper::Helper::SQL
       attr_accessor :key
+      attr_accessor :pgcrypto_options
 
       # Public: Initializes the encryptor
       #
@@ -15,13 +16,15 @@ module CryptKeeper
         @key = options.fetch(:key) do
           raise ArgumentError, "Missing :key"
         end
+
+        @pgcrypto_options = options.fetch(:pgcrypto_options, '')
       end
 
       # Public: Encrypts a string
       #
       # Returns an encrypted string
       def encrypt(value)
-        escape_and_execute_sql(["SELECT pgp_sym_encrypt(?, ?)", value.to_s, key])['pgp_sym_encrypt']
+        escape_and_execute_sql(["SELECT pgp_sym_encrypt(?, ?, ?)", value.to_s, key, pgcrypto_options])['pgp_sym_encrypt']
       end
 
       # Public: Decrypts a string

data/lib/crypt_keeper/version.rb

@@ -1,3 +1,3 @@
 module CryptKeeper
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/spec/log_subscriber/mysql_aes_spec.rb

@@ -12,7 +12,7 @@ module CryptKeeper::LogSubscriber
     subject { ::ActiveRecord::LogSubscriber.new }
 
     let(:input_query) do
-      "SELECT AES_ENCRYPT('encrypt_value', 'encrypt_key'), AES_ENCRYPT('decrypt_value', 'decrypt_key') FROM DUAL;"
+      "SELECT AES_ENCRYPT('encrypt_value', 'encrypt_key'), AES_DECRYPT('decrypt_value', 'decrypt_key') FROM DUAL;"
     end
 
     let(:output_query) do
@@ -24,7 +24,7 @@ module CryptKeeper::LogSubscriber
         event.payload[:sql].should == output_query
       end
 
-      subject.sql(ActiveSupport::Notifications::Event.new(:sql, 1, 1, 1, { sql: output_query }))
+      subject.sql(ActiveSupport::Notifications::Event.new(:sql, 1, 1, 1, { sql: input_query }))
     end
   end
 end

data/spec/log_subscriber/postgres_pgp_spec.rb

@@ -24,7 +24,7 @@ module CryptKeeper::LogSubscriber
         event.payload[:sql].should == output_query
       end
 
-      subject.sql(ActiveSupport::Notifications::Event.new(:sql, 1, 1, 1, { sql: output_query }))
+      subject.sql(ActiveSupport::Notifications::Event.new(:sql, 1, 1, 1, { sql: input_query }))
     end
   end
 end

data/spec/model_spec.rb

@@ -131,15 +131,10 @@ module CryptKeeper
         specify { record.should_not be_changed }
 
         it "unchanged plaintext does not trigger a save" do
-          queries = []
-
-          subscriber = ActiveSupport::Notifications.subscribe('sql.active_record')  do |name, started, finished, id, payload|
-            queries << payload[:sql]
+          queries = logged_queries do
+            SensitiveData.find(record.id).save
           end
 
-          SensitiveData.find(record.id).save
-          ActiveSupport::Notifications.unsubscribe subscriber
-
           updates = queries.select { |query| query.match(/^UPDATE /) }
 
           queries.should_not be_empty

data/spec/provider/postgres_pgp_spec.rb

@@ -34,6 +34,25 @@ module CryptKeeper
       describe "#decrypt" do
         specify { subject.decrypt(cipher_text).should == plain_text }
       end
+
+      describe "Custom pgcrypto options" do
+        let(:pgcrypto_options) { 'compress-level=0' }
+
+        subject { PostgresPgp.new key: 'candy', pgcrypto_options: pgcrypto_options }
+
+        it "reads and writes" do
+          queries = logged_queries do
+            encrypted = subject.encrypt(plain_text)
+            subject.decrypt(encrypted).should == plain_text
+          end
+
+          queries.should_not be_empty
+
+          queries.select { |query| query.include?("pgp_sym_encrypt") }.each do |q|
+            q.should include(pgcrypto_options)
+          end
+        end
+      end
     end
   end
 end

data/spec/support/active_record.rb

@@ -42,7 +42,25 @@ module CryptKeeper
   end
 end
 
+module LoggedQueries
+  # Logs the queries run inside the block, and return them.
+  def logged_queries(&block)
+    queries = []
+
+    subscriber = ActiveSupport::Notifications
+      .subscribe('sql.active_record') do |name, started, finished, id, payload|
+      queries << payload[:sql]
+    end
+
+    block.call
+
+    queries
+
+    ensure ActiveSupport::Notifications.unsubscribe(subscriber)
+  end
+end
 
 RSpec.configure do |config|
   config.extend CryptKeeper::ConnectionHelpers
+  config.include LoggedQueries
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crypt_keeper
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -261,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1020969970469435860
+      hash: -2554365943607960081
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1020969970469435860
+      hash: -2554365943607960081
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23