encrypt_column 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6526d7cdcee7b1990853ae5eac6e332b50b1c4a1
-  data.tar.gz: a7bbbfcaf6587c768d2f9f29cdeb4ab68939f885
+  metadata.gz: 8dba9f82d1a78c5200ea0d4d117be9c24dbf8a5a
+  data.tar.gz: bb2b83cd4d87086511aa88f78aa1622bd77456bf
 SHA512:
-  metadata.gz: ac1cb1754f319e1b9fcf5ee5f411280f3e0a135729f263094a1717ba2bfb13cc1ab5613b7243510d7190fddfc3d8506b83ed298fbb79aa7fe7c7c35188355088
-  data.tar.gz: df8415142ff9134cc9a0daa062508ec7a7b6d51bfa33a113a31c849b4960573d2cd9974f5740a8e20023451a195668270117ec5f414146c7b564cd0033857cb1
+  metadata.gz: e97baf9e34fa2bad54e02e2bc0a055660ff1980f863c7910b5f29e5d5512b5cc358e7a6534c859e679677173311dff9fa861b551a8389b2108401eddc3d40dec
+  data.tar.gz: 9d6c490a1bbd22fec5d670d29667c146e8c4ce0c7620a22ee8f6fb96a5eaaadf5545a14f659efbbc9694ffc9dc5396f969e25d51844fe373fd71a60f17b9a542

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/README.md

@@ -1,3 +1,8 @@
+[![Gem Version](https://badge.fury.io/rb/encrypt_column.svg)](https://badge.fury.io/rb/encrypt_column)
+[![Build Status](https://travis-ci.org/danlherman/encrypt_column.svg?branch=master)](https://travis-ci.org/danlherman/encrypt_column)
+[![Coverage Status](https://coveralls.io/repos/github/danlherman/encrypt_column/badge.svg?branch=master)](https://coveralls.io/github/danlherman/encrypt_column?branch=master)
+[![Issue Count](https://codeclimate.com/github/danlherman/encrypt_column/badges/issue_count.svg)](https://codeclimate.com/github/danlherman/encrypt_column)
+
 # EncryptColumn
 
 Encrypt any column with an optional hash (using searchable: true) or conditionally (if: Proc)
@@ -5,6 +10,7 @@ also has a failsafe (failsafe: true) feature to write to different db column in
 the database, i.e. `<name>_ciphertext`. This prevents users from accidentally
 commenting out the encrypt declaration and writing plaintext to the database.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,21 +29,7 @@ Or install it yourself as:
 
 ## Usage
 
-Add the following to the top of your model file
-```ruby
-  include EncryptColumn
-```
-
-The gem uses the ENCRYPTION_KEY environment variable for encryption setup:
-```
-  ENV['ENCRYPTION_KEY'] = 'your_encryption_key_goes_here'
-```
-and optionally a HASH_SALT if the searchable option is used.
-```
-  ENV['HASH_SALT'] = 'some_salt'
-```
-
-Then specify the column to be encrypted as so (i.e. encrypt ssn column):
+Specify the column to be encrypted as so (i.e. encrypt ssn column):
 ```ruby
   encrypt :ssn
 ```
@@ -66,6 +58,24 @@ Use all the options combined, like so:
   encrypt :card_number, searchable: true, failsafe: true, if -> (x) { x.card_type == 'credit' }
 ```
 
+The gem uses the ENCRYPTION_KEY environment variable for encryption setup:
+```
+  ENV['ENCRYPTION_KEY'] = 'your_encryption_key_goes_here'
+```
+Alternatively, you can specify the encryption key as an option in the encrypt line:
+```
+  encrypt :ssn, key: 'your_encryption_key_goes_here'
+```
+
+and optionally a HASH_SALT if the searchable option is used.
+```
+  ENV['HASH_SALT'] = 'some_salt'
+```
+Or specify the hash salt in the encrypt line:
+```
+  encrypt :ssn, :searchable, hash_salt: 'your_hash_salt_goes_here', key: 'your_encryption_key_goes_here'
+```
+
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/encrypt_column.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "coveralls"
 
   spec.add_dependency "bcrypt", "~> 3.1"
   spec.add_dependency "activerecord"

data/lib/encrypt_column/decrypt.rb

@@ -1,7 +1,7 @@
 class Decrypt
-  def self.cipher(ciphertext)
-    raise 'Encryption Key Config Missing' unless ENV['ENCRYPTION_KEY'].present?
-    ActiveSupport::MessageEncryptor.new(ENV['ENCRYPTION_KEY']).decrypt_and_verify(ciphertext)
+  def self.cipher(ciphertext, key = ENV['ENCRYPTION_KEY'])
+    raise 'Encryption Key Config Missing' unless key.present?
+    ActiveSupport::MessageEncryptor.new(key).decrypt_and_verify(ciphertext)
   rescue ActiveSupport::MessageVerifier::InvalidSignature
     return ciphertext
   end

data/lib/encrypt_column/encrypt.rb

@@ -1,6 +1,6 @@
 class Encrypt
-  def self.text(plaintext)
-    return raise 'Missing Encryption Key Config' if ENV['ENCRYPTION_KEY'].nil?
-    ActiveSupport::MessageEncryptor.new(ENV['ENCRYPTION_KEY']).encrypt_and_sign(plaintext)
+  def self.text(plaintext, key = ENV['ENCRYPTION_KEY'])
+    return raise 'Missing Encryption Key Config' if key.nil?
+    ActiveSupport::MessageEncryptor.new(key).encrypt_and_sign(plaintext)
   end
 end

data/lib/encrypt_column/encrypt_column.rb

@@ -8,6 +8,8 @@ module ClassMethods
     searchable = options[:searchable] || false
     encrypt_cond = options[:if] || proc { true }
     failsafe = options[:failsafe] || false
+    @@encrypt_column_key = options[:key] || ENV['ENCRYPTION_KEY']
+    @@hash_salt = options[:hash_salt] || ENV['HASH_SALT']
     column = name
     column = "#{name}_ciphertext" if failsafe
     hash_column = "#{name}_hash"
@@ -15,19 +17,19 @@ module ClassMethods
     # getter
     define_method(name) do
       return read_attribute(column) unless instance_eval(&encrypt_cond)
-      Decrypt.cipher(read_attribute(column))
+      Decrypt.cipher(read_attribute(column), @@encrypt_column_key)
     end
 
     # setter
     define_method("#{name}=") do |value|
       return write_attribute(column, value) unless instance_eval(&encrypt_cond)
-      write_attribute(column, Encrypt.text(value))
-      write_attribute(hash_column, Hashed.val(value)) if searchable
+      write_attribute(column, Encrypt.text(value, @@encrypt_column_key))
+      write_attribute(hash_column, Hashed.val(value, @@hash_salt)) if searchable
     end
 
     # search method when searchable specified
     define_singleton_method("with_#{name}") do |value|
-      where(hash_column.to_sym => Hashed.val(value))
+      where(hash_column.to_sym => Hashed.val(value, @@hash_salt))
     end if searchable
   end
 end

data/lib/encrypt_column/hashed.rb

@@ -1,9 +1,9 @@
 require 'digest'
 
 class Hashed
-  def self.val(plaintext)
+  def self.val(plaintext, salt = ENV['HASH_SALT'])
     return nil if plaintext.nil?
-    return raise 'Missing Hash Salt Config' if ENV['HASH_SALT'].nil?
-    Digest::SHA2.hexdigest(ENV['HASH_SALT'] + plaintext.to_s)
+    return raise 'Missing Hash Salt Config' if salt.nil?
+    Digest::SHA2.hexdigest(salt + plaintext.to_s)
   end
 end

data/lib/encrypt_column/version.rb

@@ -1,3 +1,3 @@
 module EncryptColumn
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encrypt_column
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dan Herman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -180,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easily encrypt columns in your app conditionally and with hashed values for