encryptable_attributes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5daff2b8fcca8a9a4e4b924fdfcdcc98489c6aac5babfb131fcc0974972824c2
-  data.tar.gz: 9dc2f517d69e1444c433cd067a3e023250fe245c6f74bbfca83817a6f19dc6b5
+  metadata.gz: 97e30bc4d67879654d302bcfa054d8ddcedb39ec9c6e97d89c97a7cad65f1605
+  data.tar.gz: e8e1ee98d330083714721b1324dc72d7eedd0cd3f7d526f3cd4a2b39c6f18fea
 SHA512:
-  metadata.gz: 509d8ed356ac43e3c181a44ce6e8e01421dc2d16945621b124eb5210ab28044c17e880d5b57f59b23528873148adf81e6c91694526db8ba56358f1b95373faf4
-  data.tar.gz: 2b43868c8aa86cc44ae78c07c2a4e224232626a367db16ac1fa4831dec83af550bcefc1fcc4e051a835d37a6f55a414cc8222ec8bbdd5cee4b7033ec8c25d396
+  metadata.gz: bc858805e483b1018f54024032a31153aa2767061d3837b0647edb1ac47df61395531c40ea28dd482d80626a3d9c4aacc187ddd1e4fb570f156b7cb816ce79af
+  data.tar.gz: 986d1b553aeeb75b8e922dbbfeeb79762f4c1ec9545396bf407028e1644a5d3d1da4a609271e82177c68abc03de9eedb08381568b4fc7e61de907f1416625ce7

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/db/*.sqlite3
+/db/*.sqlite3
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+* Added `CHANGELOG.md`
+* Speficy dependency versions
+* Reduce loaded dependencies
+* Support reading the encryption key at runtime via method call
+
+## EncryptableAttributes 0.1.0 (May 12, 2018)
+
+* Initial release

data/README.md

@@ -1,6 +1,6 @@
-# EncryptableAttributes [![Build Status](https://travis-ci.org/nsommer/encryptable_attributes.svg?branch=master)](https://travis-ci.org/nsommer/encryptable_attributes)
+# EncryptableAttributes [![Build Status](https://travis-ci.org/nsommer/encryptable_attributes.svg?branch=master)](https://travis-ci.org/nsommer/encryptable_attributes) [![Depfu](https://badges.depfu.com/badges/0aa2b808a183e56fa830b90ba072d137/overview.svg)](https://depfu.com/github/nsommer/encryptable_attributes)
 
-With the `encryptable_attributes` gem, you transparently encrypt and decrypt attributes of an ActiveRecord model. It uses `ActiveSupport::MessageEncryptor` to encrypt and decrypt values and provides a simple class-level DSL for configuration.
+With the `encryptable_attributes` gem, you transparently encrypt and decrypt attributes of an ActiveRecord model. It uses [`ActiveSupport::MessageEncryptor`](http://api.rubyonrails.org/classes/ActiveSupport/MessageEncryptor.html) to encrypt and decrypt values and provides a simple class-level DSL for configuration.
 
 ## Installation
 
@@ -33,6 +33,25 @@ end
 
 ActiveRecord models use an `attributes` hash internally to keep attributes. EncryptablesAttributes overrides the accessor methods for the corresponding attributes and encrypts given values before storing them in the `attributes` hash and decrypts them when reading them from the `attributes` hash.
 
+In addition to setting the encryption key statically as shown in the example above, you can also read the key dynamically per model instance via a method call. It looks like this.
+
+```ruby
+class Message < ActiveRecord::Base
+  include EncryptableAttributes::Base
+  
+  secure_key :individual_message_key
+  secure_attrs :title, :body
+  
+  private
+
+    # Use this to build a message key from other model attributes
+    # or to set it from content fed from outside.
+    def individual_message_key
+      'secret'
+    end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/db/migrate/20180512123720_add_message_test_model.rb

@@ -0,0 +1,8 @@
+class AddMessageTestModel < ActiveRecord::Migration[5.2]
+  def change
+    create_table :messages do |t|
+      t.string :title
+      t.string :body
+    end
+  end
+end

data/db/migrate/{20180512123720_add_user_test_model.rb → 20180512162331_add_user_test_model.rb}

@@ -2,7 +2,7 @@ class AddUserTestModel < ActiveRecord::Migration[5.2]
   def change
     create_table :users do |t|
       t.string :name
-      t.string :secret_info
+      t.string :salary
     end
   end
 end

data/db/schema.rb

@@ -10,11 +10,16 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2018_05_12_123720) do
+ActiveRecord::Schema.define(version: 2018_05_12_162331) do
+
+  create_table "messages", force: :cascade do |t|
+    t.string "title"
+    t.string "body"
+  end
 
   create_table "users", force: :cascade do |t|
     t.string "name"
-    t.string "secret_info"
+    t.string "salary"
   end
 
 end

data/encryptable_attributes.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", "~> 5"
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "standalone_migrations"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord", "~> 5"
+  spec.add_development_dependency "standalone_migrations", "~> 5.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
 end

data/lib/encryptable_attributes/base.rb

@@ -1,7 +1,15 @@
+require 'active_support/concern'
+require 'active_support/core_ext/class'
+require 'active_support/message_encryptor'
+
 module EncryptableAttributes
   module Base
     extend ActiveSupport::Concern
 
+    included do
+      class_attribute :_secure_key
+    end
+
     # Override ActiveRecord accessor
     def [](key)
       send key
@@ -14,7 +22,7 @@ module EncryptableAttributes
 
     class_methods do
       def secure_key(key)
-        @@secure_key = key
+        self._secure_key = key
       end
 
       def secure_attrs(*attr_names)
@@ -35,12 +43,22 @@ module EncryptableAttributes
       def new_crypt
         len    = ActiveSupport::MessageEncryptor.key_len
         salt   = SecureRandom.random_bytes(len)
-        key    = ActiveSupport::KeyGenerator.new(@@secure_key).generate_key(salt, len)
+        key    = ActiveSupport::KeyGenerator.new(static_or_dynamic_secure_key).generate_key(salt, len)
         @crypt = ActiveSupport::MessageEncryptor.new(key)
       end
 
       def crypt
         @crypt ||= new_crypt
       end
+
+      def static_or_dynamic_secure_key
+        if self._secure_key.is_a?(String)
+          self._secure_key
+        elsif self._secure_key.is_a?(Symbol)
+          send self._secure_key
+        else
+          raise ArgumentError, "#{self._secure_key} bust be of type String or Symbol, but is of type #{self._secure_key.class}"
+        end
+      end
   end
 end

data/lib/encryptable_attributes/version.rb

@@ -1,3 +1,3 @@
 module EncryptableAttributes
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/encryptable_attributes.rb

@@ -1,7 +1,2 @@
-require "active_support/all"
-
 require "encryptable_attributes/version"
 require "encryptable_attributes/base"
-
-module EncryptableAttributes
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: encryptable_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nils Sommer
@@ -14,16 +14,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -70,44 +70,44 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: standalone_migrations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 description: 
 email:
 - mail@nilssommer.de
@@ -118,15 +118,16 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - db/config.yml
-- db/migrate/20180512123720_add_user_test_model.rb
+- db/migrate/20180512123720_add_message_test_model.rb
+- db/migrate/20180512162331_add_user_test_model.rb
 - db/schema.rb
 - encryptable_attributes.gemspec
 - lib/encryptable_attributes.rb

data/Gemfile.lock

@@ -1,87 +0,0 @@
-PATH
-  remote: .
-  specs:
-    encryptable_attributes (0.1.0)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
-      arel (>= 9.0)
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
-    erubi (1.7.1)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    loofah (2.2.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.5)
-    rack-test (1.0.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
-    sqlite3 (1.3.13)
-    standalone_migrations (5.2.5)
-      activerecord (>= 4.2.7, < 5.3.0)
-      railties (>= 4.2.7, < 5.3.0)
-      rake (>= 10.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  bundler (~> 1.16)
-  encryptable_attributes!
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  sqlite3
-  standalone_migrations
-
-BUNDLED WITH
-   1.16.1