shuber-attr_encrypted 1.0.5 → 1.0.6

data/CHANGELOG

@@ -1,3 +1,7 @@
+2009-01-13 - Sean Huber (shuber@huberry.com)
+  * :marshal no longer defaults to true in ORM adapters
+  * Load gem dependencies
+
 2009-01-12 - Sean Huber (shuber@huberry.com)
   * Remove read_attribute and write_attribute methods - unnecessary
   * ActiveRecord and DataMapper extensions are now "adapters"
@@ -6,6 +10,7 @@
   * Add Sequel adapter
   * Update DataMapper tests
   * Update README
+  * Set attr_encrypted_options instead of overwriting the attr_encrypted method in adapters
 
 2009-01-11 - Sean Huber (shuber@huberry.com)
   * Update README

data/README.markdown

@@ -3,7 +3,7 @@ attr\_encrypted
 
 Generates attr\_accessors that encrypt and decrypt attributes transparently
 
-Works with ANY class including ActiveRecord, DataMapper, and Sequel
+It works with ANY class, however, you get a few extra features when you're using it with ActiveRecord, DataMapper, or Sequel
 
 
 Installation
@@ -267,7 +267,7 @@ If you're using this gem with ActiveRecord, you get a few extra features:
 
 #### Default options ####
 
-For your convenience, the `:encode` and `:marshal` options are set to true by default since you'll be storing everything in a database.
+For your convenience, the `:encode` option is set to true by default since you'll be storing everything in a database.
 
 
 #### Dynamic find\_by\_ and scoped\_by\_ methods ####
@@ -291,7 +291,7 @@ NOTE: This only works if all records are encrypted with the same encryption key
 
 ### DataMapper and Sequel ###
 
-Just like the default options for ActiveRecord, the `:encode` and `:marshal` options are set to true by default since you'll be storing everything in a database.
+Just like the default options for ActiveRecord, the `:encode` option is set to true by default since you'll be storing everything in a database.
 
 
 Contact

data/lib/attr_encrypted.rb

@@ -1,3 +1,9 @@
+gem 'shuber-eigenclass', '>= 1.0.1'
+require 'eigenclass'
+
+gem 'shuber-encryptor'
+require 'encryptor'
+
 require 'huberry/attr_encrypted/class'
 Class.send :include, Huberry::AttrEncrypted::Class
 

data/lib/huberry/attr_encrypted/adapters/active_record.rb

@@ -4,21 +4,19 @@ if defined?(ActiveRecord)
       module Adapters
         module ActiveRecord
           def self.extended(base)
+            base.attr_encrypted_options[:encode] = true
             base.eigenclass_eval { alias_method_chain :method_missing, :attr_encrypted }
           end
-        
+          
           protected
-        
-            # Calls attr_encrypted with the options <tt>:encode</tt> and <tt>:marshal</tt> set to true
-            # unless they've already been specified
-            #
-            # Also defines the attribute methods for db fields if they don't exist yet
+          
+            # Ensures the attribute methods for db fields have been defined before calling the original 
+            # <tt>attr_encrypted</tt> method
             def attr_encrypted(*attrs)
               define_attribute_methods
-              options = { :encode => true, :marshal => true }.merge(attrs.last.is_a?(Hash) ? attrs.pop : {})
-              super *(attrs << options)
+              super
             end
-          
+            
             # Allows you to use dynamic methods like <tt>find_by_email</tt> or <tt>scoped_by_email</tt> for 
             # encrypted attributes
             #

data/lib/huberry/attr_encrypted/adapters/data_mapper.rb

@@ -3,23 +3,21 @@ if defined?(DataMapper)
     module AttrEncrypted
       module Adapters
         module DataMapper
-          def self.included(base)
-            base.extend ClassMethods
+          def self.extended(base)
+            base.eigenclass_eval do 
+              alias_method :included_without_attr_encrypted, :included
+              alias_method :included, :included_with_attr_encrypted
+            end
           end
-        
-          module ClassMethods
-            protected
-              # Calls attr_encrypted with the options <tt>:encode</tt> and <tt>:marshal</tt> set to true
-              # unless they've already been specified
-              def attr_encrypted(*attrs)
-                options = { :encode => true, :marshal => true }.merge(attrs.last.is_a?(Hash) ? attrs.pop : {})
-                super *(attrs << options)
-              end
+          
+          def included_with_attr_encrypted(base)
+            included_without_attr_encrypted(base)
+            base.attr_encrypted_options[:encode] = true
           end
         end
       end
     end
   end
   
