shuber-encryptor 1.0.0 → 1.0.1

data/CHANGELOG

@@ -1,3 +1,6 @@
+2009-01-10 - Sean Huber (shuber@huberry.com)
+  * Add default_options attribute
+
 2009-01-06 - Sean Huber (shuber@huberry.com)
   * Initial commit
   * Add tests

data/README.markdown

@@ -18,13 +18,61 @@ Usage
 	decrypted_value = Huberry::Encryptor.decrypt(:value => encrypted_value, :key => secret_key) # 'some string to encrypt'
 
 You may also pass the `:iv` and `:algorithm` options but they are not required. If an algorithm is not specified, the Encryptor uses
-the algorithm found at `Huberry::Encryptor.default_algorithm` which is `aes-256-cbc` by default. You can change the default algorithm 
-by overwriting this attribute:
+the algorithm found at `Huberry::Encryptor.default_options[:algorithm]` which is `aes-256-cbc` by default. You can change the default options 
+by overwriting or merging this attribute:
 
-	Huberry::Encryptor.default_algorithm = 'bf'
+	Huberry::Encryptor.default_options.merge!(:algorithm => 'bf', :key => 'some default secret key')
 
 Run `openssl list-cipher-commands` in your terminal to view a list all cipher algorithms that are supported on your platform.
 
+	aes-128-cbc
+	aes-128-ecb
+	aes-192-cbc
+	aes-192-ecb
+	aes-256-cbc
+	aes-256-ecb
+	base64
+	bf
+	bf-cbc
+	bf-cfb
+	bf-ecb
+	bf-ofb
+	cast
+	cast-cbc
+	cast5-cbc
+	cast5-cfb
+	cast5-ecb
+	cast5-ofb
+	des
+	des-cbc
+	des-cfb
+	des-ecb
+	des-ede
+	des-ede-cbc
+	des-ede-cfb
+	des-ede-ofb
+	des-ede3
+	des-ede3-cbc
+	des-ede3-cfb
+	des-ede3-ofb
+	des-ofb
+	des3
+	desx
+	idea
+	idea-cbc
+	idea-cfb
+	idea-ecb
+	idea-ofb
+	rc2
+	rc2-40-cbc
+	rc2-64-cbc
+	rc2-cbc
+	rc2-cfb
+	rc2-ecb
+	rc2-ofb
+	rc4
+	rc4-40
+
 
 Contact
 -------

data/lib/encryptor.rb

@@ -2,13 +2,13 @@ require 'openssl'
 
 module Huberry
   module Encryptor
-    # The default algorithm to use if one is not explicitly passed as an option to the <tt>encrypt</tt> or <tt>decrypt</tt> methods
+    # The default options to use when calling the <tt>encrypt</tt> and <tt>decrypt</tt> methods
     #
-    # Defaults to 'aes-256-cbc'
+    # Defaults to { :algorithm => 'aes-256-cbc' }
     #
     # Run 'openssl list-cipher-commands' in your terminal to view a list all cipher algorithms that are supported on your platform
-    class << self; attr_accessor :default_algorithm; end
-    self.default_algorithm = 'aes-256-cbc'
+    class << self; attr_accessor :default_options; end
+    self.default_options = { :algorithm => 'aes-256-cbc' }
     
     # Encrypts a <tt>:value</tt> with a specified <tt>:key</tt>
     #
@@ -35,7 +35,8 @@ module Huberry
     protected
     
       def self.crypt(cipher_method, options = {})
-        cipher = OpenSSL::Cipher::Cipher.new(options[:algorithm] || default_algorithm)
+        options = default_options.merge(options)
+        cipher = OpenSSL::Cipher::Cipher.new(options[:algorithm])
         cipher.send(cipher_method)
         if options[:iv]
           cipher.key = options[:key]

data/test/encryptor_test.rb

@@ -25,19 +25,19 @@ class EncryptorTest < Test::Unit::TestCase
   end
   
   define_method 'test_should_have_a_default_algorithm' do
-    assert algorithms.include?(Huberry::Encryptor.default_algorithm)
+    assert algorithms.include?(Huberry::Encryptor.default_options[:algorithm])
   end
   
   define_method 'test_should_use_the_default_algorithm_if_one_is_not_specified' do
-    assert_equal Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => Huberry::Encryptor.default_algorithm), Huberry::Encryptor.encrypt(:value => original_value, :key => key)
+    assert_equal Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => Huberry::Encryptor.default_options[:algorithm]), Huberry::Encryptor.encrypt(:value => original_value, :key => key)
   end
   
   def test_should_be_able_to_change_the_default_algorithm
-    original_algorithm = Huberry::Encryptor.default_algorithm
+    original_algorithm = Huberry::Encryptor.default_options[:algorithm]
     assert_not_equal 'test', original_algorithm
-    Huberry::Encryptor.default_algorithm = 'test'
-    assert_equal 'test', Huberry::Encryptor.default_algorithm
-    Huberry::Encryptor.default_algorithm = original_algorithm
+    Huberry::Encryptor.default_options[:algorithm] = 'test'
+    assert_equal 'test', Huberry::Encryptor.default_options[:algorithm]
+    Huberry::Encryptor.default_options[:algorithm] = original_algorithm
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-encryptor
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-07 00:00:00 -08:00
+date: 2009-01-10 00:00:00 -08:00
 default_executable: 
 dependencies: []