mongoid-encryptor 0.0.1 → 0.0.4

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+0.0.3
+-----
+
+* fixed unexpected encryption after validation.
+
+0.0.2
+-----
+
+* fixed validation error on encrypted field in embedded document.
+
 0.0.1
 -----
 

data/README.md

@@ -9,7 +9,7 @@ Install
 
 Put this line in your Gemfile:
 
-    gem 'mongoid-encryptor'
+    gem 'mongoid-encryptor', :require => 'mongoid/encryptor'
 
 Then bundle:
 
@@ -19,10 +19,6 @@ Then bundle:
 Quick Start
 -----------
 
-Add mongoid-encryptor to your Gemfile.
-
-    gem 'mongoid-encryptor', :require => 'mongoid/encryptor'
-
 Set up SHA encrypted field in models like this:
 
     class Credential

data/lib/mongoid/encryptor/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid #:nodoc:
   module Encryptor
-    VERSION = '0.0.1'
+    VERSION = '0.0.4'
   end
 end

data/lib/mongoid/encryptor.rb

@@ -19,7 +19,7 @@ module Mongoid #:nodoc:
           mode = options.delete(:mode) || :sha
           cipher_class = EncryptedStrings.const_get("#{mode.to_s.classify}Cipher")
 
-          send(:before_validation) do |doc|
+          send(:after_validation) do |doc|
             doc.send(:write_encrypted_attribute, attr_name, cipher_class, options)
             true
           end
@@ -32,6 +32,15 @@ module Mongoid #:nodoc:
     end
 
     module InstanceMethods #:nodoc:
+      # Returns decrypted value for key.
+      #
+      # @param [String] key
+      # @return [Object]
+      def read_attribute_for_validation(key)
+        v = read_attribute(key)
+        v.try(:encrypted?) ? v.decrypt : v
+      end
+
       private
 
       # @param [String] attr_name
@@ -50,6 +59,7 @@ module Mongoid #:nodoc:
       # @param [String] attr_name
       # @param [Class] cipher_class
       # @param [Hash] options
+      # @return [String]
       def read_encrypted_attribute(attr_name, cipher_class, options)
         value = read_attribute(attr_name)
 

data/spec/embedded_document_spec.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe "Symmetric encryption on embedded document" do
+  let(:person) do
+    Person.new(:first_name => 'John',
+               :last_name => 'Smith',
+               :credit_card => CreditCard.new(:number => '0000111122224444'))
+  end
+
+  context "Has valid attributes" do
+    context "Before save" do
+      subject { person.credit_card }
+      its(:number) { should_not be_encrypted }
+      its(:number) { should eq('0000111122224444') }
+      its(:number) { should_not eq("0pOZeQMtxuPsAPaoR3fkjMEUIoAuSbFO\n") }
+      it { should be_valid }
+    end
+
+    context "after save" do
+      before { person.save!; puts person.credit_card.number }
+      subject { person.credit_card }
+      its(:number) { should be_encrypted }
+      its(:number) { should eq("0pOZeQMtxuPsAPaoR3fkjMEUIoAuSbFO\n") }
+      its(:number) { should eq('0000111122224444') }
+    end
+  end
+
+  it "doesn't encrypt value of field after validation" do
+    person.credit_card.valid?
+    person.should be_valid
+  end
+
+end

data/spec/encrypted_attributes_spec.rb

@@ -3,9 +3,23 @@ require 'spec_helper'
 
 describe 'Encrypted attributes' do
   context "Not encryption" do
-    let(:credential) { Credential.create(:email => 'john.smith@example.com') }
+    let(:credential) { Credential.new(:email => 'john.smith@example.com') }
     before { credential.password = 'this is not a secret' }
     subject { credential.password }
     it { should eq('this is not a secret') }
   end
+
+  context "Has valid attributes" do
+    let(:credential) { Credential.new(:email => 'john.smith@example.com') }
+    before { credential.password = 'this is not a secret' }
+    subject { credential }
+    it { should be_valid }
+  end
+
+  context "Has invalid attributes" do
+    let(:credential) { Credential.new(:email => 'invalid-address') }
+    before { credential.password = '' }
+    subject { credential }
+    it { should_not be_valid }
+  end
 end

data/spec/models/credential.rb

@@ -6,4 +6,5 @@ class Credential
   field :password
 
   validates_presence_of :email, :password
+  validates_format_of :email, :with => /^\A[^@]+@[^@]+\z/
 end

data/spec/models/credit_card.rb

@@ -0,0 +1,10 @@
+class CreditCard
+  include Mongoid::Document
+  include Mongoid::Encryptor
+
+  field :number
+
+  validates_format_of :number, :with => /^\A\d{16}\z/
+
+  encrypts :number, :mode => :symmetric, :password => 'secret'
+end

data/spec/models/person.rb

@@ -0,0 +1,10 @@
+class Person
+  include Mongoid::Document
+
+  field :first_name
+  field :last_name
+
+  embeds_one :credit_card
+
+  validates_presence_of :first_name, :last_name
+end

metadata

@@ -2,7 +2,7 @@
 name: mongoid-encryptor
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors: 
 - Junya Ogura
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 +09:00
+date: 2011-02-25 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.3.3
+        version: "0.3"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        version: "1.2"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.6.0
+        version: "0.6"
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -65,20 +65,9 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: "2.4"
   type: :development
   version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug19
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.11.0
-  type: :development
-  version_requirements: *id006
 description: mongoid-encryptor encrypts and decrypts one or more fields in a Mongoid model.
 email: 
 - junyaogura@gmail.com
@@ -95,11 +84,14 @@ files:
 - LICENSE
 - README.md
 - spec/asymmetric_encryption_spec.rb
+- spec/embedded_document_spec.rb
 - spec/encrypted_attributes_spec.rb
 - spec/keys/private
 - spec/keys/public
 - spec/models/asymmetric_credential.rb
 - spec/models/credential.rb
+- spec/models/credit_card.rb
+- spec/models/person.rb
 - spec/models/sha_credential.rb
 - spec/models/sha_with_salt_credential.rb
 - spec/models/symmetric_credential.rb
@@ -137,11 +129,14 @@ specification_version: 3
 summary: Encrypt a Mongoid model fields
 test_files: 
 - spec/asymmetric_encryption_spec.rb
+- spec/embedded_document_spec.rb
 - spec/encrypted_attributes_spec.rb
 - spec/keys/private
 - spec/keys/public
 - spec/models/asymmetric_credential.rb
 - spec/models/credential.rb
+- spec/models/credit_card.rb
+- spec/models/person.rb
 - spec/models/sha_credential.rb
 - spec/models/sha_with_salt_credential.rb
 - spec/models/symmetric_credential.rb