attribute_queryable_encrypted 0.0.2 → 0.0.3

data/attribute_queryable_encrypted.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency "active_support", ">= 3.0"
+  s.add_dependency "activesupport", ">= 3.0.1"
   s.add_development_dependency "rspec"
 end

data/lib/attribute_queryable_encrypted/version.rb

@@ -1,3 +1,3 @@
 module AttributeQueryableEncrypted
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/readme.md

@@ -27,26 +27,34 @@ Example:
 
 ActiveRecord:
 -------------
-ActiveRecord users gain a query method for their prefix digest column:
+ActiveRecord users gain a `find_all_by_[prefix]_[attribute]` query method for their prefix digest column:
 
       HiddenValue.find_all_by_prefix_data("This is ")
       # => [#<HiddenValue id: 1, encrypted_data: "MWE2ODg0ZTVmNTA2M2I3MTZmMWQxZGI3NzA0MjgyMzRj...", prefix_data_digest: "MTgyODBlMWFkNGZiMjAyZTc5Y2FiYTcxODZhYTg1OWM3OGNhOWI...">, #<HiddenValue id: 2, encrypted_data: "WQxZGI3NzANTA2M2I3MTZmMj0MjgyMzRMWE2ODg0ZTVm...", prefix_data_digest: "MTgyODBlMWFkNGZiMjAyZTc5Y2FiYTcxODZhYTg1OWM3OGNhOWI...">]
 
 The returned records - a subset of the full table - can then be iterated over to find an exact match.
 
-A convenience method is provided to do this for you - note that it requires an attribute getter method (but not necessarily a database column) that provides a cleartext match for your query argument:
+A convenience method is provided to do this for you - `find_by_[attribute]`. Note that it requires an attribute getter method (but not necessarily a database column) that provides a cleartext match for your query argument:
 
-      HiddenValue.find_by_prefix_data("This is a string")
+      HiddenValue.find_by_data("This is a string")
       # => #<HiddenValue id: 1, encrypted_data: "MWE2ODg0ZTVmNTA2M2I3MTZmMWQxZGI3NzA0MjgyMzRj...", prefix_data_digest: "MTgyODBlMWFkNGZiMjAyZTc5Y2FiYTcxODZhYTg1OWM3OGNhOWI...">
 
 You'll need to create an appropriately-named prefix digest column on your own.
 
+AttributeQueryableEncrypted is automatically included into ActiveRecord::Base when the gem is installed. To use, just specify the columns you want:
+
+      class HiddenValue < ActiveRecord::Base
+        attr_encrypted :data, :key => { |record| SiteKey + record.salt }
+        attribute_queryable_encrypted :data, :length => "35%", :suffix => "queryable"
+      end
+      
+Your :data accessor (provided here by attr_encrypted) should exist prior to defining the queryable accessor.
 
 Options:
 --------
 * :length     - an integer value length, or percentage expressed as a string ("72%"). Default is "50%".
 * :prefix     - prefix name for the storage accessor. Default is "prefix"
-* :suffix     - suffix name for the storage accessor. Defuault is "suffix"
+* :suffix     - suffix name for the storage accessor. Default is "digest"
 * :encode     - Base64 encode the digest hash, suitable for database persistence. Default is false.
 * :stretches  - an integer number of iterations through the digest algorithm. More will reduce the ease of a precomputed attack. Default is 3.
 * :key        - an optional key to salt the digest algorithm. Default is nil.

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Scott Burton
@@ -18,7 +18,7 @@ date: 2011-11-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: active_support
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -28,7 +28,8 @@ dependencies:
         segments: 
         - 3
         - 0
-        version: "3.0"
+        - 1
+        version: 3.0.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency