attr_cipher 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c87b0d9afabd3b0a380cd69537161244a9d1bb25
-  data.tar.gz: 4c1a4dd96803ccda04fda32cc28f88d9c14f8c9f
+  metadata.gz: f2170d301034202dd5c1e79cfd07ae541e9eca46
+  data.tar.gz: 779477637d8623cefc95241dead741ff29dd7a15
 SHA512:
-  metadata.gz: c95d014c00f9ae57e701d7e32e2e62f3d9647f46e7e08f80175131914cf651917075680688fd2e4a00fb1a7e7e4a7d1c0603b29d167127767f27c07c5fbdfb4b
-  data.tar.gz: 3c305b9b6f303b4b3e525e803705c5644db94c7bbd5dd564eac84ae7c99439ee5b9b1446d6b430c9c94d23fe094681337a0dbc62a4024022b225094e393cba1b
+  metadata.gz: 0f387a996b632e9822b611ee745cdc47a776d036a8e34951ce24566eb9e24771bc48f57be3376d30a375434942d9cb426055270d27e19a56b6bf1bbda506447f
+  data.tar.gz: e899394a28b337d284bf1ac6e8bcf6c718ef14bc96a542b20a1f5a3d5ab6c344592e751268db1ad94c5f2acfe1bbf5c2d9b7d5a37473946fbfd373004881fe35

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+##v1.4.0
+- Added serialize option to attr_cipher class method. Can now seamlessly handle value types other than just strings.
+
 ##v1.3.1
 - Fixed failing spec.
 

data/README.md

@@ -34,7 +34,7 @@ Development/Test:
 
 ## Compatibility
 
-Tested with Ruby 2.3.1p112 (2016-04-26 revision 54768) [x86_64-darwin15] against ActiveRecord 5.0.0 on macOS Sierra 10.12.4 (16E195).
+Tested with Ruby 2.3.1p112 (2016-04-26 revision 54768) [x86_64-darwin15] against ActiveRecord 5.1.3 on macOS Sierra 10.12.6 (16G29).
 
 **AttrCipher** uses OpenSSL to perform the cipher.
 
@@ -95,9 +95,19 @@ class User < ActiveRecord::Base
 end
 ```
 
+Sometimes we need to store values that are aren't strings. In order to encrypt other value types  you can pass the `serialize` option with a value of `true` to the `attr_cipher` class method:
+
+```ruby
+class User < ActiveRecord::Base
+  attr_cipher :api_key, serialize: true
+end
+```
+
+Using the serialize option will cause the value to be serialized and deserialized using YAML during the encrypting and decrypting process. No changes are necessary to the column type in the table migration, it should remain as `text`.
+
 ## Tests
 
-Tests are written using Rspec, FactoryGirl and Sqlite3. There are 13 examples with 100% code coverage.
+Tests are written using Rspec, FactoryGirl and Sqlite3. There are 15 examples with 100% code coverage.
 
 To run the tests, execute the default rake task:
 

data/lib/attr_cipher/attr_cipher.rb

@@ -1,5 +1,6 @@
 require 'active_record'
 require 'active_support/all'
+require 'yaml'
 
 module AttrCipher
   extend ActiveSupport::Concern
@@ -23,24 +24,26 @@ module AttrCipher
   self.secret = ''
 
   module ClassMethods
-    def attr_cipher(*args, secret: AttrCipher.secret, cipher: AttrCipher.cipher)
+    def attr_cipher(*args, secret: AttrCipher.secret, cipher: AttrCipher.cipher, serialize: false)
       args.each do |attribute|
-        define_cipher_attribute(attribute, secret, cipher)
+        define_cipher_attribute(attribute, secret, cipher, serialize)
       end
     end
 
     private
 
-    def define_cipher_attribute(attribute, secret, cipher)
+    def define_cipher_attribute(attribute, secret, cipher, serialize)
       define_method attribute do
         value = instance_variable_get("@#{attribute}")
         cipher_value = send("#{attribute}_cipher") unless value
         value = cipher.decrypt(secret, cipher_value) if cipher_value
+        value = YAML::load(value) if serialize
         instance_variable_set("@#{attribute}", value)
       end
 
       define_method "#{attribute}=" do |value|
         instance_variable_set("@#{attribute}", value)
+        value = YAML::dump(value) if serialize
         send("#{attribute}_cipher=", nil)
         send("#{attribute}_cipher=", cipher.encrypt(secret, value)) if value && value != ""
       end

data/lib/attr_cipher/version.rb

@@ -1,8 +1,8 @@
 module AttrCipher
   module VERSION
     MAJOR = 1
-    MINOR = 3
-    TINY  = 1
+    MINOR = 4
+    TINY  = 0
     PRE   = nil
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
     SUMMARY = "AttrCipher v#{STRING}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_cipher
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Jurgen Jocubeit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -147,5 +147,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: AttrCipher v1.3.1
+summary: AttrCipher v1.4.0
 test_files: []