-  DataMapper::Resource.send :include, Huberry::AttrEncrypted::Adapters::DataMapper
+  DataMapper::Resource.extend Huberry::AttrEncrypted::Adapters::DataMapper
 end

data/lib/huberry/attr_encrypted/adapters/sequel.rb

@@ -3,13 +3,9 @@ if defined?(Sequel)
     module AttrEncrypted
       module Adapters
         module Sequel
-          protected
-            # Calls attr_encrypted with the options <tt>:encode</tt> and <tt>:marshal</tt> set to true
-            # unless they've already been specified
-            def attr_encrypted(*attrs)
-              options = { :encode => true, :marshal => true }.merge(attrs.last.is_a?(Hash) ? attrs.pop : {})
-              super *(attrs << options)
-            end
+          def self.extended(base)
+            base.attr_encrypted_options[:encode] = true
+          end
         end
       end
     end

data/test/active_record_test.rb

@@ -20,7 +20,7 @@ create_people_table
 
 class Person < ActiveRecord::Base
   attr_encrypted :email, :key => 'a secret key'
-  attr_encrypted :credentials, :key => Proc.new { |user| Huberry::Encryptor.encrypt(:value => user.salt, :key => 'some private key') }
+  attr_encrypted :credentials, :key => Proc.new { |user| Huberry::Encryptor.encrypt(:value => user.salt, :key => 'some private key') }, :marshal => true
   
   def after_initialize
     self.salt ||= Digest::SHA256.hexdigest((Time.now.to_i * rand(5)).to_s)
@@ -71,4 +71,8 @@ class ActiveRecordTest < Test::Unit::TestCase
     assert_equal @person, Person.scoped_by_email_and_password('test@example.com', 'test').find(:first) rescue NoMethodError
   end
   
+  def test_should_encode_by_default
+    assert Person.attr_encrypted_options[:encode]
+  end
+  
 end

data/test/data_mapper_test.rb

@@ -11,7 +11,7 @@ class Client
   property :salt, String
   
   attr_encrypted :email, :key => 'a secret key'
-  attr_encrypted :credentials, :key => Proc.new { |client| Huberry::Encryptor.encrypt(:value => client.salt, :key => 'some private key') }
+  attr_encrypted :credentials, :key => Proc.new { |client| Huberry::Encryptor.encrypt(:value => client.salt, :key => 'some private key') }, :marshal => true
   
   def initialize(attrs = {})
     super attrs
@@ -45,4 +45,8 @@ class DataMapperTest < Test::Unit::TestCase
     assert Client.first.credentials.is_a?(Hash)
   end
   
+  def test_should_encode_by_default
+    assert Client.attr_encrypted_options[:encode]
+  end
+  
 end

data/test/sequel_test.rb

@@ -12,7 +12,7 @@ end
 
 class Human < Sequel::Model(:humans)  
   attr_encrypted :email, :key => 'a secret key'
-  attr_encrypted :credentials, :key => Proc.new { |human| Huberry::Encryptor.encrypt(:value => human.salt, :key => 'some private key') }
+  attr_encrypted :credentials, :key => Proc.new { |human| Huberry::Encryptor.encrypt(:value => human.salt, :key => 'some private key') }, :marshal => true
   
   def after_initialize(attrs = {})
     self.salt ||= Digest::SHA1.hexdigest((Time.now.to_i * rand(5)).to_s)
@@ -43,4 +43,8 @@ class SequelTest < Test::Unit::TestCase
     assert Human.first.credentials.is_a?(Hash)
   end
   
+  def test_should_encode_by_default
+    assert Human.attr_encrypted_options[:encode]
+  end
+  
 end

data/test/test_helper.rb

@@ -2,8 +2,7 @@ require 'test/unit'
 require 'digest/sha2'
 
 require 'rubygems'
-gem 'shuber-eigenclass', '>= 1.0.1'
-gem 'shuber-encryptor'
+
 gem 'activerecord'
 gem 'datamapper'
 gem 'sequel'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-attr_encrypted
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-12 00:00:00 -08:00
+date: 2009-01-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency