crypt_keeper 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,5 +1,9 @@
+branches: master
 language: ruby
-script: "bundle exec rake spec"
+gemfile:
+  - gemfiles/activerecord_3_0.gemfile
+  - gemfiles/activerecord_3_1.gemfile
+  - gemfiles/activerecord_3_2.gemfile
 notifications:
   email:
     recipients:
@@ -9,4 +13,3 @@ notifications:
 rvm:
   - 1.9.2
   - 1.9.3
-  - jruby-19mode

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "activerecord_3_0" do
+  gem 'activerecord',  '~> 3.0'
+  gem 'activesupport', '~> 3.0'
+end
+
+appraise "activerecord_3_1" do
+  gem 'activerecord',  '~> 3.1'
+  gem 'activesupport', '~> 3.1'
+end
+
+appraise "activerecord_3_2" do
+  gem 'activerecord',  '~> 3.2'
+  gem 'activesupport', '~> 3.2'
+end

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', version: 2, fail_fast: true, all_on_start: false, all_after_pass: false do
+guard 'rspec', version: 2, all_on_start: false, all_after_pass: false, cli: '--fail-fast' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -15,7 +15,7 @@ is a simple class that does 3 things.
 Note: Any options defined using `crypt_keeper` will be passed to `new` as a 
 hash.
 
-Use can see an AES example here [here](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/aes.rb)
+You can see an AES example [here](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/aes.rb).
 
 ## Why?
 
@@ -27,7 +27,7 @@ simple that *just works*.
 
 ```ruby
 class MyModel < ActiveRecord::Base
-  crypt_keeper :field, :other_field, :encryptor => :aes, :passphrase => 'super_good_password'
+  crypt_keeper :field, :other_field, :encryptor => :aes, :key => 'super_good_password'
 end
 
 model = MyModel.new(field: 'sometext')
@@ -35,8 +35,16 @@ model.save! #=> Your data is now encrypted
 model.field #=> 'sometext'
 ```
 
-It works with all persistences methods: `update_attribute`, `update_attributes`, 
-`create`, `save` etc.
+It works with all persistences methods: `update_attributes`, `create`, `save` 
+etc.
+
+Note: `update_attribute` is deprecated in ActiveRecord 3.2.7. It is superseded
+by [update_column](http://apidock.com/rails/ActiveRecord/Persistence/update_column) which _skips_ all validations, callbacks.
+
+That means using `update_column` will not perform any encryption. This is 
+expected behavior, and has it's use cases. An example would be migrating from
+one type of encryption to another. Using `update_column` would allow you to
+update the content without going through the current encryptor.
 
 ## Creating your own encryptor
 
@@ -60,15 +68,32 @@ end
 ```
 
 Just require your code and setup your model to use it. Just pass the class name
-as an underscored symbol
+as a string or an underscored symbol
 
 
 ```ruby
 class MyModel < ActiveRecord::Base
-  crypt_keeper :field, :other_field, :encryptor => :my_encryptor, :passphrase => 'super_good_password'
+  crypt_keeper :field, :other_field, :encryptor => :my_encryptor, :key => 'super_good_password'
 end
 ```
 
+## Available Encryptors
+
+There are two included encryptors. 
+
+* [AES](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/aes.rb)
+  * Encryption is peformed using AES-256 via OpenSSL.
+
+* [PostgreSQL PGP](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/postgres_pgp.rb). 
+ * Encryption is performed using PostgresSQL's native [PGP functions](http://www.postgresql.org/docs/9.1/static/pgcrypto.html).
+ * It requires the `pgcrypto` PostgresSQL extension. `CREATE EXTENSION IF NOT EXISTS pgcrypto`
+ * ActiveRecord logs are [automatically](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/postgres_pgp_log_subscriber.rb) filtered for you to protect senitive data from being logged.
+
+## Requirements
+
+Crypt Keeper has been tested against ActiveRecord 3.0, 3.1, and 3.2 using ruby
+1.9.2, 1.9.3 and jruby in 1.9 mode.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
+require 'appraisal'
 
 RSpec::Core::RakeTask.new :spec
 Bundler::GemHelper.install_tasks

data/crypt_keeper.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["jmazzi@gmail.com"]
   gem.description   = %q{Transparent encryption for ActiveRecord that isn't over-engineered}
   gem.summary       = gem.description
-  gem.homepage      = ""
+  gem.homepage      = "http://jmazzi.github.com/crypt_keeper/"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,14 +15,16 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CryptKeeper::VERSION
 
-  gem.add_runtime_dependency 'activerecord', '>= 3.0'
-  gem.add_runtime_dependency 'activesupport', '>= 3.0'
-  gem.add_runtime_dependency 'crypt_keeper_providers', '~> 0.1.0'
+  gem.add_runtime_dependency 'activerecord',           '>= 3.0'
+  gem.add_runtime_dependency 'activesupport',          '>= 3.0'
+  gem.add_runtime_dependency 'crypt_keeper_providers', '~> 0.2.0'
+  gem.add_runtime_dependency 'appraisal',              '~> 0.4.1'
 
-  gem.add_development_dependency 'rspec', '~> 2.10.0'
-  gem.add_development_dependency 'guard', '~> 1.2.0'
+  gem.add_development_dependency 'rspec',       '~> 2.10.0'
+  gem.add_development_dependency 'guard',       '~> 1.2.0'
   gem.add_development_dependency 'guard-rspec', '~> 1.1.0'
-  gem.add_development_dependency 'rake', '~> 0.9.2.2'
+  gem.add_development_dependency 'rake',        '~> 0.9.2.2'
+
   if RUBY_PLATFORM == 'java'
     gem.add_development_dependency 'jruby-openssl', '~> 0.7.7'
     gem.add_development_dependency 'activerecord-jdbcsqlite3-adapter'

data/gemfiles/activerecord_3_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.0"
+gem "activesupport", "~> 3.0"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3_0.gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: /home/justin/work/ruby/crypt_keeper
+  specs:
+    crypt_keeper (0.2.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+      appraisal (~> 0.4.1)
+      crypt_keeper_providers (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    crypt_keeper_providers (0.1.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.0)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  activesupport (~> 3.0)
+  crypt_keeper!
+  guard (~> 1.2.0)
+  guard-rspec (~> 1.1.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.10.0)
+  sqlite3

data/gemfiles/activerecord_3_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.1"
+gem "activesupport", "~> 3.1"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3_1.gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: /home/justin/work/ruby/crypt_keeper
+  specs:
+    crypt_keeper (0.2.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+      appraisal (~> 0.4.1)
+      crypt_keeper_providers (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    crypt_keeper_providers (0.1.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.0)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1)
+  activesupport (~> 3.1)
+  crypt_keeper!
+  guard (~> 1.2.0)
+  guard-rspec (~> 1.1.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.10.0)
+  sqlite3

data/gemfiles/activerecord_3_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+gem "activesupport", "~> 3.2"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3_2.gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: /home/justin/work/ruby/crypt_keeper
+  specs:
+    crypt_keeper (0.2.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+      appraisal (~> 0.4.1)
+      crypt_keeper_providers (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    crypt_keeper_providers (0.1.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.0)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2)
+  activesupport (~> 3.2)
+  crypt_keeper!
+  guard (~> 1.2.0)
+  guard-rspec (~> 1.1.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.10.0)
+  sqlite3

data/lib/crypt_keeper/model.rb

@@ -33,7 +33,7 @@ module CryptKeeper
       # Example
       #
       #   class MyModel < ActiveRecord::Base
-      #     crypt_keeper :field, :other_field, :encryptor => :aes, :passphrase => 'super_good_password'
+      #     crypt_keeper :field, :other_field, :encryptor => :aes, :key => 'super_good_password'
       #   end
       #
       def crypt_keeper(*args)

data/lib/crypt_keeper/version.rb

@@ -1,3 +1,3 @@
 module CryptKeeper
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/model_spec.rb

@@ -4,6 +4,11 @@ module CryptKeeper
   describe Model do
     subject { SensitiveData }
     describe "#crypt_keeper" do
+      after(:each) do
+        subject.instance_variable_set(:@encryptor_klass, nil)
+        subject.instance_variable_set(:@encryptor, nil)
+      end
+
       context "Fields" do
         it "should set the fields" do
           subject.crypt_keeper :storage, :secret, encryptor: :fake_encryptor
@@ -21,6 +26,13 @@ module CryptKeeper
           subject.crypt_keeper :storage, :secret, key1: 1, key2: 2, encryptor: :fake_encryptor
           subject.crypt_keeper_options.should == { key1: 1, key2: 2  }
         end
+
+        it "should accept class name (as string) for encryptor option" do
+          subject.crypt_keeper :storage, :secret, key1: 1, key2: 2, encryptor: "FakeEncryptor"
+          subject.send(:encryptor_klass).should == CryptKeeperProviders::FakeEncryptor
+
+          subject.instance_variable_set(:@encryptor_klass, nil)
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crypt_keeper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -149,12 +165,19 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- Appraisals
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - crypt_keeper.gemspec
+- gemfiles/activerecord_3_0.gemfile
+- gemfiles/activerecord_3_0.gemfile.lock
+- gemfiles/activerecord_3_1.gemfile
+- gemfiles/activerecord_3_1.gemfile.lock
+- gemfiles/activerecord_3_2.gemfile
+- gemfiles/activerecord_3_2.gemfile.lock
 - lib/crypt_keeper.rb
 - lib/crypt_keeper/model.rb
 - lib/crypt_keeper/version.rb
@@ -162,7 +185,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 - spec/support/encryptors.rb
-homepage: ''
+homepage: http://jmazzi.github.com/crypt_keeper/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -176,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4294679024711639404
+      hash: 868846789855728654
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -185,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4294679024711639404
+      hash: 868846789855728654
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23