redaction 0.1.0 → 0.2.0

checksums.yaml

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

data/README.md

@@ -1,4 +1,5 @@
 # Redaction
+[![Gem Version](https://badge.fury.io/rb/redaction.svg)](https://badge.fury.io/rb/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).
@@ -6,17 +7,17 @@ Easily redact your ActiveRecord Models. Great for use when you use production da
 `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.
+**NOTE:** This is currently 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"
+gem "redaction"
 ```
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
 ```
 
 ## Usage

data/lib/redaction/railtie.rb

@@ -1,6 +1,18 @@
 module Redaction
+  class << self
+    def config
+      @config ||= Railtie.config.redaction
+    end
+  end
+
   class Railtie < ::Rails::Railtie
+    config.redaction = ActiveSupport::OrderedOptions.new
+
     initializer "redaction.initialize" do
+      options = config.redaction
+
+      options.email_domain = options.email_domain
+
       ActiveSupport.on_load(:active_record) do
         include Redaction::Redactable
       end

data/lib/redaction/redactable.rb

@@ -10,6 +10,8 @@ module Redaction
       end
 
       def redact!
+        raise ProductionEnvironmentError if Rails.env.production?
+
         @_redacting = true
         redacted_attributes.each_pair do |redactor_type, attributes|
           redactor = Redaction.find(redactor_type)

data/lib/redaction/redactor.rb

@@ -9,6 +9,8 @@ module Redaction
     end
 
     def redact!
+      raise ProductionEnvironmentError if Rails.env.production?
+
       models_to_redact.each do |model|
         next if model.redacted_attributes.empty?
 

data/lib/redaction/types/email.rb

@@ -4,7 +4,11 @@ module Redaction
   module Types
     class Email < Base
       def content
-        Faker::Internet.safe_email
+        if Redaction.config.email_domain.present?
+          Faker::Internet.email(domain: Redaction.config.email_domain)
+        else
+          Faker::Internet.safe_email
+        end
       end
     end
   end

data/lib/redaction/version.rb

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

data/lib/redaction.rb

@@ -16,6 +16,14 @@ module Redaction
   autoload :Redactable, "redaction/redactable"
   autoload :Redactor, "redaction/redactor"
 
+  class ProductionEnvironmentError < StandardError
+    DEFAULT_MESSAGE = "Data cannot be redacted in production!"
+
+    def initialize(message = DEFAULT_MESSAGE)
+      super
+    end
+  end
+
   def self.find(redactor_type)
     if redactor_type.respond_to?(:call)
       redactor_type

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redaction
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Drew Bragg
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,7 +111,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -119,15 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.3
+signing_key: 
 specification_version: 4
 summary: Easily redact your ActiveRecord Models.
 test_files: []