sanitize_email 1.0.4 → 1.0.5

data/.travis.yml

@@ -5,4 +5,3 @@ rvm:
   - jruby-19mode
   - rbx-19mode
   - ruby-head
-  - jruby-head

data/CHANGELOG.md

@@ -0,0 +1,99 @@
+Version 1.0.5 - DEC.20.2012
+
+* Fixes Compatibility with Rails 3.0 by David Morton
+* Added header tests to ensure original header markers do not appear when sanitize is disabled by Harry Lascelles
+* Added tests and email_spec for have_header matcher by Harry Lascelles
+* Make activation_proc option a bit more configurable by Nikita Fedyashev
+* Adding message to engage proc, so we can sanitize on a message by message basis by Harry Lascelles
+* Allowing for nil ccs and bccs by Harry Lascelles
+* Adding original emails as headers, except for bcc by Harry Lascelles
+
+Version 1.0.4 - SEP.10.2012
+
+* Removes facets dependency, upgrades to rspec v2.11 by Peter Boling
+* REEK refactoring by Peter Boling
+* Improve handling of mal-formed calls to (un)sanitary (raises error) by Peter Boling
+* code cleanup by Peter Boling
+* Put some examples back in the README, until I improve and link to the wiki. :/
+
+Version 1.0.3 - AUG.12.2012
+
+* Accidentally broke spec suite with 1.0.2 - fixed
+* Expanded spec suite
+* Split test_helpers from rspec_matchers (test_helpers may be useful in TestUnit
+* Moving Examples from README to wiki
+* Document and implement working deprecation of version 0's SanitizeEmail::Config.config[:force_sanitize] behavior
+    * Now use SanitizeEmail.force_sanitize = true # or false or nil
+
+Version 1.0.2 - AUG.11.2012
+
+* Massive improvement to spec suite, and found bleeding
+    * needed to unregister the interceptors:
+        * Mail.class_variable_get(:@@delivery_interceptors).pop
+* Added SanitizeEmail.deprecate_in_silence
+* Added SanitizeEmail.sanitary &block
+    * Local overrides to SanitizeEmail config for specific local purpose
+    * Force Sanitization On for a block
+* Added SanitizeEmail.unsanitary &block
+    * Force Sanitization Off for a block
+* Added SanitizeEmail.force_sanitize = true # or false or nil
+    * Force Sanitization On or Off
+
+Version 1.0.1 - Unintentional, unexpected bump behavior from gem-release gem (Issues #24 & #25)
+
+Version 1.0.0.rc3 - AUG.08.2012
+
+* Forgot to switch from jeweler to gem-release, so making appropriate changes and bumping again
+* Aligning closer to bundler gem defaults
+* Removing Rails dependency - Should work with Sinatra, or any Mail-like interface
+* Added facets dependency to get cattr functionality (and hopefully other cool stuff)
+* Gem dependencies in gemspec
+
+Version 1.0.0.rc2 - AUG.08.2012 - botched
+
+* Bug: loading the gem in a rails app broke mailer specs in the app - Fixed
+    * https://github.com/pboling/sanitize_email/issues/4
+* Moved MIT-LICENSE to LICENSE, updated years
+* Added Travis-CI for... CI.
+
+Version 1.0.0.rc1
+
+* Added a good_list and a bad_list (whitelist and blacklist)
+* Added Deprecation library
+* Refactored Sanitization module into Hook class
+* Renamed Hook Class to Bleach Class
+* Improve support for non-rails implementations
+* Deprecated local_environments in favor of local_environment_proc
+* Deprecated sanitized_recipients in favor of sanitized_to
+* More specs
+
+Version 1.0.0.alpha2
+
+* Complete refactor!  Implementing initial support for Rails >= 3.0 (new ActionMailer API)
+    * Support for Rails <= 2.X remains in version 0.X.X releases.
+* NinthBit namespace is now SanitizeEmail namespace
+* Now has a first class Config class
+
+XXXXXXXXXXXXXXXXXXXXXXX Rail 3.0+ Only Form here on up! XXXXXXXXXXXXXXXXXXXXXXX
+
+Version 0.3.8
+
+* Update specs, note requirement of Rails 2.3 or below to run spec quite.
+* Support use_actual_email_prepended_to_subject
+* Fix environment check for old versions of Rails
+* Improved Readme
+
+Version 0.3.7
+
+* Improved Installation instructions
+* Fixed so tests run from inside a rails app (previously only ran standalone)
+
+Version 0.3.6
+
+* Fixed Installation instructions
+* Improved README
+
+Old version?
+
+* Fixed require paths
+* added about.yml and this CHANGELOG

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sanitize_email (1.0.3)
+    sanitize_email (1.0.4)
 
 GEM
   remote: http://rubygems.org/
@@ -37,6 +37,9 @@ GEM
     arel (3.0.2)
     builder (3.0.0)
     diff-lcs (1.1.3)
+    email_spec (1.2.1)
+      mail (~> 2.2)
+      rspec (~> 2.0)
     erubis (2.7.0)
     hike (1.2.1)
     i18n (0.6.0)
@@ -117,6 +120,7 @@ PLATFORMS
 
 DEPENDENCIES
   actionmailer (> 3)
+  email_spec
   launchy
   letter_opener
   mail

data/{README.rdoc → README.md}

@@ -1,43 +1,63 @@
-= sanitize_email {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/pboling/sanitize_email] {<img src="https://secure.travis-ci.org/pboling/sanitize_email.png?branch=master" alt="Build Status" />}[http://travis-ci.org/pboling/sanitize_email]
+# sanitize_email
 
-This gem allows you to globally override your mail delivery settings.  It's particularly helpful when you want to omit the delivery of email (e.g. in development/test environments) or alter the to/cc/bcc (e.g. in staging or demo environments) of all email generated from your application.
+This gem allows you to override your mail delivery settings, globally or in a local context.  It's particularly helpful when you want to omit the delivery of email (e.g. in development/test environments) or alter the to/cc/bcc (e.g. in staging or demo environments) of all email generated from your application.
 
-It is a "configure it and forget it" type gem that requires very little setup.  It uses the 'register_interceptor' API of ActionMailer or the Mail gem.  It should work with Rails >3 or any Ruby app that is using Mail or ActionMailer gems.
+* compatible with Rails >= 3.X (Note: 3.0 requires version >= 1.0.5)
+* compatible with any Ruby app with a Mail handler that uses the `register_interceptor` API (a la ActionMailer and Mail gems)
+* configure it and forget it
+* little configuration required
+* solves common problems in ruby web applications that use email
+* provides test helpers and spec matchers to assist with testing email content delivery
 
-It currently solves five (3!) common problems in ruby web applications that use email:
+## Summary
 
-=== #1 Working Locally with Production Data
+| Project         |  Sanitize Email  |
+|---------------- | ----------------- |
+| gem name        |  sanitize_email  |
+| license         |  MIT              |
+| homepage        |  https://github.com/pboling/sanitize_email |
+| documentation   |  http://rdoc.info/github/pboling/sanitize_email/frames |
+| author   |  [Peter Boling](railsbling.com) [![Endorse Me](http://api.coderwall.com/pboling/endorsecount.png)](http://api.coderwall.com/pboling/endorsecount.png) |
+| CI              |  https://travis-ci.org/pboling/sanitize_email [![Build Status](https://secure.travis-ci.org/pboling/sanitize_email.png?branch=master)](https://travis-ci.org/pboling/sanitize_email) |
+| QA              |  https://codeclimate.com/github/pboling/sanitize_email [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/pboling/sanitize_email) |
 
-* I have a production site with live data.
-* I dump the live data and securely transfer it to another machine (rync -e ssh), and import it using a {few rake tasks}[http://github.com/pboling/sir-du-bob]
-* On this separate machine (staging, or development) I run tests, and test various features which often send out email (registration/signup, order placement, etc.)
-* I usually want the emails to get sent from these non-production environments so I can verify what they look like when sent, but I don't ever want to risk them getting sent to addresses that are not mine.
 
-=== #2 Re-routing Email on a Staging or QA Server
+## Working Locally with Production Data
+
+1. Have a production site with live data
+2. Dump the live data and securely transfer it to another machine (e.g. rync -e ssh)
+3. Import it into a development database
+4. Test features which send out email (registration/signup, order placement, etc.)
+5. Emails get sent (in real-life!) but to sanitized email recipients
+6. Verify what they look like when sent
+7. Iterate on email content design
+8. No risk of emailing production addresses
+
+## Re-routing Email on a Staging or QA Server
 
 Another very important use case for me is to transparently re-route email generated from a staging or QA server to an appropriate person.  For example, it's common for us to set up a staging server for a client to use to view our progress and test out new features.  It's important for any email that is generated from our web application be delivered to the client's inbox so that they can review the content and ensure that it's acceptable.  Similarly, we set up QA instances for our own QA team and we use {rails-caddy}[http://github.com/jtrupiano/rails-caddy] to allow each QA person to configure it specifically for them.
 
-=== #3 Testing Email from a Hot Production Server
+## Testing Email from a Hot Production Server
 
 If you install this gem on a production server (which I don't always do), you can load up script/console and override the to/cc/bcc on all emails for the duration of your console session.  This allows you to poke and prod a live production instance, and route all email to your own inbox for inspection.  The best part is that this can all be accomplished without changing a single line of your application code.
 
-== Install Like a Boss
+## Install Like a Boss
 
   [sudo] gem install sanitize_email
 
-== Setup With An Axe
+## Setup With An Axe
 
 Customize and add to an initializer:
 
-  SanitizeEmail::Config.configure do |config|
-    config[:sanitized_to] = 'to@sanitize_email.org'
-    config[:sanitized_cc] =         'cc@sanitize_email.org'
-    config[:sanitized_bcc] =        'bcc@sanitize_email.org'
-    # sanitize emails from development and test, or set whatever logic should turn sanitize_email on and off here:
-    config[:activation_proc] =   Proc.new { %w(development test).include?(Rails.env) }
-    config[:use_actual_email_prepended_to_subject] = true   # or false
-    config[:use_actual_email_as_sanitized_user_name] = true # or false
-  end
+        SanitizeEmail::Config.configure do |config|
+          config[:sanitized_to] = 'to@sanitize_email.org'
+          config[:sanitized_cc] =         'cc@sanitize_email.org'
+          config[:sanitized_bcc] =        'bcc@sanitize_email.org'
+          # sanitize emails from development and test, or set whatever logic should turn sanitize_email on and off here:
+          config[:activation_proc] =   Proc.new { %w(development test).include?(Rails.env) }
+          config[:use_actual_email_prepended_to_subject] = true   # or false
+          config[:use_actual_email_as_sanitized_user_name] = true # or false
+        end
 
 Keep in mind, this is ruby (and possibly rails), so you can add conditionals or utilize different environment.rb files to customize these settings on a per-environment basis.
 
@@ -88,7 +108,7 @@ John Trupiano did the initial gemification and some refactoring.
 
 == Contributors
 
-George Anderson's work / improvements have been pulled in, along with several other contributors, which can be seen in the Network view on github. Thanks!
+See the [Network View](https://github.com/pboling/sanitize_email/network) and the [CHANGELOG](https://github.com/pboling/sanitize_email/blob/master/CHANGELOG.md)
 
 == References
 
@@ -99,6 +119,6 @@ George Anderson's work / improvements have been pulled in, along with several ot
 
 == Legal Stuff
 
-* Copyright (c) 2008-2012 {Peter H. Boling}[http://www.peterboling.com/about.html] of {9thBit LLC}[http://www.peterboling.com/]
+* Copyright (c) 2008-2012 {Peter H. Boling}[http://www.railsbling.com] of {9thBit LLC}[http://www.peterboling.com/]
 * Copyright (c) 2009 {John Trupiano}[http://smartlogicsolutions.com/wiki/John_Trupiano] of {SmartLogic Solutions, LLC}[http://www.smartlogicsolutions.com]
 * Released under the MIT license

data/Rakefile

@@ -25,10 +25,10 @@ end
 task :default => :spec
 
 require 'rdoc/task'
+require File.expand_path('../lib/sanitize_email/version', __FILE__)
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = "SanitizeEmail #{version}"
+  rdoc.title    = "SanitizeEmail #{SanitizeEmail::VERSION}"
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/lib/sanitize_email/bleach.rb

@@ -4,39 +4,63 @@
 module SanitizeEmail
   class Bleach
 
-    class MissingTo < StandardError; end
-    class UnknownOverride < StandardError; end
+    class MissingTo < StandardError;
+    end
+    class UnknownOverride < StandardError;
+    end
 
     # Can override global configs at the instance level.
     attr_accessor :engage, # Turn sanitization on or off just for this instance
-      :sanitized_to, :sanitized_cc, :sanitized_bcc, # Replace non-white-listed addresses with these sanitized addresses.
-      :good_list, # White-listed addresses will not be molested as to, cc, or bcc
-      :bad_list, # Black-listed addresses will be removed from to, cc and bcc when sanitization is engaged
-      :injected  # Track whether or not the subject has been injected with usernames
+                  :sanitized_to, :sanitized_cc, :sanitized_bcc, # Replace non-white-listed addresses with these sanitized addresses.
+                  :good_list, # White-listed addresses will not be molested as to, cc, or bcc
+                  :bad_list, # Black-listed addresses will be removed from to, cc and bcc when sanitization is engaged
+                  :injected # Track whether or not the subject has been injected with usernames
 
     def initialize(args = {})
       # Not using extract_options! because non-rails compatibility is a goal
-      @sanitized_to = args[:sanitized_to]    || SanitizeEmail[:sanitized_to]
-      @sanitized_cc = args[:sanitized_cc]    || SanitizeEmail[:sanitized_cc]
-      @sanitized_bcc = args[:sanitized_bcc]  || SanitizeEmail[:sanitized_bcc]
-      @good_list = args[:good_list]          || SanitizeEmail[:good_list]     || []
-      @bad_list = args[:bad_list]            || SanitizeEmail[:bad_list]      || []
-      @engage = args[:engage]                || SanitizeEmail[:engage]
+      @sanitized_to = args[:sanitized_to] || SanitizeEmail[:sanitized_to]
+      @sanitized_cc = args[:sanitized_cc] || SanitizeEmail[:sanitized_cc]
+      @sanitized_bcc = args[:sanitized_bcc] || SanitizeEmail[:sanitized_bcc]
+      @good_list = args[:good_list] || SanitizeEmail[:good_list] || []
+      @bad_list = args[:bad_list] || SanitizeEmail[:bad_list] || []
+      @engage = args[:engage] || SanitizeEmail[:engage]
       @injected = false
     end
 
     # If all recipient addresses are white-listed the field is left alone.
     def delivering_email(message)
-      if self.sanitize_engaged?
+      if self.sanitize_engaged?(message)
+        # Cache the correct addresses. These will get overwritten when the
+        cache_to = self.to_override(message.to)
+        cache_cc = self.cc_override(message.cc)
+        cache_bcc = self.bcc_override(message.bcc)
+
+        add_original_addresses_as_headers(message)
+
         message.subject = self.subject_override(message.subject, message.to) if SanitizeEmail.use_actual_email_prepended_to_subject
-        message.to = self.to_override(message.to)
-        message.cc = self.cc_override(message.cc)
-        message.bcc = self.bcc_override(message.bcc)
+        message.to = cache_to
+        message.cc = cache_cc
+        message.bcc = cache_bcc
       end
     end
 
-    def activate?
-      SanitizeEmail.activation_proc.call if SanitizeEmail.activation_proc.respond_to?(:call)
+    def add_original_addresses_as_headers(message)
+        ## Add headers by string concat. Setting hash values on message.headers does nothing, strangely. http://goo.gl/v46GY
+        {
+            'X-Sanitize-Email-To' => message.to,
+            'X-Sanitize-Email-Cc' => message.cc
+            # Don't write out the BCC, as those addresses should not be visible in message headers for obvious reasons
+        }.each { |k, v|
+          # For each type of address line
+          v.each { |a|
+            # For each address
+            message.header = message.header.to_s + "\n#{k}: #{a}"
+          } if v
+        }
+    end
+
+    def activate?(message)
+      SanitizeEmail.activation_proc.call(message) if SanitizeEmail.activation_proc.respond_to?(:call)
     end
 
     # This method will be called by the Hook to determine if an override should occur
@@ -49,7 +73,7 @@ module SanitizeEmail
     # Note: Number 1 is the method used by the SanitizeEmail.sanitary block
     # Note: Number 2 would not be used unless you setup your own register_interceptor)
     # If installed but not configured, sanitize email DOES NOTHING.  Until configured the defaults leave it turned off.
-    def sanitize_engaged?
+    def sanitize_engaged?(message)
 
       # Has it been forced via the force_sanitize mattr?
       forced = SanitizeEmail.force_sanitize
@@ -60,7 +84,7 @@ module SanitizeEmail
       return engaged unless engaged.nil?
 
       # Should we sanitize due to the activation_proc?
-      return self.activate?
+      return self.activate?(message)
 
     end
 
@@ -68,7 +92,7 @@ module SanitizeEmail
       if !actual_addresses.respond_to?(:join)
         real_subject
       else
-        "(#{actual_addresses.join(',').gsub(/@/,' at ').gsub(/[<>]/,'~')}) #{real_subject}"
+        "(#{actual_addresses.join(',').gsub(/@/, ' at ').gsub(/[<>]/, '~')}) #{real_subject}"
       end
     end
 
@@ -94,8 +118,10 @@ module SanitizeEmail
       # TODO: How does this handle email addresses with user names like "Foo Example <foo@example.org>"
       has_address = self.send(list_type).include?(address)
       case list_type
-        when :good_list then has_address ? address : nil
-        when :bad_list then has_address ? nil : address
+        when :good_list then
+          has_address ? address : nil
+        when :bad_list then
+          has_address ? nil : address
       end
     end
 
@@ -104,7 +130,7 @@ module SanitizeEmail
         if real_recipient.nil?
           new_recipient = sanitized_addresses
         else
-          new_recipient = sanitized_addresses.map{|sanitized| "#{real_recipient.gsub(/@/,' at ').gsub(/[<>]/,'~')} <#{sanitized}>"}
+          new_recipient = sanitized_addresses.map { |sanitized| "#{real_recipient.gsub(/@/, ' at ').gsub(/[<>]/, '~')} <#{sanitized}>" }
         end
         result << new_recipient
         result
@@ -121,10 +147,14 @@ module SanitizeEmail
 
     def sanitize_addresses(type)
       case type
-        when :to then Array(self.sanitized_to)
-        when :cc then Array(self.sanitized_cc)
-        when :bcc then Array(self.sanitized_bcc)
-        else raise UnknownOverride, "unknown email override"
+        when :to then
+          Array(self.sanitized_to)
+        when :cc then
+          Array(self.sanitized_cc)
+        when :bcc then
+          Array(self.sanitized_bcc)
+        else
+          raise UnknownOverride, "unknown email override"
       end
     end
 
@@ -137,35 +167,36 @@ module SanitizeEmail
 
     def override_email(type, actual_addresses)
       # Normalized to an arrays
-#puts "override_email 1: #{type} - #{actual_addresses}"
+      #puts "override_email 1: #{type} - #{actual_addresses}"
       real_addresses = Array(actual_addresses)
 
 #puts "override_email 2: #{type} - #{real_addresses}"
-      # If there were no original recipients, then we DO NOT override the nil with the sanitized recipients
+# If there were no original recipients, then we DO NOT override the nil with the sanitized recipients
       return [] if real_addresses.empty?
 
       good_listed = good_listize(real_addresses)
 #puts "override_email 3: #{type} - #{good_listed}"
-      # If there are good_list addresses to send to then use them as is, no mods needed
+# If there are good_list addresses to send to then use them as is, no mods needed
       return good_listed unless good_listed.empty?
 
+      # TODO: Allow overriding if an addressed email is on the good list?
       # If there are no sanitized addresses we can't override!
       sanitized_addresses = sanitize_addresses(type)
-#puts "override_email 3: #{type} - #{sanitized_addresses}"
+      #puts "override_email 3: #{type} - #{sanitized_addresses}"
       return [] if sanitized_addresses.empty?
 
       # At this point it is assured that the address list will need to be sanitized
       # One more check to ensure none of the configured sanitized email addresses are on the bad_list
       sanitized_addresses = self.clean_addresses(sanitized_addresses, :bad_list)
-#puts "override_email 4: #{type} - #{sanitized_addresses}"
+      #puts "override_email 4: #{type} - #{sanitized_addresses}"
 
       # If we don't want to inject the 'email' in the 'user name' section of the sanitized recipients,
       # then just return the default sanitized recipients
       return sanitized_addresses unless SanitizeEmail.use_actual_email_as_sanitized_user_name
 
       with_user_names = self.inject_user_names(real_addresses, sanitized_addresses)
-#puts "real_addresses 2: #{real_addresses}"
-#puts "override_email 5: #{type} - #{with_user_names}"
+      #puts "real_addresses 2: #{real_addresses}"
+      #puts "override_email 5: #{type} - #{with_user_names}"
       # Otherwise inject the email as the 'user name'
       return with_user_names
     end

data/lib/sanitize_email/railtie.rb

@@ -4,7 +4,7 @@
 module SanitizeEmail
   class Railtie < ::Rails::Railtie
 
-    config.before_configuration do
+    config.after_initialize do
       ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach.new)
     end
 

data/lib/sanitize_email/version.rb

@@ -1,5 +1,5 @@
 #Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
 #Released under the MIT license
 module SanitizeEmail
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/sanitize_email.gemspec

@@ -7,14 +7,13 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling", "John Trupiano", "George Anderson"]
-  s.date = "2012-08-12"
   s.summary = "Rails/Sinatra/Mail gem: Test email abilities without ever sending a message to actual live addresses"
   s.description = "In Rails, Sinatra, or simply the mail gem: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses."
   s.email = ["peter.boling@gmail.com", "jtrupiano@gmail.com", "george@benevolentcode.com"]
   s.extra_rdoc_files = [
-    "CHANGELOG",
+    "CHANGELOG.md",
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.files         = `git ls-files`.split($\)
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -39,5 +38,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<reek>, [">= 1.2.8"])
   s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
   s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency(%q<email_spec>, [">= 0"])
 end
 

data/spec/sanitize_email_spec.rb

@@ -122,6 +122,9 @@ describe SanitizeEmail do
         @email_message.should have_to("to@sanitize_email.org")
         @email_message.should have_cc("cc@sanitize_email.org")
         @email_message.should have_bcc("bcc@sanitize_email.org")
+        @email_message.should have_header("X-Sanitize-Email-To", "to@example.org")
+        @email_message.should have_header("X-Sanitize-Email-Cc", "cc@example.org")
+        @email_message.should_not have_header("X-Sanitize-Email-Bcc")
       end
       it "should not prepend originals by default" do
         @email_message.should_not have_to_username("to at example.org <to@sanitize_email.org>")
@@ -145,6 +148,9 @@ describe SanitizeEmail do
           @email_message.should have_to("to@sanitize_email.org")
           @email_message.should have_cc("cc@sanitize_email.org")
           @email_message.should have_bcc("bcc@sanitize_email.org")
+          @email_message.should have_header("X-Sanitize-Email-To", "to@example.org")
+          @email_message.should have_header("X-Sanitize-Email-Cc", "cc@example.org")
+          @email_message.should_not have_header("X-Sanitize-Email-Bcc")
         end
       end
       context "false" do
@@ -162,6 +168,9 @@ describe SanitizeEmail do
           @email_message.should have_to("to@example.org")
           @email_message.should have_cc("cc@example.org")
           @email_message.should have_bcc("bcc@example.org")
+          @email_message.should_not have_header("X-Sanitize-Email-To")
+          @email_message.should_not have_header("X-Sanitize-Email-Cc")
+          @email_message.should_not have_header("X-Sanitize-Email-Bcc")
         end
       end
       context "nil" do
@@ -181,6 +190,9 @@ describe SanitizeEmail do
             @email_message.should have_to("to@sanitize_email.org")
             @email_message.should have_cc("cc@sanitize_email.org")
             @email_message.should have_bcc("bcc@sanitize_email.org")
+            @email_message.should have_header("X-Sanitize-Email-To", "to@example.org")
+            @email_message.should have_header("X-Sanitize-Email-Cc", "cc@example.org")
+            @email_message.should_not have_header("X-Sanitize-Email-Bcc")
           end
         end
         context "activation proc disables" do
@@ -199,6 +211,9 @@ describe SanitizeEmail do
             @email_message.should have_to("to@example.org")
             @email_message.should have_cc("cc@example.org")
             @email_message.should have_bcc("bcc@example.org")
+            @email_message.should_not have_header("X-Sanitize-Email-To")
+            @email_message.should_not have_header("X-Sanitize-Email-Cc")
+            @email_message.should_not have_header("X-Sanitize-Email-Bcc")
           end
         end
       end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require 'launchy'
 require 'mail'
 require 'rails'
 require 'letter_opener'
+require 'action_mailer'
+require 'email_spec'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -173,6 +173,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: email_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'In Rails, Sinatra, or simply the mail gem: Aids in development, testing,
   qa, and production troubleshooting of email issues without worrying that emails
   will get sent to actual live addresses.'
@@ -183,18 +199,18 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGELOG
+- CHANGELOG.md
 - LICENSE
-- README.rdoc
+- README.md
 files:
 - .gitignore
 - .rspec
 - .travis.yml
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - REEK
 - Rakefile
 - init.rb
@@ -239,4 +255,3 @@ summary: ! 'Rails/Sinatra/Mail gem: Test email abilities without ever sending a
 test_files:
 - spec/sanitize_email_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/CHANGELOG

@@ -1,78 +0,0 @@
-Version 1.0.4 - SEP.10.2012
-* Removes facets dependency, upgrades to rspec v2.11 by Peter Boling
-* REEK refactoring by Peter Boling
-* Improve handling of mal-formed calls to (un)sanitary (raises error) by Peter Boling
-* code cleanup by Peter Boling
-* Put some examples back in the README, until I improve and link to the wiki. :/
-
-Version 1.0.3 - AUG.12.2012
-- Accidentally broke spec suite with 1.0.2 - fixed
-- Expanded spec suite
-- Split test_helpers from rspec_matchers (test_helpers may be useful in TestUnit
-- Moving Examples from README to wiki
-- Document and implement working deprecation of version 0's SanitizeEmail::Config.config[:force_sanitize] behavior
-  - Now use SanitizeEmail.force_sanitize = true # or false or nil
-
-Version 1.0.2 - AUG.11.2012
-- Massive improvement to spec suite, and found bleeding
-  - needed to unregister the interceptors:
-    - Mail.class_variable_get(:@@delivery_interceptors).pop
-- Added SanitizeEmail.deprecate_in_silence
-- Added SanitizeEmail.sanitary &block
-  - Local overrides to SanitizeEmail config for specific local purpose
-  - Force Sanitization On for a block
-- Added SanitizeEmail.unsanitary &block
-  - Force Sanitization Off for a block
-- Added SanitizeEmail.force_sanitize = true # or false or nil
-  - Force Sanitization On or Off
-
-Version 1.0.1 - Unintentional, unexpected bump behavior from gem-release gem (Issues #24 & #25)
-
-Version 1.0.0.rc3 - AUG.08.2012
-- Forgot to switch from jeweler to gem-release, so making appropriate changes and bumping again
-- Aligning closer to bundler gem defaults
-- Removing Rails dependency - Should work with Sinatra, or any Mail-like interface
-- Added facets dependency to get cattr functionality (and hopefully other cool stuff)
-- Gem dependencies in gemspec
-
-Version 1.0.0.rc2 - AUG.08.2012 - botched
-- Bug: loading the gem in a rails app broke mailer specs in the app - Fixed
-  - https://github.com/pboling/sanitize_email/issues/4
-- Moved MIT-LICENSE to LICENSE, updated years
-- Added Travis-CI for... CI.
-
-Version 1.0.0.rc1
-- Added a good_list and a bad_list (whitelist and blacklist)
-- Added Deprecation library
-- Refactored Sanitization module into Hook class
-- Renamed Hook Class to Bleach Class
-- Improve support for non-rails implementations
-- Deprecated local_environments in favor of local_environment_proc
-- Deprecated sanitized_recipients in favor of sanitized_to
-- More specs
-
-Version 1.0.0.alpha2
-- Complete refactor!  Implementing initial support for Rails >= 3.0 (new ActionMailer API)
-  - Support for Rails <= 2.X remains in version 0.X.X releases.
-- NinthBit namespace is now SanitizeEmail namespace
-- Now has a first class Config class
-
-XXXXXXXXXXXXXXXXXXXXXXX Rail 3.0+ Only Form here on up! XXXXXXXXXXXXXXXXXXXXXXX
-
-Version 0.3.8
-- Update specs, note requirement of Rails 2.3 or below to run spec quite.
-- Support use_actual_email_prepended_to_subject
-- Fix environment check for old versions of Rails
-- Improved Readme
-
-Version 0.3.7
-- Improved Installation instructions
-- Fixed so tests run from inside a rails app (previously only ran standalone)
-
-Version 0.3.6
-- Fixed Installation instructions
-- Improved README
-
-Old version?
-- Fixed require paths
-- added about.yml and this CHANGELOG