mournful_settings 0.0.3 → 0.0.4

data/README.rdoc

@@ -50,22 +50,28 @@ To use a stored setting, use the 'for' class method:
 
 == Encryption
 
-By default mournful settings uses a blowfish cipher to encrypt settings, and
-its own key string.
+By default mournful settings are encrypted. You can choose not to encrypt a
+setting, by setting :encrypted => false. 
 
-=== Set key
+    Setting.create(
+      :name => 'pi', 
+      :value => '3.14159', 
+      :value_type => 'number',
+      :encrypted => false
+    )
 
-If you wish to use your own encryption key, you can define the key in
-an initializer, like this:
+Out of the box, encryption uses a blowfish cipher, and a generic key string.
 
-    Setting::Cipher.key = 'your key'
+=== Set key and cipher
 
-=== Change cipher
+If you wish to use your own encryption key, you can define the key like this:
 
-Mournful settings uses Ruby's OpenSSL::Cipher. If you wish to use to change
+    MournfulSettings::Setting::Cipher.key = 'your key'
+
+Mournful settings uses Ruby's OpenSSL::Cipher. If you wish to change
 the cipher from blowfish, you can alter it like this:
 
-    Setting::Cipher.config = 'aes-128-cbc'
+    MournfulSettings::Setting::Cipher.config = 'aes-128-cbc'
 
 To see a list of the available options use:
 
@@ -73,6 +79,43 @@ To see a list of the available options use:
 
 See: http://ruby-doc.org/stdlib-1.9.3/libdoc/openssl/rdoc/OpenSSL/Cipher.html
 
+=== Where to set the cipher within your app
+
+If you use a setting in an initializer you need to ensure that your cipher
+configuration is set before the setting is used. This means you either need
+to order your initializers putting your mournful_settings initializer first or 
+define the cipher settings in a before_initialize block defined in 
+config/application:
+
+    module YourRailsApp
+      class Application < Rails::Application
+
+        .....
+
+        config.before_initialize do
+          MournfulSettings::Setting::Cipher.key = 'your key'
+        end
+      end
+    end
+
+See: http://guides.rubyonrails.org/configuring.html#initialization-events
+
+=== Changing key and/or cipher
+
+If you change the cipher configuration, existing encrypted settings will break.
+Therefore, to make the change after you have started using encrypted settings,
+you must decrypt your settings, make the change and then re-encrypt the settings 
+again. To ease this task, use the Setting.recrypt_all method:
+
+    Setting.recrypt_all { Setting::Cipher.key = 'your key' }
+
+So the process would be:
+
+- Stop the server
+- Run the recrypt task
+- Add/Update the configuration code in the app
+- Start the server
+
 == Integration with ActiveAdmin
 
 Mournful settings contains a ActiveAdmin register file, that allow settings to 

data/lib/mournful_settings/setting.rb

@@ -38,6 +38,13 @@ module MournfulSettings
       end
     end
     
+    def self.recrypt_all &do_while_unencrypted
+      encrypted = where(:encrypted => true)
+      encrypted.each {|s| s.encrypted = false; s.save}
+      do_while_unencrypted.call if do_while_unencrypted
+      encrypted.each {|s| s.encrypted = true; s.save}
+    end
+        
     private
     def encrypt(text)
       add_separators Base64.encode64 Cipher.encrypt text.to_s

data/lib/mournful_settings/version.rb

@@ -1,10 +1,14 @@
 module MournfulSettings
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end
 
 # History
 # =======
 # 
+# 0.0.4: Changing cipher configuration
+# ------------------------------------
+# Adds facility to allow cipher to be changed with existing live data
+# 
 # 0.0.3: Encrypted by default
 # ---------------------------
 # Modifies model and active admin registration file to make encrypting settings

data/test/dummy/test/setting_test.rb

@@ -29,7 +29,7 @@ class SettingTest < Test::Unit::TestCase
   end
   
   def test_encrypted_value
-    assert_kind_of(String, encrypted_setting.value)
+    assert_kind_of(String, encrypted_setting.reload.value)
     assert_equal(@value, encrypted_setting.value)
   end
   
@@ -92,6 +92,37 @@ class SettingTest < Test::Unit::TestCase
     end
   end
   
+  def test_changing_cipher
+    cipher = 'bf-cbc'
+    assert_not_equal(cipher, Setting::Cipher.config)
+    test_encrypted_value
+    Setting::Cipher.config = cipher
+    assert_equal(cipher, Setting::Cipher.config)
+    assert_raise OpenSSL::Cipher::CipherError do
+      test_encrypted_value
+    end
+  end
+  
+  def test_changing_key
+    key = 'Some new key'
+    assert_not_equal(key, Setting::Cipher.key)
+    test_encrypted_value
+    Setting::Cipher.key = key
+    assert_equal(key, Setting::Cipher.key)
+    assert_raise OpenSSL::Cipher::CipherError do
+      test_encrypted_value
+    end
+  end
+  
+  def test_recrypt_all
+    key = 'Some new key'
+    assert_not_equal(key, Setting::Cipher.key)
+    test_encrypted_value
+    Setting.recrypt_all { Setting::Cipher.key = key }
+    assert_equal(key, Setting::Cipher.key)
+    test_encrypted_value
+  end
+  
   private
   def text_setting 
     @text_setting ||= Setting.create(:name => 'text_setting', :value => 'foo', :value_type => 'text', :encrypted => false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mournful_settings
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: