sanitize_email 1.0.5 → 1.0.6

data/.gitignore

@@ -5,3 +5,4 @@ pkg
 .idea
 spec/tmp
 *.gem
+.rvmrc

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+Version 1.0.6 - JAN.25.2013
+
+* \[New Feature\] use_actual_environment_prepended_to_subject by [altonymous](https://github.com/Altonymous)
+
 Version 1.0.5 - DEC.20.2012
 
 * Fixes Compatibility with Rails 3.0 by David Morton

data/Gemfile.lock

@@ -1,119 +1,120 @@
 PATH
   remote: .
   specs:
-    sanitize_email (1.0.4)
+    sanitize_email (1.0.5)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.7)
-      actionpack (= 3.2.7)
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
       mail (~> 2.4.4)
-    actionpack (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
       rack (~> 1.4.0)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.7)
-      activesupport (= 3.2.7)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
       builder (~> 3.0.0)
-    activerecord (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
-    activesupport (3.2.7)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+    activesupport (3.2.9)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    addressable (2.2.8)
+    addressable (2.3.2)
     arel (3.0.2)
-    builder (3.0.0)
+    builder (3.0.4)
     diff-lcs (1.1.3)
-    email_spec (1.2.1)
+    email_spec (1.4.0)
+      launchy (~> 2.1)
       mail (~> 2.2)
-      rspec (~> 2.0)
     erubis (2.7.0)
     hike (1.2.1)
-    i18n (0.6.0)
+    i18n (0.6.1)
     journey (1.0.4)
-    json (1.7.3)
-    launchy (2.1.0)
-      addressable (~> 2.2.6)
-    letter_opener (0.0.2)
-      launchy
+    json (1.7.5)
+    launchy (2.1.2)
+      addressable (~> 2.3)
+    letter_opener (1.0.0)
+      launchy (>= 2.0.4)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.19)
-    multi_json (1.3.6)
+    multi_json (1.5.0)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
       rack (>= 0.4)
     rack-ssl (1.3.2)
       rack
-    rack-test (0.6.1)
+    rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.7)
-      actionmailer (= 3.2.7)
-      actionpack (= 3.2.7)
-      activerecord (= 3.2.7)
-      activeresource (= 3.2.7)
-      activesupport (= 3.2.7)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
       bundler (~> 1.0)
-      railties (= 3.2.7)
-    railties (3.2.7)
-      actionpack (= 3.2.7)
-      activesupport (= 3.2.7)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
+    rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
-    reek (1.2.12)
+    reek (1.2.13)
       ripper_ruby_parser (~> 0.0.7)
       ruby2ruby (~> 1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    ripper_ruby_parser (0.0.7)
+    ripper_ruby_parser (0.0.8)
       sexp_processor (~> 3.0)
     roodi (2.1.0)
       ruby_parser
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
+    rspec-mocks (2.12.0)
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
     sexp_processor (3.2.0)
-    sprockets (2.1.3)
+    sprockets (2.2.2)
       hike (~> 1.2)
+      multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.15.4)
+    thor (0.16.0)
     tilt (1.3.3)
-    treetop (1.4.10)
+    treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby

data/README.md

@@ -2,7 +2,7 @@
 
 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.
 
-* compatible with Rails >= 3.X (Note: 3.0 requires version >= 1.0.5)
+* compatible with Rails >= 3.X (since v1.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
@@ -17,7 +17,7 @@ This gem allows you to override your mail delivery settings, globally or in a lo
 | 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) |
+| author   |  [Peter Boling](http://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) |
 
@@ -50,13 +50,14 @@ If you install this gem on a production server (which I don't always do), you ca
 Customize and add to an initializer:
 
         SanitizeEmail::Config.configure do |config|
-          config[:sanitized_to] = 'to@sanitize_email.org'
+          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
+          # run/call whatever logic should turn sanitize_email on and off in this Proc:
+          config[:activation_proc] =      Proc.new { %w(development test).include?(Rails.env) }
+          config[:use_actual_email_prepended_to_subject] = true         # or false
+          config[:use_actual_environment_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.
@@ -95,30 +96,58 @@ SanitizeEmail.configure block.
     end
   end
 
-== Deprecations
+## Deprecations
 
 Sometimes things get deprecated (meaning they still work, but are noisy about it).  If this happens to you, and you like your head in the sand, call this number:
 
   SanitizeEmail::Deprecation.deprecate_in_silence = true
 
-== Authors
+## Authors
 
 Peter Boling is the original author of the code, and current maintainer of both the rails 2 and rails 3 development tracks.
 John Trupiano did the initial gemification and some refactoring.
 
-== Contributors
+## Contributors
 
 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
+## Contributing
 
-* {Source Code}[http://github.com/pboling/sanitize_email]
-* {Gem Release Announcement}[http://blog.smartlogicsolutions.com/2009/04/25/reintroducing-sanitize_email-work-with-production-email-without-fear/]
-* {Peter's Original Writeup}[http://galtzo.blogspot.com/2008/11/sanitize-email-never-worry-about.html]
-* {Using sanitize_email to Preview HTML Emails Locally}[http://blog.smartlogicsolutions.com/2009/04/30/using-sanitize-email-to-preview-html-emails-locally/]
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+6. Create new Pull Request
 
-== Legal Stuff
+## Versioning
 
-* 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
+This library aims to adhere to [Semantic Versioning 2.0.0][semver].
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
+
+For example:
+
+    spec.add_dependency 'sanitize_email', '~> 4.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
+## References
+
+* [Source Code](http://github.com/pboling/sanitize_email)
+* [Gem Release Announcement](http://blog.smartlogicsolutions.com/2009/04/25/reintroducing-sanitize_email-work-with-production-email-without-fear/)
+* [Peter's Original Writeup](http://galtzo.blogspot.com/2008/11/sanitize-email-never-worry-about.html)
+* [Using sanitize_email to Preview HTML Emails Locally](http://blog.smartlogicsolutions.com/2009/04/30/using-sanitize-email-to-preview-html-emails-locally/)
+
+## Legal
+
+* MIT License
+* Copyright (c) 2008-2013 [Peter H. Boling](http://www.railsbling.com) of Acquaintable [http://acquaintable.com/]
+* Copyright (c) 2009 [John Trupiano](http://smartlogicsolutions.com/wiki/John_Trupiano) of [SmartLogic Solutions, LLC](http://www.smartlogicsolutions.com)

data/lib/sanitize_email/bleach.rb

@@ -37,7 +37,9 @@ module SanitizeEmail
 
         add_original_addresses_as_headers(message)
 
-        message.subject = self.subject_override(message.subject, message.to) if SanitizeEmail.use_actual_email_prepended_to_subject
+        message.subject = self.prepend_email_to_subject(message.subject, message.to) if SanitizeEmail.use_actual_email_prepended_to_subject
+        message.subject = self.prepend_environment_to_subject(message.subject) if SanitizeEmail.use_actual_environment_prepended_to_subject
+
         message.to = cache_to
         message.cc = cache_cc
         message.bcc = cache_bcc
@@ -88,7 +90,7 @@ module SanitizeEmail
 
     end
 
-    def subject_override(real_subject, actual_addresses)
+    def prepend_email_to_subject(real_subject, actual_addresses)
       if !actual_addresses.respond_to?(:join)
         real_subject
       else
@@ -96,6 +98,12 @@ module SanitizeEmail
       end
     end
 
+    def prepend_environment_to_subject(real_subject)
+      if defined?(Rails) && Rails.env.present?
+        "[#{Rails.env}] #{real_subject}"
+      end
+    end
+
     def to_override(actual_addresses)
       to = override_email(:to, actual_addresses)
       raise MissingTo, 'after overriding :to there are no addresses to send in To: header.' if to.empty?

data/lib/sanitize_email/config.rb

@@ -32,6 +32,10 @@ module SanitizeEmail
       # e.g. "real@example.com rest of subject"
       :use_actual_email_prepended_to_subject => false,
 
+      # Prepend the Rails environment onto the Subject line of the message
+      # e.g. "[development] rest of subject"
+      :use_actual_environment_prepended_to_subject => false,
+
       :activation_proc => Proc.new { false }
     }
 

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.5'
+  VERSION = '1.0.6'
 end

data/spec/sanitize_email_spec.rb

@@ -9,6 +9,7 @@ describe SanitizeEmail do
     :sanitized_cc =>  'cc@sanitize_email.org',
     :sanitized_bcc => 'bcc@sanitize_email.org',
     :use_actual_email_prepended_to_subject => false,
+    :use_actual_environment_prepended_to_subject => false,
     :use_actual_email_as_sanitized_user_name => false
   }
 
@@ -42,6 +43,7 @@ describe SanitizeEmail do
       config[:sanitized_cc] =         options[:sanitized_cc]
       config[:sanitized_bcc] =        options[:sanitized_bcc]
       config[:use_actual_email_prepended_to_subject] = options[:use_actual_email_prepended_to_subject]
+      config[:use_actual_environment_prepended_to_subject] = options[:use_actual_environment_prepended_to_subject]
       config[:use_actual_email_as_sanitized_user_name] = options[:use_actual_email_as_sanitized_user_name]
 
       # For testing *deprecated* configuration options:
@@ -124,7 +126,7 @@ describe SanitizeEmail do
         @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")
+        @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@sanitize_email.org")
       end
       it "should not prepend originals by default" do
         @email_message.should_not have_to_username("to at example.org <to@sanitize_email.org>")
@@ -150,7 +152,7 @@ describe SanitizeEmail do
           @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")
+          @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@sanitize_email.org")
         end
       end
       context "false" do
@@ -168,9 +170,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")
+          @email_message.should_not have_header("X-Sanitize-Email-To", "to@example.org")
+          @email_message.should_not have_header("X-Sanitize-Email-Cc", "cc@example.org")
+          @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@example.org")
         end
       end
       context "nil" do
@@ -192,7 +194,7 @@ describe SanitizeEmail do
             @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")
+            @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@sanitize_email.org")
           end
         end
         context "activation proc disables" do
@@ -211,9 +213,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")
+            @email_message.should_not have_header("X-Sanitize-Email-To", "to@example.org")
+            @email_message.should_not have_header("X-Sanitize-Email-Cc", "cc@example.org")
+            @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@example.org")
           end
         end
       end
@@ -221,6 +223,45 @@ describe SanitizeEmail do
   end
 
   context "config options" do
+    context ":use_actual_environment_prepended_to_subject" do
+      context "true" do
+        before(:each) do
+          sanitize_spec_dryer('test')
+          configure_sanitize_email({:use_actual_environment_prepended_to_subject => true})
+          sanitary_mail_delivery
+        end
+        it "original to is prepended" do
+          @email_message.should have_subject("[test] original subject")
+        end
+        it "should not alter non-sanitized attributes" do
+          @email_message.should have_from('from@example.org')
+          @email_message.should have_reply_to('reply_to@example.org')
+        end
+        it "should not prepend overrides" do
+          @email_message.should_not have_to_username("to at sanitize_email.org")
+          @email_message.should_not have_subject("(to at sanitize_email.org)")
+        end
+      end
+      context "false" do
+        before(:each) do
+          sanitize_spec_dryer('test')
+          configure_sanitize_email({:use_actual_environment_prepended_to_subject => false})
+          sanitary_mail_delivery
+        end
+        it "original to is not prepended" do
+          @email_message.should_not have_subject("[test] original subject")
+        end
+        it "should not alter non-sanitized attributes" do
+          @email_message.should have_from('from@example.org')
+          @email_message.should have_reply_to('reply_to@example.org')
+        end
+        it "should not prepend overrides" do
+          @email_message.should_not have_to_username("to at sanitize_email.org")
+          @email_message.should_not have_subject("(to at sanitize_email.org)")
+        end
+      end
+    end
+
     context ":use_actual_email_prepended_to_subject" do
       context "true" do
         before(:each) do

data/spec/spec_helper.rb

@@ -13,6 +13,9 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  config.include(EmailSpec::Helpers)
+  config.include(EmailSpec::Matchers)
+
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails