attr_cipher 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed7ac40e52f0199687e0ab1c37631bc1c9e467cb
-  data.tar.gz: 22672d14a563134ae6f19ad3b1e57e3afc8180a8
+SHA256:
+  metadata.gz: a212d3fcf9f7735054f2563181425df265981ebb1e5a943ebca4040f2b51d8ac
+  data.tar.gz: 1e4a4d0e5130df90026435218059398fe2db5edcb3dc67eb4fee626208265bac
 SHA512:
-  metadata.gz: e5a86beddafd05bb1ecf5b35820f798b8609f32e06fbb97741f74acf7d5a6b00a97459604ecf45cf62e7abd7185552a6a622119343b661fd2e39bcac050f921f
-  data.tar.gz: 68cdbc62e3b4cb5e4871a715444740a31143129c35e9474a2d9de11c65ab85ac10efc0198f8d3925f2877e047b7b3f3b45d202f046ca5d0f24e66f1050c444ea
+  metadata.gz: bfad87fc435b793fd26f8d9d179d8d657b556b15665e1d1be56781171b424ea24f4981bc5029be2831a3ab08968c4de1a80424810ddc61797c6791e5b3c84c67
+  data.tar.gz: 6643a44ccead56acaa9db1a61defd994b90f77c25aeeda3e1d040dc9b0211b94fa7ddf2d6a06524ac4c306a734369d0d5534d27a678aad511c16830a75c42ee0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+##v2.0.0
+- Removed automatic inclusion in ActiveRecord::Base class, now optional.
+- Added Ruby 2.5.3 to Travis CI config.
+- Tested against ActiveRecord 5.2.2.
+- Updated Rspec to 3.7.0 (dev dependency).
+- Updated Sqlite to ~> 1.3.13 (dev dependency).
+- Updated README.
+
 ##v1.5.0
 - Created `AttrCipher::SecretException` class.
 - Updated FactoryGirl to FactoryBot (dev dependency).

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2018 Brightcommerce, Inc. All rights reserved.
+Copyright 2017-2019 Brightcommerce, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,12 +9,16 @@
 
 Using the same secret for both encryption of plaintext and decryption of ciphertext, **AttrCipher** uses a method that is known as a symmetric-key algorithm, specifically the Advanced Encryption Standard Cipher-Block Chaining algorithm with a 256bit key (AES-256-CBC). However, you can provide your own cipher algorithm to **AttrCipher**, if you prefer. As a side note, 256bit AES is what the United States government uses to encrypt information at the Top Secret level.
 
+***Version 2.0.0+ Breaking Changes***
+
+_Please note:_ AttrCipher is **no longer automatically included** in models anymore. You will need to either `require attr_cipher/active_record` in an initializer, or `include AttrCipher` in each model using the `attr_cipher` macro. This is to prevent pollution of ActiveRecord::Base. See [usage](#usage) section below for details.
+
 ## Installation
 
 To install add the following line to your `Gemfile`:
 
 ``` ruby
-gem 'attr_cipher'
+gem 'attr_cipher', '~> 2.0'
 ```
 
 And run `bundle install`.
@@ -26,15 +30,15 @@ Runtime:
 - activesupport (>= 4.2.6)
 
 Development/Test:
-- rake (~> 10.5)
-- rspec (~> 3.4)
-- sqlite3 (~> 1.3)
+- rake (~> 10.5.0)
+- rspec (~> 3.7.0)
+- sqlite3 (~> 1.3.13)
 - simplecov (~> 0.16.1)
 - factory_bot (~> 4.8.2)
 
 ## Compatibility
 
-Tested with Ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-darwin16] against ActiveRecord 5.1.4 on macOS Sierra 10.13.4 (17E202).
+Tested with Ruby 2.5.3p105 (2018-10-18 revision 65156) [x86_64-darwin18] against ActiveRecord 5.2.2 on macOS Mojave 10.14 (18A391).
 
 **AttrCipher** uses OpenSSL to perform the cipher.
 
@@ -43,14 +47,17 @@ Tested with Ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-darwin16] against
 **AttrCipher** uses a global secret by default and it must be at least 100 characters or more. You can set the secret by setting `AttrCipher.secret` (e.g. `$ openssl rand -hex 50`).
 
 ```ruby
-AttrCipher.secret = ENV['SECRET_KEY']
+# config/initializers/attr_cipher.rb
+AttrCipher.secret = Rails.application.secrets.secret_key_base
 ```
 
 You can also set the secret on a per attribute basis.
 
 ```ruby
 class User
-  attr_cipher :api_key, secret: ENV['USER_API_KEY_SECRET']
+  include AttrArray
+
+  attr_cipher :api_key, secret: Rails.application.secrets.secret_key_base
 end
 ```
 
@@ -64,6 +71,15 @@ ActiveRecord::Schema.define do
 end
 ```
 
+To include AttrCipher in all models, add the following to an initializer:
+
+```ruby
+# config/initializers/attr_cipher.rb
+require 'attr_cipher/active_record'
+```
+
+You then don't need to `include AttrCipher` in any model.
+
 Attributes to be encrypted are declared using the `attr_cipher` class method in your model:
 
 ```ruby
@@ -135,4 +151,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright 2017-2018 Brightcommerce, Inc.
+Copyright 2017-2019 Brightcommerce, Inc. All rights reserved.

data/lib/attr_cipher/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send :include, AttrCipher

data/lib/attr_cipher/attr_cipher.rb

@@ -41,5 +41,3 @@ module AttrCipher
     end
   end
 end
-
-ActiveRecord::Base.send :include, AttrCipher

data/lib/attr_cipher/version.rb

@@ -1,7 +1,7 @@
 module AttrCipher
   module VERSION
-    MAJOR = 1
-    MINOR = 5
+    MAJOR = 2
+    MINOR = 0
     TINY  = 0
     PRE   = nil
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_cipher
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jurgen Jocubeit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +120,7 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/attr_cipher.rb
+- lib/attr_cipher/active_record.rb
 - lib/attr_cipher/attr_cipher.rb
 - lib/attr_cipher/cipher.rb
 - lib/attr_cipher/secret_exception.rb
@@ -145,8 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: AttrCipher v1.5.0
+summary: AttrCipher v2.0.0
 test_files: []