encrypted_attributes 0.0.1 → 0.0.2

data/CHANGELOG

@@ -0,0 +1,15 @@
+*SVN*
+
+*0.0.2* (September 26th, 2007)
+
+* Move test fixtures out of the test application root directory
+
+* Convert dos newlines to unix newlines
+
+*0.0.1* (August 5th, 2007)
+
+* Official public release
+
+* Add documentation
+
+* Refactor unit test names

data/README

@@ -1,6 +1,6 @@
 = encrypted_attributes
 
-encrypted_attributes adds support for automatically encrypting ActiveRecord
++encrypted_attributes+ adds support for automatically encrypting ActiveRecord
 attributes.
 
 == Resources
@@ -15,7 +15,7 @@ Wiki
 
 Announcement
 
-* http://www.pluginaweek.org/
+* http://www.pluginaweek.org
 
 Source
 
@@ -32,10 +32,12 @@ various models and various projects.  encrypted_attributes, in association
 with the encrypted_strings plugin, helps make encrypting ActiveRecord
 attributes easier by automating the process.
 
-The options that #encrypts takes includes all of the encryption options for
+The options that +encrypts+ takes includes all of the encryption options for
 the specific type of encryptor being used in the encrypted_strings plugin.
 Therefore, if setting the key for asymmetric encryption, this would be passed
-into the #encrypts method.  Examples of this are shown below.
+into the +encrypts+ method.  Examples of this are show in the Usage section.
+
+== Usage
 
 === SHA Encryption
 
@@ -87,9 +89,9 @@ With custom key files:
 The attribute which stores the unencrypted value is a "virtual" attribute.
 This means that there is no column with the same name in the database.
 Instead, the encrypted value is stored in the crypted attributed.  By default,
-this is assumed to be "crypted_#{attr_name}".  Therefore, if you are encrypting
+this is assumed to be +crypted_#{attr_name}+.  Therefore, if you are encrypting
 the "password" attribute, the encrypted value would be stored in
-"crypted_password".
++crypted_password+.
 
 The crypted attribute name can be customized like so:
 
@@ -105,12 +107,10 @@ the various options that can be passed in.
 
 == Testing
 
-This plugin requires that the plugin_test_helper gem be installed in order to
-run the unit tests.  To install this gem:
-
-  gem install plugin_test_helper
+Before you can run any tests, the following gem must be installed:
+* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
 
 == Dependencies
 
 This plugin depends on the presence of the following plugins:
-# encrypted_strings - http://wiki.pluginaweek.org/Encrypted_strings
+* encrypted_strings[http://wiki.pluginaweek.org/Encrypted_strings]

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'encrypted_attributes'
-PKG_VERSION        = '0.0.1'
+PKG_VERSION        = '0.0.2'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 
@@ -31,14 +31,14 @@ spec = Gem::Specification.new do |s|
   s.name            = PKG_NAME
   s.version         = PKG_VERSION
   s.platform        = Gem::Platform::RUBY
-  s.summary         = ''
+  s.summary         = 'Adds support for automatically encrypting ActiveRecord attributes'
   
-  s.files           = FileList['{lib,tasks,test}/**/*'].to_a + %w(init.rb MIT-LICENSE Rakefile README)
+  s.files           = FileList['{lib,tasks,test}/**/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
   s.require_path    = 'lib'
   s.autorequire     = 'encrypted_attributes'
   s.has_rdoc        = true
-  s.add_dependency  'encrypted_strings', '>= 0.0.1'
   s.test_files      = Dir['test/**/*_test.rb']
+  s.add_dependency  'encrypted_strings', '>= 0.0.1'
   
   s.author          = 'Aaron Pfeifer, Neil Abraham'
   s.email           = 'info@pluginaweek.org'
@@ -77,4 +77,4 @@ task :release => [:gem, :package] do
     
     ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
   end
-end
+end

data/lib/encrypted_attributes/extensions/encryptor.rb

@@ -1,5 +1,5 @@
 module PluginAWeek #:nodoc:
-  module EncryptedAttributes #:nodoc:
+  module EncryptedAttributes
     module Extensions #:nodoc:
       module Encryptor #:nodoc:
         def process_options(model, operation, options)
@@ -11,4 +11,4 @@ end
 
 PluginAWeek::EncryptedStrings::Encryptor.class_eval do
   extend PluginAWeek::EncryptedAttributes::Extensions::Encryptor
-end
+end

data/lib/encrypted_attributes/extensions/sha_encryptor.rb

@@ -1,28 +1,28 @@
-module PluginAWeek #:nodoc:
-  module EncryptedAttributes #:nodoc:
-    module Extensions #:nodoc:
-      module ShaEncryptor
-        # Adds support for using a salt that is generated based on the model and
-        # stored in an attribute.
-        def process_options(model, operation, options)
-          if (salt_attr_name = options[:salt]) && (salt_attr_name == true || salt_attr_name.is_a?(Symbol))
-            salt_attr_name = 'salt' if salt_attr_name == true
-            
-            if operation == :write
-              salt_value = model.send("create_#{salt_attr_name}").to_s
-              model.send("#{salt_attr_name}=", salt_value)
-            else
-              salt_value = model.send(salt_attr_name)
-            end
-            
-            options[:salt] = salt_value
-          end
-        end
-      end
-    end
-  end
-end
-
-PluginAWeek::EncryptedStrings::ShaEncryptor.class_eval do
-  extend PluginAWeek::EncryptedAttributes::Extensions::ShaEncryptor
-end
+module PluginAWeek #:nodoc:
+  module EncryptedAttributes
+    module Extensions #:nodoc:
+      module ShaEncryptor
+        # Adds support for using a salt that is generated based on the model and
+        # stored in an attribute.
+        def process_options(model, operation, options)
+          if (salt_attr_name = options[:salt]) && (salt_attr_name == true || salt_attr_name.is_a?(Symbol))
+            salt_attr_name = 'salt' if salt_attr_name == true
+            
+            if operation == :write
+              salt_value = model.send("create_#{salt_attr_name}").to_s
+              model.send("#{salt_attr_name}=", salt_value)
+            else
+              salt_value = model.send(salt_attr_name)
+            end
+            
+            options[:salt] = salt_value
+          end
+        end
+      end
+    end
+  end
+end
+
+PluginAWeek::EncryptedStrings::ShaEncryptor.class_eval do
+  extend PluginAWeek::EncryptedAttributes::Extensions::ShaEncryptor
+end

data/lib/encrypted_attributes.rb

@@ -1,73 +1,73 @@
-require 'encrypted_strings'
-require 'encrypted_attributes/extensions/encryptor'
-require 'encrypted_attributes/extensions/sha_encryptor'
-
-module PluginAWeek #:nodoc:
-  module EncryptedAttributes
-    def self.included(base) #:nodoc:
-      base.extend(MacroMethods)
-    end
-    
-    module MacroMethods
-      # Encrypts the specified attribute.
-      # 
-      # Configuration options:
-      # * <tt>mode</tt> - The mode of encryption to use.  Default is sha.
-      # * <tt>crypted_name</tt> - The name of the attribute to store the crypted value in.  Default is "crypted_#{attr_name}".
-      # 
-      # For additional configuration options, see the individual encryptor class.
-      def encrypts(attr_name, options = {})
-        mode = options.delete(:mode) || :sha
-        encryptor_class = "PluginAWeek::EncryptedStrings::#{mode.to_s.classify}Encryptor".constantize
-        
-        options.reverse_merge!(
-          :crypted_name => "crypted_#{attr_name}"
-        )
-        crypted_attr_name = options.delete(:crypted_name)
-        raise ArgumentError, 'Attribute name cannot be same as crypted name' if attr_name == crypted_attr_name
-        
-        # Creator accessor for the virtual attribute
-        attr_accessor attr_name
-        
-        # Define the reader when reading the crypted value from the db
-        crypted_var_name = "@#{crypted_attr_name}"
-        define_method(crypted_attr_name) do
-          if (value = read_attribute(crypted_attr_name)) && !value.encrypted?
-            encryptor_options = options.dup
-            encryptor_class.process_options(self, :read, encryptor_options)
-            value.encryptor = encryptor_class.new(encryptor_options)
-          end
-          
-          value
-        end
-        
-        # Set the value immediately before validation takes place
-        before_validation do |model|
-          value = model.send(attr_name)
-          
-          if !value.blank?
-            unless value.encrypted?
-              encryptor_options = options.dup
-              encryptor_class.process_options(model, :write, encryptor_options)
-              value = value.encrypt(mode, encryptor_options)
-            end
-            
-            model.send("#{crypted_attr_name}=", value)
-          end
-        end
-        
-        # After saving, be sure to reset the virtual attribute value.  This also
-        # supported resetting the confirmation field if, for example, the plugin
-        # is being used for passwords
-        after_save do |model|
-          model.send("#{attr_name}=", nil)
-          model.send("#{attr_name}_confirmation=", nil) if model.respond_to?("#{attr_name}_confirmation=")
-        end
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.class_eval do
-  include PluginAWeek::EncryptedAttributes
-end
+require 'encrypted_strings'
+require 'encrypted_attributes/extensions/encryptor'
+require 'encrypted_attributes/extensions/sha_encryptor'
+
+module PluginAWeek #:nodoc:
+  module EncryptedAttributes
+    def self.included(base) #:nodoc:
+      base.extend(MacroMethods)
+    end
+    
+    module MacroMethods
+      # Encrypts the specified attribute.
+      # 
+      # Configuration options:
+      # * +mode+ - The mode of encryption to use.  Default is sha.
+      # * +crypted_name+ - The name of the attribute to store the crypted value in.  Default is "crypted_#{attr_name}".
+      # 
+      # For additional configuration options, see the individual encryptor class.
+      def encrypts(attr_name, options = {})
+        mode = options.delete(:mode) || :sha
+        encryptor_class = "PluginAWeek::EncryptedStrings::#{mode.to_s.classify}Encryptor".constantize
+        
+        options.reverse_merge!(
+          :crypted_name => "crypted_#{attr_name}"
+        )
+        crypted_attr_name = options.delete(:crypted_name)
+        raise ArgumentError, 'Attribute name cannot be same as crypted name' if attr_name == crypted_attr_name
+        
+        # Creator accessor for the virtual attribute
+        attr_accessor attr_name
+        
+        # Define the reader when reading the crypted value from the db
+        crypted_var_name = "@#{crypted_attr_name}"
+        define_method(crypted_attr_name) do
+          if (value = read_attribute(crypted_attr_name)) && !value.encrypted?
+            encryptor_options = options.dup
+            encryptor_class.process_options(self, :read, encryptor_options)
+            value.encryptor = encryptor_class.new(encryptor_options)
+          end
+          
+          value
+        end
+        
+        # Set the value immediately before validation takes place
+        before_validation do |model|
+          value = model.send(attr_name)
+          
+          if !value.blank?
+            unless value.encrypted?
+              encryptor_options = options.dup
+              encryptor_class.process_options(model, :write, encryptor_options)
+              value = value.encrypt(mode, encryptor_options)
+            end
+            
+            model.send("#{crypted_attr_name}=", value)
+          end
+        end
+        
+        # After saving, be sure to reset the virtual attribute value.  This also
+        # supported resetting the confirmation field if, for example, the plugin
+        # is being used for passwords
+        after_save do |model|
+          model.send("#{attr_name}=", nil)
+          model.send("#{attr_name}_confirmation=", nil) if model.respond_to?("#{attr_name}_confirmation=")
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include PluginAWeek::EncryptedAttributes
+end

data/test/unit/encrypted_attributes_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+require File.dirname(__FILE__) + '/../test_helper'
 
 class EncryptedAttributesTest < Test::Unit::TestCase
   def setup

data/test/unit/encryptor_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+require File.dirname(__FILE__) + '/../test_helper'
 
 class EncryptorTest < Test::Unit::TestCase
   def test_should_not_make_any_changes_on_process_options

data/test/unit/sha_encryptor_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+require File.dirname(__FILE__) + '/../test_helper'
 
 class ShaEncryptorTest < Test::Unit::TestCase
   def test_should_respond_to_process_options

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: encrypted_attributes
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-08-05 00:00:00 -04:00
-summary: ""
+  version: 0.0.2
+date: 2007-09-26 00:00:00 -04:00
+summary: Adds support for automatically encrypting ActiveRecord attributes
 require_paths: 
 - lib
 email: info@pluginaweek.org
@@ -29,44 +29,44 @@ post_install_message:
 authors: 
 - Aaron Pfeifer, Neil Abraham
 files: 
+- lib/encrypted_attributes.rb
 - lib/encrypted_attributes
 - lib/encrypted_attributes/extensions
-- lib/encrypted_attributes/extensions/encryptor.rb
 - lib/encrypted_attributes/extensions/sha_encryptor.rb
-- lib/encrypted_attributes.rb
+- lib/encrypted_attributes/extensions/encryptor.rb
+- test/test_helper.rb
+- test/fixtures
 - test/app_root
+- test/keys
+- test/unit
+- test/fixtures/users.yml
 - test/app_root/app
+- test/app_root/db
 - test/app_root/app/models
-- test/app_root/app/models/asymmetric_user.rb
+- test/app_root/app/models/sha_user_with_salt.rb
 - test/app_root/app/models/confirmed_sha_user.rb
+- test/app_root/app/models/asymmetric_user.rb
 - test/app_root/app/models/sha_user.rb
 - test/app_root/app/models/sha_user_with_custom_crypted_attr.rb
+- test/app_root/app/models/user.rb
 - test/app_root/app/models/sha_user_with_custom_salt.rb
-- test/app_root/app/models/sha_user_with_salt.rb
 - test/app_root/app/models/symmetric_user.rb
-- test/app_root/app/models/user.rb
-- test/app_root/db
 - test/app_root/db/migrate
 - test/app_root/db/migrate/001_create_users.rb
-- test/app_root/test
-- test/app_root/test/fixtures
-- test/app_root/test/fixtures/users.yml
-- test/keys
 - test/keys/private
 - test/keys/public
-- test/test_helper.rb
-- test/unit
 - test/unit/encrypted_attributes_test.rb
-- test/unit/encryptor_test.rb
 - test/unit/sha_encryptor_test.rb
+- test/unit/encryptor_test.rb
+- CHANGELOG
 - init.rb
 - MIT-LICENSE
 - Rakefile
 - README
 test_files: 
 - test/unit/encrypted_attributes_test.rb
-- test/unit/encryptor_test.rb
 - test/unit/sha_encryptor_test.rb
+- test/unit/encryptor_test.rb
 rdoc_options: []
 
 extra_rdoc_files: []