redaction 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8111bc43a6fc2d4dbd6224b80664d7410bf62780c6d609b5532c9043ee3032fa
+  data.tar.gz: 8ab8dcfa4d70432f19c179eb77e4f9093a12b1f8261c7aad1fe0800e372bda30
+SHA512:
+  metadata.gz: d2479196f571dfc27a21f48147d488b08140eaa4afa0821467d0d5d04b4b3f9ae3295c8db4b316d70fe7be39848de8925a6ebb84cc5533deed1c6171ddf79e14
+  data.tar.gz: 135321f897acb08d60cac36b3c8413ea9bd2c42280cee09bc30ac9ee999099009c7c4f8d735c128f8b1326e64d9beac1107e8d959748ea36eaba956373a9abb2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Drew Bragg
+
+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,130 @@
+# Redaction
+[![Tests](https://github.com/DRBragg/redaction/actions/workflows/ci.yml/badge.svg)](https://github.com/DRBragg/redaction/actions/workflows/ci.yml)
+
+Easily redact your ActiveRecord Models. Great for use when you use production data in staging or dev. Simply set the redaction type of the attributes you want to redact and run via the [console](#via-the-rails-console) or the included [rake task](#via-rake-task).
+
+`redaction` uses [Faker](https://github.com/faker-ruby/faker) under the hood to generate redacted data.
+
+## Installation
+**NOTE:** This is currently an unreleased library very much in beta. Use at your own risk.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "redaction", git: "https://github.com/drbragg/redaction.git"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+### Redacting a Model
+To "redact" a models attribute add:
+```ruby
+class Model < ApplicationRecord
+  redacts :<attribute>, with: :<redactor_type>
+end
+```
+`<redactor_type>` can be a symbol, proc, or custom class. See [Redactor Types](#redactor-types) for more information.
+
+`redacts` accepts multiple attributes, provided they all use the same redactor type. i.e.:
+```ruby
+class User < ApplicationRecord
+  redacts :first_name, :last_name, with: :name
+end
+```
+### Redactor Types
+
+#### Built in
+`redaction` comes with a few different redactor types:
+| Type         | Generates    |
+|:------------:|:------------:|
+| `:basic`     | A Sentence   |
+| `:basic_html`| An HTML snippet with `strong` and `em` tags wrapping some of the words  |
+| `:email`     | A safe (will not send) email address |
+| `:html`      | Multiple HTML Paragraphs with a random amount of link tags, `strong` tags, and `em` tags  |
+| `:name`      | A person first/last name |
+| `:phone`     | A phone number |
+| `:text`      | Multiple paragraphs |
+
+To use a built in redactor type set the `with:` option of a `redacts` call to the appropriate symbol.
+
+#### Using a Proc
+A Proc `:with` value is given two arguments: the record being redacted, and a hash with the :attribute key-value pair.
+```ruby
+class Model < ApplicationRecord
+  redacts :attribute, with: -> (record, data) { record.id }
+end
+```
+would cause `Model#attribute` to be set to `Model#id` after redaction
+#### Using a custom class
+Add a folder in `app/`, `redactors/` is suggested, and put custom redactors in there. A custom redactor should inherit from `Redaction::Types::Base` and should define a `content` method. Like so:
+```ruby
+# app/redactors/custom_redactor.rb
+class CustomRedactor < Redaction::Types::Base
+  def content
+    "Some Custom Value"
+  end
+end
+```
+and then to use it:
+```ruby
+class Model < ApplicationRecord
+  redacts :attribute, with: CustomRedactor
+end
+```
+would cause `Model#attribute` to be set to "Some Custom Value" after redaction.
+Custom redactor types also get access to the record being redacted via `record`, and a hash with the `:attribute` key-value pair via `data`
+
+### Preforming a Redaction
+There are two ways to preform the redaction.
+
+#### Via Rake Task
+```bash
+rails redaction:redact
+```
+This will target **all** the models with redacted attributes. To target specific models run:
+```bash
+rails redaction:redact MODELS=User,Post
+```
+This will only redact the `User` and `Post` Models
+
+#### Via the Rails Console
+```ruby
+Redaction.redact!
+```
+This will target **all** the models with redacted attributes. To target specific models run:
+```ruby
+Redaction.redact!(models: ["User", "Post"])
+```
+This will only redact the `User` and `Post` Models
+
+#### Validations and Callbacks
+By default, preforming a redaction does not trigger validations or update the `updated_at` attribute.
+
+Callbacks can be skipped with the `:redacting?` method. i.e.:
+```ruby
+class User < ApplicationRecord
+  after_save :do_something, unless: :redacting?
+
+  redacts :first_name, :last_name, with: :name
+end
+```
+
+## Roadmap
+- [ ] Raise Error or at least a message when skipping a passed in Model
+- [ ] Configuration (touch, email domains, etc)
+- [ ] Better Documentation
+- [ ] More types
+- [ ] Release v1.0 as a real gem
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at [drbragg/redaction](https://github.com/drbragg/redaction). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/DRBragg/redaction/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgments
+`redaction` leans heavily on the awesome [Faker gem](https://github.com/faker-ruby/faker).  If not for their hard work this would be a much different and probably more complex project.  If you like `redaction` please consider sending them a thank you or contributing to the gem.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+load "tasks/redaction.rake"

data/lib/redaction/railtie.rb

@@ -0,0 +1,13 @@
+module Redaction
+  class Railtie < ::Rails::Railtie
+    initializer "redaction.initialize" do
+      ActiveSupport.on_load(:active_record) do
+        include Redaction::Redactable
+      end
+    end
+
+    rake_tasks do
+      load "tasks/redaction.rake"
+    end
+  end
+end

data/lib/redaction/redactable.rb

@@ -0,0 +1,44 @@
+module Redaction
+  module Redactable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :redacted_attributes, instance_writer: false
+
+      after_commit do
+        @_redacting = false
+      end
+
+      def redact!
+        @_redacting = true
+        redacted_attributes.each_pair do |redactor_type, attributes|
+          redactor = Redaction.find(redactor_type)
+
+          attributes.each do |attribute|
+            if send(attribute).present?
+              send("#{attribute}=", redactor.call(self, {attribute: attribute}))
+            end
+          end
+        end
+
+        save!(validate: false, touch: false, context: :redaction)
+      end
+
+      def redacting?
+        !!@_redacting
+      end
+    end
+
+    class_methods do
+      def redacts(*attributes, with: :basic)
+        self.redacted_attributes ||= Hash.new { |hash, key| hash[key] = [] }
+
+        self.redacted_attributes[with] += attributes
+      end
+
+      def has_redacted_content?
+        self.redacted_attributes&.any?
+      end
+    end
+  end
+end

data/lib/redaction/redactor.rb

@@ -0,0 +1,46 @@
+require "ruby-progressbar"
+
+module Redaction
+  class Redactor
+    attr_reader :models_to_redact
+
+    def initialize(models: nil)
+      @models_to_redact = set_models(models)
+    end
+
+    def redact!
+      models_to_redact.each do |model|
+        next if model.redacted_attributes.empty?
+
+        model_progress = progress_bar(model.name, model.count)
+
+        model.all.unscoped.find_each do |record|
+          record.redact!
+          model_progress.increment
+        end
+      end
+    end
+
+    private
+
+    def set_models(models)
+      if models.present?
+        models
+          .map { |model| model.constantize }
+          .select { |model| model.has_redacted_content? }
+      else
+        Redaction.redactable_models
+      end
+    end
+
+    def progress_bar(title, total)
+      ProgressBar.create(
+        format: "%t %b\u{15E7}%i %p%%",
+        progress_mark: " ",
+        remainder_mark: "\u{FF65}",
+        title: title,
+        total: total
+      )
+    end
+  end
+end

data/lib/redaction/types/base.rb

@@ -0,0 +1,20 @@
+module Redaction
+  module Types
+    class Base
+      attr_reader :record, :data
+
+      def self.call(record, data)
+        new(record, data).content
+      end
+
+      def initialize(record, data)
+        @record = record
+        @data = data
+      end
+
+      def content
+        "[REDACTED]"
+      end
+    end
+  end
+end

data/lib/redaction/types/basic.rb

@@ -0,0 +1,11 @@
+require "faker"
+
+module Redaction
+  module Types
+    class Basic < Base
+      def content
+        Faker::Lorem.sentence(word_count: rand(3..10)).gsub(/\.$/, "")
+      end
+    end
+  end
+end

data/lib/redaction/types/basic_html.rb

@@ -0,0 +1,14 @@
+require "faker"
+
+module Redaction
+  module Types
+    class BasicHtml < Base
+      def content
+        [nil, "em", "strong"].shuffle.map! do |tag|
+          text = Faker::Lorem.sentence(word_count: rand(1..3)).sub(/\.$/, "")
+          tag ? "<#{tag}>#{text}</#{tag}>" : text
+        end.join(" ")
+      end
+    end
+  end
+end

data/lib/redaction/types/email.rb

@@ -0,0 +1,11 @@
+require "faker"
+
+module Redaction
+  module Types
+    class Email < Base
+      def content
+        Faker::Internet.safe_email
+      end
+    end
+  end
+end

data/lib/redaction/types/html.rb

@@ -0,0 +1,44 @@
+require "faker"
+
+module Redaction
+  module Types
+    class Html < Base
+      include ActionView::Helpers::TagHelper
+
+      TAGS = %i[em strong a]
+      private_constant :TAGS
+
+      def content
+        1.upto(rand(1..3)).map { content_tag(:p, generate_paragraph.html_safe) }.join("\n")
+      end
+
+      private
+
+      def generate_paragraph
+        sentences = Faker::Lorem.sentences(number: rand(1..5)).map! do |sentence|
+          words = sentence.split(/\s+/)
+
+          words.map! do |word|
+            case rand(10)
+            when 0, 1, 2
+              create_html_word(word)
+            else
+              word
+            end
+          end
+
+          words.join(" ")
+        end
+
+        sentences.join(" ")
+      end
+
+      def create_html_word(word)
+        tag = TAGS.sample
+        options = tag == :a ? {href: "http://example.com"} : {}
+
+        content_tag(tag, word, options)
+      end
+    end
+  end
+end

data/lib/redaction/types/name.rb

@@ -0,0 +1,11 @@
+require "faker"
+
+module Redaction
+  module Types
+    class Name < Base
+      def content
+        Faker::Name.first_name
+      end
+    end
+  end
+end

data/lib/redaction/types/phone.rb

@@ -0,0 +1,13 @@
+require "faker"
+
+module Redaction
+  module Types
+    class Phone < Base
+      def content
+        # Use cell_phone so no extension is added
+        # see: https://github.com/faker-ruby/faker/blob/master/doc/default/phone_number.md
+        Faker::PhoneNumber.cell_phone
+      end
+    end
+  end
+end

data/lib/redaction/types/text.rb

@@ -0,0 +1,15 @@
+require "faker"
+
+module Redaction
+  module Types
+    class Text < Base
+      def content
+        paragraphs = 1.upto(rand(1..3)).map do
+          Faker::Lorem.paragraph(sentence_count: rand(1..5))
+        end
+
+        "#{paragraphs.join("\n\n")}\n"
+      end
+    end
+  end
+end

data/lib/redaction/version.rb

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

data/lib/redaction.rb

@@ -0,0 +1,34 @@
+require "redaction/version"
+require "redaction/railtie"
+
+module Redaction
+  module Types
+    autoload :Base, "redaction/types/base"
+    autoload :Basic, "redaction/types/basic"
+    autoload :BasicHtml, "redaction/types/basic_html"
+    autoload :Email, "redaction/types/email"
+    autoload :Html, "redaction/types/html"
+    autoload :Name, "redaction/types/name"
+    autoload :Phone, "redaction/types/phone"
+    autoload :Text, "redaction/types/text"
+  end
+
+  autoload :Redactable, "redaction/redactable"
+  autoload :Redactor, "redaction/redactor"
+
+  def self.find(redactor_type)
+    if redactor_type.respond_to?(:call)
+      redactor_type
+    else
+      "Redaction::Types::#{redactor_type.to_s.camelize}".safe_constantize || Redaction::Types::Base
+    end
+  end
+
+  def self.redactable_models
+    ApplicationRecord.subclasses.select { |descendant| descendant.has_redacted_content? }
+  end
+
+  def self.redact!(models: nil)
+    Redactor.new(models: models).redact!
+  end
+end

data/lib/tasks/redaction.rake

@@ -0,0 +1,15 @@
+namespace :redaction do
+  desc "Update Models with redacted data"
+  task redact: :environment do
+    if Rails.env.production?
+      abort "Cannot redact in production"
+    end
+
+    Rails.application.eager_load!
+
+    model_names = (ENV["MODELS"] || "").split(",").map(&:strip)
+    puts model_names.empty? ? "Redacting all models" : "Redacting models: #{model_names.join(", ")}"
+
+    Redaction.redact!(models: model_names)
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: redaction
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Bragg
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily redact your ActiveRecord Models.
+email:
+- drbragg@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/redaction.rb
+- lib/redaction/railtie.rb
+- lib/redaction/redactable.rb
+- lib/redaction/redactor.rb
+- lib/redaction/types/base.rb
+- lib/redaction/types/basic.rb
+- lib/redaction/types/basic_html.rb
+- lib/redaction/types/email.rb
+- lib/redaction/types/html.rb
+- lib/redaction/types/name.rb
+- lib/redaction/types/phone.rb
+- lib/redaction/types/text.rb
+- lib/redaction/version.rb
+- lib/tasks/redaction.rake
+homepage: https://github.com/drbragg/redaction
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/drbragg/redaction
+  source_code_uri: https://github.com/drbragg/redaction
+  changelog_uri: https://github.com/drbragg/redaction/blob/main/CHANGELOG.md
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Easily redact your ActiveRecord Models.
+test_files: []