simple_encryptable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e71d844778dbffd0c1dfbceae91340e319ff558576730972d1a8050e48ca55a2
+  data.tar.gz: 7d176835432850b263061f6e358bb9560601de28ca8247defefd0222e975f2bf
+SHA512:
+  metadata.gz: 2c86f5a72c73f580be17e4f8050749ec30f563869a650aab3d2eabc57aa5f54ca28911be9f9a6c2775362734e1f1d1f00e7f8243648bc4e70897d3bde8dba9b8
+  data.tar.gz: 12e93d6966fd12d3eadf9e5bbd5b6c10f2e47a7814fe43c64645dcdfefc33551cf5c3be842b00c1db96a9da9a469f6d55f61b4838d9dab8756e9003ca5c4e509

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# OS files
+.DS_Store

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to this project will be documented in this file. This
+project adheres to [Semantic Versioning](http://semver.org).
+
+
+## [0.1.0] - 2019-08-24
+
+### Changed
+
+- Gem in is 0.1.0 release, basic functionality implemented
+
+[0.1.0]: https://github.com/rkorzeniec/simple_encryptable/compare/...v0.1.0
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_encryptable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 rkorzeniec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# SimpleEncryptable
+
+SimpleEncryptable is based on Rails encryption mechanisms, it is streamline without all the bells and whistles, only the esentials. Heavilly inspired by [Pawel Urbanek](https://pawelurbanek.com/rails-secure-encrypt-decrypt).
+
+## Installation
+
+Add SimpleEncryptable application's Gemfile:
+
+```ruby
+gem 'simple_encryptable'
+```
+or
+```ruby
+gem 'simple_encryptable', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_encryptable
+
+## Usage
+With `ActiveRecord` objects, the database must have `encrypted_[attribute]` column(s). With `PORO` objects, `attr_accessor [attribute]` must be provided.
+
+You must include `SimpleEncryptable`, it is not dynamically loaded into all `ActiveRecord` objects. Providing `secret` and `salt` tokens is crutial. Ideally store them in an .env file or using Rails credentials mechanism.
+
+```ruby
+  class User
+    include SimpleEncryptable
+
+    attr_encryptor :secret_attribute, :another_secret_attribute, secret: 'foo', salt: 'bar'
+  end
+```
+
+## Contributing
+
+1. [Fork it](https://help.github.com/articles/about-forks/)
+2. Clone the project `git clone git@github.com:[YOUR GITHUB USERNAME]/simple_encryptable.git`
+3. `cd simple_encryptable`
+4. Install dependencies, `bundle install`
+5. Create your feature branch `git checkout -b my-new-feature`
+6. Write your feature, along with tests for your changes
+7. Run the tests `rake test`, all must be green
+8. Commit your changes `git commit -am 'Added some feature'`
+9. Push to the branch `git push origin my-new-feature`
+10. Create new [Pull Request](https://help.github.com/articles/creating-a-pull-request/)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_encryptable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_encryptable/encryptor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'active_support/key_generator'
+require 'active_support/message_encryptor'
+
+module SimpleEncryptable
+  class Encryptor
+    class << self
+      def encrypt(value, options)
+        key = key(options)
+        ActiveSupport::MessageEncryptor.new(key).encrypt_and_sign(value)
+      end
+
+      def decrypt(value, options)
+        key = key(options)
+        ActiveSupport::MessageEncryptor.new(key).decrypt_and_verify(value)
+      end
+
+      private
+
+      def key(arguments = {})
+        raise Error, 'Secret option is missing.' if arguments[:secret].to_s.empty?
+        raise Error, 'Salt option is missing' if arguments[:salt].to_s.empty?
+
+        ::ActiveSupport::KeyGenerator
+          .new(arguments[:secret])
+          .generate_key(arguments[:salt], ActiveSupport::MessageEncryptor.key_len).freeze
+      end
+    end
+  end
+end

data/lib/simple_encryptable/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleEncryptable
+  class Error < StandardError; end
+end

data/lib/simple_encryptable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleEncryptable
+  VERSION = '0.1.0'
+end

data/lib/simple_encryptable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'simple_encryptable/error'
+require 'simple_encryptable/encryptor'
+require 'simple_encryptable/version'
+
+module SimpleEncryptable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def attr_encryptable(*attributes)
+      options = attributes.last.is_a?(Hash) ? attributes.pop : {}
+
+      attributes.each do |attribute|
+        define_method("#{attribute}=".to_sym) do |value|
+          return if value.nil?
+
+          public_send(
+            "encrypted_#{attribute}=".to_sym,
+            Encryptor.encrypt(value, options)
+          )
+        end
+
+        define_method(attribute) do
+          value = public_send("encrypted_#{attribute}".to_sym)
+          Encryptor.decrypt(value, options) if value.present?
+        end
+
+        define_method("#{attribute}?".to_sym) do
+          value = send(attribute)
+          value.respond_to?(:empty?) ? !value.empty? : !!value
+        end
+      end
+    end
+  end
+end

data/simple_encryptable.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_encryptable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'simple_encryptable'
+  spec.version = SimpleEncryptable::VERSION
+  spec.authors = ['Robert Korzeniec']
+  spec.email = ['r.korzeniec@gmail.com']
+
+  spec.summary = 'Simple encryption service, without all the extras'
+  spec.description = 'This simple enrtyption service was heavily inspired by https://pawelurbanek.com/rails-secure-encrypt-decrypt'
+
+  spec.license = 'MIT'
+  spec.homepage = 'https://github.com/rkorzeniec/simple_encryptable/'
+  spec.metadata['source_code_uri'] = 'https://github.com/rkorzeniec/simple_encryptable'
+  spec.metadata['changelog_uri'] = 'https://github.com/rkorzeniec/simple_encryptable/CHANGELOG.md'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_dependency 'activesupport', '>= 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.11.3'
+  spec.add_development_dependency 'minitest-profile', '~> 0.0.2'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.3.6'
+  spec.add_development_dependency 'rake', '~> 12.0'
+end

data/test/simple_encryptor/test_encryptor.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+describe SimpleEncryptable::Encryptor do
+  describe '.encrypt' do
+    let(:encrypted_value) do
+      SimpleEncryptable::Encryptor.encrypt('foo', secret: 'bar', salt: 'baz')
+    end
+
+    it { refute_equal('foo', encrypted_value) }
+    it { refute_nil(encrypted_value) }
+
+    it { assert_kind_of(String, encrypted_value) }
+    it { assert_equal(110, encrypted_value.length) }
+
+    it do
+      exception = assert_raises(SimpleEncryptable::Error) do
+        SimpleEncryptable::Encryptor.encrypt('foo', {})
+      end
+      assert_equal('Secret option is missing.', exception.message)
+    end
+  end
+
+  describe '.decrypt' do
+    it do
+      value = SimpleEncryptable::Encryptor.encrypt('foo', secret: 'bar', salt: 'baz')
+
+      assert_equal(
+        'foo',
+        SimpleEncryptable::Encryptor.decrypt(value, secret: 'bar', salt: 'baz')
+      )
+    end
+
+    it do
+      exception = assert_raises(SimpleEncryptable::Error) do
+        SimpleEncryptable::Encryptor.decrypt('foo', {})
+      end
+      assert_equal('Secret option is missing.', exception.message)
+    end
+  end
+end

data/test/simple_encryptor/test_error.rb

@@ -0,0 +1,5 @@
+require 'test_helper'
+
+describe SimpleEncryptable do
+  it { assert_includes(SimpleEncryptable::Error.ancestors, StandardError) }
+end

data/test/simple_encryptor/test_version.rb

@@ -0,0 +1,5 @@
+require 'test_helper'
+
+describe SimpleEncryptable do
+  it { assert_equal('0.1.0', SimpleEncryptable::VERSION) }
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'simple_encryptable'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/profile'
+
+Minitest::Reporters.use!

data/test/test_simple_encryptor.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class User
+  include SimpleEncryptable
+
+  attr_accessor :encrypted_email, :encrypted_password, :encrypted_token
+
+  attr_encryptable :email, secret: 'foo', salt: 'bar'
+  attr_encryptable :password, :token, secret: 'baz', salt: 'zab'
+  attr_encryptable :aux
+
+  def initialize(email: nil, password: nil, token: nil, aux: nil)
+    self.email = email
+    self.password = password
+    self.token = token
+    self.aux = aux
+  end
+end
+
+
+describe SimpleEncryptable do
+  describe '.attr_encryptable' do
+    let(:user) { User.new(email: 'john@example.com') }
+
+    it 'defines writer' do
+      assert(user.respond_to?(:email=))
+    end
+
+    it 'defines reader' do
+      assert(user.respond_to?(:email))
+    end
+
+    it 'defines boolean method' do
+      assert(user.respond_to?(:email?))
+    end
+
+    it 'encrypts email correctly' do
+      decrypted_email = SimpleEncryptable::Encryptor.decrypt(
+        user.encrypted_email, secret: 'foo', salt: 'bar'
+      )
+
+      assert_equal('john@example.com', decrypted_email)
+    end
+
+    it 'encrypted does not equal email' do
+      refute_equal('john@example.com', user.encrypted_email)
+    end
+
+    it 'encrypts as string' do
+      assert_kind_of(String, user.encrypted_email)
+    end
+
+    it 'encrypts always with same length' do
+      assert_equal(138, user.encrypted_email.size)
+    end
+
+    it 'decrypts correctly' do
+      assert_equal('john@example.com', user.email)
+    end
+
+    it 'encrypted when value set' do
+      assert(user.email?)
+    end
+
+    it 'encrypted when value set' do
+      user = User.new
+      refute(user.email?)
+    end
+
+    it 'handles multiple encriptions' do
+      user = User.new(password: 'password', token: 'secret')
+      assert(user.password?)
+      assert_equal('password', user.password)
+      assert(user.token?)
+      assert_equal('secret', user.token)
+    end
+
+    it do
+      exception = assert_raises(SimpleEncryptable::Error) do
+        User.new(aux: 'secret')
+      end
+      assert_equal('Secret option is missing.', exception.message)
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: simple_encryptable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Korzeniec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: minitest-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: This simple enrtyption service was heavily inspired by https://pawelurbanek.com/rails-secure-encrypt-decrypt
+email:
+- r.korzeniec@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_encryptable.rb
+- lib/simple_encryptable/encryptor.rb
+- lib/simple_encryptable/error.rb
+- lib/simple_encryptable/version.rb
+- simple_encryptable.gemspec
+- test/simple_encryptor/test_encryptor.rb
+- test/simple_encryptor/test_error.rb
+- test/simple_encryptor/test_version.rb
+- test/test_helper.rb
+- test/test_simple_encryptor.rb
+homepage: https://github.com/rkorzeniec/simple_encryptable/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rkorzeniec/simple_encryptable
+  changelog_uri: https://github.com/rkorzeniec/simple_encryptable/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Simple encryption service, without all the extras
+test_files: []