encrypted_search_attributes 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGE2MWE3OGJkYjIyOGEyNTgyMDdjNTQ4YWUzYmM3MjhkMzkzNDRkNA==
-  data.tar.gz: !binary |-
-    YWQ3YzYzMzc5ZjQ0Y2I5MmU0ZWE1NjRhMjM1MzY5NWE4MDM4NTEzNg==
+SHA1:
+  metadata.gz: 71c31041e7631bfc6e189c0b2b88fff33ed376f6
+  data.tar.gz: af0c66f1efec431a32218112b929fd57661b2ba7
 SHA512:
-  metadata.gz: !binary |-
-    OTExZDViYzQ0NzI1NzAyOTBiNzJlMzUyMmZhYTg2ZGJjNTA5MDFiYTk4ODZj
-    ZDBhZTMwMzZmNzMwN2FlZTNhYzkwYzE3Y2FiMTdiZjA2Mzg3NGY5MzA3NTYz
-    NDhhYjJkMDAxMzVkMGU5ZTViMTM3MGMyM2E1NGU5NGNmNjYyYTU=
-  data.tar.gz: !binary |-
-    MmJmMTUzOTMzYjI2Y2U2ZTFhNDM2ZGVhZjdjYTE5M2EzNGRhYmUwM2I5MTEw
-    OTAxMGMwNWM3OWUwYWM5MTFjODJiMDkyMTQxM2YwZDEwMTZiNGQyMjk5M2Q3
-    ZWI2NGI0M2ZlZjdlMzYyMjQ3MzY0OTViYzkyNGJmNzc0ZDE2NmE=
+  metadata.gz: 64acc8baadd3c6bf1976ec71455b8db26a3d7d35b69ae56c0e75b63902e9fc636a482b16e442194e352df83c42bafca0a1eded48800be4c5cb93251f39953f28
+  data.tar.gz: d1ba0cde85f8fcf68f9e9d8d19dd55eb631a1d03e5fbf9238b28a380633b71def5d58da66d8ee88830f559767638691d36eeec8b4a9384dfc5bdef123557b6f7

data/README.md

@@ -2,11 +2,13 @@
 
 Auto populates encrypted fields that are designed for searching
 
-Encrypting a field makes it very difficult to perform a case insensitive search for the columns data. This gem normalizes the text before encrypted it and storing it in a search column. The current normalization method is to convert the text to all lowercase.
+Encrypting a field makes it very difficult to perform a case insensitive search for the columns data. This gem normalizes the text before encrypted it and storing it in a search column. The default normalization method is to convert the text to all lowercase, but you can specify your own normalization method.
 
 This gem is intended to be used with the symmetric-encryption gem. It assumes that a `encrypted_search_attribute` column exists for the encrypted attribute.
 
-## Example
+## Examples
+
+### Using the default normalization method
 
 Let's assume we have the following ActiveRecord model defined.
 
@@ -26,6 +28,38 @@ This would require the database schema to look something like this.
   end
 ```
 
+### Specifying a custom normalization method
+
+You can specify custom normalizations in a couple of different ways
+
+#### Procs
+
+You can specify a proc that gets called to perform the normalization. This works well if you only have one field that you need to override the normalization for.
+
+```ruby
+class Widget < ActiveRecord::Base
+  attr_encrypted        :name
+  attr_encrypted_search :name,
+                        normalize: ->(unencrypted_value) { enencrypted_value.to_s.downcase.gsub('.', '') }
+end
+```
+
+#### Symbol referencing a method
+
+```ruby
+class Widget < ActiveRecord::Base
+  attr_encrypted        :name
+  attr_encrypted_search :name,
+                        normalize: :normalize_search_value
+
+  private
+
+  def normalize_search_value(unencypted_value)
+    enencrypted_value.to_s.downcase.gsub('.', '')
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,13 +74,9 @@ Or install it yourself as:
 
     $ gem install encrypted_search_attributes
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
-1. Fork it ( http://github.com/mscottford/encrypted_search_attributes/fork )
+1. Fork it ( http://github.com/corgibytes/encrypted_search_attributes/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/encrypted_search_attributes/extensions/active_record/base.rb

@@ -4,9 +4,10 @@ module ActiveRecord
       def attr_encrypted_search(*params)
         define_attribute_methods rescue nil
 
-        options   = params.last.is_a?(Hash) ? params.pop.dup : {}
-        compress  = options.delete(:compress) || false
-        type      = options.delete(:type) || :string
+        options = params.last.is_a?(Hash) ? params.pop.dup : {}
+        compress = options.delete(:compress) || false
+        type = options.delete(:type) || :string
+        normalize = options.delete(:normalize)
 
         raise "Invalid type: #{type.inspect}. Valid types: #{SymmetricEncryption::COERCION_TYPES.inspect}" unless SymmetricEncryption::COERCION_TYPES.include?(type)
 
@@ -20,14 +21,34 @@ module ActiveRecord
         end
 
         params.each do |attribute|
-          mod.module_eval(<<-ENCRYPTEDSEARCH, __FILE__, __LINE__ + 1)
-            def #{attribute}=(value)
+          mod.module_eval do
+            define_method("#{attribute}=") do |value|
               if value
-                self.encrypted_search_#{attribute} = ::SymmetricEncryption.encrypt(value.downcase,false,#{compress},:#{type})
+                send(
+                  "encrypted_search_#{attribute}=",
+                  ::SymmetricEncryption.encrypt(
+                    send("normalize_#{attribute}", value),
+                    false,
+                    compress,
+                    type
+                  )
+                )
               end
               super(value)
             end
-          ENCRYPTEDSEARCH
+
+            define_method("normalize_#{attribute}") do |value|
+              if normalize
+                if normalize.respond_to?(:call)
+                  normalize.call(value)
+                else
+                  send(normalize, value)
+                end
+              else
+                value.downcase
+              end
+            end
+          end
         end
 
       end

data/lib/encrypted_search_attributes/version.rb

@@ -1,3 +1,3 @@
 module EncryptedSearchAttributes
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/acceptance/attr_encrypted_search_spec.rb

@@ -49,6 +49,15 @@ describe 'attr_encrypted_search' do
     expect(widget.encrypted_search_name).to eq(search_value)
   end
 
+  it 'correctly handles nil values' do
+    widget = Widget.create!(name: nil)
+
+    expect(widget.encrypted_search_name).to eq(nil)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(nil)
+  end
+
   it 'sets encrypted search field on assignment' do
     widget = Widget.create!
 

data/spec/acceptance/custom_method_normalizer_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+db_config_file = File.expand_path('../../config/database.yml', __FILE__)
+encryption_config_file = File.expand_path('../../config/symmetric-encryption.yml', __FILE__)
+
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config_file)).result)
+ActiveRecord::Base.establish_connection('test')
+
+ActiveRecord::Schema.define(version: 0) do
+  create_table :widget_with_custom_methods, force: true do |t|
+    t.string :encrypted_name
+    t.string :encrypted_search_name
+  end
+end
+
+class WidgetWithCustomMethod < ActiveRecord::Base
+  attr_encrypted        :name
+  attr_encrypted_search :name,
+                        normalize: :downcase_no_spaces
+
+  private
+
+  def downcase_no_spaces(value)
+    value.downcase.gsub(' ', '')
+  end
+end
+
+SymmetricEncryption.load!(encryption_config_file, 'test')
+
+# Initialize the database connection
+config = YAML.load(ERB.new(File.new(db_config_file).read).result)['test']
+
+WidgetWithCustomMethod.establish_connection(config)
+
+describe 'custom method attr_encrypted_search' do
+  it 'sets encrypted search field on initialization' do
+    widget = WidgetWithCustomMethod.new(name: 'Test Value')
+
+    search_value = ::SymmetricEncryption.encrypt('testvalue')
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.save!
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(search_value)
+  end
+
+  it 'sets the encrypted search field on creation' do
+    widget = WidgetWithCustomMethod.create!(name: 'Another Test')
+
+    search_value = ::SymmetricEncryption.encrypt('anothertest')
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(search_value)
+  end
+
+  it 'correctly handles nil values' do
+    widget = WidgetWithCustomMethod.create!(name: nil)
+
+    expect(widget.encrypted_search_name).to eq(nil)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(nil)
+  end
+
+  it 'sets encrypted search field on assignment' do
+    widget = WidgetWithCustomMethod.create!
+
+    widget.name = 'Something Else'
+
+    search_value = ::SymmetricEncryption.encrypt('somethingelse')
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.save!
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(search_value)
+  end
+
+  it 'preserves attr_encrypted functionality' do
+    widget = WidgetWithCustomMethod.create!(name: 'Anything')
+    expect(widget.name).to eq('Anything')
+    expect(widget.encrypted_name).to eq(::SymmetricEncryption.encrypt('Anything'))
+
+    widget.reload
+    expect(widget.encrypted_name).to eq(::SymmetricEncryption.encrypt('Anything'))
+  end
+end

data/spec/acceptance/custom_proc_normalizer_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+db_config_file = File.expand_path('../../config/database.yml', __FILE__)
+encryption_config_file = File.expand_path('../../config/symmetric-encryption.yml', __FILE__)
+
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config_file)).result)
+ActiveRecord::Base.establish_connection('test')
+
+ActiveRecord::Schema.define(version: 0) do
+  create_table :widget_with_custom_procs, force: true do |t|
+    t.string :encrypted_name
+    t.string :encrypted_search_name
+  end
+end
+
+class WidgetWithCustomProc < ActiveRecord::Base
+  attr_encrypted        :name
+  attr_encrypted_search :name,
+                        normalize: ->(value) { value.downcase.gsub(' ', '') }
+end
+
+SymmetricEncryption.load!(encryption_config_file, 'test')
+
+# Initialize the database connection
+config = YAML.load(ERB.new(File.new(db_config_file).read).result)['test']
+
+WidgetWithCustomProc.establish_connection(config)
+
+describe 'custom proc attr_encrypted_search' do
+  it 'sets encrypted search field on initialization' do
+    widget = WidgetWithCustomProc.new(name: 'Test Value')
+
+    search_value = ::SymmetricEncryption.encrypt('testvalue')
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.save!
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(search_value)
+  end
+
+  it 'sets the encrypted search field on creation' do
+    widget = WidgetWithCustomProc.create!(name: 'Another Test')
+
+    search_value = ::SymmetricEncryption.encrypt('anothertest')
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(search_value)
+  end
+
+  it 'correctly handles nil values' do
+    widget = WidgetWithCustomProc.create!(name: nil)
+
+    expect(widget.encrypted_search_name).to eq(nil)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(nil)
+  end
+
+  it 'sets encrypted search field on assignment' do
+    widget = WidgetWithCustomProc.create!
+
+    widget.name = 'Something Else'
+
+    search_value = ::SymmetricEncryption.encrypt('somethingelse')
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.save!
+    expect(widget.encrypted_search_name).to eq(search_value)
+
+    widget.reload
+    expect(widget.encrypted_search_name).to eq(search_value)
+  end
+
+  it 'preserves attr_encrypted functionality' do
+    widget = WidgetWithCustomProc.create!(name: 'Anything')
+    expect(widget.name).to eq('Anything')
+    expect(widget.encrypted_name).to eq(::SymmetricEncryption.encrypt('Anything'))
+
+    widget.reload
+    expect(widget.encrypted_name).to eq(::SymmetricEncryption.encrypt('Anything'))
+  end
+end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: encrypted_search_attributes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - M. Scott Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: symmetric-encryption
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.13
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.8
 description: Encrypting a field makes it very difficult to perform a case insensitive
@@ -104,7 +104,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,6 +114,8 @@ files:
 - lib/encrypted_search_attributes/extensions/active_record/base.rb
 - lib/encrypted_search_attributes/version.rb
 - spec/acceptance/attr_encrypted_search_spec.rb
+- spec/acceptance/custom_method_normalizer_spec.rb
+- spec/acceptance/custom_proc_normalizer_spec.rb
 - spec/config/database.yml
 - spec/config/symmetric-encryption.yml
 - spec/config/test_new.iv
@@ -131,22 +133,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Auto populates encrypted fields that are designed for searching
 test_files:
 - spec/acceptance/attr_encrypted_search_spec.rb
+- spec/acceptance/custom_method_normalizer_spec.rb
+- spec/acceptance/custom_proc_normalizer_spec.rb
 - spec/config/database.yml
 - spec/config/symmetric-encryption.yml
 - spec/config/test_new.iv