attr_cipher 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00b32ff728220c366f964a0305a33a5b1c8216e1
-  data.tar.gz: fcf407ad3d80e9533649b0910147d7d5ea8c5d1d
+  metadata.gz: '028e1e05b611dc3e8076d5c4df72906eaeb140f7'
+  data.tar.gz: 79154ae0e9ae0d7fd2ea7e9fed7cd0de31d6347b
 SHA512:
-  metadata.gz: 516fc8a442a58f34795447dd56f3f01cc8eed3d4bd7cf5cec96331de37f3b63eaeeac34bd6851fc1a51e20c34700478628a94538660d64e834fc36e6617c8ed9
-  data.tar.gz: 1a6437ac77c47f4a991d7c237cf04c86faaa9b61b726426dcf9728b47839c633ddf6edcfa5a9f9f77feac60c8c8f267e3e2e08196d1dde642172f825258761e3
+  metadata.gz: fceb794e899feeaf99ca4aeefcdc9709541425d6b4852c9b1d674cbca82c2a667370321264e109477bb49d2f3ab05dc89f78e8e07b00c04588d83cbe7ade5d2c
+  data.tar.gz: b11e01c3de37fd7f23b455fe9af84aeb8d0055d94c06bfc294072cb1ba7ea218d0cf7b8d3d36f7210c14a09b10dee51247886964087c602cfead72a43e167f26

data/README.md

@@ -54,24 +54,27 @@ class User
 end
 ```
 
-Attributes to be encrypted are declared using the `attr_cipher` class method in your model:
+Add the attribute as a column to your ActiveRecord migration with `_cipher` appended to the attribute name:
 
 ```ruby
 ActiveRecord::Schema.define do
   create_table :users do |t|
-    t.text :security_question
-    t.text :security_answer_cipher
+    t.text :api_key_cipher
   end
 end
+```
+
+Attributes to be encrypted are declared using the `attr_cipher` class method in your model:
 
+```ruby
 class User < ActiveRecord::Base
-  attr_cipher :security_answer
+  attr_cipher :api_key
 end
 ```
 
-**AttrCipher** automatically creates the `#security_answer` getter and `#security_answer=` setter. The getter authomatically decrypts the return value. The setter encrypts the value provided and stores it in the `security_answer_cipher` column.
-CustomCipher
-If you don't want to use the AES-256-CBC cipher, you can provide your own cipher module. Define an object that responds to `encrypt(secret, value)` and `decrypt(secret, value)`:
+In the above example, **AttrCipher** automatically creates the `#api_key` getter and `#api_key=` setter. The getter automatically decrypts the return value. The setter encrypts the value provided and stores it in the `api_key_cipher` column.
+
+If you don't want to use the AES-256-CBC cipher, you can provide your own cipher object. Define an object that responds to `encrypt(secret, value)` and `decrypt(secret, value)` class methods:
 
 ```ruby
 module CustomCipher
@@ -84,7 +87,7 @@ module CustomCipher
 end
 ```
 
-Then pass the custom cipher module to the `cipher` option of the `attr_cipher` class method:
+Then pass the custom cipher object to the `cipher` option of the `attr_cipher` class method:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -112,7 +115,7 @@ bundle exec rake
 
 ## Credit
 
-I would like to thank [Nando Vieira](http://nandovieira.com/) for his [encrypt_attr](https://github.com/fnando/encrypt_attr) gem which provided a lot of the inspiration and framework for **AttrCipher**.
+I would like to thank [Nando Vieira](http://nandovieira.com/) for his [encrypt_attr](https://github.com/fnando/encrypt_attr) gem from which some of the code was derived.
 
 This gem was written and is maintained by [Jurgen Jocubeit](https://github.com/JurgenJocubeit), CEO and President Brightcommerce, Inc.
 

data/lib/attr_cipher/version.rb

@@ -1,11 +1,11 @@
 module AttrCipher
   module VERSION
     MAJOR = 1
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     PRE   = nil
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
     SUMMARY = "AttrCipher v#{STRING}"
-    DESCRIPTION = "Provides functionality to store encrypted attributes using AES-256-CBC."
+    DESCRIPTION = "Provides functionality to transparently store and retrieve encrypted attributes in ActiveRecord models."
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_cipher
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jurgen Jocubeit
@@ -120,7 +120,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.2
-description: Provides functionality to store encrypted attributes using AES-256-CBC.
+description: Provides functionality to transparently store and retrieve encrypted
+  attributes in ActiveRecord models.
 email:
 - support@brightcommerce.com
 executables: []
@@ -158,5 +159,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: AttrCipher v1.1.0
+summary: AttrCipher v1.2.0
 test_files: []