encryptor 1.0.1 → 1.1.0

data/README.rdoc

@@ -0,0 +1,90 @@
+= Encryptor
+
+A simple wrapper for the standard ruby OpenSSL library
+
+Used by http://github.com/shuber/attr_encrypted to easily encrypt/decrypt attributes in any class
+
+
+== Installation
+
+  gem install encryptor
+
+
+== Usage
+
+  secret_key = Digest::SHA256.hexdigest('a secret key')
+  encrypted_value = Encryptor.encrypt(:value => 'some string to encrypt', :key => secret_key) # '������{)��q�ށ�ܣ��q���Au/�ޜP'
+  decrypted_value = Encryptor.decrypt(:value => encrypted_value, :key => secret_key) # 'some string to encrypt'
+
+You may also pass the <tt>:iv</tt> and <tt>:algorithm</tt> options but they are not required. If an algorithm is not specified, the Encryptor uses
+the algorithm found at <tt>Encryptor.default_options[:algorithm]</tt> which is <tt>aes-256-cbc</tt> by default. You can change the default options 
+by overwriting or merging this attribute:
+
+  Encryptor.default_options.merge!(:algorithm => 'bf', :key => 'some default secret key')
+
+Run <tt>openssl list-cipher-commands</tt> 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
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Contact
+
+Problems, comments, and suggestions all welcome: shuber@huberry.com

data/Rakefile

@@ -17,6 +17,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Encryptor'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/encryptor.rb

@@ -1,51 +1,50 @@
 require 'openssl'
 
-module Huberry
-  module Encryptor
-    # The default options to use when calling the <tt>encrypt</tt> and <tt>decrypt</tt> methods
-    #
-    # 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_options; end
-    self.default_options = { :algorithm => 'aes-256-cbc' }
-    
-    # Encrypts a <tt>:value</tt> with a specified <tt>:key</tt>
-    #
-    # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
-    #
-    # Example
-    #
-    #   encrypted_value = Huberry::Encryptor.encrypt(:value => 'some string to encrypt', :key => 'some secret key')
-    def self.encrypt(options)
-      crypt :encrypt, options
-    end
-    
-    # Decrypts a <tt>:value</tt> with a specified <tt>:key</tt>
-    #
-    # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
-    #
-    # Example
-    #
-    #   decrypted_value = Huberry::Encryptor.decrypt(:value => 'some encrypted string', :key => 'some secret key')
-    def self.decrypt(options)
-      crypt :decrypt, options
-    end
-    
-    protected
-    
-      def self.crypt(cipher_method, options = {})
-        options = default_options.merge(options)
-        cipher = OpenSSL::Cipher::Cipher.new(options[:algorithm])
-        cipher.send(cipher_method)
-        if options[:iv]
-          cipher.key = options[:key]
-          cipher.iv = options[:iv]
-        else
-          cipher.pkcs5_keyivgen(options[:key])
-        end
-        result = cipher.update(options[:value])
-        result << cipher.final
-      end
+module Encryptor
+  # The default options to use when calling the <tt>encrypt</tt> and <tt>decrypt</tt> methods
+  #
+  # 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
+  def self.default_options
+    @default_options ||= { :algorithm => 'aes-256-cbc' }
+  end
+  
+  # Encrypts a <tt>:value</tt> with a specified <tt>:key</tt>
+  #
+  # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
+  #
+  # Example
+  #
+  #   encrypted_value = Huberry::Encryptor.encrypt(:value => 'some string to encrypt', :key => 'some secret key')
+  def self.encrypt(options)
+    crypt :encrypt, options
   end
+  
+  # Decrypts a <tt>:value</tt> with a specified <tt>:key</tt>
+  #
+  # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
+  #
+  # Example
+  #
+  #   decrypted_value = Huberry::Encryptor.decrypt(:value => 'some encrypted string', :key => 'some secret key')
+  def self.decrypt(options)
+    crypt :decrypt, options
+  end
+  
+  protected
+  
+    def self.crypt(cipher_method, options = {})
+      options = default_options.merge(options)
+      cipher = OpenSSL::Cipher::Cipher.new(options[:algorithm])
+      cipher.send(cipher_method)
+      if options[:iv]
+        cipher.key = options[:key]
+        cipher.iv = options[:iv]
+      else
+        cipher.pkcs5_keyivgen(options[:key])
+      end
+      result = cipher.update(options[:value])
+      result << cipher.final
+    end
 end

data/test/encryptor_test.rb

@@ -11,33 +11,33 @@ class EncryptorTest < Test::Unit::TestCase
   
   algorithms.each do |algorithm|
     define_method "test_should_crypt_with_#{algorithm}_algorithm_with_iv" do
