yattr_encrypted 0.1.3 → 0.1.4

data/README.mdown

@@ -1,6 +1,6 @@
 # YattrEncrypted #
 
-Version: 0.1.3  (but you should check lib/yattr_encrypted/version.rb to be sure)
+Version: 0.1.4  (but you should check lib/yattr_encrypted/version.rb to be sure)
 
 ## Applicability ##
 
@@ -88,6 +88,23 @@ matching encrypted values without retrieving the encrypted data.
 
 ### Options ###
 
+**yattr_encrypted** accepts five options:
+
+* :prefix - the prefix which is prepended to *attribute* to form the encrypted attribute
+name. Defaults to ''
+* :suffix - the suffix which appended to *attribute* to form the encrypted attribute
+name. Defaults to '_encrypted'
+* :key - allows attribute specific encryption keys. The default - if not specified - is
+`Rails.application.config.secret_token`
+* :read_filter - a LAMBDA (or Proc) which is called to modify the clear-text value of
+the *attribute* prior to returning it.
+* :write_filter - a LAMBDA (or Proc) which is called on the assigned value prior to
+assigning it to the *attribute*
+
+These options are discussed in some detail below in the applicable section.
+
+### Encrypted Attribute Name ###
+
 The encrypted field name defaults to `<field>_encrypted`. You can change this on
 a field by field basis using the `:prefix` and `:suffix`  - which define strings
 which are prefixed and suffixed to the field name to create the encrypted field name.
@@ -99,7 +116,7 @@ They default to:
 Notice that the underscore ('_') must be included in `:prefix` and `:suffix`, if you
 want them.
 
-### Encryption keys
+### Encryption keys ###
 
 The default encryption key is the value of `<application>::Application.config.secret_token`
 which is in `config/initializers/secret_token.rb`.
@@ -114,7 +131,18 @@ and 'this is a very long secret key' is not.
 
 If you supply your own key, it can be a String or a Proc which returns a String.
 
-### Initial Values ###
+### Special Attribute Processing ###
+
+Special processing for attribute values can be implemented by using the `:read_filter` and
+`:write_filter` options of the `yattr_encrypted` macro.
+
+A `:read_filter` is a proc (or lambda) which accepts a single argument. It is called on the
+value of the *attribute* immediately before being returned by the clear text attribute accessor.
+
+A `:write_filter` is a proc (or lambda) which accepts a single argument. It is called
+on the value passed to the *attribute* writer prior to any other action in the writer.
+
+### Encription Initial Values ###
 
 As stated everywhere - random initial values are automatically generated for all fields.
 They are prepended to the actual encrypted data and stripped during decryption. You can't

data/lib/yattr_encrypted.rb

@@ -76,6 +76,7 @@ module YattrEncrypted
 
         # iterate through attributes and create accessors, verify encryped accessors exist
         attributes.map { |x| x.to_sym }.each do |attribute|
+puts "yate_encrypted: #{attribute}"
           encrypted_attribute_name = [options[:prefix], attribute, options[:suffix]].join.to_sym
 
           # barf if reader and write doesn't exist for encrypted attribute
@@ -86,23 +87,24 @@ module YattrEncrypted
 
           tmp =<<-XXX
           def #{attribute}
+            options = yate_encrypted_attributes[:#{attribute}]
             unless @#{attribute} && !@#{attribute}.empty?
-              options = yate_encrypted_attributes[:#{attribute}]
               @#{attribute} = #{encrypted_attribute_name} ? \
                   yate_decrypt(#{encrypted_attribute_name}, options[:key]) : \
                   ''
               self.yate_checksums[:#{attribute}] = yate_attribute_hash_value(:#{attribute})
               self.yate_dirty[:#{attribute}] = true
             end
-            @#{attribute}
+            options[:read_filter] ? options[:read_filter].call(@#{attribute}) : @#{attribute}
           end
           XXX
           class_eval(tmp)
 
           tmp =<<-XXX
           def #{attribute}= value
-            @#{attribute} = value
             options = yate_encrypted_attributes[:#{attribute}]
+            value = options[:write_filter].call(value) if options[:write_filter]
+            @#{attribute} = value
             self.#{encrypted_attribute_name} = yate_encrypt(value, options[:key])
             self.yate_checksums[:#{attribute}] = yate_attribute_hash_value(:#{attribute})
             self.yate_dirty[:#{attribute}] = true

data/lib/yattr_encrypted/version.rb

@@ -1,3 +1,3 @@
 module YattrEncrypted
-  VERSION = '0.1.3'
-end
+  VERSION = '0.1.4'
+end

data/test/yattr_encrypted_test.rb

@@ -35,8 +35,12 @@ module ActiveRecord
 end
 
 class SomeClass < ActiveRecord::Base
-  attr_accessor :field_encrypted
+  attr_accessor :field_encrypted, :special_reader_encrypted, :special_writer_encrypted
   yattr_encrypted :field, :key => 'a honkin big key: honk honk honk honk honk'
+  yattr_encrypted :special_reader, :key => 'a honkin big key: honk honk honk honk honk',
+    :read_filter => lambda { |val| val.strip }
+  yattr_encrypted :special_writer, :key => 'a honkin big key: honk honk honk honk honk',
+    :write_filter => lambda { |val| puts val; val.upcase }
 end
 
 class TestYattrEncrypted < MiniTest::Unit::TestCase
@@ -73,4 +77,21 @@ class TestYattrEncrypted < MiniTest::Unit::TestCase
     decrypted = @sc.send(:yate_decrypt, @sc.field_encrypted, options[:key])
     assert_equal( { key: 'value' }, decrypted, "decrypt @sc.field_encrypted should be correct")
   end
+  
+  def test_special_reader
+    value = 'a string with leading and trailing white space'
+    value_with_whitespace = '    ' + value + '   '
+    @sc.special_reader = value_with_whitespace
+    assert_equal value_with_whitespace, @sc.instance_variable_get(:@special_reader),
+        "@special_reader should include the leading and trailing whitespace"
+    assert_equal value, @sc.special_reader, "@sc.special_reader should have leading and trailing ws stripped"
+  end
+  
+  def test_special_writer
+    value = 'a string with leading and trailing white space'
+    @sc.special_writer = value
+    assert_equal value.upcase, @sc.instance_variable_get(:@special_writer),
+      "@special_writer should be upcased"
+    assert_equal value.upcase, @sc.special_writer, "@sc.special_writer should be upcased"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yattr_encrypted
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2151767260 !ruby/object:Gem::Requirement
+  requirement: &2151769420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151767260
+  version_requirements: *2151769420
 description: Generates yattr_accessors that encrypt and decrypt attributes transparently.
   Based on attr_encrypted by Sean Huber [https://github.com/shuber]
 email: mike@clove.com
@@ -56,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3636252519896888946
+      hash: 2285454077099666257
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: