encryption_migrator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd96784103c66c4d821f06b7f8035f8f6787f2c9
+  data.tar.gz: fad35f89cbe82fdfa90483f3bc52c45d7d70c3a8
+SHA512:
+  metadata.gz: ccb3863bf1ea76aa2ab196ef90bdc3ae4a3f419601908403c48da33f8853d4b4b49be76711405cccae51ed75b7680946470f0ad56152f0afef62ce9ab2ed6f84
+  data.tar.gz: 919de8765226c7148926c3df45e08cd1596273a6798107169304a9361ad81f8beed72a3af894de3326ab089f47ccca4311dfd95c54c589470661bea1e61a451b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in encryption_migrator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tom Kadwill
+
+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,59 @@
+# EncryptionMigrator
+
+This gem allows you to un-encrypt attr_encrypted fields and convert them back to regular fields.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'encryption_migrator'
+```
+
+## Usage
+Here is the encrypted attribute that I want to remove:
+
+```irb
+2.3.0 :001 > User.first
+  User Load (0.6ms)  SELECT  `users`.* FROM `users`  ORDER BY `users`.`id` ASC LIMIT 1
+ => #<User id: 1, created_at: "2016-02-20 12:27:46", updated_at: "2016-02-20 12:27:46", encrypted_name: "MoVXQ76yxiQPgJ3mdkR81A==\n">
+```
+
+1) Remove `attr_encrypted` line from models:
+```ruby
+class User < ActiveRecord::Base
+  attr_encrypted :name, :key => 'a secret key', :attribute => 'encrypted_name' # => remove this line
+end
+```
+
+2) Add a migration to un-encrypt columns:
+```ruby
+class UnencryptFields < ActiveRecord::Migration
+  def up
+    unencrypt_field :users, :name, key: 'a secret key'
+  end
+end
+```
+
+Now you can see that the field has been unencrypted:
+
+```irb
+2.3.0 :001 > User.first
+  User Load (0.4ms)  SELECT  `users`.* FROM `users`  ORDER BY `users`.`id` ASC LIMIT 1
+ => #<User id: 1, created_at: "2016-02-20 12:27:46", updated_at: "2016-02-20 12:27:46", name: "tom">
+```
+
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/encryption_migrator.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+
+# RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "encryption_migrator"
+
+# 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

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/encryption_migrator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encryption_migrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "encryption_migrator"
+  spec.version       = EncryptionMigrator::VERSION
+  spec.authors       = ["Tom Kadwill"]
+  spec.email         = ["tomkadwill@gmail.com"]
+
+  spec.summary       = %q{Migration helpers for encryption}
+  spec.description   = %q{Add methods to ActiveRecord::Migration that help with encryption}
+  spec.homepage      = "http://github.com/tomkadwill/encryption_migrator"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/encryption_migrator.rb

@@ -0,0 +1,40 @@
+require "encryption_migrator/version"
+
+module EncryptionMigrator
+  def self.constant_for(model)
+    model.to_s.singularize.camelize.constantize
+  end
+
+  def self.define_class_with_encrypted(const, attr, encrypted_attr, key)
+    const.class_eval do
+      attr_encrypted attr, key: key, attribute: encrypted_attr
+    end
+  end
+
+  def self.decrypt_and_update_row(row, const, column, key)
+    encrypted_sym = encrypted_column_sym(column)
+    define_class_with_encrypted(const, column, encrypted_sym, key)
+    attr = const.decrypt(column, row.read_attribute(encrypted_sym))
+    row.update_column(:"#{column}", attr)
+  end
+
+  def self.encrypted_column_sym(column)
+    :"encrypted_#{column}"
+  end
+end
+
+class ActiveRecord::Migration
+  def unencrypt_field(model, column, key:)
+    const = EncryptionMigrator.constant_for(model)
+    encrypted_sym = :"encrypted_#{column}"
+
+    add_column model, column, :string
+    const.reset_column_information
+
+    const.all.each do |row|
+      EncryptionMigrator.decrypt_and_update_row(row, const, column, key)
+    end
+
+    remove_column model, encrypted_sym
+  end
+end

data/lib/encryption_migrator/version.rb

@@ -0,0 +1,3 @@
+module EncryptionMigrator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: encryption_migrator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Kadwill
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Add methods to ActiveRecord::Migration that help with encryption
+email:
+- tomkadwill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- encryption_migrator.gemspec
+- lib/encryption_migrator.rb
+- lib/encryption_migrator/version.rb
+homepage: http://github.com/tomkadwill/encryption_migrator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Migration helpers for encryption
+test_files: []