sanitize_email 1.0.8 → 1.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 440f53fcb711fc2460929f24e8bf21bd8eb0c8b2
+  data.tar.gz: d82a8ddecb3b756d9a6f2279f8e281d95e2716fd
+SHA512:
+  metadata.gz: c7a542593a80ba4492eb77dad01e74c5d802ef9ad44a2a28c2e51ac65b95419757d8b834c15f0a69fb1e5398c1d1347f645aadfec15c006082677be13f9f9511
+  data.tar.gz: abf7bb45bc8927ad2c59d005116027738f5ed17e946fb947fafc595e9772fcc83b4f231b756c0e2a511232d693198a058c3ea4b88d36e6377e73211a459c610a

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 1.9.2
+  - 2.0.0
   - jruby-19mode
   - rbx-19mode
-  - ruby-head
+#  - ruby-head

data/CHANGELOG.md

@@ -1,10 +1,13 @@
+Version 1.0.9 - AUG.31.2013
+* \[Bug Fix\] More Fixes for #12 - Strange repeating headers, and repeated subject injection by Peter Boling
+
 Version 1.0.8 - AUG.30.2013
-* \[Bug Fix\] Fixes #12 - Streange repeating headers by Peter Boling
+* \[Bug Fix\] Partial Fix for #12 - Strange repeating headers by Peter Boling
 * Lots of refactoring by Peter Boling
   * Properly supports when a to/cc field has multiple recipients sanitized and adds all to mail headers
 * Improved specs by Peter Boling
 
-Version 1.0.7 - AUG.06.2012
+Version 1.0.7 - AUG.06.2013
 
 * \[Bug Fix\] Stripping the message headers before appending new headers.
   - In a scenario where there is a trailing space, adding the newline before we append results in a blank header which throws an error as illegal by Eric Musgrove

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sanitize_email (1.0.7)
+    sanitize_email (1.0.8)
 
 GEM
   remote: http://rubygems.org/

data/lib/sanitize_email/mail_header_tools.rb

@@ -3,7 +3,7 @@ module SanitizeEmail
 
     def self.prepend_subject_array(message)
       prepend = []
-      prepend << SanitizeEmail::MailHeaderTools.prepend_email_to_subject(message.to) if SanitizeEmail.use_actual_email_prepended_to_subject
+      prepend << SanitizeEmail::MailHeaderTools.prepend_email_to_subject(Array(message.to)) if SanitizeEmail.use_actual_email_prepended_to_subject
       prepend << SanitizeEmail::MailHeaderTools.prepend_environment_to_subject if SanitizeEmail.use_actual_environment_prepended_to_subject
       prepend
     end
@@ -13,14 +13,14 @@ module SanitizeEmail
     end
 
     def self.prepend_email_to_subject(actual_addresses)
-      "(#{actual_addresses.join(',').gsub(/@/, ' at ').gsub(/[<>]/, '~')})" if actual_addresses.respond_to?(:join)
+      "(#{actual_addresses.uniq.join(',').gsub(/@/, ' at ').gsub(/[<>]/, '~')})" if actual_addresses.respond_to?(:join)
     end
 
     def self.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, # can be an array
-        'X-Sanitize-Email-Cc' => message.cc  # can be an array
+        'X-Sanitize-Email-To' => Array(message.to).uniq, # can be an array, so casting it as an array
+        'X-Sanitize-Email-Cc' => Array(message.cc).uniq  # can be an array, so casting it as an array
         # 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
@@ -32,7 +32,7 @@ module SanitizeEmail
       message.subject.insert(0, SanitizeEmail::MailHeaderTools.prepend_subject_array(message).join(' ') + ' ')
     end
 
-    # Add headers by string concat. Setting hash values on message.headers does nothing, strangely. http://goo.gl/v46GY
+    # According to https://github.com/mikel/mail this is the correct way to update headers.
     def self.update_header(k, v, message)
       # For each address, as v can be an array of addresses
       Array(v).each_with_index { |a, index|
@@ -43,6 +43,7 @@ module SanitizeEmail
         #puts "for #{num}: #{header_key}"
         message.header[header_key] = a.to_s
         # Old way
+        # Add headers by string concat. Setting hash values on message.headers does nothing, strangely. http://goo.gl/v46GY
         #message.header = message.header.to_s.strip + "\n#{k}: #{a}"
       } if v
       #puts "\nafter message.header:\n #{message.header}\n"

data/lib/sanitize_email/overridden_addresses.rb

@@ -109,7 +109,7 @@ module SanitizeEmail
       addresses.map { |address|
         # If this address is on the good list then let it pass
         self.address_list_filter(list_type, address)
-      }.compact
+      }.compact.uniq
     end
 
     def sanitize_addresses(type)

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.8'
+  VERSION = '1.0.9'
 end

data/spec/sanitize_email_spec.rb

@@ -54,6 +54,20 @@ describe SanitizeEmail do
     Mail.register_interceptor(SanitizeEmail::Bleach.new)
   end
 
+  def funky_config
+    SanitizeEmail::Config.configure do |config|
+      config[:sanitized_to] =         %w( funky@sanitize_email.org yummy@sanitize_email.org same@example.org )
+      config[:sanitized_cc] =         nil
+      config[:sanitized_bcc] =        nil
+      # run/call whatever logic should turn sanitize_email on and off in this Proc:
+      config[:activation_proc] =      Proc.new { Rails.env != 'production' }
+      config[:use_actual_email_prepended_to_subject] = true
+      config[:use_actual_environment_prepended_to_subject] = true
+      config[:use_actual_email_as_sanitized_user_name] = false
+    end
+    Mail.register_interceptor(SanitizeEmail::Bleach.new)
+  end
+
   def sanitary_mail_delivery(config_options = {})
     SanitizeEmail.sanitary(config_options) do
       mail_delivery
@@ -72,6 +86,17 @@ describe SanitizeEmail do
     end
   end
 
+  def mail_delivery_hot_mess
+    @email_message = Mail.deliver do
+      from      'same@example.org'
+      to        %w( same@example.org same@example.org same@example.org same@example.org same@example.org )
+      cc        'same@example.org'
+      bcc       'same@example.org'
+      reply_to  'same@example.org'
+      subject   'original subject'
+    end
+  end
+
   def mail_delivery
     @email_message = Mail.deliver do
       from      'from@example.org'
@@ -198,6 +223,95 @@ describe SanitizeEmail do
       end
     end
 
+    context "sanitary with funky config" do
+      before(:each) do
+        funky_config
+        SanitizeEmail.force_sanitize = true
+        mail_delivery
+      end
+      it "original to is prepended to subject" do
+        @email_message.should have_subject(/\(to at example.org\).*original subject/)
+      end
+      it "original to is only prepended once to subject" do
+        @email_message.should_not have_subject(/\(to at example.org\).*\(to at example.org\).*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
+      it "should override where original recipients were not nil" do
+        @email_message.should have_to("funky@sanitize_email.org")
+      end
+      it "should not override where original recipients were nil" do
+        @email_message.should_not have_cc("cc@sanitize_email.org")
+        @email_message.should_not have_bcc("bcc@sanitize_email.org")
+      end
+      it "should set headers of originals" do
+        @email_message.should have_header("X-Sanitize-Email-To", "to@example.org")
+        @email_message.should have_header("X-Sanitize-Email-Cc", "cc@example.org")
+      end
+      it "should not set headers of bcc" do
+        @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@sanitize_email.org")
+      end
+      it "should not set headers of overrides" do
+        @email_message.should_not have_header("X-Sanitize-Email-To", "funky@sanitize_email.org")
+        @email_message.should_not have_header("X-Sanitize-Email-Cc", "cc@sanitize_email.org")
+        @email_message.should_not have_header("X-Sanitize-Email-Bcc", "bcc@sanitize_email.org")
+        #puts "email headers:\n#{@email_message.header}"
+      end
+      it "should not prepend originals by default" do
+        @email_message.should_not have_to_username("to at example.org <to@sanitize_email.org>")
+        @email_message.should_not have_subject("(to at example.org) original subject")
+      end
+    end
+
+    context "sanitary with funky config and hot mess delivery" do
+      before(:each) do
+        funky_config
+        SanitizeEmail.force_sanitize = true
+        mail_delivery_hot_mess
+      end
+      it "original to is prepended to subject" do
+        @email_message.should have_subject(/\(same at example.org\).*original subject/)
+      end
+      it "original to is only prepended once to subject" do
+        @email_message.should_not have_subject(/\(same at example.org\).*\(same at example.org\).*original subject/)
+      end
+      it "should not alter non-sanitized attributes" do
+        @email_message.should have_from('same@example.org')
+        @email_message.should have_reply_to('same@example.org')
+      end
+      it "should not prepend overrides" do
+        @email_message.should_not have_to_username("same at example.org")
+      end
+      it "should override where original recipients were not nil" do
+        @email_message.should have_to("same@example.org")
+      end
+      it "should not override where original recipients were nil" do
+        @email_message.should_not have_cc("same@example.org")
+        @email_message.should_not have_bcc("same@example.org")
+      end
+      it "should set headers of originals" do
+        @email_message.should have_header("X-Sanitize-Email-To", "same@example.org")
+        @email_message.should have_header("X-Sanitize-Email-Cc", "same@example.org")
+      end
+      it "should not set headers of bcc" do
+        @email_message.should_not have_header("X-Sanitize-Email-Bcc", "same@example.org")
+      end
+      it "should not set headers of overrides" do
+        @email_message.should_not have_header("X-Sanitize-Email-Bcc", "same@example.org")
+        puts "email headers:\n#{@email_message.header}"
+      end
+      it "should not prepend originals by default" do
+        @email_message.should_not have_to_username("same at example.org <same@example.org>")
+        @email_message.should_not have_subject("(same at example.org) original subject")
+      end
+    end
+
     context "force_sanitize" do
       context "true" do
         before(:each) do

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.0.8
-  prerelease: 
+  version: 1.0.9
 platform: ruby
 authors:
 - Peter Boling
@@ -11,185 +10,163 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: letter_opener
   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'
 - !ruby/object:Gem::Dependency
   name: launchy
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
   name: mail
   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'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.8
 - !ruby/object:Gem::Dependency
   name: roodi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !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,
+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.'
 email: peter.boling@gmail.com
@@ -228,28 +205,27 @@ files:
 homepage: http://github.com/pboling/sanitize_email
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: ! 'Rails/Sinatra/Mail gem: Test email abilities without ever sending a message
+specification_version: 4
+summary: 'Rails/Sinatra/Mail gem: Test email abilities without ever sending a message
   to actual live addresses'
 test_files:
 - spec/sanitize_email_spec.rb