attr_cipher 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2170d301034202dd5c1e79cfd07ae541e9eca46
-  data.tar.gz: 779477637d8623cefc95241dead741ff29dd7a15
+  metadata.gz: ed7ac40e52f0199687e0ab1c37631bc1c9e467cb
+  data.tar.gz: 22672d14a563134ae6f19ad3b1e57e3afc8180a8
 SHA512:
-  metadata.gz: 0f387a996b632e9822b611ee745cdc47a776d036a8e34951ce24566eb9e24771bc48f57be3376d30a375434942d9cb426055270d27e19a56b6bf1bbda506447f
-  data.tar.gz: e899394a28b337d284bf1ac6e8bcf6c718ef14bc96a542b20a1f5a3d5ab6c344592e751268db1ad94c5f2acfe1bbf5c2d9b7d5a37473946fbfd373004881fe35
+  metadata.gz: e5a86beddafd05bb1ecf5b35820f798b8609f32e06fbb97741f74acf7d5a6b00a97459604ecf45cf62e7abd7185552a6a622119343b661fd2e39bcac050f921f
+  data.tar.gz: 68cdbc62e3b4cb5e4871a715444740a31143129c35e9474a2d9de11c65ab85ac10efc0198f8d3925f2877e047b7b3f3b45d202f046ca5d0f24e66f1050c444ea

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Change Log
 
+##v1.5.0
+- Created `AttrCipher::SecretException` class.
+- Updated FactoryGirl to FactoryBot (dev dependency).
+- Updated Codecov to ~> 0.16.1 (dev dependency).
+- Added Ruby 2.4.4 to Travis CI config.
+- Switched serialize option to use Marshal instead of YAML.
+- Refactored cipher.
+
 ##v1.4.0
-- Added serialize option to attr_cipher class method. Can now seamlessly handle value types other than just strings.
+- Added serialize option to `attr_cipher` class method. Can now seamlessly handle value types other than just strings.
 
 ##v1.3.1
 - Fixed failing spec.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 Brightcommerce, Inc. All rights reserved.
+Copyright 2017-2018 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

@@ -29,18 +29,18 @@ Development/Test:
 - rake (~> 10.5)
 - rspec (~> 3.4)
 - sqlite3 (~> 1.3)
-- simplecov (~> 0.11.2)
-- factory_girl (~> 4.5)
+- simplecov (~> 0.16.1)
+- factory_bot (~> 4.8.2)
 
 ## Compatibility
 
-Tested with Ruby 2.3.1p112 (2016-04-26 revision 54768) [x86_64-darwin15] against ActiveRecord 5.1.3 on macOS Sierra 10.12.6 (16G29).
+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).
 
 **AttrCipher** uses OpenSSL to perform the cipher.
 
 ## Usage
 
