has_secure_attribute 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 791d8b4c2ad53a2ab79fe663e7e6e7e19b355e90
-  data.tar.gz: ecebf104e0f461d50c064d86d9441581f6950b9f
+  metadata.gz: 407ec97a134d4ff2d2ecc448a0c2b538b51945f9
+  data.tar.gz: 26c2a1fef2541a2954e468714effe93cf6fbe8cd
 SHA512:
-  metadata.gz: 758ae145496f31c48766909bffd81d03dd316a458e3bea9d6027061de6bf2b6437d94e58fb6f57db087d9579e003a98b2b70f8760cc74fd9ab37f28eee32e7b1
-  data.tar.gz: 42305c94aede34da459b9f0611ca57a157808c5556027c3225628651485adc5107a9d53893de1d950cf50a46c2daad708120fd88dda4e48ddb6e9ff3f2b45771
+  metadata.gz: 3851f367a95043922611cf6f73589e1ddcb5f0e14c4eefe64425ed243ebea0633af5571ce6d830862032746daef3352812a36a20818bd917cf694b1ae0448aab
+  data.tar.gz: e22119c5300c2128acaa8dc803dec34e0f0b417770d595d89087ea83fbebed59d4a71a999fb15da96f48a55f073475c1e3badd57d611ee0ac45726df373a89e1

data/README.md

@@ -1,2 +1,46 @@
-Under construction
-==================
+`has_secure_attribute`
+======================
+
+Why have `has_secure_password` and not any attribute that you want. I believe that, quite often, we want to one-way encrypt one attribute and authenticate against its value, and this is not only the `password` case.
+
+Requires
+--------
+
+`ActiveRecord` and `BCrypt`
+
+Install
+-------
+
+`gem install 'has_secure_attribute'`
+
+or in your `Gemfile`
+
+`gem 'has_secure_attribute'` and then `bundle`
+
+Use it
+------
+
+    class User < ActiveRecord::Base
+      has_secure_security_answer
+    end
+
+In the above example:
+
+* Your should have a `users` table that has one column: `security_answer_digest`.
+* It creates a reader: `security_answer`.
+* It creates a writer: `security_answer=(value)` which basically saves the security answer given into the database on column `security_answer_digest` but is saves it encrypted.
+* It adds some validations (if you want to avoid having these validations: `has_secure_security_answer :validations => false`).
+  * It creates a confirmation validation on `security_answer` but only if `security_answer` is given (for confirmation validations see [this](http://http://guides.rubyonrails.org/active_record_validations.html#confirmation)).
+  * It creates a presence validation on `security_answer` but only on create.
+  * It creates a presence validation on `security_answer_confirmation` but only if `security_answer` has been given.
+  * It raises an exception if `security_answer_digest` is empty on create.
+* It defines the method `authenticate_security_answer(answer_to_authenticate)` which returns `false` if the answer given does not correspond to the saved digest, or returns the object instance itself if it does.
+
+Do you want to test it?
+------------------------
+
+`bundle exec rake`
+
+__Note:__ Testing works with a MySQL database. So, you need to have MySQL installed. Other than that, everything else needed to run the tests is done automatically. (db create, db migrate e.t.c.)
+
+

data/lib/has_secure_attribute/version.rb

@@ -1,3 +1,3 @@
 module HasSecureAttribute
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_secure_attribute
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Panayotis Matsinopoulos