encryptor 1.1.1 → 1.1.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Sean Huber - shuber@huberry.com
+Copyright (c) 2011 Sean Huber - shuber@huberry.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -15,15 +15,15 @@ Used by http://github.com/shuber/attr_encrypted to easily encrypt/decrypt attrib
 
 === Basic
 
-  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'
-
-The value to encrypt or decrypt may also be passed as the first argument if you'd like.
-
   secret_key = Digest::SHA256.hexdigest('a secret key')
   encrypted_value = Encryptor.encrypt('some string to encrypt', :key => secret_key) # '������{)��q�ށ�ܣ��q���Au/�ޜP'
   decrypted_value = Encryptor.decrypt(encrypted_value, :key => secret_key) # 'some string to encrypt'
 
+The value to encrypt or decrypt may also be passed as the <tt>:value</tt> option if you'd like.
+
+  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:
@@ -33,7 +33,7 @@ by overwriting or merging this attribute:
 
 === Strings
 
-<tt>Encryptor</tt> adds <tt>encrypt</tt> and <tt>decrypt</tt> methods to <tt>String</tt> objects for your convenience. These two methods accept the same arguments as the associated ones in the <tt>Encryptor</tt> module. There nice when you set the default options in the <tt>Encryptor.default_options</tt> attribute. For example:
+<tt>Encryptor</tt> adds <tt>encrypt</tt> and <tt>decrypt</tt> methods to <tt>String</tt> objects for your convenience. These two methods accept the same arguments as the associated ones in the <tt>Encryptor</tt> module. They're nice when you set the default options in the <tt>Encryptor.default_options</tt> attribute. For example:
 
   Encryptor.default_options.merge!(:key => 'some default secret key')
   credit_card = 'xxxx xxxx xxxx 1234'
@@ -44,7 +44,7 @@ There's also <tt>encrypt!</tt> and <tt>decrypt!</tt> methods that replace the co
 
 === Algorithms
 
-Run <tt>openssl list-cipher-commands</tt> in your terminal to view a list all cipher algorithms that are supported on your platform.
+Run <tt>openssl list-cipher-commands</tt> in your terminal to view a list of all cipher algorithms that are supported on your platform.
 
   aes-128-cbc
   aes-128-ecb
@@ -98,14 +98,6 @@ Run <tt>openssl list-cipher-commands</tt> in your terminal to view a list all ci
 
 * 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
+* 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.

data/Rakefile

@@ -2,17 +2,17 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-desc 'Default: run unit tests.'
+desc 'Default: run unit tests'
 task :default => :test
 
-desc 'Test the encryptor gem.'
+desc 'Test the encryptor gem'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc 'Generate documentation for the encryptor gem.'
+desc 'Generate documentation for the encryptor gem'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Encryptor'

data/lib/encryptor.rb

@@ -1,17 +1,23 @@
 require 'openssl'
 require 'encryptor/string'
 
+String.send(:include, Encryptor::String)
+
 # A simple wrapper for the standard OpenSSL library
 module Encryptor
+  autoload :Version, 'encryptor/version'
+
+  extend self
+
   # 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
+  def 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
@@ -21,10 +27,10 @@ module Encryptor
   #   encrypted_value = Encryptor.encrypt(:value => 'some string to encrypt', :key => 'some secret key')
   #   # or
   #   encrypted_value = Encryptor.encrypt('some string to encrypt', :key => 'some secret key')
-  def self.encrypt(*args)
+  def encrypt(*args)
     crypt :encrypt, *args
   end
-  
+
   # Decrypts a <tt>:value</tt> with a specified <tt>:key</tt>
   #
   # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
@@ -34,13 +40,13 @@ module Encryptor
   #   decrypted_value = Encryptor.decrypt(:value => 'some encrypted string', :key => 'some secret key')
   #   # or
   #   decrypted_value = Encryptor.decrypt('some encrypted string', :key => 'some secret key')
-  def self.decrypt(*args)
+  def decrypt(*args)
     crypt :decrypt, *args
   end
-  
+
   protected
-  
-    def self.crypt(cipher_method, *args) #:nodoc:
+
+    def crypt(cipher_method, *args) #:nodoc:
       options = default_options.merge(:value => args.first).merge(args.last.is_a?(Hash) ? args.last : {})
       cipher = OpenSSL::Cipher::Cipher.new(options[:algorithm])
       cipher.send(cipher_method)
@@ -53,6 +59,4 @@ module Encryptor
       result = cipher.update(options[:value])
       result << cipher.final
     end
-end
-
-String.send :include, Encryptor::String
+end

data/lib/encryptor/string.rb

@@ -1,21 +1,21 @@
-module Encryptor #:nodoc:
+module Encryptor
   # Adds <tt>encrypt</tt> and <tt>decrypt</tt> methods to strings
   module String
     # Returns a new string containing the encrypted version of itself
     def encrypt(options = {})
       Encryptor.encrypt(options.merge(:value => self))
     end
-    
+
     # Replaces the contents of a string with the encrypted version of itself
     def encrypt!(options ={})
       replace encrypt(options)
     end
-  
+
     # Returns a new string containing the decrypted version of itself
     def decrypt(options = {})
       Encryptor.decrypt(options.merge(:value => self))
     end
-    
+
     # Replaces the contents of a string with the decrypted version of itself
     def decrypt!(options ={})
       replace decrypt(options)

data/lib/encryptor/version.rb

@@ -0,0 +1,17 @@
+module Encryptor
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 1
+    MINOR = 1
+    PATCH = 2
+
+    # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
+    #
+    # Example
+    #
+    #   Version.to_s # '1.0.2'
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/test/encryptor_test.rb