-**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`).
+**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']
@@ -107,7 +107,7 @@ Using the serialize option will cause the value to be serialized and deserialize
 
 ## Tests
 
-Tests are written using Rspec, FactoryGirl and Sqlite3. There are 15 examples with 100% code coverage.
+Tests are written using Rspec, FactoryBot and Sqlite3. There are 17 examples with 100% code coverage.
 
 To run the tests, execute the default rake task:
 
@@ -135,4 +135,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright 2017 Brightcommerce, Inc.
+Copyright 2017-2018 Brightcommerce, Inc.

data/lib/attr_cipher/attr_cipher.rb

@@ -1,16 +1,9 @@
 require 'active_record'
 require 'active_support/all'
-require 'yaml'
 
 module AttrCipher
   extend ActiveSupport::Concern
 
-  class Error < ::StandardError
-  end
-
-  class SecretTooShortException < Error
-  end
-
   class << self
     attr_accessor :cipher
     attr_reader :secret
@@ -36,16 +29,14 @@ module AttrCipher
       define_method attribute do
         value = instance_variable_get("@#{attribute}")
         cipher_value = send("#{attribute}_cipher") unless value
-        value = cipher.decrypt(secret, cipher_value) if cipher_value
-        value = YAML::load(value) if serialize
+        value = cipher.decrypt(secret, cipher_value, serialize) if cipher_value
         instance_variable_set("@#{attribute}", value)
       end
 
       define_method "#{attribute}=" do |value|
         instance_variable_set("@#{attribute}", value)
-        value = YAML::dump(value) if serialize
         send("#{attribute}_cipher=", nil)
-        send("#{attribute}_cipher=", cipher.encrypt(secret, value)) if value && value != ""
+        send("#{attribute}_cipher=", cipher.encrypt(secret, value, serialize)) if value && value != ""
       end
     end
   end

data/lib/attr_cipher/cipher.rb

@@ -6,10 +6,9 @@ module AttrCipher
   class Cipher
     ALGORITHM = "AES-256-CBC".freeze
 
-    attr_reader :secret
-
-    def initialize(secret)
+    def initialize(secret = nil, serialize = false)
       @secret = secret
+      @serialize = serialize
     end
 
     def cipher(mode, value)
@@ -20,34 +19,32 @@ module AttrCipher
       cipher.update(value) + cipher.final
     end
 
-    def decode(value)
-      Base64.decode64(value)
-    end
-
     def decrypt(value)
-      raise ::AttrCipher::SecretTooShortException.new(
-        "Secret must have at least 100 characters"
-      ) if @secret.size < 100
-      cipher(:decrypt, decode(value))
-    end
-
-    def encode(value)
-      Base64.encode64(value).chomp
+      if @secret.nil? || (@secret.respond_to?(:size) && @secret.size < 100)
+        raise SecretException.new("Secret not set or must have at least 100 characters.")
+      else
+        decoded = Base64.decode64(value)
+        decrypted = cipher(:decrypt, decoded)
+        @serialize ? Marshal.load(decrypted) : decrypted
+      end
     end
 
     def encrypt(value)
-      raise ::AttrCipher::SecretTooShortException.new(
-        "Secret must have at least 100 characters"
-      ) if @secret.size < 100
-      encode(cipher(:encrypt, value))
+      if @secret.nil? || (@secret.respond_to?(:size) && @secret.size < 100)
+        raise SecretException.new("Secret not set or must have at least 100 characters.")
+      else
+        data = @serialize ? Marshal.dump(value) : value.to_s
+        encrypted = cipher(:encrypt, data)
+        Base64.encode64(encrypted).chomp
+      end
     end
 
-    def self.decrypt(secret, value)
-      new(secret).decrypt(value)
+    def self.decrypt(secret, value, serialize = false)
+      new(secret, serialize).decrypt(value)
     end
 
-    def self.encrypt(secret, value)
-      new(secret).encrypt(value)
+    def self.encrypt(secret, value, serialize = false)
+      new(secret, serialize).encrypt(value)
     end
   end
 end

data/lib/attr_cipher/secret_exception.rb

@@ -0,0 +1,4 @@
+module AttrCipher
+  class SecretException < ::StandardError
+  end
+end

data/lib/attr_cipher/version.rb

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

data/lib/attr_cipher.rb

@@ -1,3 +1,4 @@
 require 'attr_cipher/version'
+require 'attr_cipher/secret_exception'
 require 'attr_cipher/cipher'
 require 'attr_cipher/attr_cipher'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_cipher
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jurgen Jocubeit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-27 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 4.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.16.1
 description: Provides functionality to transparently store and retrieve encrypted
   attributes in ActiveRecord models.
 email:
@@ -122,12 +122,13 @@ files:
 - lib/attr_cipher.rb
 - lib/attr_cipher/attr_cipher.rb
 - lib/attr_cipher/cipher.rb
+- lib/attr_cipher/secret_exception.rb
 - lib/attr_cipher/version.rb
 homepage: https://github.com/brightcommerce/attr_cipher
 licenses:
 - MIT
 metadata:
-  copyright: Copyright 2017 Brightcommerce, Inc.
+  copyright: Copyright 2017-2018 Brightcommerce, Inc.
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -144,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: AttrCipher v1.4.0
+summary: AttrCipher v1.5.0
 test_files: []