-      encrypted_value = Huberry::Encryptor.encrypt(:value => original_value, :key => key, :iv => iv, :algorithm => algorithm)
+      encrypted_value = Encryptor.encrypt(:value => original_value, :key => key, :iv => iv, :algorithm => algorithm)
       assert_not_equal original_value, encrypted_value
-      assert_not_equal Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm), encrypted_value
-      assert_equal original_value, Huberry::Encryptor.decrypt(:value => encrypted_value, :key => key, :iv => iv, :algorithm => algorithm)
+      assert_not_equal Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm), encrypted_value
+      assert_equal original_value, Encryptor.decrypt(:value => encrypted_value, :key => key, :iv => iv, :algorithm => algorithm)
     end
     
     define_method "test_should_crypt_with_#{algorithm}_algorithm_without_iv" do
-      encrypted_value = Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm)
+      encrypted_value = Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm)
       assert_not_equal original_value, encrypted_value
-      assert_equal original_value, Huberry::Encryptor.decrypt(:value => encrypted_value, :key => key, :algorithm => algorithm)
+      assert_equal original_value, Encryptor.decrypt(:value => encrypted_value, :key => key, :algorithm => algorithm)
     end
   end
   
   define_method 'test_should_have_a_default_algorithm' do
-    assert algorithms.include?(Huberry::Encryptor.default_options[:algorithm])
+    assert algorithms.include?(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_options[:algorithm]), Huberry::Encryptor.encrypt(:value => original_value, :key => key)
+    assert_equal Encryptor.encrypt(:value => original_value, :key => key, :algorithm => Encryptor.default_options[:algorithm]), Encryptor.encrypt(:value => original_value, :key => key)
   end
   
   def test_should_be_able_to_change_the_default_algorithm
-    original_algorithm = Huberry::Encryptor.default_options[:algorithm]
+    original_algorithm = Encryptor.default_options[:algorithm]
     assert_not_equal 'test', original_algorithm
-    Huberry::Encryptor.default_options[:algorithm] = 'test'
-    assert_equal 'test', Huberry::Encryptor.default_options[:algorithm]
-    Huberry::Encryptor.default_options[:algorithm] = original_algorithm
+    Encryptor.default_options[:algorithm] = 'test'
+    assert_equal 'test', Encryptor.default_options[:algorithm]
+    Encryptor.default_options[:algorithm] = original_algorithm
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: encryptor
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-10 00:00:00 -05:00
+date: 2010-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -22,12 +22,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- CHANGELOG
 - lib/encryptor.rb
 - MIT-LICENSE
 - Rakefile
-- README.markdown
-has_rdoc: false
+- README.rdoc
+- test/encryptor_test.rb
+has_rdoc: true
 homepage: http://github.com/shuber/encryptor
 licenses: []
 
@@ -36,7 +36,7 @@ rdoc_options:
 - --line-numbers
 - --inline-source
 - --main
-- README.markdown
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/CHANGELOG

@@ -1,12 +0,0 @@
-2009-02-10 - Sean Huber (shuber@huberry.com)
-  * Update README
-
-2009-01-10 - Sean Huber (shuber@huberry.com)
-  * Add default_options attribute
-
-2009-01-06 - Sean Huber (shuber@huberry.com)
-  * Initial commit
-  * Add tests
-  * Update README
-  * Add gemspec
-  * Modify gemspec so github will rebuild the gem

data/README.markdown

@@ -1,86 +0,0 @@
-Encryptor
-=========
-
-A simple wrapper for the standard ruby OpenSSL library
-
-See [http://github.com/shuber/attr_encrypted](http://github.com/shuber/attr_encrypted) to easily encrypt/decrypt attributes in any class
-
-
-Installation
-------------
-
-	gem install shuber-encryptor --source http://gems.github.com
-
-
-Usage
------
-
-	secret_key = Digest::SHA256.hexdigest('a secret key')
-	encrypted_value = Huberry::Encryptor.encrypt(:value => 'some string to encrypt', :key => secret_key) # '������{)��q�ށ�ܣ��q���Au/�ޜP'
-	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_options[:algorithm]` which is `aes-256-cbc` by default. You can change the default options 
-by overwriting or merging this attribute:
-
-	Huberry::Encryptor.default_options.merge!(:algorithm => 'bf', :key => 'some default secret key')
-
-You can extract the `Encryptor` module out of the `Huberry` namespace if you'd like
-
-	Encryptor = Huberry::Encryptor
-
-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
--------
-
-Problems, comments, and suggestions all welcome: [shuber@huberry.com](mailto:shuber@huberry.com)