@@ -1,9 +1,7 @@
-require 'test/unit'
-require 'digest/sha2'
-require File.dirname(__FILE__) + '/../lib/encryptor'
+require File.expand_path('../test_helper', __FILE__)
 
 class EncryptorTest < Test::Unit::TestCase
-  
+
   algorithms = %x(openssl list-cipher-commands).split
   key = Digest::SHA256.hexdigest(([Time.now.to_s] * rand(3)).join)
   iv = Digest::SHA256.hexdigest(([Time.now.to_s] * rand(3)).join)
@@ -12,82 +10,82 @@ class EncryptorTest < Test::Unit::TestCase
   algorithms.reject { |algorithm| algorithm == 'base64' }.each do |algorithm|
     encrypted_value_with_iv = Encryptor.encrypt(:value => original_value, :key => key, :iv => iv, :algorithm => algorithm)
     encrypted_value_without_iv = Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm)
-    
+
     define_method "test_should_crypt_with_the_#{algorithm}_algorithm_with_iv" do
       assert_not_equal original_value, encrypted_value_with_iv
       assert_not_equal encrypted_value_without_iv, encrypted_value_with_iv
       assert_equal original_value, Encryptor.decrypt(:value => encrypted_value_with_iv, :key => key, :iv => iv, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_crypt_with_the_#{algorithm}_algorithm_without_iv" do
       assert_not_equal original_value, encrypted_value_without_iv
       assert_equal original_value, Encryptor.decrypt(:value => encrypted_value_without_iv, :key => key, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_encrypt_with_the_#{algorithm}_algorithm_with_iv_with_the_first_arg_as_the_value" do
       assert_equal encrypted_value_with_iv, Encryptor.encrypt(original_value, :key => key, :iv => iv, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_encrypt_with_the_#{algorithm}_algorithm_without_iv_with_the_first_arg_as_the_value" do
       assert_equal encrypted_value_without_iv, Encryptor.encrypt(original_value, :key => key, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_decrypt_with_the_#{algorithm}_algorithm_with_iv_with_the_first_arg_as_the_value" do
       assert_equal original_value, Encryptor.decrypt(encrypted_value_with_iv, :key => key, :iv => iv, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_decrypt_with_the_#{algorithm}_algorithm_without_iv_with_the_first_arg_as_the_value" do
       assert_equal original_value, Encryptor.decrypt(encrypted_value_without_iv, :key => key, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_call_encrypt_on_a_string_with_the_#{algorithm}_algorithm_with_iv" do
       assert_equal encrypted_value_with_iv, original_value.encrypt(:key => key, :iv => iv, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_call_encrypt_on_a_string_with_the_#{algorithm}_algorithm_without_iv" do
       assert_equal encrypted_value_without_iv, original_value.encrypt(:key => key, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_call_decrypt_on_a_string_with_the_#{algorithm}_algorithm_with_iv" do
       assert_equal original_value, encrypted_value_with_iv.decrypt(:key => key, :iv => iv, :algorithm => algorithm)
     end
-    
+
     define_method "test_should_call_decrypt_on_a_string_with_the_#{algorithm}_algorithm_without_iv" do
       assert_equal original_value, encrypted_value_without_iv.decrypt(:key => key, :algorithm => algorithm)
     end
-    
+
     define_method "test_string_encrypt!_on_a_string_with_the_#{algorithm}_algorithm_with_iv" do
       original_value_dup = original_value.dup
       original_value_dup.encrypt!(:key => key, :iv => iv, :algorithm => algorithm)
       assert_equal original_value.encrypt(:key => key, :iv => iv, :algorithm => algorithm), original_value_dup
     end
-    
+
     define_method "test_string_encrypt!_on_a_string_with_the_#{algorithm}_algorithm_without_iv" do
       original_value_dup = original_value.dup
       original_value_dup.encrypt!(:key => key, :algorithm => algorithm)
       assert_equal original_value.encrypt(:key => key, :algorithm => algorithm), original_value_dup
     end
-    
+
     define_method "test_string_decrypt!_on_a_string_with_the_#{algorithm}_algorithm_with_iv" do
       encrypted_value_with_iv_dup = encrypted_value_with_iv.dup
       encrypted_value_with_iv_dup.decrypt!(:key => key, :iv => iv, :algorithm => algorithm)
       assert_equal original_value, encrypted_value_with_iv_dup
     end
-    
+
     define_method "test_string_decrypt!_on_a_string_with_the_#{algorithm}_algorithm_without_iv" do
       encrypted_value_without_iv_dup = encrypted_value_without_iv.dup
       encrypted_value_without_iv_dup.decrypt!(:key => key, :algorithm => algorithm)
       assert_equal original_value, encrypted_value_without_iv_dup
     end
   end
-  
+
   define_method 'test_should_use_the_default_algorithm_if_one_is_not_specified' do
     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_have_a_default_algorithm
     assert !Encryptor.default_options[:algorithm].nil?
     assert !Encryptor.default_options[:algorithm].empty?
   end
-  
+
 end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require 'digest/sha2'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'encryptor'

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: encryptor
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-29 00:00:00 -08:00
+date: 2011-04-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: A simple wrapper for the standard ruby OpenSSL library
+description: A simple wrapper for the standard ruby OpenSSL library to encrypt and decrypt strings
 email: shuber@huberry.com
 executables: []
 
@@ -22,12 +28,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/encryptor.rb
 - lib/encryptor/string.rb
+- lib/encryptor/version.rb
+- lib/encryptor.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
 - test/encryptor_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/shuber/encryptor
 licenses: []
@@ -41,23 +49,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A simple wrapper for the standard ruby OpenSSL library
 test_files: 
 - test/encryptor_test.rb
+- test/test_helper.rb