secure_yaml 1.1.0 → 2.0.0

data/README.md

@@ -71,17 +71,24 @@ decrypted_yaml = SecureYaml::load(File.open('database.yml'))
 decrypted_yaml = SecureYaml::load(File.open('database.yml'), 'NEW_SECRET_KEY_PROPERTY_NAME')
 ```
 
+<br />
 ### Customising decryption
 
 The default decryption method applied by this library when loading a YAML file is [AES-256-CFB](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
-However, if you wish to, you can specify your own custom decryption:
+However, if you wish to, you can specify your own custom decryption algorithm:
 
 ```ruby
 require 'secure_yaml'
 
-decrypted_yaml = SecureYaml::load(File.open('database.yml')) do |secret_key, encrypted_data|
-  "decrypt data here from #{secret_key} and #{encrypted_data}"
-end
+custom_decryption_algorithm = Class.new {
+  def self.decrypt(secret_key, encrypted_data)
+    "your decrypted data returned here"
+  end
+}
+
+decrypted_yaml = SecureYaml::load(File.open('database.yml'), {
+  :decryption_algorithm => custom_decryption_algorithm
+})
 ```
 
 

data/lib/secure_yaml/version.rb

@@ -1,5 +1,5 @@
 module SecureYaml
 
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 
 end

data/lib/secure_yaml/yaml_decrypter.rb

@@ -12,7 +12,7 @@ module SecureYaml
     def decrypt(yaml)
       case yaml
         when Hash
-          yaml.inject({}) {|new_hash, (key, value)| new_hash[key] = decrypt(value); new_hash}
+          yaml.inject({}) {|new_hash, (key, value)| new_hash[key.to_sym] = decrypt(value); new_hash}
         when String
           yaml.gsub(/^#{ENCRYPTED_PROPERTY_WRAPPER_ID}\((.*)\)$/) {@decryption_algorithm.decrypt(@secret_key, $1)}
         else

data/lib/secure_yaml.rb

@@ -7,10 +7,11 @@ module SecureYaml
 
   DEFAULT_SECRET_KEY_PROP_NAME = 'PROPERTIES_ENCRYPTION_PASSWORD'
 
-  def self.load(yaml_file, secret_key_prop_name = DEFAULT_SECRET_KEY_PROP_NAME, &decryption_block)
-    decryption_algorithm = block_given? ? custom_decryption_algorithm(decryption_block) : Cipher.new
+  def self.load(yaml_file, opts = {})
+    opts[:secret_key_property_name] ||= DEFAULT_SECRET_KEY_PROP_NAME
+    opts[:decryption_algorithm] ||= Cipher.new
 
-    yaml_loader(decryption_algorithm, retrieve_secret_key(secret_key_prop_name)).load(yaml_file)
+    yaml_loader(opts[:decryption_algorithm], retrieve_secret_key(opts[:secret_key_property_name])).load(yaml_file)
   end
 
   private
@@ -21,18 +22,6 @@ module SecureYaml
     secret_key
   end
 
-  def self.custom_decryption_algorithm(decryption_block)
-    Class.new {
-      def initialize(decryption_block)
-        @decryption_block = decryption_block
-      end
-
-      def decrypt(secret_key, encrypted_data)
-        @decryption_block.call(secret_key, encrypted_data)
-      end
-    }.new(decryption_block)
-  end
-
   def self.yaml_loader(decryption_algorithm, secret_key)
     Loader.new(YamlDecrypter.new(decryption_algorithm, secret_key))
   end

data/spec/fixtures/test.yml

@@ -0,0 +1,2 @@
+:plain_prop: "1234"
+:encrypted_prop: "ENC(EBnrEqmvC5BbOXw=)"

data/spec/integration/secure_yaml_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'SecureYaml' do
+
+  before(:each) do
+    @secret_key = 'secret'
+    ENV[SecureYaml::DEFAULT_SECRET_KEY_PROP_NAME] = @secret_key
+    @test_yaml_file = File.open('spec/fixtures/test.yml')
+  end
+
+  it 'should load decrypted yaml file using default decryption algorithm' do
+    yaml = SecureYaml::load(@test_yaml_file)
+
+    yaml.should == {:plain_prop => '1234', :encrypted_prop => 'secret-text'}
+  end
+
+  it 'should load decrypted yaml file using custom decryption algorithm' do
+    custom_decryption_algorithm = Class.new {
+      def self.decrypt(secret_key, encrypted_data)
+        "decrypted!"
+      end
+    }
+
+    yaml = SecureYaml::load(@test_yaml_file, {:decryption_algorithm => custom_decryption_algorithm})
+
+    yaml.should == {:plain_prop => '1234', :encrypted_prop => 'decrypted!'}
+  end
+
+end

data/spec/secure_yaml_spec.rb

@@ -5,14 +5,20 @@ describe 'SecureYaml' do
   before(:each) do
     @secret_key = 'secret key'
     @yaml = {:prop => 'test'}
-    loader = double(SecureYaml::Loader)
-    loader.stub(:load).and_return(@yaml)
-    SecureYaml::Loader.stub(:new).and_return(loader)
+
+    @default_decryption_algorithm = double(SecureYaml::Cipher)
+    SecureYaml::Cipher.stub(:new).and_return(@default_decryption_algorithm)
+
+
+    @loader = double(SecureYaml::Loader)
+    @yaml_decrypter = double(SecureYaml::YamlDecrypter)
+    SecureYaml::Loader.stub(:new).with(@yaml_decrypter).and_return(@loader)
+    @loader.stub(:load).and_return(@yaml)
   end
 
   it 'should load decrypted yaml file' do
-
     ENV[SecureYaml::DEFAULT_SECRET_KEY_PROP_NAME] = @secret_key
+    SecureYaml::YamlDecrypter.stub(:new).with(@default_decryption_algorithm, @secret_key).and_return(@yaml_decrypter)
 
     yaml = SecureYaml::load(double(File))
 
@@ -28,18 +34,23 @@ describe 'SecureYaml' do
   it 'should allow use of custom secret key property name' do
     custom_secret_key_prop_name = 'CUSTOMER_SECRET_KEY_PROP_NAME'
     ENV[custom_secret_key_prop_name] = @secret_key
+    SecureYaml::YamlDecrypter.stub(:new).with(@default_decryption_algorithm, @secret_key).and_return(@yaml_decrypter)
 
-    yaml = SecureYaml::load(double(File), custom_secret_key_prop_name)
+    yaml = SecureYaml::load(double(File), {:secret_key_property_name => custom_secret_key_prop_name})
 
     yaml.should == @yaml
   end
 
   it 'should allow use of custom decryption algorithm' do
     ENV[SecureYaml::DEFAULT_SECRET_KEY_PROP_NAME] = @secret_key
-
-    yaml = SecureYaml::load(double(File)) do |secret_key, encrypted_data|
-      "decrypt data here from #{secret_key} and #{encrypted_data}"
-    end
+    custom_decryption_algorithm = Class.new {
+      def self.decrypt(secret_key, encrypted_data)
+        "decrypt data here from #{secret_key} and #{encrypted_data}"
+      end
+    }
+    SecureYaml::YamlDecrypter.stub(:new).with(custom_decryption_algorithm, @secret_key).and_return(@yaml_decrypter)
+
+    yaml = SecureYaml::load(double(File), {:decryption_algorithm => custom_decryption_algorithm})
 
     yaml.should == @yaml
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secure_yaml
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -96,12 +96,14 @@ files:
 - lib/secure_yaml/version.rb
 - lib/secure_yaml/yaml_decrypter.rb
 - secure_yaml.gemspec
-- spec/secure_yaml/cipher_spec.rb
-- spec/secure_yaml/cli/property_encryption_application_spec.rb
-- spec/secure_yaml/loader_spec.rb
-- spec/secure_yaml/yaml_decrypter_spec.rb
+- spec/fixtures/test.yml
+- spec/integration/secure_yaml_spec.rb
 - spec/secure_yaml_spec.rb
 - spec/spec_helper.rb
+- spec/unit/secure_yaml/cipher_spec.rb
+- spec/unit/secure_yaml/cli/property_encryption_application_spec.rb
+- spec/unit/secure_yaml/loader_spec.rb
+- spec/unit/secure_yaml/yaml_decrypter_spec.rb
 homepage: https://github.com/qmg-hlewis/secure_yaml
 licenses: []
 post_install_message: